Commit e25ebb9e authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch 'docs_known_hosts' into 'main' 

docs: add some precisions on known_hosts

See merge request to-be-continuous/docker-compose!12
parents d081ab14 39ef74f1

README.md

+11 −11
Original line number Diff line number Diff line
@@ -316,7 +316,7 @@ Here are some advices about your **secrets** (variables marked with a :lock:): 
The Docker Compose template uses some global configuration used throughout all jobs and environments.



| Input / Variable         | Description                                                                                                                                                                         | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| ------------------------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------- |

| `image` / `DCMP_IMAGE` | The Docker image used to run Docker Compose CLI commands                                                                                                                            | `registry.hub.docker.com/library/docker:latest` |

| `cmd` / `DCMP_CMD`     | The docker compose or stack command (`docker compose`, `docker-compose` or `docker stack`)                                                                                          | _none_ (auto) |

| `base-app-name` / `DCMP_BASE_APP_NAME`| Base application name                                                                                                                                                               | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |
@@ -326,7 +326,7 @@ The Docker Compose template uses some global configuration used throughout all j 
| `down-opts`/ `DCMP_DOWN_OPTS` | [`compose down` options](https://docs.docker.com/reference/cli/docker/compose/down/#options) (only when using Docker Compose)                                                       | `--volumes --remove-orphans --rmi all` |

| `stack-deploy-opts` / `DCMP_STACK_DEPLOY_OPTS` | [`stack deploy` options](https://docs.docker.com/reference/cli/docker/stack/deploy/) (only when using Docker Stack)                                                                 | `--prune` |

| :lock: `DCMP_SSH_PRIVATE_KEY` | Default SSH key to use when connecting to Docker hosts over SSH (can be overridden per env)                                                                                         | _none_ |

| `ssh-known-hosts` / `DCMP_SSH_KNOWN_HOSTS` | SSH `known_hosts` (file or text variable) | _none_ |

| `ssh-known-hosts` / `DCMP_SSH_KNOWN_HOSTS` | SSH `known_hosts` (file or text variable: you can get its value with `ssh-keyscan -H <DOCKER_HOST>`, mandatory if you're using a remote docker through ssh)                         | _none_ |



### Review environments configuration