mirror of https://github.com/docker/docs.git
Update Compose reference API to v2.10.2
Signed-off-by: GitHub <noreply@github.com>
This commit is contained in:
parent
232d94dc71
commit
f032278139
|
@ -40,7 +40,7 @@ exclude:
|
||||||
latest_engine_api_version: "1.41"
|
latest_engine_api_version: "1.41"
|
||||||
docker_ce_version: "20.10"
|
docker_ce_version: "20.10"
|
||||||
compose_v1_version: "1.29.2"
|
compose_v1_version: "1.29.2"
|
||||||
compose_version: "v2.7.0"
|
compose_version: "v2.10.2"
|
||||||
compose_file_v3: "3.9"
|
compose_file_v3: "3.9"
|
||||||
compose_file_v2: "2.4"
|
compose_file_v2: "2.4"
|
||||||
machine_version: "0.16.0"
|
machine_version: "0.16.0"
|
||||||
|
|
|
@ -10,7 +10,7 @@ long: |-
|
||||||
|
|
||||||
If you change a service's `Dockerfile` or the contents of its build directory,
|
If you change a service's `Dockerfile` or the contents of its build directory,
|
||||||
run `docker compose build` to rebuild it.
|
run `docker compose build` to rebuild it.
|
||||||
usage: docker compose build [SERVICE...]
|
usage: docker compose build [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
command: docker compose convert
|
command: docker compose convert
|
||||||
aliases: config
|
aliases: docker compose convert, docker compose config
|
||||||
short: Converts the compose file to platform's canonical format
|
short: Converts the compose file to platform's canonical format
|
||||||
long: |-
|
long: |-
|
||||||
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
|
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
|
||||||
|
@ -7,7 +7,7 @@ long: |-
|
||||||
fully defined Compose model.
|
fully defined Compose model.
|
||||||
|
|
||||||
To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
|
To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
|
||||||
usage: docker compose convert SERVICES
|
usage: docker compose convert [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
command: docker compose cp
|
command: docker compose cp
|
||||||
short: Copy files/folders between a service container and the local filesystem
|
short: Copy files/folders between a service container and the local filesystem
|
||||||
long: Copy files/folders between a service container and the local filesystem
|
long: Copy files/folders between a service container and the local filesystem
|
||||||
usage: "docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-\n\tdocker compose
|
usage: |-
|
||||||
cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH"
|
docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-
|
||||||
|
docker compose cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose create
|
command: docker compose create
|
||||||
short: Creates containers for a service.
|
short: Creates containers for a service.
|
||||||
long: Creates containers for a service.
|
long: Creates containers for a service.
|
||||||
usage: docker compose create [SERVICE...]
|
usage: docker compose create [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
@ -47,6 +47,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: pull
|
||||||
|
value_type: string
|
||||||
|
default_value: missing
|
||||||
|
description: Pull image before running ("always"|"missing"|"never")
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
|
|
|
@ -14,7 +14,7 @@ long: |-
|
||||||
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 will not be 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
|
usage: docker compose down [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -20,7 +20,7 @@ long: |-
|
||||||
```
|
```
|
||||||
|
|
||||||
The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
|
The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
|
||||||
usage: docker compose events [options] [--] [SERVICE...]
|
usage: docker compose events [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -5,7 +5,7 @@ long: |-
|
||||||
|
|
||||||
With this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so
|
With this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so
|
||||||
you can use a command such as `docker compose exec web sh` to get an interactive prompt.
|
you can use a command such as `docker compose exec web sh` to get an interactive prompt.
|
||||||
usage: docker compose exec [options] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS...]
|
usage: docker compose exec [OPTIONS] SERVICE COMMAND [ARGS...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose images
|
command: docker compose images
|
||||||
short: List images used by the created containers
|
short: List images used by the created containers
|
||||||
long: List images used by the created containers
|
long: List images used by the created containers
|
||||||
usage: docker compose images [SERVICE...]
|
usage: docker compose images [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -6,10 +6,20 @@ long: |-
|
||||||
```console
|
```console
|
||||||
$ docker-compose kill -s SIGINT
|
$ docker-compose kill -s SIGINT
|
||||||
```
|
```
|
||||||
usage: docker compose kill [options] [SERVICE...]
|
usage: docker compose kill [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
- option: remove-orphans
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Remove containers for services not defined in the Compose file.
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: signal
|
- option: signal
|
||||||
shorthand: s
|
shorthand: s
|
||||||
value_type: string
|
value_type: string
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose logs
|
command: docker compose logs
|
||||||
short: View output from containers
|
short: View output from containers
|
||||||
long: Displays log output from services.
|
long: Displays log output from services.
|
||||||
usage: docker compose logs [SERVICE...]
|
usage: docker compose logs [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose ls
|
command: docker compose ls
|
||||||
short: List running compose projects
|
short: List running compose projects
|
||||||
long: List Compose projects running on platform.
|
long: List Compose projects running on platform.
|
||||||
usage: docker compose ls
|
usage: docker compose ls [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose port
|
command: docker compose port
|
||||||
short: Print the public port for a port binding.
|
short: Print the public port for a port binding.
|
||||||
long: Prints the public port for a port binding.
|
long: Prints the public port for a port binding.
|
||||||
usage: docker compose port [options] [--] SERVICE PRIVATE_PORT
|
usage: docker compose port [OPTIONS] SERVICE PRIVATE_PORT
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -10,7 +10,7 @@ long: |-
|
||||||
example-bar-1 "/docker-entrypoint.…" bar exited (0)
|
example-bar-1 "/docker-entrypoint.…" bar exited (0)
|
||||||
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp
|
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp
|
||||||
```
|
```
|
||||||
usage: docker compose ps [SERVICE...]
|
usage: docker compose ps [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -3,7 +3,7 @@ short: Pull service images
|
||||||
long: |-
|
long: |-
|
||||||
Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on
|
Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on
|
||||||
those images.
|
those images.
|
||||||
usage: docker compose pull [SERVICE...]
|
usage: docker compose pull [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -19,7 +19,7 @@ long: |-
|
||||||
build: .
|
build: .
|
||||||
image: your-dockerid/yourimage ## goes to your repository on Docker Hub
|
image: your-dockerid/yourimage ## goes to your repository on Docker Hub
|
||||||
```
|
```
|
||||||
usage: docker compose push [SERVICE...]
|
usage: docker compose push [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose restart
|
command: docker compose restart
|
||||||
short: Restart containers
|
short: Restart service containers
|
||||||
long: |-
|
long: |-
|
||||||
Restarts all stopped and running services.
|
Restarts all stopped and running services, or the specified services only.
|
||||||
|
|
||||||
If you make changes to your `compose.yml` configuration, these changes are not reflected
|
If you make changes to your `compose.yml` configuration, these changes are not reflected
|
||||||
after running this command. For example, changes to environment variables (which are added
|
after running this command. For example, changes to environment variables (which are added
|
||||||
|
@ -11,7 +11,7 @@ long: |-
|
||||||
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, please 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
|
usage: docker compose restart [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -16,7 +16,7 @@ long: |-
|
||||||
Are you sure? [yN] y
|
Are you sure? [yN] y
|
||||||
Removing djangoquickstart_web_run_1 ... done
|
Removing djangoquickstart_web_run_1 ... done
|
||||||
```
|
```
|
||||||
usage: docker compose rm [SERVICE...]
|
usage: docker compose rm [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -54,8 +54,7 @@ long: |-
|
||||||
|
|
||||||
This runs a database upgrade script, and removes the container when finished running, even if a restart policy is
|
This runs a database upgrade script, and removes the container when finished running, even if a restart policy is
|
||||||
specified in the service configuration.
|
specified in the service configuration.
|
||||||
usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l
|
usage: docker compose run [OPTIONS] SERVICE [COMMAND] [ARGS...]
|
||||||
KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
|
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -2,7 +2,7 @@ command: docker compose stop
|
||||||
short: Stop services
|
short: Stop services
|
||||||
long: |
|
long: |
|
||||||
Stops running containers without removing them. They can be started again with `docker compose start`.
|
Stops running containers without removing them. They can be started again with `docker compose start`.
|
||||||
usage: docker compose stop [SERVICE...]
|
usage: docker compose stop [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -17,7 +17,7 @@ long: |-
|
||||||
|
|
||||||
If the process encounters an error, the exit code for this command is `1`.
|
If the process encounters an error, the exit code for this command is `1`.
|
||||||
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
||||||
usage: docker compose up [SERVICE...]
|
usage: docker compose up [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
@ -165,6 +165,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: pull
|
||||||
|
value_type: string
|
||||||
|
default_value: missing
|
||||||
|
description: Pull image before running ("always"|"missing"|"never")
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: quiet-pull
|
- option: quiet-pull
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose version
|
command: docker compose version
|
||||||
short: Show the Docker Compose version information
|
short: Show the Docker Compose version information
|
||||||
long: Show the Docker Compose version information
|
long: Show the Docker Compose version information
|
||||||
usage: docker compose version
|
usage: docker compose version [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
|
|
Loading…
Reference in New Issue