From 56a4d3352f67a75494eb58162e59d37c6ba932e7 Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Wed, 3 Jul 2024 17:38:29 +0200 Subject: [PATCH] revert changes at dcgoss --- extras/dcgoss/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/extras/dcgoss/README.md b/extras/dcgoss/README.md index 55cb4771..6ad563df 100644 --- a/extras/dcgoss/README.md +++ b/extras/dcgoss/README.md @@ -9,7 +9,7 @@ containers. It is based on `dgoss`. ### Run -Run is used to validate a container defined in `docker-compose.yml`. It expects both a `docker-compose.yml` +Run is used to validate a docker defined in `docker-compose.yml`. It expects both a `docker-compose.yml` and `goss.yaml` file to exist in the directory it was invoked from. Container configuration is used from the compose file, for example: @@ -25,13 +25,13 @@ compose file, for example: * Start the container as defined in `docker-compose.yml` * Stream the containers log output into the container as `/goss/docker_output.log` - * This allows writing tests or waits against the container output + * This allows writing tests or waits against the docker output * (optional) Run `goss` with `$GOSS_WAIT_OPTS` if `./goss_wait.yaml` file exists in the current dir * Run `goss` with `$GOSS_OPTS` using `./goss.yaml` ### Edit -Edit will launch a container, install goss, and drop the user into an interactive shell. +Edit will launch a docker container, install goss, and drop the user into an interactive shell. Once the user quits the interactive shell, any `goss.yaml` or `goss_wait.yaml` are copied out into the current directory. This allows the user to leverage the `goss add|autoadd` commands to write tests as they would on a regular machine. @@ -98,8 +98,8 @@ Allows to specify a differing name for `goss.yaml`. Useful when the same image i #### GOSS_VARS The name of the variables file relative to `GOSS_FILES_PATH` to copy into the -container and use for valiation (i.e. `dcgoss run`) and copy out of the -container when writing tests (i.e. `dcgoss edit`). If set, the +docker container and use for valiation (i.e. `dcgoss run`) and copy out of the +docker container when writing tests (i.e. `dcgoss edit`). If set, the `--vars` flag is passed to `goss validate` commands inside the container. If unset (or empty), the `--vars` flag is omitted, which is the normal behavior. @@ -107,12 +107,12 @@ If unset (or empty), the `--vars` flag is omitted, which is the normal behavior. #### GOSS_FILES_STRATEGY -Strategy used for copying goss files into the container. +Strategy used for copying goss files into the docker container. If set to `'mount'` a volume with goss files is mounted and log output is streamed into the container as `/goss/docker_output.log` file. -Other strategy is `'cp'` which uses `'docker cp'` (or `'podman cp'`) command to copy goss files into container. +Other strategy is `'cp'` which uses `'docker cp'` (or `'podman cp'`) command to copy goss files into docker container. With the `'cp'` strategy you lose the ability to write tests or waits against the output. -The `'cp'` strategy is required especially when container daemon is not on the local machine. +The `'cp'` strategy is required especially when docker daemon is not on the local machine. **Default:** `'mount'`