feat(docker-compose): Nutze Cache für docker compose

documentation/chapters/templates/IaC/docker-compose.adoc

@@ -3,12 +3,12 @@
 .Provided Templates:
 |===
 |Name |Description
-|.docker-compose-deploy | Executes Docker Compose against a remote maschine.
+|.docker-compose-deploy | Executes docker compose against a remote machine.
-|.docker-compose-validate | Validates the syntactic correctness of your compose files. Still can have execution Problems.
+|.docker-compose-validate | Validates the syntactic correctness of your compose files. Still can have execution problems.
 |===
 
 Copy files with scp from your repository onto the remote system.
-Then executes `docker compose` over a SSH connection.
+Then executes `docker compose` over an SSH connection.
 For this SSH connection you have to provide an SSH key under a CI-CD-Variable with the name $SSH_PRIVATE_KEY.
 If you already have a different $SSH_PRIVATE_KEY you can overwrite the variable SSH_PRIVATE_KEY_DEPLOY.
 
@@ -17,18 +17,18 @@ The .env file should not contain any secrets.
 For this reason you can create a .env file dynamically.
 To generate a .env file you can provide a script under the path ENV_SETUP_FILE.
 
-.Beispiel für ein setup_env.sh
+.Example for a setup_env.sh
 ----
 #!/bin/sh
 
-#Prints all Enviroments into the .env File.
+# Prints all enviroments into the .env file.
 printenv >> .env
 
-#to set a different project prefix use this ENV
+# to set a different project prefix use this ENV
 echo COMPOSE_PROJECT_NAME=project-prefix >>.env
 
-#Secrets
+#  Secrets
-#Some Secret is a Variable within the gitlab CI Variable
+# $SOME_PASSWORD is a variable within the gitlab CI variable
 echo SOME_PASSWORD="$SOME_PASSWORD" >>.env
 ----
 
@@ -64,20 +64,20 @@ We have a workaround for this, please override your script with the following:
 
 | DOCKER_REGISTRY
 | The container registry that will be used to pull images.
-| "$CI_REGISTRY"
+| $CI_REGISTRY
 
 | DOCKER_REGISTRY_PASS
 | The passwort to the docker registry that should be used.
-| "$CI_REGISTRY_PASSWORD"
+| $CI_REGISTRY_PASSWORD
 
 | DOCKER_REGISTRY_USER
 | The user to the docker registry that should be used.
-| "$CI_REGISTRY_USER"
+| $CI_REGISTRY_USER
 
 | ENV_SETUP_FILE
 | If you want to use a .env file, this script can be used to create one.
 Secrets should not be stored within your repository. Use the CI-CD variables in the gitlab setting page.
-| "setup_env.sh"
+| setup_env.sh
 
 | SCP_DESTINATION
 | Target path for scp to push files to.
@@ -96,6 +96,14 @@ For example multiple `-f compose.file.extra` definitions.
 | Additional arguments you want to send to docker compose up.
 For example multiple `--no-deps --no-build` definitions.
 | -
+
+| DOCKER_COMPOSE_VERSION
+| Version of `docker compose`.
+| v2.7.0
+
+| DOCKER_COMPOSE
+| Local path to `docker compose`. If this file does not exist, the script will download it from github.
+| $CI_PROJECT_DIR/docker-compose
 |===
 
 :template: IaC/docker-compose.gitlab-ci.yml

templates/IaC/docker-compose.gitlab-ci.yml

@@ -3,6 +3,7 @@
   stage: deploy
   variables:
     DOCKER_COMPOSE_VERSION: "v2.7.0"
+    DOCKER_COMPOSE: "$CI_PROJECT_DIR/docker-compose"
     SCP_DESTINATION: ""
     SCP_SOURCE: $CI_PROJECT_DIR
     COMPOSE_EXTRA_ARGS: ""
@@ -17,6 +18,10 @@
     SSH_PRIVATE_KEY_DEPLOY: $SSH_PRIVATE_KEY
   rules:
     - when: manual
+  cache:
+    key: "docker-compose-$DOCKER_COMPOSE_VERSION"
+    paths:
+      - $CI_PROJECT_DIR/docker-compose
   # https://docs.gitlab.com/ee/ci/ssh_keys/
   before_script:
     - if [ -f "$ENV_SETUP_FILE" ]; then chmod +x ./$ENV_SETUP_FILE; ./$ENV_SETUP_FILE; fi
@@ -27,15 +32,18 @@
     - chmod 700 ~/.ssh
     # Add keys to known hosts for Docker Compose
     - ssh-keyscan $SSH_URL >> ~/.ssh/known_hosts
-    # Install docker-compose, from release directly
+    # If missing, install docker-compose from release directly
-    - wget https://github.com/docker/compose/releases/download/$DOCKER_COMPOSE_VERSION/docker-compose-linux-x86_64 -O /usr/local/bin/docker-compose
+    - >
+      if [[ ! -f "$DOCKER_COMPOSE"  ]]; then
+        wget https://github.com/docker/compose/releases/download/$DOCKER_COMPOSE_VERSION/docker-compose-linux-x86_64 -O $DOCKER_COMPOSE
+      fi
     - chmod +x /usr/local/bin/docker-compose
   script:
     - export DOCKER_HOST=ssh://$SSH_USER@$SSH_URL:$SSH_PORT
     - if [[ -n "$SCP_SOURCE" && -n "$SCP_DESTINATION"  ]]; then scp -rp $SCP_SOURCE $SSH_USER@$SSH_URL:$SCP_DESTINATION; fi
     - if [[ -n "$DOCKER_REGISTRY" ]]; then echo "$DOCKER_REGISTRY_PASS" | docker login  $DOCKER_REGISTRY --username $DOCKER_REGISTRY_USER --password-stdin; fi
-    - docker-compose $COMPOSE_EXTRA_ARGS pull
+    - $DOCKER_COMPOSE $COMPOSE_EXTRA_ARGS pull
-    - docker-compose $COMPOSE_EXTRA_ARGS up -d --remove-orphans $COMPOSE_UP_EXTRA_ARGS
+    - $DOCKER_COMPOSE $COMPOSE_EXTRA_ARGS up -d --remove-orphans $COMPOSE_UP_EXTRA_ARGS
 
 .broken-ssh-connection-workaround:
   script:
@@ -45,17 +53,25 @@
     - rm -f /tmp/docker.sock
     - ssh -M -S docker-ctrl-socket -fnNT -L /tmp/docker.sock:/var/run/docker.sock "$SSH_USER@$SSH_URL" -p $SSH_PORT -o ControlPersist=no
     - if [[ -n "$DOCKER_REGISTRY" ]]; then echo "$DOCKER_REGISTRY_PASS" | docker login $DOCKER_REGISTRY --username $DOCKER_REGISTRY_USER --password-stdin; fi
-    - docker-compose $COMPOSE_EXTRA_ARGS pull
+    - $DOCKER_COMPOSE $COMPOSE_EXTRA_ARGS pull
-    - docker-compose $COMPOSE_EXTRA_ARGS up -d --remove-orphans $COMPOSE_UP_EXTRA_ARGS
+    - $DOCKER_COMPOSE $COMPOSE_EXTRA_ARGS up -d --remove-orphans $COMPOSE_UP_EXTRA_ARGS
 
 .docker-compose-validate:
   image: docker:20.10.16-alpine3.15
   stage: verify
   variables:
     DOCKER_COMPOSE_VERSION: "v2.7.0"
+    DOCKER_COMPOSE: "$CI_PROJECT_DIR/docker-compose"
+  cache:
+    key: "docker-compose-$DOCKER_COMPOSE_VERSION"
+    paths:
+      - $CI_PROJECT_DIR/docker-compose
   before_script:
-    # Install docker-compose, from release directly
+    # If missing, install docker-compose from release directly
-    - wget https://github.com/docker/compose/releases/download/$DOCKER_COMPOSE_VERSION/docker-compose-linux-x86_64 -O /usr/local/bin/docker-compose
+    - >
+      if [[ ! -f "$DOCKER_COMPOSE"  ]]; then
+        wget https://github.com/docker/compose/releases/download/$DOCKER_COMPOSE_VERSION/docker-compose-linux-x86_64 -O $DOCKER_COMPOSE
+      fi
     - chmod +x /usr/local/bin/docker-compose
   script:
-    - docker-compose $COMPOSE_EXTRA_ARGS config --quiet
+    - $DOCKER_COMPOSE $COMPOSE_EXTRA_ARGS config --quiet