From 9631a49daa2ed3c04656f0f86506cbad9b02efea Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Tue, 31 Oct 2023 10:40:48 +0000 Subject: [PATCH 1/3] ENGDOCS-1764 Signed-off-by: aevesdocker --- docs/reference/compose.md | 10 ++++----- docs/reference/compose_alpha_dry-run.md | 2 +- docs/reference/compose_alpha_publish.md | 2 +- docs/reference/compose_alpha_scale.md | 4 ++-- docs/reference/compose_alpha_viz.md | 4 ++-- docs/reference/compose_build.md | 2 +- docs/reference/compose_config.md | 6 ++--- docs/reference/compose_cp.md | 2 +- docs/reference/compose_create.md | 4 ++-- docs/reference/compose_down.md | 14 ++++++------ docs/reference/compose_exec.md | 8 +++---- docs/reference/compose_images.md | 2 +- docs/reference/compose_logs.md | 12 +++++----- docs/reference/compose_ls.md | 6 ++--- docs/reference/compose_pause.md | 2 +- docs/reference/compose_ps.md | 6 ++--- docs/reference/compose_pull.md | 17 +++++++------- docs/reference/compose_push.md | 2 +- docs/reference/compose_restart.md | 6 ++--- docs/reference/compose_rm.md | 2 +- docs/reference/compose_run.md | 14 ++++++------ docs/reference/compose_scale.md | 4 ++-- docs/reference/compose_start.md | 2 +- docs/reference/compose_stop.md | 2 +- docs/reference/compose_top.md | 2 +- docs/reference/compose_unpause.md | 2 +- docs/reference/compose_up.md | 30 ++++++++++++------------- docs/reference/compose_version.md | 4 ++-- docs/reference/compose_wait.md | 2 +- docs/reference/compose_watch.md | 4 ++-- 30 files changed, 89 insertions(+), 90 deletions(-) diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 052124bbe..46df7b832 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -57,7 +57,7 @@ Define and run multi-container applications with Docker. ## Description -You can use compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage +You can use the compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers. ### Use `-f` to specify the name and path of one or more Compose files @@ -146,16 +146,16 @@ demo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms ### Use profiles to enable optional services Use `--profile` to specify one or more active profiles -Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services +Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services without any specified profiles. -You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. +You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled. Profiles can also be set by `COMPOSE_PROFILES` environment variable. ### Configuring parallelism Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. -Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file +Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file one at a time. This can also be used to control build concurrency. Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. @@ -171,7 +171,7 @@ and `COMPOSE_PARALLEL_LIMIT` does the same as the `--parallel` flag. If flags are explicitly set on the command line, the associated environment variable is ignored. -Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned +Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. ### Use Dry Run mode to test your command diff --git a/docs/reference/compose_alpha_dry-run.md b/docs/reference/compose_alpha_dry-run.md index a66ed5340..9e8350e2a 100644 --- a/docs/reference/compose_alpha_dry-run.md +++ b/docs/reference/compose_alpha_dry-run.md @@ -1,7 +1,7 @@ # docker compose alpha dry-run -EXPERIMENTAL - Dry run command allow you to test a command without applying changes +Dry run command allows you to test a command without applying changes. diff --git a/docs/reference/compose_alpha_publish.md b/docs/reference/compose_alpha_publish.md index 056d211b0..97c7357b8 100644 --- a/docs/reference/compose_alpha_publish.md +++ b/docs/reference/compose_alpha_publish.md @@ -1,7 +1,7 @@ # docker compose alpha publish -Publish compose application +Publish a Compose application. ### Options diff --git a/docs/reference/compose_alpha_scale.md b/docs/reference/compose_alpha_scale.md index 3cda50e20..15536b359 100644 --- a/docs/reference/compose_alpha_scale.md +++ b/docs/reference/compose_alpha_scale.md @@ -1,14 +1,14 @@ # docker compose alpha scale -Scale services +Scale services. ### Options | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services. | +| `--no-deps` | | | Don't start linked services | diff --git a/docs/reference/compose_alpha_viz.md b/docs/reference/compose_alpha_viz.md index 04bffc0b8..4a1763061 100644 --- a/docs/reference/compose_alpha_viz.md +++ b/docs/reference/compose_alpha_viz.md @@ -1,7 +1,7 @@ # docker compose alpha viz -EXPERIMENTAL - Generate a graphviz graph from your compose file +Generate a Graphviz graph from your compose file ### Options @@ -12,7 +12,7 @@ EXPERIMENTAL - Generate a graphviz graph from your compose file | `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | | `--networks` | | | Include service's attached networks in output graph | | `--ports` | | | Include service's exposed ports in output graph | -| `--spaces` | | | If given, space character ' ' will be used to indent,
otherwise tab character '\t' will be used | +| `--spaces` | | | If given, space character ' ' is used to indent,
otherwise tab character '\t' is used | diff --git a/docs/reference/compose_build.md b/docs/reference/compose_build.md index 1eaec63e8..f12c667b2 100644 --- a/docs/reference/compose_build.md +++ b/docs/reference/compose_build.md @@ -1,7 +1,7 @@ # docker compose build -Build or rebuild services +Build or rebuild services. ### Options diff --git a/docs/reference/compose_config.md b/docs/reference/compose_config.md index 15612ea33..9663ef817 100644 --- a/docs/reference/compose_config.md +++ b/docs/reference/compose_config.md @@ -1,7 +1,7 @@ # docker compose convert -Parse, resolve and render compose file in canonical format +Parse, resolve and render Compose files in canonical format. ### Aliases @@ -31,6 +31,6 @@ Parse, resolve and render compose file in canonical format ## Description -`docker compose config` renders the actual data model to be applied on the Docker engine. -it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into +`docker compose config` renders the actual data model to be applied on the Docker Engine. +It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into the canonical format. diff --git a/docs/reference/compose_cp.md b/docs/reference/compose_cp.md index 9be79443a..f3d7b4c51 100644 --- a/docs/reference/compose_cp.md +++ b/docs/reference/compose_cp.md @@ -1,7 +1,7 @@ # docker compose cp -Copy files/folders between a service container and the local filesystem +Copy files or folders between a service container and the local filesystem. ### Options diff --git a/docs/reference/compose_create.md b/docs/reference/compose_create.md index 0efcc9017..423279ec8 100644 --- a/docs/reference/compose_create.md +++ b/docs/reference/compose_create.md @@ -10,10 +10,10 @@ Creates containers for a service. | `--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 policy. | +| `--no-build` | | | Don't build an image, even if it's policy | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 92d10389d..7d2774116 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -1,17 +1,17 @@ # docker compose down -Stop and remove containers, networks +Stop and remove containers, networks, volumes, and images. ### Options | Name | Type | Default | Description | |:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `--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` | `0` | Specify a shutdown timeout in seconds | -| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. | +| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers.] | @@ -22,12 +22,12 @@ Stops containers and removes containers, networks, volumes, and images created b By default, the only things removed are: -- Containers for services defined in the Compose file -- Networks defined in the networks section of the Compose file -- The default network, if one is used +- Containers for services defined in the Compose file. +- Networks defined in the networks section of the Compose file. +- The default network, if one is used. Networks and volumes defined as external are never removed. -Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically +Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or named volumes. diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md index 7c5f7d6a4..c09554837 100644 --- a/docs/reference/compose_exec.md +++ b/docs/reference/compose_exec.md @@ -7,14 +7,14 @@ Execute a command in a running container. | Name | Type | Default | Description | |:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: Run command in the background. | +| `-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` | `0` | index of the container if service has multiple replicas | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | -| `--privileged` | | | Give extended privileges to the process. | -| `-u`, `--user` | `string` | | Run the command as this user. | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | +| `--privileged` | | | Give extended privileges to the process | +| `-u`, `--user` | `string` | | Run the command as this user | +| `-w`, `--workdir` | `string` | | Path to workdir directory for this command | diff --git a/docs/reference/compose_images.md b/docs/reference/compose_images.md index 02a8f57ec..aee6965fc 100644 --- a/docs/reference/compose_images.md +++ b/docs/reference/compose_images.md @@ -1,7 +1,7 @@ # docker compose images -List images used by the created containers +List images used by the created containers. ### Options diff --git a/docs/reference/compose_logs.md b/docs/reference/compose_logs.md index 58f56ed09..0461f9581 100644 --- a/docs/reference/compose_logs.md +++ b/docs/reference/compose_logs.md @@ -1,19 +1,19 @@ # docker compose logs -View output from containers +View output from containers. ### Options | 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. | +| `-f`, `--follow` | | | Follow log output | +| `--no-color` | | | Produce monochrome output | +| `--no-log-prefix` | | | Don't print prefix in logs | | `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | -| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. | -| `-t`, `--timestamps` | | | Show timestamps. | +| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | +| `-t`, `--timestamps` | | | Show timestamps | | `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | diff --git a/docs/reference/compose_ls.md b/docs/reference/compose_ls.md index 50a13d96f..7b435564d 100644 --- a/docs/reference/compose_ls.md +++ b/docs/reference/compose_ls.md @@ -1,7 +1,7 @@ # docker compose ls -List running compose projects +List running compose projects. ### Options @@ -9,9 +9,9 @@ List running compose projects |:----------------|:---------|:--------|:--------------------------------------------| | `-a`, `--all` | | | Show all stopped Compose projects | | `--dry-run` | | | Execute command in dry run mode | -| `--filter` | `filter` | | Filter output based on conditions provided. | +| `--filter` | `filter` | | Filter output based on conditions provided | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs. | +| `-q`, `--quiet` | | | Only display IDs | diff --git a/docs/reference/compose_pause.md b/docs/reference/compose_pause.md index 334c82f18..a9be4ed16 100644 --- a/docs/reference/compose_pause.md +++ b/docs/reference/compose_pause.md @@ -1,7 +1,7 @@ # docker compose pause -Pause services +Pause services. ### Options diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md index 401ec7a28..4fcf5ab62 100644 --- a/docs/reference/compose_ps.md +++ b/docs/reference/compose_ps.md @@ -1,7 +1,7 @@ # docker compose ps -List containers +List containers. ### Options @@ -29,7 +29,7 @@ NAME IMAGE COMMAND SERVICE CREATED STATUS example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp ``` -By default, only running containers are shown. `--all` flag can be used to include stopped containers +By default, only running containers are shown. `--all` flag can be used to include stopped containers. ```console $ docker compose ps --all @@ -53,7 +53,7 @@ $ docker compose ps --format json ``` The JSON output allows you to use the information in other tools for further -processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} +processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/) to pretty-print the JSON: ```console diff --git a/docs/reference/compose_pull.md b/docs/reference/compose_pull.md index e68328fa7..097681d12 100644 --- a/docs/reference/compose_pull.md +++ b/docs/reference/compose_pull.md @@ -1,18 +1,18 @@ # docker compose pull -Pull service images +Pull service images. ### Options | 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. | -| `--policy` | `string` | | Apply pull policy ("missing"\|"always"). | -| `-q`, `--quiet` | | | Pull without printing progress information. | +| `--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 | +| `--policy` | `string` | | Apply pull policy ("missing"\|"always") | +| `-q`, `--quiet` | | | Pull without printing progress information | @@ -25,7 +25,7 @@ those images. ## Examples -suppose you have this `compose.yaml`: +Consider the following `compose.yaml`: ```yaml services: @@ -66,5 +66,4 @@ $ docker compose pull db ⠹ c8752d5b785c Waiting 9.3s ``` -`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let -user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag +`docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag. diff --git a/docs/reference/compose_push.md b/docs/reference/compose_push.md index 90a4fef24..33c983458 100644 --- a/docs/reference/compose_push.md +++ b/docs/reference/compose_push.md @@ -1,7 +1,7 @@ # docker compose push -Push service images +Push service images. ### Options diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index 973851ab5..2568d871e 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -1,14 +1,14 @@ # docker compose restart -Restart service containers +Restart service containers. ### Options | Name | Type | Default | Description | |:------------------|:------|:--------|:--------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't restart dependent services. | +| `--no-deps` | | | Don't restart dependent services | | `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | @@ -23,6 +23,6 @@ after running this command. For example, changes to environment variables (which after a container is built, but before the container's command is executed) are not updated after restarting. -If you are looking to configure a service's restart policy, please refer to +If you are looking to configure a service's restart policy, refer to [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). diff --git a/docs/reference/compose_rm.md b/docs/reference/compose_rm.md index cbd8e50f6..7179f320d 100644 --- a/docs/reference/compose_rm.md +++ b/docs/reference/compose_rm.md @@ -1,7 +1,7 @@ # docker compose rm -Removes stopped service containers +Removes stopped service containers. By default, anonymous volumes attached to containers will not be removed. You can override this with -v. To list all volumes, use "docker volume ls". diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index 3eea660e5..62c662264 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -7,23 +7,23 @@ Run a one-off command on a service. | Name | Type | Default | Description | |:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------| -| `--build` | | | Build image before starting container. | +| `--build` | | | Build image before starting container | | `--cap-add` | `list` | | Add Linux capabilities | | `--cap-drop` | `list` | | Drop Linux capabilities | | `-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. | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached | | `-l`, `--label` | `stringArray` | | Add or override a label | | `--name` | `string` | | Assign a name to the container | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | -| `--no-deps` | | | Don't start linked services. | -| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `--no-deps` | | | Don't start linked services | +| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host | +| `--quiet-pull` | | | Pull without printing progress information | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--rm` | | | Automatically remove the container when it exits | -| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. | +| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host | | `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | | `-u`, `--user` | `string` | | Run as specified username or uid | | `-v`, `--volume` | `stringArray` | | Bind mount a volume. | diff --git a/docs/reference/compose_scale.md b/docs/reference/compose_scale.md index 5cf5830e2..e6185d436 100644 --- a/docs/reference/compose_scale.md +++ b/docs/reference/compose_scale.md @@ -1,14 +1,14 @@ # docker compose scale -Scale services +Scale services. ### Options | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services. | +| `--no-deps` | | | Don't start linked services | diff --git a/docs/reference/compose_start.md b/docs/reference/compose_start.md index b525347f7..b8f424cfd 100644 --- a/docs/reference/compose_start.md +++ b/docs/reference/compose_start.md @@ -1,7 +1,7 @@ # docker compose start -Start services +Start services. ### Options diff --git a/docs/reference/compose_stop.md b/docs/reference/compose_stop.md index e7cf92a80..71441f24b 100644 --- a/docs/reference/compose_stop.md +++ b/docs/reference/compose_stop.md @@ -1,7 +1,7 @@ # docker compose stop -Stop services +Stop services. ### Options diff --git a/docs/reference/compose_top.md b/docs/reference/compose_top.md index 9aff0ce71..5d12a0f83 100644 --- a/docs/reference/compose_top.md +++ b/docs/reference/compose_top.md @@ -1,7 +1,7 @@ # docker compose top -Display the running processes +Display the running processes. ### Options diff --git a/docs/reference/compose_unpause.md b/docs/reference/compose_unpause.md index 0df10a992..923eb2ead 100644 --- a/docs/reference/compose_unpause.md +++ b/docs/reference/compose_unpause.md @@ -1,7 +1,7 @@ # docker compose unpause -Unpause services +Unpause services. ### Options diff --git a/docs/reference/compose_up.md b/docs/reference/compose_up.md index 8f7428e05..f634cb7d0 100644 --- a/docs/reference/compose_up.md +++ b/docs/reference/compose_up.md @@ -1,7 +1,7 @@ # docker compose up -Create and start containers +Create and start containers. ### Options @@ -10,28 +10,28 @@ Create and start containers | `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | | `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | | `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | -| `--attach-dependencies` | | | Automatically attach to log output of dependent services. | -| `--build` | | | Build images before starting containers. | +| `--attach-dependencies` | | | Automatically attach to log output of dependent services | +| `--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` | | Do not attach (stream logs) to the specified services. | -| `--no-build` | | | Don't build an image, even if it's policy. | +| `--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` | | Do not attach (stream logs) to the specified services | +| `--no-build` | | | Don't build an image, even if it's policy | | `--no-color` | | | Produce monochrome output. | -| `--no-deps` | | | Don't start linked services. | +| `--no-deps` | | | Don't start linked services | | `--no-log-prefix` | | | Don't print prefix in logs. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | | | Don't start the services after creating them. | +| `--no-start` | | | Don't start the services after creating them | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. | +| `--quiet-pull` | | | Pull without printing progress information | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running. | -| `--timestamps` | | | Show timestamps. | +| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | +| `--timestamps` | | | Show timestamps | | `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy. | +| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | diff --git a/docs/reference/compose_version.md b/docs/reference/compose_version.md index 66081d65e..c3be03c4e 100644 --- a/docs/reference/compose_version.md +++ b/docs/reference/compose_version.md @@ -1,7 +1,7 @@ # docker compose version -Show the Docker Compose version information +Show the Docker Compose version information. ### Options @@ -9,7 +9,7 @@ Show the Docker Compose version information |:-----------------|:---------|:--------|:---------------------------------------------------------------| | `--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. | +| `--short` | | | Shows only Compose's version number.| diff --git a/docs/reference/compose_wait.md b/docs/reference/compose_wait.md index 9c9ff6f1c..59f2f2681 100644 --- a/docs/reference/compose_wait.md +++ b/docs/reference/compose_wait.md @@ -1,7 +1,7 @@ # docker compose wait -Block until the first service container stops +Block until the first service container stops. ### Options diff --git a/docs/reference/compose_watch.md b/docs/reference/compose_watch.md index 068704618..1363fe2f3 100644 --- a/docs/reference/compose_watch.md +++ b/docs/reference/compose_watch.md @@ -1,7 +1,7 @@ # docker compose watch -Watch build context for service and rebuild/refresh containers when files are updated +Watch build context for service and rebuild orrefresh containers when files are updated. ### Options @@ -9,7 +9,7 @@ Watch build context for service and rebuild/refresh containers when files are up |:------------|:-----|:--------|:----------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | | `--no-up` | | | Do not build & start services before watching | -| `--quiet` | | | hide build output | +| `--quiet` | | | Hide build output | From 0d4cbbdbc9cfc105a2f1ca16c438c4c7dd20828f Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Tue, 31 Oct 2023 10:44:59 +0000 Subject: [PATCH 2/3] fix Signed-off-by: aevesdocker --- docs/reference/compose_down.md | 2 +- docs/reference/compose_watch.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 7d2774116..37683a901 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -11,7 +11,7 @@ Stop and remove containers, networks, volumes, and images. | `--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` | `0` | Specify a shutdown timeout in seconds | -| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers.] | +| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. | diff --git a/docs/reference/compose_watch.md b/docs/reference/compose_watch.md index 1363fe2f3..8874e2744 100644 --- a/docs/reference/compose_watch.md +++ b/docs/reference/compose_watch.md @@ -1,7 +1,7 @@ # docker compose watch -Watch build context for service and rebuild orrefresh containers when files are updated. +Watch build context for service and rebuild or refresh containers when files are updated. ### Options From 4cd61957ed14dc1b7c6cdd1f477468cbd94559dc Mon Sep 17 00:00:00 2001 From: aevesdocker Date: Tue, 31 Oct 2023 10:50:42 +0000 Subject: [PATCH 3/3] fix build Signed-off-by: aevesdocker --- docs/reference/compose_alpha_publish.md | 2 +- docs/reference/compose_alpha_viz.md | 4 +-- docs/reference/compose_build.md | 2 +- docs/reference/compose_config.md | 2 +- docs/reference/compose_cp.md | 2 +- docs/reference/compose_create.md | 4 +-- docs/reference/compose_down.md | 4 +-- docs/reference/compose_exec.md | 8 +++--- docs/reference/compose_images.md | 2 +- docs/reference/compose_logs.md | 12 ++++----- docs/reference/compose_ls.md | 6 ++--- docs/reference/compose_pause.md | 2 +- docs/reference/compose_ps.md | 2 +- docs/reference/compose_pull.md | 12 ++++----- docs/reference/compose_push.md | 2 +- docs/reference/compose_restart.md | 4 +-- docs/reference/compose_rm.md | 2 +- docs/reference/compose_run.md | 14 +++++----- docs/reference/compose_scale.md | 4 +-- docs/reference/compose_start.md | 2 +- docs/reference/compose_stop.md | 2 +- docs/reference/compose_top.md | 2 +- docs/reference/compose_unpause.md | 2 +- docs/reference/compose_up.md | 30 +++++++++++----------- docs/reference/compose_version.md | 4 +-- docs/reference/compose_wait.md | 2 +- docs/reference/compose_watch.md | 4 +-- docs/reference/docker_compose.yaml | 10 ++++---- docs/reference/docker_compose_config.yaml | 4 +-- docs/reference/docker_compose_down.yaml | 8 +++--- docs/reference/docker_compose_ps.yaml | 4 +-- docs/reference/docker_compose_pull.yaml | 5 ++-- docs/reference/docker_compose_restart.yaml | 2 +- 33 files changed, 85 insertions(+), 86 deletions(-) diff --git a/docs/reference/compose_alpha_publish.md b/docs/reference/compose_alpha_publish.md index 97c7357b8..056d211b0 100644 --- a/docs/reference/compose_alpha_publish.md +++ b/docs/reference/compose_alpha_publish.md @@ -1,7 +1,7 @@ # docker compose alpha publish -Publish a Compose application. +Publish compose application ### Options diff --git a/docs/reference/compose_alpha_viz.md b/docs/reference/compose_alpha_viz.md index 4a1763061..04bffc0b8 100644 --- a/docs/reference/compose_alpha_viz.md +++ b/docs/reference/compose_alpha_viz.md @@ -1,7 +1,7 @@ # docker compose alpha viz -Generate a Graphviz graph from your compose file +EXPERIMENTAL - Generate a graphviz graph from your compose file ### Options @@ -12,7 +12,7 @@ Generate a Graphviz graph from your compose file | `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | | `--networks` | | | Include service's attached networks in output graph | | `--ports` | | | Include service's exposed ports in output graph | -| `--spaces` | | | If given, space character ' ' is used to indent,
otherwise tab character '\t' is used | +| `--spaces` | | | If given, space character ' ' will be used to indent,
otherwise tab character '\t' will be used | diff --git a/docs/reference/compose_build.md b/docs/reference/compose_build.md index f12c667b2..1eaec63e8 100644 --- a/docs/reference/compose_build.md +++ b/docs/reference/compose_build.md @@ -1,7 +1,7 @@ # docker compose build -Build or rebuild services. +Build or rebuild services ### Options diff --git a/docs/reference/compose_config.md b/docs/reference/compose_config.md index 9663ef817..2639cd735 100644 --- a/docs/reference/compose_config.md +++ b/docs/reference/compose_config.md @@ -1,7 +1,7 @@ # docker compose convert -Parse, resolve and render Compose files in canonical format. +Parse, resolve and render compose file in canonical format ### Aliases diff --git a/docs/reference/compose_cp.md b/docs/reference/compose_cp.md index f3d7b4c51..9be79443a 100644 --- a/docs/reference/compose_cp.md +++ b/docs/reference/compose_cp.md @@ -1,7 +1,7 @@ # docker compose cp -Copy files or folders between a service container and the local filesystem. +Copy files/folders between a service container and the local filesystem ### Options diff --git a/docs/reference/compose_create.md b/docs/reference/compose_create.md index 423279ec8..0efcc9017 100644 --- a/docs/reference/compose_create.md +++ b/docs/reference/compose_create.md @@ -10,10 +10,10 @@ Creates containers for a service. | `--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 policy | +| `--no-build` | | | Don't build an image, even if it's policy. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 37683a901..4012b70ca 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -1,14 +1,14 @@ # docker compose down -Stop and remove containers, networks, volumes, and images. +Stop and remove containers, networks ### Options | Name | Type | Default | Description | |:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `--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` | `0` | Specify a shutdown timeout in seconds | | `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. | diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md index c09554837..7c5f7d6a4 100644 --- a/docs/reference/compose_exec.md +++ b/docs/reference/compose_exec.md @@ -7,14 +7,14 @@ Execute a command in a running container. | Name | Type | Default | Description | |:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: Run command in the background | +| `-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` | `0` | index of the container if service has multiple replicas | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | -| `--privileged` | | | Give extended privileges to the process | -| `-u`, `--user` | `string` | | Run the command as this user | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command | +| `--privileged` | | | Give extended privileges to the process. | +| `-u`, `--user` | `string` | | Run the command as this user. | +| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | diff --git a/docs/reference/compose_images.md b/docs/reference/compose_images.md index aee6965fc..02a8f57ec 100644 --- a/docs/reference/compose_images.md +++ b/docs/reference/compose_images.md @@ -1,7 +1,7 @@ # docker compose images -List images used by the created containers. +List images used by the created containers ### Options diff --git a/docs/reference/compose_logs.md b/docs/reference/compose_logs.md index 0461f9581..58f56ed09 100644 --- a/docs/reference/compose_logs.md +++ b/docs/reference/compose_logs.md @@ -1,19 +1,19 @@ # docker compose logs -View output from containers. +View output from containers ### Options | 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 | +| `-f`, `--follow` | | | Follow log output. | +| `--no-color` | | | Produce monochrome output. | +| `--no-log-prefix` | | | Don't print prefix in logs. | | `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | -| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | -| `-t`, `--timestamps` | | | Show timestamps | +| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. | +| `-t`, `--timestamps` | | | Show timestamps. | | `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | diff --git a/docs/reference/compose_ls.md b/docs/reference/compose_ls.md index 7b435564d..50a13d96f 100644 --- a/docs/reference/compose_ls.md +++ b/docs/reference/compose_ls.md @@ -1,7 +1,7 @@ # docker compose ls -List running compose projects. +List running compose projects ### Options @@ -9,9 +9,9 @@ List running compose projects. |:----------------|:---------|:--------|:--------------------------------------------| | `-a`, `--all` | | | Show all stopped Compose projects | | `--dry-run` | | | Execute command in dry run mode | -| `--filter` | `filter` | | Filter output based on conditions provided | +| `--filter` | `filter` | | Filter output based on conditions provided. | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | | | Only display IDs. | diff --git a/docs/reference/compose_pause.md b/docs/reference/compose_pause.md index a9be4ed16..334c82f18 100644 --- a/docs/reference/compose_pause.md +++ b/docs/reference/compose_pause.md @@ -1,7 +1,7 @@ # docker compose pause -Pause services. +Pause services ### Options diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md index 4fcf5ab62..b73cae5d7 100644 --- a/docs/reference/compose_ps.md +++ b/docs/reference/compose_ps.md @@ -1,7 +1,7 @@ # docker compose ps -List containers. +List containers ### Options diff --git a/docs/reference/compose_pull.md b/docs/reference/compose_pull.md index 097681d12..03be4de05 100644 --- a/docs/reference/compose_pull.md +++ b/docs/reference/compose_pull.md @@ -1,18 +1,18 @@ # docker compose pull -Pull service images. +Pull service images ### Options | 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 | -| `--policy` | `string` | | Apply pull policy ("missing"\|"always") | -| `-q`, `--quiet` | | | Pull without printing progress information | +| `--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. | +| `--policy` | `string` | | Apply pull policy ("missing"\|"always"). | +| `-q`, `--quiet` | | | Pull without printing progress information. | diff --git a/docs/reference/compose_push.md b/docs/reference/compose_push.md index 33c983458..90a4fef24 100644 --- a/docs/reference/compose_push.md +++ b/docs/reference/compose_push.md @@ -1,7 +1,7 @@ # docker compose push -Push service images. +Push service images ### Options diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index 2568d871e..1e7bdf3c8 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -1,14 +1,14 @@ # docker compose restart -Restart service containers. +Restart service containers ### Options | Name | Type | Default | Description | |:------------------|:------|:--------|:--------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't restart dependent services | +| `--no-deps` | | | Don't restart dependent services. | | `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_rm.md b/docs/reference/compose_rm.md index 7179f320d..cbd8e50f6 100644 --- a/docs/reference/compose_rm.md +++ b/docs/reference/compose_rm.md @@ -1,7 +1,7 @@ # docker compose rm -Removes stopped service containers. +Removes stopped service containers By default, anonymous volumes attached to containers will not be removed. You can override this with -v. To list all volumes, use "docker volume ls". diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index 62c662264..3eea660e5 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -7,23 +7,23 @@ Run a one-off command on a service. | Name | Type | Default | Description | |:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------| -| `--build` | | | Build image before starting container | +| `--build` | | | Build image before starting container. | | `--cap-add` | `list` | | Add Linux capabilities | | `--cap-drop` | `list` | | Drop Linux capabilities | | `-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 | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached. | | `-l`, `--label` | `stringArray` | | Add or override a label | | `--name` | `string` | | Assign a name to the container | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | -| `--no-deps` | | | Don't start linked services | -| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host | -| `--quiet-pull` | | | Pull without printing progress information | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `--no-deps` | | | Don't start linked services. | +| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | +| `--quiet-pull` | | | Pull without printing progress information. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--rm` | | | Automatically remove the container when it exits | -| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host | +| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. | | `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | | `-u`, `--user` | `string` | | Run as specified username or uid | | `-v`, `--volume` | `stringArray` | | Bind mount a volume. | diff --git a/docs/reference/compose_scale.md b/docs/reference/compose_scale.md index e6185d436..5cf5830e2 100644 --- a/docs/reference/compose_scale.md +++ b/docs/reference/compose_scale.md @@ -1,14 +1,14 @@ # docker compose scale -Scale services. +Scale services ### Options | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services | +| `--no-deps` | | | Don't start linked services. | diff --git a/docs/reference/compose_start.md b/docs/reference/compose_start.md index b8f424cfd..b525347f7 100644 --- a/docs/reference/compose_start.md +++ b/docs/reference/compose_start.md @@ -1,7 +1,7 @@ # docker compose start -Start services. +Start services ### Options diff --git a/docs/reference/compose_stop.md b/docs/reference/compose_stop.md index 71441f24b..e7cf92a80 100644 --- a/docs/reference/compose_stop.md +++ b/docs/reference/compose_stop.md @@ -1,7 +1,7 @@ # docker compose stop -Stop services. +Stop services ### Options diff --git a/docs/reference/compose_top.md b/docs/reference/compose_top.md index 5d12a0f83..9aff0ce71 100644 --- a/docs/reference/compose_top.md +++ b/docs/reference/compose_top.md @@ -1,7 +1,7 @@ # docker compose top -Display the running processes. +Display the running processes ### Options diff --git a/docs/reference/compose_unpause.md b/docs/reference/compose_unpause.md index 923eb2ead..0df10a992 100644 --- a/docs/reference/compose_unpause.md +++ b/docs/reference/compose_unpause.md @@ -1,7 +1,7 @@ # docker compose unpause -Unpause services. +Unpause services ### Options diff --git a/docs/reference/compose_up.md b/docs/reference/compose_up.md index f634cb7d0..8f7428e05 100644 --- a/docs/reference/compose_up.md +++ b/docs/reference/compose_up.md @@ -1,7 +1,7 @@ # docker compose up -Create and start containers. +Create and start containers ### Options @@ -10,28 +10,28 @@ Create and start containers. | `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | | `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | | `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | -| `--attach-dependencies` | | | Automatically attach to log output of dependent services | -| `--build` | | | Build images before starting containers | +| `--attach-dependencies` | | | Automatically attach to log output of dependent services. | +| `--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` | | Do not attach (stream logs) to the specified services | -| `--no-build` | | | Don't build an image, even if it's policy | +| `--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` | | Do not attach (stream logs) to the specified services. | +| `--no-build` | | | Don't build an image, even if it's policy. | | `--no-color` | | | Produce monochrome output. | -| `--no-deps` | | | Don't start linked services | +| `--no-deps` | | | Don't start linked services. | | `--no-log-prefix` | | | Don't print prefix in logs. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | | | Don't start the services after creating them | +| `--no-start` | | | Don't start the services after creating them. | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | -| `--quiet-pull` | | | Pull without printing progress information | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | -| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | +| `--quiet-pull` | | | Pull without printing progress information. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | -| `--timestamps` | | | Show timestamps | +| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running. | +| `--timestamps` | | | Show timestamps. | | `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | +| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy. | diff --git a/docs/reference/compose_version.md b/docs/reference/compose_version.md index c3be03c4e..66081d65e 100644 --- a/docs/reference/compose_version.md +++ b/docs/reference/compose_version.md @@ -1,7 +1,7 @@ # docker compose version -Show the Docker Compose version information. +Show the Docker Compose version information ### Options @@ -9,7 +9,7 @@ Show the Docker Compose version information. |:-----------------|:---------|:--------|:---------------------------------------------------------------| | `--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.| +| `--short` | | | Shows only Compose's version number. | diff --git a/docs/reference/compose_wait.md b/docs/reference/compose_wait.md index 59f2f2681..9c9ff6f1c 100644 --- a/docs/reference/compose_wait.md +++ b/docs/reference/compose_wait.md @@ -1,7 +1,7 @@ # docker compose wait -Block until the first service container stops. +Block until the first service container stops ### Options diff --git a/docs/reference/compose_watch.md b/docs/reference/compose_watch.md index 8874e2744..068704618 100644 --- a/docs/reference/compose_watch.md +++ b/docs/reference/compose_watch.md @@ -1,7 +1,7 @@ # docker compose watch -Watch build context for service and rebuild or refresh containers when files are updated. +Watch build context for service and rebuild/refresh containers when files are updated ### Options @@ -9,7 +9,7 @@ Watch build context for service and rebuild or refresh containers when files are |:------------|:-----|:--------|:----------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | | `--no-up` | | | Do not build & start services before watching | -| `--quiet` | | | Hide build output | +| `--quiet` | | | hide build output | diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml index b6f5d76c5..c096f8923 100644 --- a/docs/reference/docker_compose.yaml +++ b/docs/reference/docker_compose.yaml @@ -1,7 +1,7 @@ command: docker compose short: Docker Compose long: |- - You can use compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage + You can use the compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers. ### Use `-f` to specify the name and path of one or more Compose files @@ -90,16 +90,16 @@ long: |- ### Use profiles to enable optional services Use `--profile` to specify one or more active profiles - Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services + Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services without any specified profiles. - You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. + You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled. Profiles can also be set by `COMPOSE_PROFILES` environment variable. ### Configuring parallelism Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. - Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file + Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file one at a time. This can also be used to control build concurrency. Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. @@ -115,7 +115,7 @@ long: |- If flags are explicitly set on the command line, the associated environment variable is ignored. - Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned + Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned containers for the project. ### Use Dry Run mode to test your command diff --git a/docs/reference/docker_compose_config.yaml b/docs/reference/docker_compose_config.yaml index d19a786c6..d180c8d14 100644 --- a/docs/reference/docker_compose_config.yaml +++ b/docs/reference/docker_compose_config.yaml @@ -2,8 +2,8 @@ command: docker compose config aliases: docker compose config, docker compose convert short: Parse, resolve and render compose file in canonical format long: |- - `docker compose config` renders the actual data model to be applied on the Docker engine. - it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into + `docker compose config` renders the actual data model to be applied on the Docker Engine. + It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into the canonical format. usage: docker compose config [OPTIONS] [SERVICE...] pname: docker compose diff --git a/docs/reference/docker_compose_down.yaml b/docs/reference/docker_compose_down.yaml index 8d6388129..7964dd49c 100644 --- a/docs/reference/docker_compose_down.yaml +++ b/docs/reference/docker_compose_down.yaml @@ -5,13 +5,13 @@ long: |- By default, the only things removed are: - - Containers for services defined in the Compose file - - Networks defined in the networks section of the Compose file - - The default network, if one is used + - Containers for services defined in the Compose file. + - Networks defined in the networks section of the Compose file. + - The default network, if one is used. Networks and volumes defined as external are never removed. - Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically + Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or named volumes. usage: docker compose down [OPTIONS] [SERVICES] diff --git a/docs/reference/docker_compose_ps.yaml b/docs/reference/docker_compose_ps.yaml index 7525fcdb0..9e6bb072e 100644 --- a/docs/reference/docker_compose_ps.yaml +++ b/docs/reference/docker_compose_ps.yaml @@ -9,7 +9,7 @@ long: |- example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp ``` - By default, only running containers are shown. `--all` flag can be used to include stopped containers + By default, only running containers are shown. `--all` flag can be used to include stopped containers. ```console $ docker compose ps --all @@ -128,7 +128,7 @@ examples: |- ``` The JSON output allows you to use the information in other tools for further - processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} + processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/) to pretty-print the JSON: ```console diff --git a/docs/reference/docker_compose_pull.yaml b/docs/reference/docker_compose_pull.yaml index 5d2886afa..46a471162 100644 --- a/docs/reference/docker_compose_pull.yaml +++ b/docs/reference/docker_compose_pull.yaml @@ -89,7 +89,7 @@ inherited_options: kubernetes: false swarm: false examples: |- - suppose you have this `compose.yaml`: + Consider the following `compose.yaml`: ```yaml services: @@ -130,8 +130,7 @@ examples: |- ⠹ c8752d5b785c Waiting 9.3s ``` - `docker compose pull` will try to pull image for services with a build section. If pull fails, it will let - user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag + `docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag. deprecated: false hidden: false experimental: false diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index bc907aacc..3126eb005 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -8,7 +8,7 @@ long: |- after a container is built, but before the container's command is executed) are not updated after restarting. - If you are looking to configure a service's restart policy, please refer to + If you are looking to configure a service's restart policy, refer to [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). usage: docker compose restart [OPTIONS] [SERVICE...]