Skip to content

Commit b8ff782

Browse files
authored
docs: Update and more general wording for "docker container" (#934)
* docs: Update and more general wording for "docker container" * revert one change * revert one change at README.md * revert changes at dcgoss * revert again
1 parent c9e7b54 commit b8ff782

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a href="https://asciinema.org/a/4suhr8p42qcn6r7crfzt6cc3e?autoplay=1" target="_blank"><img src="https://cloud.githubusercontent.com/assets/6783261/17330426/ce7ad066-5894-11e6-84ea-29fd4207af58.gif" alt="asciicast"></a>
1515
<!-- markdownlint-enable line-length no-inline-html -->
1616

17-
**Note:** For testing docker containers see the [dgoss](https://github.com/goss-org/goss/tree/master/extras/dgoss) wrapper.
17+
**Note:** For testing containers see the [dgoss](https://github.com/goss-org/goss/tree/master/extras/dgoss) wrapper.
1818
Also, user submitted wrapper scripts for Kubernetes [kgoss](https://github.com/goss-org/goss/tree/master/extras/kgoss)
1919
and Docker Compose [dcgoss](https://github.com/goss-org/goss/tree/master/extras/dcgoss).
2020

extras/dgoss/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# dgoss
22

3-
dgoss is a convenience wrapper around goss that aims to bring the simplicity of goss to docker containers.
3+
dgoss is a convenience wrapper around goss that aims to bring the simplicity of goss to containers.
44

55
## Examples and Tutorials
66

77
* [blog tutorial](https://medium.com/@aelsabbahy/tutorial-how-to-test-your-docker-image-in-half-a-second-bbd13e06a4a9) -
88
Introduction to dgoss tutorial
99
* [video tutorial](https://youtu.be/PEHz5EnZ-FM) - Same as above, but in video format
1010
* [dgoss-examples](https://github.com/aelsabbahy/dgoss-examples) - Repo containing examples of using dgoss to validate
11-
docker images
11+
container images
1212

1313
## Installation
1414

@@ -45,9 +45,10 @@ dgoss run ...
4545

4646
### Run
4747

48-
Run is used to validate a docker container.
48+
Run is used to validate a container.
4949
It expects a `./goss.yaml` file to exist in the directory it was invoked from.
50-
In most cases one can just substitute the docker command for the dgoss command, for example:
50+
In most cases one can just substitute the runtime command (`docker` or `podman`)
51+
for the dgoss command, for example:
5152

5253
**run:**
5354

@@ -61,13 +62,13 @@ In most cases one can just substitute the docker command for the dgoss command,
6162

6263
* Run the container with the flags you specified.
6364
* Stream the containers log output into the container as `/goss/docker_output.log`
64-
* This allows writing tests or waits against the docker output
65+
* This allows writing tests or waits against the container output
6566
* (optional) Run `goss` with `$GOSS_WAIT_OPTS` if `./goss_wait.yaml` file exists in the current dir
6667
* Run `goss` with `$GOSS_OPTS` using `./goss.yaml`
6768

6869
### Edit
6970

70-
Edit will launch a docker container, install goss, and drop the user into an interactive shell.
71+
Edit will launch a container, install goss, and drop the user into an interactive shell.
7172
Once the user quits the interactive shell, any `goss.yaml` or `goss_wait.yaml` are copied out into the current directory.
7273
This allows the user to leverage the `goss add|autoadd` commands to write tests as they would on a regular machine.
7374

@@ -117,18 +118,18 @@ directory `DGOSS_TEMP_DIR`. (Default: `''`)
117118
#### GOSS_VARS
118119

119120
The name of the variables file relative to `GOSS_FILES_PATH` to copy into the
120-
docker container and use for valiation (i.e. `dgoss run`) and copy out of the
121-
docker container when writing tests (i.e. `dgoss edit`). If set, the
121+
container and use for valiation (i.e. `dgoss run`) and copy out of the
122+
container when writing tests (i.e. `dgoss edit`). If set, the
122123
`--vars` flag is passed to `goss validate` commands inside the container.
123124
If unset (or empty), the `--vars` flag is omitted, which is the normal behavior.
124125
(Default: `''`).
125126

126127
#### GOSS_FILES_STRATEGY
127128

128-
Strategy used for copying goss files into the docker container. If set to `'mount'` a volume with goss files is mounted
129+
Strategy used for copying goss files into the container. If set to `'mount'` a volume with goss files is mounted
129130
and log output is streamed into the container as `/goss/docker_output.log` file. Other strategy is `'cp'` which uses
130-
`'docker cp'` command to copy goss files into docker container. With the `'cp'` strategy you lose the ability to write
131-
tests or waits against the docker output. The `'cp'` strategy is required especially when docker daemon is not on the
131+
`'docker cp'` command to copy goss files into container. With the `'cp'` strategy you lose the ability to write
132+
tests or waits against the container output. The `'cp'` strategy is required especially when container daemon is not on the
132133
local machine.
133134
(Default `'mount'`)
134135

extras/kgoss/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To find `goss.yaml` in another directory specify that directory's path in `GOSS_
9696

9797
### Run
9898

99-
The `run` command is used to validate a docker container. It expects a
99+
The `run` command is used to validate a container. It expects a
100100
`./goss.yaml` file to exist in the directory it was invoked from.
101101

102102
**Example:**
@@ -111,7 +111,7 @@ The `run` command is used to validate a docker container. It expects a
111111

112112
### Edit
113113

114-
Edit will launch a docker container, install goss, and drop the user into an
114+
Edit will launch a container, install goss, and drop the user into an
115115
interactive shell. Once the user quits the interactive shell, any `goss.yaml`
116116
or `goss_wait.yaml` are copied out into the current directory. This allows the
117117
user to leverage the `goss add|autoadd` commands to write tests as they would

0 commit comments

Comments
 (0)