From 312f0d1d6174ef2e334fbbbd6e8d513ec4d61e2b Mon Sep 17 00:00:00 2001 From: Guillaume Lours <705411+glours@users.noreply.github.com> Date: Fri, 5 May 2023 12:43:27 +0200 Subject: [PATCH] Update dry-run documentation Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> --- docs/reference/compose.md | 8 ++++---- docs/reference/compose_alpha.md | 6 ++++++ docs/reference/compose_alpha_viz.md | 1 + docs/reference/compose_alpha_watch.md | 7 ++++--- docs/reference/compose_build.md | 1 + docs/reference/compose_config.md | 1 + docs/reference/compose_cp.md | 1 + docs/reference/compose_create.md | 1 + docs/reference/compose_down.md | 1 + docs/reference/compose_events.md | 7 ++++--- docs/reference/compose_exec.md | 1 + docs/reference/compose_images.md | 1 + docs/reference/compose_kill.md | 1 + docs/reference/compose_logs.md | 1 + docs/reference/compose_ls.md | 1 + docs/reference/compose_pause.md | 6 ++++++ docs/reference/compose_port.md | 1 + docs/reference/compose_ps.md | 1 + docs/reference/compose_pull.md | 1 + docs/reference/compose_push.md | 1 + docs/reference/compose_restart.md | 1 + docs/reference/compose_rm.md | 1 + docs/reference/compose_run.md | 1 + docs/reference/compose_start.md | 6 ++++++ docs/reference/compose_stop.md | 1 + docs/reference/compose_top.md | 6 ++++++ docs/reference/compose_unpause.md | 6 ++++++ docs/reference/compose_up.md | 1 + docs/reference/compose_version.md | 1 + docs/reference/docker_compose.yaml | 8 ++++---- docs/reference/docker_compose_alpha.yaml | 11 +++++++++++ docs/reference/docker_compose_alpha_viz.yaml | 11 +++++++++++ docs/reference/docker_compose_alpha_watch.yaml | 11 +++++++++++ docs/reference/docker_compose_build.yaml | 11 +++++++++++ docs/reference/docker_compose_config.yaml | 11 +++++++++++ docs/reference/docker_compose_cp.yaml | 11 +++++++++++ docs/reference/docker_compose_create.yaml | 11 +++++++++++ docs/reference/docker_compose_down.yaml | 11 +++++++++++ docs/reference/docker_compose_events.yaml | 11 +++++++++++ docs/reference/docker_compose_exec.yaml | 11 +++++++++++ docs/reference/docker_compose_images.yaml | 11 +++++++++++ docs/reference/docker_compose_kill.yaml | 11 +++++++++++ docs/reference/docker_compose_logs.yaml | 11 +++++++++++ docs/reference/docker_compose_ls.yaml | 11 +++++++++++ docs/reference/docker_compose_pause.yaml | 11 +++++++++++ docs/reference/docker_compose_port.yaml | 11 +++++++++++ docs/reference/docker_compose_ps.yaml | 11 +++++++++++ docs/reference/docker_compose_pull.yaml | 11 +++++++++++ docs/reference/docker_compose_push.yaml | 11 +++++++++++ docs/reference/docker_compose_restart.yaml | 11 +++++++++++ docs/reference/docker_compose_rm.yaml | 11 +++++++++++ docs/reference/docker_compose_run.yaml | 11 +++++++++++ docs/reference/docker_compose_start.yaml | 11 +++++++++++ docs/reference/docker_compose_stop.yaml | 11 +++++++++++ docs/reference/docker_compose_top.yaml | 11 +++++++++++ docs/reference/docker_compose_unpause.yaml | 11 +++++++++++ docs/reference/docker_compose_up.yaml | 11 +++++++++++ docs/reference/docker_compose_version.yaml | 11 +++++++++++ 58 files changed, 375 insertions(+), 14 deletions(-) diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 01ce96d5e..bb6efd23d 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -175,7 +175,7 @@ containers for the project. ### Use Dry Run mode to test your command Use `--dry-run` flag to test a command without changing your application stack state. -Dry Run mode will show you all the steps Compose will apply by executing the command, for example: +Dry Run mode shows you all the steps Compose applies when executing a command, for example: ```console $ docker compose --dry-run up --build -d [+] Pulling 1/1 @@ -192,10 +192,10 @@ $ docker compose --dry-run up --build -d ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Started 0.0s ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Started Started ``` -You could see that the first step will be to pull the image defined by `db` service, then build the `backend` service. -After that, containers will be created, the `db` service started and the `backend` and `proxy` will wait until `db` service is healthy to start. +From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service. +Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting. -The Dry Run mode is not supported by all commands, especially by the command which doesn't change the state of a Compose stack +Dry Run mode does not currently work with all commands. In particular, you cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example. Here the list of commands supporting `--dry-run` flag: diff --git a/docs/reference/compose_alpha.md b/docs/reference/compose_alpha.md index af9fd171f..34485d7de 100644 --- a/docs/reference/compose_alpha.md +++ b/docs/reference/compose_alpha.md @@ -11,6 +11,12 @@ Experimental commands | [`watch`](compose_alpha_watch.md) | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated | +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + diff --git a/docs/reference/compose_alpha_viz.md b/docs/reference/compose_alpha_viz.md index b76e86cd5..04bffc0b8 100644 --- a/docs/reference/compose_alpha_viz.md +++ b/docs/reference/compose_alpha_viz.md @@ -7,6 +7,7 @@ EXPERIMENTAL - Generate a graphviz graph from your compose file | Name | Type | Default | Description | |:---------------------|:------|:--------|:---------------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--image` | | | Include service's image name in output graph | | `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | | `--networks` | | | Include service's attached networks in output graph | diff --git a/docs/reference/compose_alpha_watch.md b/docs/reference/compose_alpha_watch.md index 4b154c308..10fd902e3 100644 --- a/docs/reference/compose_alpha_watch.md +++ b/docs/reference/compose_alpha_watch.md @@ -5,9 +5,10 @@ EXPERIMENTAL - Watch build context for service and rebuild/refresh containers wh ### Options -| Name | Type | Default | Description | -|:----------|:-----|:--------|:------------------| -| `--quiet` | | | hide build output | +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--quiet` | | | hide build output | diff --git a/docs/reference/compose_build.md b/docs/reference/compose_build.md index a26dfeb6c..6612093a3 100644 --- a/docs/reference/compose_build.md +++ b/docs/reference/compose_build.md @@ -8,6 +8,7 @@ Build or rebuild services | Name | Type | Default | Description | |:-----------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------| | `--build-arg` | `stringArray` | | Set build-time variables for services. | +| `--dry-run` | | | Execute command in dry run mode | | `-m`, `--memory` | `bytes` | `0` | Set memory limit for the build container. Not supported by BuildKit. | | `--no-cache` | | | Do not use cache when building the image | | `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) | diff --git a/docs/reference/compose_config.md b/docs/reference/compose_config.md index da21e50bf..27e21d1a1 100644 --- a/docs/reference/compose_config.md +++ b/docs/reference/compose_config.md @@ -11,6 +11,7 @@ Parse, resolve and render compose file in canonical format | Name | Type | Default | Description | |:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | | `--hash` | `string` | | Print the service config hash, one per line. | | `--images` | | | Print the image names, one per line. | diff --git a/docs/reference/compose_cp.md b/docs/reference/compose_cp.md index 210a050bf..e6513e943 100644 --- a/docs/reference/compose_cp.md +++ b/docs/reference/compose_cp.md @@ -8,6 +8,7 @@ Copy files/folders between a service container and the local filesystem | Name | Type | Default | Description | |:----------------------|:------|:--------|:----------------------------------------------------------------------| | `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | +| `--dry-run` | | | Execute command in dry run mode | | `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | | `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . | diff --git a/docs/reference/compose_create.md b/docs/reference/compose_create.md index ef968330d..de8903201 100644 --- a/docs/reference/compose_create.md +++ b/docs/reference/compose_create.md @@ -8,6 +8,7 @@ Creates containers for a service. | Name | Type | Default | Description | |:-------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------| | `--build` | | | Build images before starting containers. | +| `--dry-run` | | | Execute command in dry run mode | | `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | | `--no-build` | | | Don't build an image, even if it's missing. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 4cd230111..994ad33be 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -7,6 +7,7 @@ Stop and remove containers, networks | Name | Type | Default | Description | |:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_events.md b/docs/reference/compose_events.md index d9ff7cd98..3c231fbc4 100644 --- a/docs/reference/compose_events.md +++ b/docs/reference/compose_events.md @@ -5,9 +5,10 @@ Receive real time events from containers. ### Options -| Name | Type | Default | Description | -|:---------|:-----|:--------|:------------------------------------------| -| `--json` | | | Output events as a stream of json objects | +| Name | Type | Default | Description | +|:------------|:-----|:--------|:------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--json` | | | Output events as a stream of json objects | diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md index 7eca980fa..213677914 100644 --- a/docs/reference/compose_exec.md +++ b/docs/reference/compose_exec.md @@ -8,6 +8,7 @@ Execute a command in a running container. | Name | Type | Default | Description | |:------------------|:--------------|:--------|:----------------------------------------------------------------------------------| | `-d`, `--detach` | | | Detached mode: Run command in the background. | +| `--dry-run` | | | Execute command in dry run mode | | `-e`, `--env` | `stringArray` | | Set environment variables | | `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | diff --git a/docs/reference/compose_images.md b/docs/reference/compose_images.md index 59568dc5c..02a8f57ec 100644 --- a/docs/reference/compose_images.md +++ b/docs/reference/compose_images.md @@ -7,6 +7,7 @@ List images used by the created containers | Name | Type | Default | Description | |:----------------|:---------|:--------|:--------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. | | `-q`, `--quiet` | | | Only display IDs | diff --git a/docs/reference/compose_kill.md b/docs/reference/compose_kill.md index aebae7c19..2e79d806e 100644 --- a/docs/reference/compose_kill.md +++ b/docs/reference/compose_kill.md @@ -7,6 +7,7 @@ Force stop service containers. | Name | Type | Default | Description | |:-------------------|:---------|:----------|:----------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | diff --git a/docs/reference/compose_logs.md b/docs/reference/compose_logs.md index 422065525..58f56ed09 100644 --- a/docs/reference/compose_logs.md +++ b/docs/reference/compose_logs.md @@ -7,6 +7,7 @@ View output from containers | Name | Type | Default | Description | |:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `-f`, `--follow` | | | Follow log output. | | `--no-color` | | | Produce monochrome output. | | `--no-log-prefix` | | | Don't print prefix in logs. | diff --git a/docs/reference/compose_ls.md b/docs/reference/compose_ls.md index 0cb9c076d..50a13d96f 100644 --- a/docs/reference/compose_ls.md +++ b/docs/reference/compose_ls.md @@ -8,6 +8,7 @@ List running compose projects | Name | Type | Default | Description | |:----------------|:---------|:--------|:--------------------------------------------| | `-a`, `--all` | | | Show all stopped Compose projects | +| `--dry-run` | | | Execute command in dry run mode | | `--filter` | `filter` | | Filter output based on conditions provided. | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. | | `-q`, `--quiet` | | | Only display IDs. | diff --git a/docs/reference/compose_pause.md b/docs/reference/compose_pause.md index dd34191bd..334c82f18 100644 --- a/docs/reference/compose_pause.md +++ b/docs/reference/compose_pause.md @@ -3,6 +3,12 @@ Pause services +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + diff --git a/docs/reference/compose_port.md b/docs/reference/compose_port.md index 0eeeb0ddc..c3e59da9e 100644 --- a/docs/reference/compose_port.md +++ b/docs/reference/compose_port.md @@ -7,6 +7,7 @@ Print the public port for a port binding. | Name | Type | Default | Description | |:-------------|:---------|:--------|:--------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--index` | `int` | `1` | index of the container if service has multiple replicas | | `--protocol` | `string` | `tcp` | tcp or udp | diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md index dd6b570e8..4e97a8a85 100644 --- a/docs/reference/compose_ps.md +++ b/docs/reference/compose_ps.md @@ -8,6 +8,7 @@ List containers | Name | Type | Default | Description | |:----------------------|:--------------|:--------|:--------------------------------------------------------------------------------------------------------------| | `-a`, `--all` | | | Show all stopped containers (including those created by the run command) | +| `--dry-run` | | | Execute command in dry run mode | | [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). | | [`--format`](#format) | `string` | `table` | Format the output. Values: [table \| json] | | `-q`, `--quiet` | | | Only display IDs | diff --git a/docs/reference/compose_pull.md b/docs/reference/compose_pull.md index cf3712f4d..cc88e5f02 100644 --- a/docs/reference/compose_pull.md +++ b/docs/reference/compose_pull.md @@ -7,6 +7,7 @@ Pull service images | Name | Type | Default | Description | |:-------------------------|:-----|:--------|:--------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--ignore-buildable` | | | Ignore images that can be built. | | `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures. | | `--include-deps` | | | Also pull services declared as dependencies. | diff --git a/docs/reference/compose_push.md b/docs/reference/compose_push.md index 6c8896813..90a4fef24 100644 --- a/docs/reference/compose_push.md +++ b/docs/reference/compose_push.md @@ -7,6 +7,7 @@ Push service images | Name | Type | Default | Description | |:-------------------------|:-----|:--------|:-------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--ignore-push-failures` | | | Push what it can and ignores images with push failures | | `--include-deps` | | | Also push images of services declared as dependencies | | `-q`, `--quiet` | | | Push without printing progress information | diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index ff201c2f7..94039c3e7 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -7,6 +7,7 @@ Restart service containers | Name | Type | Default | Description | |:------------------|:------|:--------|:--------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `--no-deps` | | | Don't restart dependent services. | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_rm.md b/docs/reference/compose_rm.md index c0ad6c888..cbd8e50f6 100644 --- a/docs/reference/compose_rm.md +++ b/docs/reference/compose_rm.md @@ -12,6 +12,7 @@ Any data which is not in a volume will be lost. | Name | Type | Default | Description | |:------------------|:-----|:--------|:----------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `-f`, `--force` | | | Don't ask to confirm removal | | `-s`, `--stop` | | | Stop the containers, if required, before removing | | `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers | diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index 012a87e36..0c2b2bc81 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -9,6 +9,7 @@ Run a one-off command on a service. |:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------| | `--build` | | | Build image before starting container. | | `-d`, `--detach` | | | Run container in background and print container ID | +| `--dry-run` | | | Execute command in dry run mode | | `--entrypoint` | `string` | | Override the entrypoint of the image | | `-e`, `--env` | `stringArray` | | Set environment variables | | `-i`, `--interactive` | | | Keep STDIN open even if not attached. | diff --git a/docs/reference/compose_start.md b/docs/reference/compose_start.md index 8f8cb5b48..b525347f7 100644 --- a/docs/reference/compose_start.md +++ b/docs/reference/compose_start.md @@ -3,6 +3,12 @@ Start services +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + diff --git a/docs/reference/compose_stop.md b/docs/reference/compose_stop.md index 04275449d..de6a0da3b 100644 --- a/docs/reference/compose_stop.md +++ b/docs/reference/compose_stop.md @@ -7,6 +7,7 @@ Stop services | Name | Type | Default | Description | |:------------------|:------|:--------|:--------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_top.md b/docs/reference/compose_top.md index eee5a3cab..9aff0ce71 100644 --- a/docs/reference/compose_top.md +++ b/docs/reference/compose_top.md @@ -3,6 +3,12 @@ Display the running processes +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + diff --git a/docs/reference/compose_unpause.md b/docs/reference/compose_unpause.md index e819c0c4f..0df10a992 100644 --- a/docs/reference/compose_unpause.md +++ b/docs/reference/compose_unpause.md @@ -3,6 +3,12 @@ Unpause services +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + diff --git a/docs/reference/compose_up.md b/docs/reference/compose_up.md index 220a2af42..70f416362 100644 --- a/docs/reference/compose_up.md +++ b/docs/reference/compose_up.md @@ -13,6 +13,7 @@ Create and start containers | `--attach-dependencies` | | | Attach to dependent containers. | | `--build` | | | Build images before starting containers. | | `-d`, `--detach` | | | Detached mode: Run containers in the background | +| `--dry-run` | | | Execute command in dry run mode | | `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | | `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | | `--no-attach` | `stringArray` | | Don't attach to specified service. | diff --git a/docs/reference/compose_version.md b/docs/reference/compose_version.md index 9706b3850..66081d65e 100644 --- a/docs/reference/compose_version.md +++ b/docs/reference/compose_version.md @@ -7,6 +7,7 @@ Show the Docker Compose version information | Name | Type | Default | Description | |:-----------------|:---------|:--------|:---------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | | `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | | `--short` | | | Shows only Compose's version number. | diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml index bce174ba3..e999c9930 100644 --- a/docs/reference/docker_compose.yaml +++ b/docs/reference/docker_compose.yaml @@ -122,7 +122,7 @@ long: |- ### Use Dry Run mode to test your command Use `--dry-run` flag to test a command without changing your application stack state. - Dry Run mode will show you all the steps Compose will apply by executing the command, for example: + Dry Run mode shows you all the steps Compose applies when executing a command, for example: ```console $ docker compose --dry-run up --build -d [+] Pulling 1/1 @@ -139,10 +139,10 @@ long: |- ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Started 0.0s ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Started Started ``` - You could see that the first step will be to pull the image defined by `db` service, then build the `backend` service. - After that, containers will be created, the `db` service started and the `backend` and `proxy` will wait until `db` service is healthy to start. + From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service. + Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting. - The Dry Run mode is not supported by all commands, especially by the command which doesn't change the state of a Compose stack + Dry Run mode does not currently work with all commands. In particular, you cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example. Here the list of commands supporting `--dry-run` flag: diff --git a/docs/reference/docker_compose_alpha.yaml b/docs/reference/docker_compose_alpha.yaml index 4cfcd9c9f..5921d9436 100644 --- a/docs/reference/docker_compose_alpha.yaml +++ b/docs/reference/docker_compose_alpha.yaml @@ -9,6 +9,17 @@ cname: clink: - docker_compose_alpha_viz.yaml - docker_compose_alpha_watch.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/docs/reference/docker_compose_alpha_viz.yaml b/docs/reference/docker_compose_alpha_viz.yaml index c27c8a41d..6f4a7f4ca 100644 --- a/docs/reference/docker_compose_alpha_viz.yaml +++ b/docs/reference/docker_compose_alpha_viz.yaml @@ -57,6 +57,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/docs/reference/docker_compose_alpha_watch.yaml b/docs/reference/docker_compose_alpha_watch.yaml index 1aa5d9d2e..7a98477e4 100644 --- a/docs/reference/docker_compose_alpha_watch.yaml +++ b/docs/reference/docker_compose_alpha_watch.yaml @@ -17,6 +17,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/docs/reference/docker_compose_build.yaml b/docs/reference/docker_compose_build.yaml index 30de722f2..01f5ad2bb 100644 --- a/docs/reference/docker_compose_build.yaml +++ b/docs/reference/docker_compose_build.yaml @@ -138,6 +138,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_config.yaml b/docs/reference/docker_compose_config.yaml index d05425e40..387e73fea 100644 --- a/docs/reference/docker_compose_config.yaml +++ b/docs/reference/docker_compose_config.yaml @@ -130,6 +130,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_cp.yaml b/docs/reference/docker_compose_cp.yaml index 89e8da6a2..18e4f9be8 100644 --- a/docs/reference/docker_compose_cp.yaml +++ b/docs/reference/docker_compose_cp.yaml @@ -50,6 +50,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_create.yaml b/docs/reference/docker_compose_create.yaml index 1dfa25e37..030b72d3b 100644 --- a/docs/reference/docker_compose_create.yaml +++ b/docs/reference/docker_compose_create.yaml @@ -78,6 +78,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_down.yaml b/docs/reference/docker_compose_down.yaml index 9b4916bd4..bb1ac314b 100644 --- a/docs/reference/docker_compose_down.yaml +++ b/docs/reference/docker_compose_down.yaml @@ -61,6 +61,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_events.yaml b/docs/reference/docker_compose_events.yaml index f6a389eda..99e226e93 100644 --- a/docs/reference/docker_compose_events.yaml +++ b/docs/reference/docker_compose_events.yaml @@ -34,6 +34,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_exec.yaml b/docs/reference/docker_compose_exec.yaml index fe0a0833c..96466bee0 100644 --- a/docs/reference/docker_compose_exec.yaml +++ b/docs/reference/docker_compose_exec.yaml @@ -106,6 +106,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_images.yaml b/docs/reference/docker_compose_images.yaml index bbb457695..7afa355d2 100644 --- a/docs/reference/docker_compose_images.yaml +++ b/docs/reference/docker_compose_images.yaml @@ -26,6 +26,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_kill.yaml b/docs/reference/docker_compose_kill.yaml index b286a9876..61360c526 100644 --- a/docs/reference/docker_compose_kill.yaml +++ b/docs/reference/docker_compose_kill.yaml @@ -31,6 +31,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_logs.yaml b/docs/reference/docker_compose_logs.yaml index f0163c02c..f1b7bad31 100644 --- a/docs/reference/docker_compose_logs.yaml +++ b/docs/reference/docker_compose_logs.yaml @@ -79,6 +79,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_ls.yaml b/docs/reference/docker_compose_ls.yaml index b3ff6bae5..68d5f1fcb 100644 --- a/docs/reference/docker_compose_ls.yaml +++ b/docs/reference/docker_compose_ls.yaml @@ -46,6 +46,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_pause.yaml b/docs/reference/docker_compose_pause.yaml index 378ebb38e..24da45fda 100644 --- a/docs/reference/docker_compose_pause.yaml +++ b/docs/reference/docker_compose_pause.yaml @@ -5,6 +5,17 @@ long: | usage: docker compose pause [SERVICE...] pname: docker compose plink: docker_compose.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_port.yaml b/docs/reference/docker_compose_port.yaml index 3655fa3a8..6ffe8065a 100644 --- a/docs/reference/docker_compose_port.yaml +++ b/docs/reference/docker_compose_port.yaml @@ -25,6 +25,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_ps.yaml b/docs/reference/docker_compose_ps.yaml index d19346d18..f7e8f5279 100644 --- a/docs/reference/docker_compose_ps.yaml +++ b/docs/reference/docker_compose_ps.yaml @@ -87,6 +87,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Format the output (--format) {#format} diff --git a/docs/reference/docker_compose_pull.yaml b/docs/reference/docker_compose_pull.yaml index c07afde13..d7f475dd6 100644 --- a/docs/reference/docker_compose_pull.yaml +++ b/docs/reference/docker_compose_pull.yaml @@ -68,6 +68,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- suppose you have this `compose.yaml`: diff --git a/docs/reference/docker_compose_push.yaml b/docs/reference/docker_compose_push.yaml index 5efd080bd..82a9435c3 100644 --- a/docs/reference/docker_compose_push.yaml +++ b/docs/reference/docker_compose_push.yaml @@ -54,6 +54,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index 91ba742e8..b5ecfb289 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -36,6 +36,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_rm.yaml b/docs/reference/docker_compose_rm.yaml index 4c5f748ba..7d8828b6a 100644 --- a/docs/reference/docker_compose_rm.yaml +++ b/docs/reference/docker_compose_rm.yaml @@ -64,6 +64,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index 97066f123..df5492331 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -256,6 +256,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_start.yaml b/docs/reference/docker_compose_start.yaml index 165f7a32e..5f3d601a5 100644 --- a/docs/reference/docker_compose_start.yaml +++ b/docs/reference/docker_compose_start.yaml @@ -4,6 +4,17 @@ long: Starts existing containers for a service. usage: docker compose start [SERVICE...] pname: docker compose plink: docker_compose.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_stop.yaml b/docs/reference/docker_compose_stop.yaml index c79e41f34..9cc5258b9 100644 --- a/docs/reference/docker_compose_stop.yaml +++ b/docs/reference/docker_compose_stop.yaml @@ -17,6 +17,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_top.yaml b/docs/reference/docker_compose_top.yaml index 1624feb94..67beeb8bb 100644 --- a/docs/reference/docker_compose_top.yaml +++ b/docs/reference/docker_compose_top.yaml @@ -4,6 +4,17 @@ long: Displays the running processes. usage: docker compose top [SERVICES...] pname: docker compose plink: docker_compose.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```console $ docker compose top diff --git a/docs/reference/docker_compose_unpause.yaml b/docs/reference/docker_compose_unpause.yaml index 0a2961ba2..522959848 100644 --- a/docs/reference/docker_compose_unpause.yaml +++ b/docs/reference/docker_compose_unpause.yaml @@ -4,6 +4,17 @@ long: Unpauses paused containers of a service. usage: docker compose unpause [SERVICE...] pname: docker compose plink: docker_compose.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_up.yaml b/docs/reference/docker_compose_up.yaml index c20802061..1c46ca79a 100644 --- a/docs/reference/docker_compose_up.yaml +++ b/docs/reference/docker_compose_up.yaml @@ -273,6 +273,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false diff --git a/docs/reference/docker_compose_version.yaml b/docs/reference/docker_compose_version.yaml index 3834264d3..2b11da2ed 100644 --- a/docs/reference/docker_compose_version.yaml +++ b/docs/reference/docker_compose_version.yaml @@ -25,6 +25,17 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false