-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update and more general wording for "docker container" #934
Merged
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0f3bde2
docs: Update and more general wording for "docker container"
dklimpel fcdd293
revert one change
dklimpel 64ad3c0
Merge branch 'master' into docs_fix_wording_docker
dklimpel dfc94ab
Merge branch 'master' into docs_fix_wording_docker
dklimpel e6a581e
revert one change at README.md
dklimpel ca223f8
Merge branch 'master' into docs_fix_wording_docker
dklimpel 56a4d33
revert changes at dcgoss
dklimpel 33700a0
revert again
dklimpel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,7 @@ containers. It is based on `dgoss`. | |
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. lets revert the changes in this file, since it's dcgoss aka docker-compose goss. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
### Run | ||
|
||
Run is used to validate a docker container defined in `docker-compose.yml`. It expects both a `docker-compose.yml` | ||
Run is used to validate a container 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 docker output | ||
* This allows writing tests or waits against the container 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 docker container, install goss, and drop the user into an interactive shell. | ||
Edit will launch a 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,21 +98,21 @@ 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 | ||
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 | ||
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 | ||
`--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. | ||
|
||
**Default:** `''` | ||
|
||
#### GOSS_FILES_STRATEGY | ||
|
||
Strategy used for copying goss files into the docker container. | ||
Strategy used for copying goss files into the 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'` command to copy goss files into docker container. | ||
With the `'cp'` strategy you lose the ability to write tests or waits against the docker output. | ||
The `'cp'` strategy is required especially when docker daemon is not on the local machine. | ||
Other strategy is `'cp'` which uses `'docker cp'` (or `'podman cp'`) command to copy goss files into 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. | ||
|
||
**Default:** `'mount'` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The blog post references docker, this line should be reverted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.