diff --git a/documentation/chapters/templates/IaC/docker-compose.adoc b/documentation/chapters/templates/IaC/docker-compose.adoc index 3b041e4..3e43e92 100644 --- a/documentation/chapters/templates/IaC/docker-compose.adoc +++ b/documentation/chapters/templates/IaC/docker-compose.adoc @@ -7,13 +7,13 @@ |.docker-compose-validate | Validates the syntactic correctness of your compose files. Still can have execution Problems. |=== -Copy files with scp onto from your Repo to the Remote system. -Then executes Docker-compose over a SSH connection. -For this SSH connection you have to Provide a 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. +Copy files with scp from your repository onto the remote system. +Then executes `docker compose` over a 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. -To Parametrise the Docker-Compose File you can use a .env File. -The .env File should not contain any Secrets. +To parametrise the docker-compose file you can use a .env file. +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. @@ -24,7 +24,7 @@ To generate a .env file you can provide a script under the path ENV_SETUP_FILE. #Prints all Enviroments into the .env File. printenv >> .env -#to set a diffrent Project Prefix use this ENV +#to set a different project prefix use this ENV echo COMPOSE_PROJECT_NAME=project-prefix >>.env #Secrets @@ -34,7 +34,7 @@ echo SOME_PASSWORD="$SOME_PASSWORD" >>.env == SSH Problem workaround -Sometimes there is a problem with some SSH servers and Docker. +Sometimes there is a problem with some SSH servers and docker. We have a workaround for this, please override your script with the following: ---- @@ -59,11 +59,11 @@ We have a workaround for this, please override your script with the following: | 22 | SSH_USER -| The user that is used to login into the remote maschine. +| The user that is used to log into the remote maschine. | - | DOCKER_REGISTRY -| The Container Registry that will be used to pull images. +| The container registry that will be used to pull images. | "$CI_REGISTRY" | DOCKER_REGISTRY_PASS @@ -75,8 +75,8 @@ We have a workaround for this, please override your script with the following: | "$CI_REGISTRY_USER" | ENV_SETUP_FILE -| If you want to use a .env file, this skript can be used to create one. -Secrets should not be stored within your repository. Use the CI-CD Variables in the setting page. +| 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" | SCP_DESTINATION @@ -84,16 +84,16 @@ Secrets should not be stored within your repository. Use the CI-CD Variables in | - | SCP_SOURCE -| Path you want to copy to the remote System. +| Path you want to copy to the remote system. | $CI_PROJECT_DIR | COMPOSE_EXTRA_ARGS -| Additional arguments you want to send to Docker Compose. +| Additional arguments you want to send to docker compose. For example multiple `-f compose.file.extra` definitions. | - | COMPOSE_UP_EXTRA_ARGS -| Additional arguments you want to send to Docker Compose up. +| Additional arguments you want to send to docker compose up. For example multiple `--no-deps --no-build` definitions. | - |=== diff --git a/templates/IaC/docker-compose.gitlab-ci.yml b/templates/IaC/docker-compose.gitlab-ci.yml index 75e96ee..17f093b 100644 --- a/templates/IaC/docker-compose.gitlab-ci.yml +++ b/templates/IaC/docker-compose.gitlab-ci.yml @@ -27,7 +27,7 @@ - chmod 700 ~/.ssh # Add keys to known hosts for Docker Compose - ssh-keyscan $SSH_URL >> ~/.ssh/known_hosts - #Install docker Compose, from release directly + # 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 - chmod +x /usr/local/bin/docker-compose script: @@ -41,7 +41,7 @@ script: - export DOCKER_HOST=unix:///tmp/docker.sock - if [[ -n "$SCP_SOURCE" && -n "$SCP_DESTINATION" ]]; then scp -rp $SCP_SOURCE $SSH_USER@$SSH_URL:$SCP_DESTINATION; fi - # Tunnel Docker socket from remote Maschine to local Maschine. This should be more stable than the current SSH Implementation of Docker + # Tunnel Docker socket from remote machine to local machine. This should be more stable than the current SSH implementation of Docker - 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 @@ -52,10 +52,10 @@ image: docker:20.10.16-alpine3.15 stage: verify variables: - DOCKER_COMPOSE_VERSION: 2.7.0 + DOCKER_COMPOSE_VERSION: "v2.7.0" before_script: - #Install docker Compose, from release directly + # 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 - chmod +x /usr/local/bin/docker-compose script: - - docker-compose $COMPOSE_EXTRA_ARGS config + - docker-compose $COMPOSE_EXTRA_ARGS config --quiet