Om deployment servers, stages, branches en dergelijken te configureren moet er een deploy-config.yml bestand worden aangemaakt. In dit bestand worden alle ‘secrets’ gezet. Zorg ervoor, dat wanneer je een public repository gebruikt, dit bestand niet wordt meegepushed.

Definieren

Om te beginnen moet er een deploy-config.yml bestand aangemaakt worden. Dit kan doormiddel van het dupliceren van het voorbeeld bestand. Wanneer dit niet mogelijk is, gebruik dan het volgende voorbeeld of download het orginele bestand.

Algemeen

# General information:
general:
  ssh_repo_url: 'git@github.com:johankladder/yii2-app-advanced.git'   # The repository your project is stored

# Staging servers:
server:
  # The production server
  production:
    host: 'applicationname.com'                       # Deployment server hostname/ip
    stage: 'production'                               # Stage name; can be used by 'dep deploy-yii [stage]
    branch: 'master'                                  # The branch that should be used to deploy
    deploy_path: '/var/www/applicationname.com'       # The deploy location
    ssh_user: 'username'                              # The SSH username, that has access to the remote server

In het bovenstaande (gedeeltelijke) example is te zien hoe een stage gedefinieerd wordt.

• Allereerst wordt een betreffende repository opgegeven. Deze repository mag zowel private als public zijn.
• Daarna kunnen de server settings worden gedefinieerd;
  • Allereerst moet de host worden gedefinieerd. De host is het adres waarop de remote server te bereiken is. Dit kan zowel een ip-adres als dns naam zijn. Het is belangrijk dat een hostnaam maar een keer gebruikt mag worden tussen elke stage. Er kunnen dus niet meerdere stages zijn die ‘applicationname.com’ als hostname hebben.
  • Daarna kan de stage worden opgegeven. De stage is de key die je gaat gebruiken bij het oproepen van een actie. Bijvoorbeeld in dit voorbeeld zou je voor het deployen vender/bin/dep deploy-yii production moeten gebruiken.
  • Als derde wordt er een branchnaam opgegeven. Deze branch wordt gebruikt om als basis te gebruiken voor het deployen.
  • Hierna wordt een zogenoemd deploy_path opgegeven. Dit is de locatie waar Deployer zijn bestanden en mappen mag plaatsen.
  • Als laatste wordt er een SSH gebruikersnaam opgegeven. Dit is de naam die je gebruikt om via SSH toegang te krijgen naar de server.

Volgorde van bovenstaande keys zijn niet van belang.

Instellingen

    [...]
    username: '.....'
    settings:
      yii:
        init: 'Development'                           # Environment that can be used. See `php init` for possibilities
      migrate:
        rbac: true                                    # Execute RBAC migrations
        db: true                                      # Execute `yii migrate`
      sync:
        uploads:
          source: 'shared/uploads/'                   # Base of the sync folder
          dest: 'shared/uploads'                      # 'To' pathname from base deployment path
          create_if_not_exists: true                  # Create the 'To' path if not exist
    shared:
      - 'common/config/config.yaml'

Om stages meer opties te geven, kan het volgende onder de SSH username worden geplaatst. In deze situatie zal er tijdens het deployen het volgende gebeuren:

• Een Yii applicatie zal in ‘Development’ environment worden ingesteld. De deployer voert php init op de remote server uit en zal dit doen met de ‘Development’ optie.
• RBAC migraties zullen worden uitgevoerd.
• Database migraties zullen worden uitgevoerd.
• De map projectroot/shared/uploads zal worden gesynchroniseerd met deploypath/shared/uploads. En deze zal worden aangemaakt wanneer deze niet aanwezig is.
• Het bestand ‘common/config/config.yaml’ zal worden gezien als shared resources.

Meer opties:

Wanneer het bestand wordt ingesteld. Houdt dan rekening met de volgende restricties en mogelijkheden:

Ga naar deployen