1. Install package composer require shopsys/deployment

2. Copy deploy-project.sh into your project to deploy/deploy-project.sh

3. Create or copy htpasswd file with login credentials to deploy/basicHttpAuth

   Default login for basicHttpAuth is username/password For info about how change http auth credentials see Change HTTP auth

4. Update your gitlab-ci.yml

   • create new stage with name deploy:

     stages:
         - build
         - test
         - review
     +   - deploy
         - service

   • Add new deploy template:

     .deploy: &deploy
         image:
             name: shopsys/kubernetes-buildpack:0.9
         stage: deploy
         tags:
             - docker
         rules:
             -   if: '$CI_PIPELINE_SOURCE == "schedule"'
                 when: never
         script:
             - docker create -ti --name image ${TAG} bash
             - docker cp image:/var/www/html/var/ ./
             - mkdir -p /root/.kube/ && echo "${KUBE_CONFIG}" > /root/.kube/config
             - chmod +x ./deploy/deploy-project.sh && ./deploy/deploy-project.sh deploy

   • Add new jobs for deploy devel and production:

     deploy:production:
         <<: *deploy
         resource_group: deploy_production
         variables:
             KUBE_CONFIG: ${KUBE_CONFIG_PROD}
         needs:
             - build
         rules:
             -   if: '$CI_PIPELINE_SOURCE == "schedule"'
                 when: never
             -   if: '$CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH =~ /^master-.*$/'
                 when: manual
                 allow_failure: false
         environment:
             name: production
             url: https://${DOMAIN_HOSTNAME_1}
     
     deploy:devel:
         <<: *deploy
         resource_group: deploy_devel
         variables:
             KUBE_CONFIG: ${KUBE_CONFIG_DEVEL}
         needs:
             - build
             - test:standards
             - test:functional
             - test:acceptance
         rules:
             -   if: '$CI_PIPELINE_SOURCE == "schedule"'
                 when: never
             -   if: '$CI_COMMIT_BRANCH == "devel" || $CI_COMMIT_BRANCH =~ /^devel-.*$/'
         environment:
             name: devel
             url: https://${DOMAIN_HOSTNAME_1}

5. Set Environment variables to in Gitlab (Settings -> CI/CD -> Variables)

6. Push changes and have fun

Environment variables can be set in Gitlab (Settings -> CI/CD -> Variables)

If you want to define your custom variables see Define custom variables section

*1) Credentials can be generated in Gitlab (Settings -> Repository -> Deploy Tokens) with read_registry scope only

You can add your custom variables. Do not forget to edit deploy-project.sh

You can override kubernetes manifests by place your custom manifest into orchestration/kubernetes/ path in your project

You need to mirror folders to be able to override manifests

1. Create new Phing target that will run your cron:

      <target name="cron-customers" description="....">
          <exec executable="${path.php.executable}" passthru="true" checkreturn="true">
              <arg value="${path.bin-console}" />
              <arg value="shopsys:cron" />
              <arg value="--instance-name=customers" />
          </exec>
      </target>

2. Declare new cron to your deploy configuration file deploy-project.sh:

   As a key there is used phing target that you created in step 1. and value represents crontab timer

       ...
       declare -A CRON_INSTANCES=(
           ["cron"]='*/5 * * * *'
   +       ["cron-customers"]='*/5 * * * *'
       )
       ...

This example will work with 3 domains

1. Create environment variable for every domain:

   Name	Value
   DOMAIN_HOSTNAME_1	mydomain.prod.shopsys.cloud
   DOMAIN_HOSTNAME_2	sk.mydomain.prod.shopsys.cloud
   DOMAIN_HOSTNAME_3	en.mydomain.prod.shopsys.cloud

2. Edit deploy-project.sh

   ...
   function deploy() {
       DOMAINS=(
           DOMAIN_HOSTNAME_1
           DOMAIN_HOSTNAME_2
   +       DOMAIN_HOSTNAME_3
       )
   ...

1. Create Environment variable
2. Edit deploy-project.sh

   ...
   declare -A ENVIRONMENT_VARIABLES=(
       ["DATABASE_HOST"]=${POSTGRES_DATABASE_IP_ADDRESS}
       ["DATABASE_NAME"]=${PROJECT_NAME}
       ["DATABASE_PORT"]=${POSTGRES_DATABASE_PORT}
   )
   ...

   Left part is name of variable in application and right part is name of variable Gitlab.

Add new variable to deploy/deploy-project.sh and specify your redis version

  ...
  BASIC_AUTH_PATH="${BASE_PATH}/deploy/basicHttpAuth"
  DEPLOY_TARGET_PATH="${BASE_PATH}/var/deployment/deploy"
+ REDIS_VERSION='redis:4.0-alpine'

  function deploy() {
  ...

Add new variables to deploy/deploy-project.sh to enable pod autoscaling:

• Enable this functionality:

  ...
  function deploy() {
      DOMAINS=(
          DOMAIN_HOSTNAME_1
          ...
      )
    
  +   ENABLE_AUTOSCALING=true
  ...

• If you need more replicas, then specify max replicas with parameter MAX_PHP_FPM_REPLICAS (Default are 2 replicas)

Add to deploy/deploy-project.sh new array FORCE_HTTP_AUTH_IN_PRODUCTION with domains which should be not accessible without HTTP auth:

...
    )

+   # This setting has no effect when `RUNNING_PRODUCTION` is set to `0`
+   FORCE_HTTP_AUTH_IN_PRODUCTION=(
+       DOMAIN_HOSTNAME_2
+   )

    declare -A ENVIRONMENT_VARIABLES=(
...

1. Generate new HTTP auth string (for example here), or by command htpasswd -nb username password
2. Replace or add new HTTP auth string to deploy/basicHttpAuth
3. Set new credentials to variable in deploy/deploy-project.sh

...
function deploy() {
    DOMAINS=(
        DOMAIN_HOSTNAME_1
        ...
    )
  
+   HTTP_AUTH_CREDENTIALS="username:password"
...

You need only to add IP address to deploy/deploy-project.sh to WHITELIST_IPS variable

TIP: It would be nice to have all IP addresses described like:

#              Some IP   Another IP    Some service
WHITELIST_IPS="8.8.8.8, 217.23.44.23, 93.111.234.111"

You can enable automatic notification of your deployment directly into Slack channel. It has some features:

1. Notify about starting of deployment with a preview of features

2. Notify about the end of deployment. There are two possible alerts - Success and Error

This script works only with Gitlab and Slack, but you can override deploy/slack-notification.py if you want to change behavior. For Slack, you have to create some Slack App with permissions (chat:write, chat:write.public).

There has to be set some environment variables list in the table bellow: