docs(typos): Fix ein paar Typos

This commit is contained in:
Timo Beller 2022-07-26 13:43:20 +02:00
parent dd11b231ed
commit ed9a453697
2 changed files with 20 additions and 20 deletions

View File

@ -7,13 +7,13 @@
|.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 onto from your Repo to the Remote system. Copy files with scp from your repository onto the remote system.
Then executes Docker-compose over a SSH connection. 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. 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. 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. To parametrise the docker-compose file you can use a .env file.
The .env File should not contain any Secrets. The .env file should not contain any secrets.
For this reason you can create a .env file dynamically. 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. 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. #Prints all Enviroments into the .env File.
printenv >> .env 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 echo COMPOSE_PROJECT_NAME=project-prefix >>.env
#Secrets #Secrets
@ -34,7 +34,7 @@ echo SOME_PASSWORD="$SOME_PASSWORD" >>.env
== SSH Problem workaround == 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: 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 | 22
| SSH_USER | 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 | DOCKER_REGISTRY
| The Container Registry that will be used to pull images. | The container registry that will be used to pull images.
| "$CI_REGISTRY" | "$CI_REGISTRY"
| DOCKER_REGISTRY_PASS | DOCKER_REGISTRY_PASS
@ -75,8 +75,8 @@ We have a workaround for this, please override your script with the following:
| "$CI_REGISTRY_USER" | "$CI_REGISTRY_USER"
| ENV_SETUP_FILE | ENV_SETUP_FILE
| If you want to use a .env file, this skript can be used to create one. | 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 setting page. 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 | SCP_DESTINATION
@ -84,16 +84,16 @@ Secrets should not be stored within your repository. Use the CI-CD Variables in
| - | -
| SCP_SOURCE | SCP_SOURCE
| Path you want to copy to the remote System. | Path you want to copy to the remote system.
| $CI_PROJECT_DIR | $CI_PROJECT_DIR
| COMPOSE_EXTRA_ARGS | 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. For example multiple `-f compose.file.extra` definitions.
| - | -
| COMPOSE_UP_EXTRA_ARGS | 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. For example multiple `--no-deps --no-build` definitions.
| - | -
|=== |===

View File

@ -27,7 +27,7 @@
- chmod 700 ~/.ssh - chmod 700 ~/.ssh
# Add keys to known hosts for Docker Compose # Add keys to known hosts for Docker Compose
- ssh-keyscan $SSH_URL >> ~/.ssh/known_hosts - 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 - 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 - chmod +x /usr/local/bin/docker-compose
script: script:
@ -41,7 +41,7 @@
script: script:
- export DOCKER_HOST=unix:///tmp/docker.sock - 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 - 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 - 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 - 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 - 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 image: docker:20.10.16-alpine3.15
stage: verify stage: verify
variables: variables:
DOCKER_COMPOSE_VERSION: 2.7.0 DOCKER_COMPOSE_VERSION: "v2.7.0"
before_script: 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 - 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 - chmod +x /usr/local/bin/docker-compose
script: script:
- docker-compose $COMPOSE_EXTRA_ARGS config - docker-compose $COMPOSE_EXTRA_ARGS config --quiet