Skip to content

Adds the docker-args #93

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions content/en/docs/measuring/usage-scenario.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ services:
gcb-wordpress-dummy:
# ...
depends_on:
- gcb-wordpress-mariadb
- gcb-wordpress-mariadb
```

- `services` **[dict]**: (Dictionary of container dictionaries for orchestration)
Expand All @@ -101,7 +101,7 @@ services:
- `ports:` **[int:int]** *(optional)*
+ Docker container portmapping on host OS to be used with `--allow-unsafe` flag.
- `depends_on:` **[list|dict]** *(optional)*
+ Can either be an list of services names on which the service is dependent. It affects the startup order and forces the dependency to be "ready" before the service is started.
+ Can either be an list of services names on which the service is dependent. It affects the startup order and forces the dependency to be "ready" before the service is started.
+ Or it can be an dict where each key represents a service as a string. The string then can have two values:
* `service_healthy`: Will wait for the container until the docker *healthcheck* returns *healthy*.
* `service_started`: Similar to the list syntax this will enforce a starting order and just wait until the container has been created.
Expand All @@ -113,7 +113,7 @@ services:
+ The networks to put the container into. If no networks are defined throughout the `usage_scenario.yml` the container will be put into the default network will all others in the file.
- `healthcheck:` **[dict]** *(optional)*
+ Please see the definition of these arguments and how healthcheck works in the official docker compose definition. We just copy them over: [Docker compose healthcheck specification](https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck)
+ `test:` **[str|list]**
+ `test:` **[str|list]**
+ `interval:` **[str]**
+ `timeout:` **[str]**
+ `retries:` **[integer]**
Expand All @@ -139,7 +139,8 @@ services:
- `read-sci-stdout:` **[bool]** *(optional)*
+ Enables the reading of ticks for the unit of work (*R*) required to calculate the SCI metric.
+ Please see [SCI (Green Software Foundation) →]({{< relref "sci" >}}) for more information.

- `docker-args:` **[list]** *(optional)
+ A list of string that should be added to the `docker run` command of that container. The argument needs to be listed in the `user.capabilities` json under `measurement:orchestrators:docker:allow-args`. The string in the `user.capabilities` can be a regex. Opening this up could be a potential security issue!

Please note that every key below `services` will serve as the name of the
container later on. You can overwrite the container name with the key `container_name`.
Expand Down