Merge pull request #11149 from aevesdocker/ENGDOCS-1764

ENGDOCS-1764: Trivial fixes
This commit is contained in:
Guillaume Lours 2023-11-02 10:30:10 +01:00 committed by GitHub
commit 5661fd1bfe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 35 additions and 37 deletions

View File

@ -57,7 +57,7 @@ Define and run multi-container applications with Docker.
## Description ## Description
You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage You can use the compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
multiple services in Docker containers. multiple services in Docker containers.
### Use `-f` to specify the name and path of one or more Compose files ### 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 profiles to enable optional services
Use `--profile` to specify one or more active profiles 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. 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. Profiles can also be set by `COMPOSE_PROFILES` environment variable.
### Configuring parallelism ### Configuring parallelism
Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. 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. 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. 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. 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. containers for the project.
### Use Dry Run mode to test your command ### Use Dry Run mode to test your command

View File

@ -1,7 +1,7 @@
# docker compose alpha dry-run # docker compose alpha dry-run
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
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.
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

View File

@ -1,14 +1,14 @@
# docker compose alpha scale # docker compose alpha scale
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Scale services Scale services.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:------------|:-----|:--------|:--------------------------------| |:------------|:-----|:--------|:--------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--no-deps` | | | Don't start linked services. | | `--no-deps` | | | Don't start linked services |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

View File

@ -31,6 +31,6 @@ Parse, resolve and render compose file in canonical format
## Description ## Description
`docker compose config` renders the actual data model to be applied on the Docker engine. `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 It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
the canonical format. the canonical format.

View File

@ -22,12 +22,12 @@ Stops containers and removes containers, networks, volumes, and images created b
By default, the only things removed are: By default, the only things removed are:
- Containers for services defined in the Compose file - Containers for services defined in the Compose file.
- Networks defined in the networks section of the Compose file - Networks defined in the networks section of the Compose file.
- The default network, if one is used - The default network, if one is used.
Networks and volumes defined as external are never removed. Networks and volumes defined as external are never removed.
Anonymous volumes are not removed by default. However, as they dont have a stable name, they will not be automatically Anonymous volumes are not removed by default. However, as they dont 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 mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
named volumes. named volumes.

View File

@ -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 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 ```console
$ docker compose ps --all $ 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 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: to pretty-print the JSON:
```console ```console

View File

@ -25,7 +25,7 @@ those images.
## Examples ## Examples
suppose you have this `compose.yaml`: Consider the following `compose.yaml`:
```yaml ```yaml
services: services:
@ -66,5 +66,4 @@ $ docker compose pull db
⠹ c8752d5b785c Waiting 9.3s ⠹ c8752d5b785c Waiting 9.3s
``` ```
`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let `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.
user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag

View File

@ -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 a container is built, but before the container's command is executed) are not updated
after restarting. 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) [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). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).

View File

@ -1,7 +1,7 @@
command: docker compose command: docker compose
short: Docker Compose short: Docker Compose
long: |- long: |-
You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage You can use the compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
multiple services in Docker containers. multiple services in Docker containers.
### Use `-f` to specify the name and path of one or more Compose files ### 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 profiles to enable optional services
Use `--profile` to specify one or more active profiles 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. 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. Profiles can also be set by `COMPOSE_PROFILES` environment variable.
### Configuring parallelism ### Configuring parallelism
Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. 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. 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. 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. 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. containers for the project.
### Use Dry Run mode to test your command ### Use Dry Run mode to test your command

View File

@ -2,8 +2,8 @@ command: docker compose config
aliases: docker compose config, docker compose convert aliases: docker compose config, docker compose convert
short: Parse, resolve and render compose file in canonical format short: Parse, resolve and render compose file in canonical format
long: |- long: |-
`docker compose config` renders the actual data model to be applied on the Docker engine. `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 It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
the canonical format. the canonical format.
usage: docker compose config [OPTIONS] [SERVICE...] usage: docker compose config [OPTIONS] [SERVICE...]
pname: docker compose pname: docker compose

View File

@ -5,13 +5,13 @@ long: |-
By default, the only things removed are: By default, the only things removed are:
- Containers for services defined in the Compose file - Containers for services defined in the Compose file.
- Networks defined in the networks section of the Compose file - Networks defined in the networks section of the Compose file.
- The default network, if one is used - The default network, if one is used.
Networks and volumes defined as external are never removed. Networks and volumes defined as external are never removed.
Anonymous volumes are not removed by default. However, as they dont have a stable name, they will not be automatically Anonymous volumes are not removed by default. However, as they dont 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 mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
named volumes. named volumes.
usage: docker compose down [OPTIONS] [SERVICES] usage: docker compose down [OPTIONS] [SERVICES]

View File

@ -9,7 +9,7 @@ long: |-
example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp 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 ```console
$ docker compose ps --all $ docker compose ps --all
@ -128,7 +128,7 @@ examples: |-
``` ```
The JSON output allows you to use the information in other tools for further 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: to pretty-print the JSON:
```console ```console

View File

@ -89,7 +89,7 @@ inherited_options:
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
suppose you have this `compose.yaml`: Consider the following `compose.yaml`:
```yaml ```yaml
services: services:
@ -130,8 +130,7 @@ examples: |-
⠹ c8752d5b785c Waiting 9.3s ⠹ c8752d5b785c Waiting 9.3s
``` ```
`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let `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.
user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false

View File

@ -8,7 +8,7 @@ long: |-
after a container is built, but before the container's command is executed) are not updated after a container is built, but before the container's command is executed) are not updated
after restarting. 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) [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). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).
usage: docker compose restart [OPTIONS] [SERVICE...] usage: docker compose restart [OPTIONS] [SERVICE...]