Skip to content

Commit 43c4e0c

Browse files
authored
docs: improvement of the explanation of goss_wait.yaml (#1001)
* docs: improvement of the explanation of `goss_wait.yaml` * fix md lint
1 parent 6434d95 commit 43c4e0c

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

extras/dcgoss/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,14 @@ containers. It is based on `dgoss`.
1010
### Run
1111

1212
Run is used to validate a docker container defined in `docker-compose.yml`. It expects both a `docker-compose.yml`
13-
and `goss.yaml` file to exist in the directory it was invoked from. Container configuration is used from the
14-
compose file, for example:
13+
and `goss.yaml` file to exist in the directory it was invoked from.
14+
15+
If the file `./goss_wait.yaml` exists in the current directory, goss regularly
16+
checks whether the conditions in the file are met. Only then does goss start the
17+
actual check with the file `./goss.yaml`. This is used, for example, to wait
18+
until a certain port is open before executing the tests.
19+
20+
Container configuration is used from the compose file, for example:
1521

1622
**run:**
1723

extras/dgoss/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ dgoss run ...
4747

4848
Run is used to validate a container.
4949
It expects a `./goss.yaml` file to exist in the directory it was invoked from.
50+
51+
If the file `./goss_wait.yaml` exists in the current directory, goss regularly
52+
checks whether the conditions in the file are met. Only then does goss start the
53+
actual check with the file `./goss.yaml`. This is used, for example, to wait
54+
until a certain port is open before executing the tests.
55+
5056
In most cases one can just substitute the runtime command (`docker` or `podman`)
5157
for the dgoss command, for example:
5258

extras/kgoss/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,11 @@ To find `goss.yaml` in another directory specify that directory's path in `GOSS_
9999
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

102+
If the file `./goss_wait.yaml` exists in the current directory, goss regularly
103+
checks whether the conditions in the file are met. Only then does goss start the
104+
actual check with the file `./goss.yaml`. This is used, for example, to wait
105+
until a certain port is open before executing the tests.
106+
102107
**Example:**
103108

104109
`kgoss run -e JENKINS_OPTS="--httpPort=8080 --httpsPort=-1" -e JAVA_OPTS="-Xmx1048m" -i jenkins:alpine`

0 commit comments

Comments
 (0)