1berry/docker-compose
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[v2] docs: regenerate yaml docs

Browse Source 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2021-09-13 17:38:29 +02:00 committed by Nicolas De loof
parent 9798ea4aa5
commit 1c01e9d00f
23 changed files with 1117 additions and 1181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

297
docs/reference/docker_compose.yaml
View File

@ -1,186 +1,145 @@
command: docker compose command: docker compose
short: Docker Compose short: Docker Compose
long: "You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] long: "You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage\nmultiple services in Docker containers.\n\n### Use `-f` to specify name and path of one or more Compose files\nUse the `-f` flag to specify the location of a Compose configuration file.\n\n#### Specifying multiple Compose files\nYou can supply multiple `-f` configuration files. When you supply multiple files, Compose combines them into a single \nconfiguration. Compose builds the configuration in the order you supply the files. Subsequent files override and add \nto their predecessors.\n\nFor example, consider this command line:\n\n```\n$ docker compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db\n```\nThe `docker-compose.yml` file might specify a `webapp` service.\n\n```yaml\nservices:\n webapp:\n image: examples/web\n ports:\n - \"8000:8000\"\n volumes:\n - \"/data\"\n```\nIf the `docker-compose.admin.yml` also specifies this same service, any matching fields override the previous file. \nNew values, add to the `webapp` service configuration.\n\n```yaml\nservices:\n webapp:\n build: .\n environment:\n - DEBUG=1\n```\n\nWhen you use multiple Compose files, all paths in the files are relative to the first configuration file specified \nwith `-f`. You can use the `--project-directory` option to override this base path.\n\nUse a `-f` with `-` (dash) as the filename to read the configuration from stdin. When stdin is used all paths in the \nconfiguration are relative to the current working directory.\n\nThe `-f` flag is optional. If you don’t provide this flag on the command line, Compose traverses the working directory \nand its parent directories looking for a `compose.yaml` or `docker-compose.yaml` file.\n\n#### Specifying a path to a single Compose file\nYou can use the `-f` flag to specify a path to a Compose file that is not located in the current directory, either \nfrom the command line or by setting up a `COMPOSE_FILE` environment variable in your shell or in an environment file.\n\nFor an example of using the `-f` option at the command line, suppose you are running the Compose Rails sample, and \nhave a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like `docker compose pull` to \nget the postgres image for the db service from anywhere by using the `-f` flag as follows: \n```\ndocker compose -f ~/sandbox/rails/compose.yaml pull db\n```\n\n### Use `-p` to specify a project name\n\nEach configuration has a project name. If you supply a `-p` flag, you can specify a project name. If you don’t \nspecify the flag, Compose uses the current directory name. \nProject name can also be set by `COMPOSE_PROJECT_NAME` environment variable.\n\nMost compose subcommand can be ran without a compose file, just passing \nproject name to retrieve the relevant resources.\n\n```\n$ docker compose -p my_project ps -a\nNAME SERVICE STATUS PORTS\nmy_project_demo_1 demo running \n\n$ docker compose -p my_project logs\ndemo_1 | PING localhost (127.0.0.1): 56 data bytes\ndemo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms\n```\n\n### Use profiles to enable optional services\n\nUse `--profile` to specify one or more active profiles\nCalling `docker compose --profile frontend up` will start the services with the profile `frontend` and services \nwithout any specified profiles. \nYou can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled.\n\nProfiles can also be set by `COMPOSE_PROFILES` environment variable.\n\n### Set up environment variables\n\nYou can set environment variables for various docker compose options, including the `-f`, `-p` and `--profiles` flags.\n\nSetting the `COMPOSE_FILE` environment variable is equivalent to passing the `-f` flag,\n`COMPOSE_PROJECT_NAME` environment variable does the same for to the `-p` flag,\nand so does `COMPOSE_PROFILES` environment variable for to the `--profiles` flag.\n\nIf flags are explicitly set on command line, associated environment variable is ignored"
[ARGS...]`, to build and manage\nmultiple services in Docker containers.\n\n###
Use `-f` to specify name and path of one or more Compose files\nUse the `-f` flag
to specify the location of a Compose configuration file.\n\n#### Specifying multiple
Compose files\nYou can supply multiple `-f` configuration files. When you supply
multiple files, Compose combines them into a single \nconfiguration. Compose builds
the configuration in the order you supply the files. Subsequent files override
and add \nto their predecessors.\n\nFor example, consider this command line:\n\n```\n$
docker-compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db\n```\nThe
`docker-compose.yml` file might specify a `webapp` service.\n\n```yaml\nservices:\n
\ webapp:\n image: examples/web\n ports:\n - \"8000:8000\"\n volumes:\n
\ - \"/data\"\n```\nIf the `docker-compose.admin.yml` also specifies this
same service, any matching fields override the previous file. \nNew values, add
to the `webapp` service configuration.\n\n```yaml\nservices:\n webapp:\n build:
.\n environment:\n - DEBUG=1\n```\n\nWhen you use multiple Compose files,
all paths in the files are relative to the first configuration file specified
\nwith `-f`. You can use the `--project-directory` option to override this base
path.\n\nUse a `-f` with `-` (dash) as the filename to read the configuration
from stdin. When stdin is used all paths in the \nconfiguration are relative to
the current working directory.\n\nThe `-f` flag is optional. If you don’t provide
this flag on the command line, Compose traverses the working directory \nand its
parent directories looking for a `compose.yaml` or `docker-compose.yaml` file.\n\n####
Specifying a path to a single Compose file\nYou can use the `-f` flag to specify
a path to a Compose file that is not located in the current directory, either
\nfrom the command line or by setting up a `COMPOSE_FILE` environment variable
in your shell or in an environment file.\n\nFor an example of using the `-f` option
at the command line, suppose you are running the Compose Rails sample, and \nhave
a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command
like `docker compose pull` to \nget the postgres image for the db service from
anywhere by using the `-f` flag as follows: \n```\ndocker compose -f ~/sandbox/rails/compose.yaml
pull db\n```\n\n### Use `-p` to specify a project name\n\nEach configuration has
a project name. If you supply a `-p` flag, you can specify a project name. If
you don’t \nspecify the flag, Compose uses the current directory name. \nProject
name can also be set by `COMPOSE_PROJECT_NAME` environment variable.\n\nMost compose
subcommand can be ran without a compose file, just passing \nproject name to retrieve
the relevant resources.\n\n```\n$ docker compose -p my_project ps -a\nNAME SERVICE
\ STATUS PORTS\nmy_project_demo_1 demo running \n\n$
docker compose -p my_project logs\ndemo_1 | PING localhost (127.0.0.1): 56 data
bytes\ndemo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms\n```\n\n###
Use profiles to enable optional services\n\nUse `--profile` to specify one or
more active profiles\nCalling `docker compose --profile frontend up` will start
the services with the profile `frontend` and services \nwithout any specified
profiles. \nYou can also enable multiple profiles, e.g. with `docker compose --profile
frontend --profile debug up` the profiles `frontend` and `debug` will be enabled.\n\nProfiles
can also be set by `COMPOSE_PROFILES` environment variable.\n\n### Set up environment
variables\n\nYou can set environment variables for various docker-compose options,
including the `-f`, `-p` and `--profiles` flags.\n\nSetting the `COMPOSE_FILE`
environment variable is equivalent to passing the `-f` flag,\n`COMPOSE_PROJECT_NAME`
environment variable does the same for to the `-p` flag,\nand so does `COMPOSE_PROFILES`
environment variable for to the `--profiles` flag.\n\nIf flags are explicitly
set on command line, associated environment variable is ignored"
usage: docker compose usage: docker compose
pname: docker pname: docker
plink: docker.yaml plink: docker.yaml
cname: cname:
- docker compose build - docker compose build
- docker compose convert - docker compose convert
- docker compose cp - docker compose cp
- docker compose create - docker compose create
- docker compose down - docker compose down
- docker compose events - docker compose events
- docker compose exec - docker compose exec
- docker compose images - docker compose images
- docker compose kill - docker compose kill
- docker compose logs - docker compose logs
- docker compose ls - docker compose ls
- docker compose pause - docker compose pause
- docker compose port - docker compose port
- docker compose ps - docker compose ps
- docker compose pull - docker compose pull
- docker compose push - docker compose push
- docker compose restart - docker compose restart
- docker compose rm - docker compose rm
- docker compose run - docker compose run
- docker compose start - docker compose start
- docker compose stop - docker compose stop
- docker compose top - docker compose top
- docker compose unpause - docker compose unpause
- docker compose up - docker compose up
clink: clink:
- docker_compose_build.yaml - docker_compose_build.yaml
- docker_compose_convert.yaml - docker_compose_convert.yaml
- docker_compose_cp.yaml - docker_compose_cp.yaml
- docker_compose_create.yaml - docker_compose_create.yaml
- docker_compose_down.yaml - docker_compose_down.yaml
- docker_compose_events.yaml - docker_compose_events.yaml
- docker_compose_exec.yaml - docker_compose_exec.yaml
- docker_compose_images.yaml - docker_compose_images.yaml
- docker_compose_kill.yaml - docker_compose_kill.yaml
- docker_compose_logs.yaml - docker_compose_logs.yaml
- docker_compose_ls.yaml - docker_compose_ls.yaml
- docker_compose_pause.yaml - docker_compose_pause.yaml
- docker_compose_port.yaml - docker_compose_port.yaml
- docker_compose_ps.yaml - docker_compose_ps.yaml
- docker_compose_pull.yaml - docker_compose_pull.yaml
- docker_compose_push.yaml - docker_compose_push.yaml
- docker_compose_restart.yaml - docker_compose_restart.yaml
- docker_compose_rm.yaml - docker_compose_rm.yaml
- docker_compose_run.yaml - docker_compose_run.yaml
- docker_compose_start.yaml - docker_compose_start.yaml
- docker_compose_stop.yaml - docker_compose_stop.yaml
- docker_compose_top.yaml - docker_compose_top.yaml
- docker_compose_unpause.yaml - docker_compose_unpause.yaml
- docker_compose_up.yaml - docker_compose_up.yaml
options: options:
- option: ansi - option: ansi
value_type: string value_type: string
default_value: auto default_value: auto
description: | description: |
Control when to print ANSI control characters ("never"|"always"|"auto") Control when to print ANSI control characters ("never"|"always"|"auto")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: env-file - option: env-file
value_type: string value_type: string
description: Specify an alternate environment file. description: Specify an alternate environment file.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: file - option: file
shorthand: f shorthand: f
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Compose configuration files description: Compose configuration files
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-ansi - option: no-ansi
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not print ANSI control characters (DEPRECATED) description: Do not print ANSI control characters (DEPRECATED)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: profile - option: profile
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Specify a profile to enable description: Specify a profile to enable
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: project-directory - option: project-directory
value_type: string value_type: string
description: |- description: |-
Specify an alternate working directory Specify an alternate working directory
(default: the path of the Compose file) (default: the path of the Compose file)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: project-name - option: project-name
shorthand: p shorthand: p
value_type: string value_type: string
description: Project name description: Project name
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: workdir - option: verbose
value_type: string value_type: bool
description: |- default_value: "false"
description: Show more output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
value_type: string
description: |-
DEPRECATED! USE --project-directory INSTEAD. DEPRECATED! USE --project-directory INSTEAD.
Specify an alternate working directory Specify an alternate working directory
(default: the path of the Compose file) (default: the path of the Compose file)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

189
docs/reference/docker_compose_build.yaml
View File

@ -1,108 +1,103 @@
command: docker compose build command: docker compose build
short: Build or rebuild services short: Build or rebuild services
long: "Services are built once and then tagged, by default as `project_service`. \n\nIf long: "Services are built once and then tagged, by default as `project_service`. \n\nIf the Compose file specifies an\n[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, \nthe image is tagged with that name, substituting any variables beforehand. See\n[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).\n\nIf you change a service's `Dockerfile` or the contents of its build directory, \nrun `docker compose build` to rebuild it."
the Compose file specifies an\n[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image)
name, \nthe image is tagged with that name, substituting any variables beforehand.
See\n[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).\n\nIf
you change a service's `Dockerfile` or the contents of its build directory, \nrun
`docker compose build` to rebuild it."
usage: docker compose build [SERVICE...] usage: docker compose build [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: build-arg - option: build-arg
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Set build-time variables for services. description: Set build-time variables for services.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: compress - option: compress
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Compress the build context using gzip. DEPRECATED description: Compress the build context using gzip. DEPRECATED
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force-rm - option: force-rm
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Always remove intermediate containers. DEPRECATED description: Always remove intermediate containers. DEPRECATED
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: string value_type: string
description: | description: |
Set memory limit for the build container. Not supported on buildkit yet. Set memory limit for the build container. Not supported on buildkit yet.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-cache - option: no-cache
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not use cache when building the image description: Do not use cache when building the image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-rm - option: no-rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Do not remove intermediate containers after a successful build. DEPRECATED Do not remove intermediate containers after a successful build. DEPRECATED
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: parallel - option: parallel
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Build images in parallel. DEPRECATED description: Build images in parallel. DEPRECATED
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: progress - option: progress
value_type: string value_type: string
default_value: auto default_value: auto
description: Set type of progress output ("auto", "plain", "noTty") description: Set type of progress output ("auto", "plain", "noTty")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: pull - option: pull
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always attempt to pull a newer version of the image. description: Always attempt to pull a newer version of the image.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't print anything to STDOUT description: Don't print anything to STDOUT
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

150
docs/reference/docker_compose_convert.yaml
View File

@ -1,87 +1,83 @@
command: docker compose convert command: docker compose convert
aliases: config aliases: config
short: Converts the compose file to platform's canonical format short: Converts the compose file to platform's canonical format
long: "`docker compose convert` render the actual data model to be applied on target long: "`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,\nit merges the Compose files set by `-f` flags, resolves variables in Compose file, and expands short-notation into \nfully defined Compose model. \n\nTo allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`"
platform. When used with Docker engine,\nit merges the Compose files set by `-f`
flags, resolves variables in Compose file, and expands short-notation into \nfully
defined Compose model. \n\nTo allow smooth migration from docker-compose, this
subcommand declares alias `docker compose config`"
usage: docker compose convert SERVICES usage: docker compose convert SERVICES
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: format - option: format
value_type: string value_type: string
default_value: yaml default_value: yaml
description: 'Format the output. Values: [yaml | json]' description: 'Format the output. Values: [yaml | json]'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: hash - option: hash
value_type: string value_type: string
description: Print the service config hash, one per line. description: Print the service config hash, one per line.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-interpolate - option: no-interpolate
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't interpolate environment variables. description: Don't interpolate environment variables.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: profiles - option: profiles
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print the profile names, one per line. description: Print the profile names, one per line.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Only validate the configuration, don't print anything. description: Only validate the configuration, don't print anything.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: resolve-image-digests - option: resolve-image-digests
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Pin image tags to digests. description: Pin image tags to digests.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: services - option: services
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print the service names, one per line. description: Print the service names, one per line.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: volumes - option: volumes
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print the volume names, one per line. description: Print the volume names, one per line.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

76
docs/reference/docker_compose_cp.yaml
View File

@ -7,45 +7,45 @@ usage: |-
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: all - option: all
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Copy to all the containers of the service. description: Copy to all the containers of the service.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: archive - option: archive
shorthand: a shorthand: a
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Archive mode (copy all uid/gid information) description: Archive mode (copy all uid/gid information)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: follow-link - option: follow-link
shorthand: L shorthand: L
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always follow symbol link in SRC_PATH description: Always follow symbol link in SRC_PATH
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: index - option: index
value_type: int value_type: int
default_value: "1" default_value: "1"
description: | description: |
Index of the container if there are multiple instances of a service [default: 1]. Index of the container if there are multiple instances of a service [default: 1].
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

72
docs/reference/docker_compose_create.yaml
View File

@ -5,44 +5,44 @@ usage: docker compose create [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: build - option: build
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Build images before starting containers. description: Build images before starting containers.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force-recreate - option: force-recreate
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Recreate containers even if their configuration and image haven't changed. Recreate containers even if their configuration and image haven't changed.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-build - option: no-build
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't build an image, even if it's missing. description: Don't build an image, even if it's missing.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-recreate - option: no-recreate
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
If containers already exist, don't recreate them. Incompatible with --force-recreate. If containers already exist, don't recreate them. Incompatible with --force-recreate.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

74
docs/reference/docker_compose_down.yaml
View File

@ -18,46 +18,46 @@ usage: docker compose down
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: remove-orphans - option: remove-orphans
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Remove containers for services not defined in the Compose file. Remove containers for services not defined in the Compose file.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: rmi - option: rmi
value_type: string value_type: string
description: | description: |
Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all") Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "10"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: volumes - option: volumes
shorthand: v shorthand: v
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: |4 description: |4
Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

18
docs/reference/docker_compose_events.yaml
View File

@ -24,15 +24,15 @@ usage: docker compose events [options] [--] [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: json - option: json
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Output events as a stream of json objects description: Output events as a stream of json objects
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

139
docs/reference/docker_compose_exec.yaml
View File

@ -1,81 +1,78 @@
command: docker compose exec command: docker compose exec
short: Execute a command in a running container. short: Execute a command in a running container.
long: "This is the equivalent of `docker exec` targeting a Compose service. \n\nWith long: "This is the equivalent of `docker exec` targeting a Compose service. \n\nWith this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so \nyou can use a command such as `docker compose exec web sh` to get an interactive prompt."
this subcommand you can run arbitrary commands in your services. Commands are
by default allocating a TTY, so \nyou 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] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: "" - option: detach
shorthand: T shorthand: d
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: 'Detached mode: Run command in the background.'
Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: env
- option: detach shorthand: e
shorthand: d value_type: stringArray
value_type: bool default_value: '[]'
default_value: "false" description: Set environment variables
description: 'Detached mode: Run command in the background.' deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: index
- option: env value_type: int
shorthand: e default_value: "1"
value_type: stringArray description: |
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: index
value_type: int
default_value: "1"
description: |
index of the container if there are multiple instances of a service [default: 1]. index of the container if there are multiple instances of a service [default: 1].
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: privileged - option: no-TTY
value_type: bool shorthand: T
default_value: "false" value_type: bool
description: Give extended privileges to the process. default_value: "false"
deprecated: false description: |
experimental: false Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY.
experimentalcli: false deprecated: false
kubernetes: false experimental: false
swarm: false experimentalcli: false
- option: user kubernetes: false
shorthand: u swarm: false
value_type: string - option: privileged
description: Run the command as this user. value_type: bool
deprecated: false default_value: "false"
experimental: false description: Give extended privileges to the process.
experimentalcli: false deprecated: false
kubernetes: false experimental: false
swarm: false experimentalcli: false
- option: workdir kubernetes: false
shorthand: w swarm: false
value_type: string - option: user
description: Path to workdir directory for this command. shorthand: u
deprecated: false value_type: string
experimental: false description: Run the command as this user.
experimentalcli: false deprecated: false
kubernetes: false experimental: false
swarm: false experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Path to workdir directory for this command.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

20
docs/reference/docker_compose_images.yaml
View File

@ -5,16 +5,16 @@ usage: docker compose images [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Only display IDs description: Only display IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

20
docs/reference/docker_compose_kill.yaml
View File

@ -10,16 +10,16 @@ usage: docker compose kill [options] [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: signal - option: signal
shorthand: s shorthand: s
value_type: string value_type: string
default_value: SIGKILL default_value: SIGKILL
description: SIGNAL to send to the container. description: SIGNAL to send to the container.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

106
docs/reference/docker_compose_logs.yaml
View File

@ -1,48 +1,76 @@
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 [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: follow - option: follow
shorthand: f shorthand: f
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Follow log output. description: Follow log output.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-color - option: no-color
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Produce monochrome output. description: Produce monochrome output.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-log-prefix - option: no-log-prefix
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't print prefix in logs. description: Don't print prefix in logs.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: timestamps - option: since
shorthand: t value_type: string
value_type: bool description: |
default_value: "false" Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
description: Show timestamps. deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: tail
value_type: string
default_value: all
description: |
Number of lines to show from the end of the logs for each container.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps
shorthand: t
value_type: bool
default_value: "false"
description: Show timestamps.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until
value_type: string
description: |
Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

64
docs/reference/docker_compose_ls.yaml
View File

@ -5,33 +5,43 @@ usage: docker compose ls
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: filter - option: all
value_type: filter shorthand: a
description: Filter output based on conditions provided. value_type: bool
deprecated: false default_value: "false"
experimental: false description: Show all stopped Compose projects
experimentalcli: false deprecated: false
kubernetes: false experimental: false
swarm: false experimentalcli: false
- option: format kubernetes: false
value_type: string swarm: false
default_value: pretty - option: filter
description: 'Format the output. Values: [pretty | json].' value_type: filter
deprecated: false description: Filter output based on conditions provided.
experimental: false deprecated: false
experimentalcli: false experimental: false
kubernetes: false experimentalcli: false
swarm: false kubernetes: false
- option: quiet swarm: false
shorthand: q - option: format
value_type: bool value_type: string
default_value: "false" default_value: pretty
description: Only display IDs. description: 'Format the output. Values: [pretty | json].'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display IDs.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

3
docs/reference/docker_compose_pause.yaml
View File

@ -1,7 +1,6 @@
command: docker compose pause command: docker compose pause
short: pause services short: pause services
long: Pauses running containers of a service. They can be unpaused with `docker compose long: Pauses running containers of a service. They can be unpaused with `docker compose unpause`.
unpause`.
usage: docker compose pause [SERVICE...] usage: docker compose pause [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml

36
docs/reference/docker_compose_port.yaml
View File

@ -5,24 +5,24 @@ usage: docker compose port [options] [--] SERVICE PRIVATE_PORT
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: index - option: index
value_type: int value_type: int
default_value: "1" default_value: "1"
description: index of the container if service has multiple replicas description: index of the container if service has multiple replicas
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: protocol - option: protocol
value_type: string value_type: string
default_value: tcp default_value: tcp
description: tcp or udp description: tcp or udp
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

99
docs/reference/docker_compose_ps.yaml
View File

@ -1,52 +1,65 @@
command: docker compose ps command: docker compose ps
short: List containers short: List containers
long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```\n$ long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```\n$ docker compose ps\nNAME SERVICE STATUS PORTS\nexample_foo_1 foo running (healthy) 0.0.0.0:8000->80/tcp\nexample_bar_1 bar exited (1) \n```"
docker compose ps\nNAME SERVICE STATUS PORTS\nexample_foo_1 usage: docker compose ps [SERVICE...]
\ foo running (healthy) 0.0.0.0:8000->80/tcp\nexample_bar_1
\ bar exited (1) \n```"
usage: docker compose ps
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: all - option: all
shorthand: a shorthand: a
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Show all stopped containers (including those created by the run command) Show all stopped containers (including those created by the run command)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: format - option: filter
value_type: string value_type: string
default_value: pretty description: Filter services by a property
description: 'Format the output. Values: [pretty | json].' deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: format
- option: quiet value_type: string
shorthand: q default_value: pretty
value_type: bool description: 'Format the output. Values: [pretty | json]'
default_value: "false" deprecated: false
description: Only display IDs experimental: false
deprecated: false experimentalcli: false
experimental: false kubernetes: false
experimentalcli: false swarm: false
kubernetes: false - option: quiet
swarm: false shorthand: q
- option: services value_type: bool
value_type: bool default_value: "false"
default_value: "false" description: Only display IDs
description: Display services deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: services
value_type: bool
default_value: "false"
description: Display services
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: status
value_type: string
description: Filter services by status
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

119
docs/reference/docker_compose_pull.yaml
View File

@ -1,80 +1,57 @@
command: docker compose pull command: docker compose pull
short: Pull service images short: Pull service images
long: "Pulls an image associated with a service defined in a `compose.yaml` file, long: "Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on \nthose images."
but does not start containers based on \nthose images."
usage: docker compose pull [SERVICE...] usage: docker compose pull [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: ignore-pull-failures - option: ignore-pull-failures
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Pull what it can and ignores images with pull failures description: Pull what it can and ignores images with pull failures
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: include-deps - option: include-deps
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Also pull services declared as dependencies description: Also pull services declared as dependencies
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-parallel - option: no-parallel
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: DEPRECATED disable parallel pulling. description: DEPRECATED disable parallel pulling.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: parallel - option: parallel
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: DEPRECATED pull multiple images in parallel. description: DEPRECATED pull multiple images in parallel.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Pull without printing progress information description: Pull without printing progress information
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: "suppose you have this `compose.yaml` file from the Quickstart: [Compose examples: "suppose you have this `compose.yaml` file from the Quickstart: [Compose and Rails sample](compose/rails/).\n\n```yaml\nservices:\n db:\n image: postgres\n web:\n build: .\n command: bundle exec rails s -p 3000 -b '0.0.0.0'\n volumes:\n - .:/myapp\n ports:\n - \"3000:3000\"\n depends_on:\n - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory as the `ccompose.yaml` file that defines the service, \nDocker pulls the associated image. For example, to call the postgres image configured as the db service in our example, \nyou would run `docker compose pull db`.\n\n```\n$ docker compose pull db\n[+] Running 1/15\n ⠸ db Pulling 12.4s\n ⠿ 45b42c59be33 Already exists 0.0s\n ⠹ 40adec129f1a Downloading 3.374MB/4.178MB 9.3s\n ⠹ b4c431d00c78 Download complete 9.3s\n ⠹ 2696974e2815 Download complete 9.3s\n ⠹ 564b77596399 Downloading 5.622MB/7.965MB 9.3s\n ⠹ 5044045cf6f2 Downloading 216.7kB/391.1kB 9.3s\n ⠹ d736e67e6ac3 Waiting 9.3s\n ⠹ 390c1c9a5ae4 Waiting 9.3s\n ⠹ c0e62f172284 Waiting 9.3s\n ⠹ ebcdc659c5bf Waiting 9.3s\n ⠹ 29be22cb3acc Waiting 9.3s\n ⠹ f63c47038e66 Waiting 9.3s\n ⠹ 77a0c198cde5 Waiting 9.3s\n ⠹ c8752d5b785c Waiting 9.3s\n``̀"
and Rails sample](compose/rails/).\n\n```yaml\nservices:\n db:\n image: postgres\n
\ web:\n build: .\n command: bundle exec rails s -p 3000 -b '0.0.0.0'\n
\ volumes:\n - .:/myapp\n ports:\n - \"3000:3000\"\n depends_on:\n
\ - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory
as the `ccompose.yaml` file that defines the service, \nDocker pulls the associated
image. For example, to call the postgres image configured as the db service in
our example, \nyou would run `docker compose pull db`.\n\n```\n$ docker compose
pull db\n[+] Running 1/15\n ⠸ db Pulling 12.4s\n
\ ⠿ 45b42c59be33 Already exists 0.0s\n
\ ⠹ 40adec129f1a Downloading 3.374MB/4.178MB 9.3s\n
\ ⠹ b4c431d00c78 Download complete 9.3s\n
\ ⠹ 2696974e2815 Download complete 9.3s\n
\ ⠹ 564b77596399 Downloading 5.622MB/7.965MB 9.3s\n
\ ⠹ 5044045cf6f2 Downloading 216.7kB/391.1kB 9.3s\n
\ ⠹ d736e67e6ac3 Waiting 9.3s\n
\ ⠹ 390c1c9a5ae4 Waiting 9.3s\n
\ ⠹ c0e62f172284 Waiting 9.3s\n
\ ⠹ ebcdc659c5bf Waiting 9.3s\n
\ ⠹ 29be22cb3acc Waiting 9.3s\n
\ ⠹ f63c47038e66 Waiting 9.3s\n
\ ⠹ 77a0c198cde5 Waiting 9.3s\n
\ ⠹ c8752d5b785c Waiting 9.3s\n``̀"
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

25
docs/reference/docker_compose_push.yaml
View File

@ -1,24 +1,19 @@
command: docker compose push command: docker compose push
short: Push service images short: Push service images
long: "Pushes images for services to their respective registry/repository.\n\nThe long: "Pushes images for services to their respective registry/repository.\n\nThe following assumptions are made:\n- You are pushing an image you have built locally\n- You have access to the build key\n\nExamples\n\n```yaml\nservices:\n service1:\n build: .\n image: localhost:5000/yourimage ## goes to local registry\n \n service2:\n build: .\n image: your-dockerid/yourimage ## goes to your repository on Docker Hub\n```"
following assumptions are made:\n- You are pushing an image you have built locally\n-
You have access to the build key\n\nExamples\n\n```yaml\nservices:\n service1:\n
\ build: .\n image: localhost:5000/yourimage ## goes to local registry\n
\ \n service2:\n build: .\n image: your-dockerid/yourimage
\ ## goes to your repository on Docker Hub\n```"
usage: docker compose push [SERVICE...] usage: docker compose push [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: ignore-push-failures - option: ignore-push-failures
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Push what it can and ignores images with push failures description: Push what it can and ignores images with push failures
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

20
docs/reference/docker_compose_restart.yaml
View File

@ -5,16 +5,16 @@ usage: docker compose restart
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "10"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

80
docs/reference/docker_compose_rm.yaml
View File

@ -20,46 +20,46 @@ usage: docker compose rm [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: all - option: all
shorthand: a shorthand: a
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Deprecated - no effect description: Deprecated - no effect
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't ask to confirm removal description: Don't ask to confirm removal
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: stop - option: stop
shorthand: s shorthand: s
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Stop the containers, if required, before removing description: Stop the containers, if required, before removing
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: volumes - option: volumes
shorthand: v shorthand: v
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Remove any anonymous volumes attached to containers description: Remove any anonymous volumes attached to containers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

290
docs/reference/docker_compose_run.yaml
View File

@ -1,169 +1,143 @@
command: docker compose run command: docker compose run
short: Run a one-off command on a service. short: Run a one-off command on a service.
long: "Runs a one-time command against a service. \n\nthe following command starts long: "Runs a one-time command against a service. \n\nthe following command starts the `web` service and runs `bash` as its command.\n`docker compose run web bash`\n\nCommands you use with run start in new containers with configuration defined by that of the service,\nincluding volumes, links, and other details. However, there are two important differences:\n\nFirst, the command passed by `run` overrides the command defined in the service configuration. For example, if the \n`web` service configuration is started with `bash`, then `docker compose run web python app.py` overrides it with \n`python app.py`.\n\nThe second difference is that the `docker compose run` command does not create any of the ports specified in the \nservice configuration. This prevents port collisions with already-open ports. If you do want the service’s ports \nto be created and mapped to the host, specify the `--service-ports`\n\n```\ndocker compose run --service-ports web python manage.py shell\n```\n\nAlternatively, manual port mapping can be specified with the `--publish` or `-p` options, just as when using docker run:\n\n```\ndocker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell\n```\n\n\nIf you start a service configured with links, the run command first checks to see if the linked service is running \nand starts the service if it is stopped. Once all the linked services are running, the run executes the command you \npassed it. For example, you could run:\n\n```\ndocker compose run db psql -h db -U docker\n```\n\nThis opens an interactive PostgreSQL shell for the linked `db` container.\n\nIf you do not want the run command to start linked containers, use the `--no-deps` flag:\n\n```\ndocker compose run --no-deps web python manage.py shell\n```\n\nIf you want to remove the container after running while overriding the container’s restart policy, use the `--rm` flag:\n\n```\ndocker compose run --rm web python manage.py db upgrade\n```\n\nThis runs a database upgrade script, and removes the container when finished running, even if a restart policy is \nspecified in the service configuration."
the `web` service and runs `bash` as its command.\n`docker compose run web bash`\n\nCommands usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
you use with run start in new containers with configuration defined by that of
the service,\nincluding volumes, links, and other details. However, there are
two important differences:\n\nFirst, the command passed by `run` overrides the
command defined in the service configuration. For example, if the \n`web` service
configuration is started with `bash`, then `docker compose run web python app.py`
overrides it with \n`python app.py`.\n\nThe second difference is that the `docker
compose run` command does not create any of the ports specified in the \nservice
configuration. This prevents port collisions with already-open ports. If you do
want the service’s ports \nto be created and mapped to the host, specify the `--service-ports`\n\n```\ndocker
compose run --service-ports web python manage.py shell\n```\n\nAlternatively,
manual port mapping can be specified with the `--publish` or `-p` options, just
as when using docker run:\n\n```\ndocker compose run --publish 8080:80 -p 2022:22
-p 127.0.0.1:2021:21 web python manage.py shell\n```\n\n\nIf you start a service
configured with links, the run command first checks to see if the linked service
is running \nand starts the service if it is stopped. Once all the linked services
are running, the run executes the command you \npassed it. For example, you could
run:\n\n```\ndocker compose run db psql -h db -U docker\n```\n\nThis opens an
interactive PostgreSQL shell for the linked `db` container.\n\nIf you do not want
the run command to start linked containers, use the `--no-deps` flag:\n\n```\ndocker
compose run --no-deps web python manage.py shell\n```\n\nIf you want to remove
the container after running while overriding the container’s restart policy, use
the `--rm` flag:\n\n```\ndocker compose run --rm web python manage.py db upgrade\n```\n\nThis
runs a database upgrade script, and removes the container when finished running,
even if a restart policy is \nspecified in the service configuration."
usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l
KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: detach - option: detach
shorthand: d shorthand: d
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Run container in background and print container ID description: Run container in background and print container ID
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: entrypoint - option: entrypoint
value_type: string value_type: string
description: Override the entrypoint of the image description: Override the entrypoint of the image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Set environment variables description: Set environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: labels - option: labels
shorthand: l shorthand: l
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Add or override a label description: Add or override a label
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: name - option: name
value_type: string value_type: string
description: ' Assign a name to the container' description: ' Assign a name to the container'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-TTY - option: no-TTY
shorthand: T shorthand: T
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Disable pseudo-noTty allocation. By default docker compose run allocates a TTY Disable pseudo-noTty allocation. By default docker compose run allocates a TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-deps - option: no-deps
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't start linked services. description: Don't start linked services.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: publish - option: publish
shorthand: p shorthand: p
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Publish a container's port(s) to the host. description: Publish a container's port(s) to the host.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Automatically remove the container when it exits description: Automatically remove the container when it exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: service-ports - option: service-ports
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Run command with the service's ports enabled and mapped to the host. Run command with the service's ports enabled and mapped to the host.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: use-aliases - option: use-aliases
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Use the service's network useAliases in the network(s) the container connects to. Use the service's network useAliases in the network(s) the container connects to.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: Run as specified username or uid description: Run as specified username or uid
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: volumes - option: volume
shorthand: v shorthand: v
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: Bind mount a volume. description: Bind mount a volume.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
description: Working directory inside the container description: Working directory inside the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

23
docs/reference/docker_compose_stop.yaml
View File

@ -1,21 +1,20 @@
command: docker compose stop command: docker compose stop
short: Stop services short: Stop services
long: Stops running containers without removing them. They can be started again with long: Stops running containers without removing them. They can be started again with `docker compose start`.
`docker compose start`.
usage: docker compose stop [SERVICE...] usage: docker compose stop [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "10"
description: Specify a shutdown timeout in seconds description: Specify a shutdown timeout in seconds
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

6
docs/reference/docker_compose_top.yaml
View File

@ -1,12 +1,10 @@
command: docker compose top command: docker compose top
short: Display the running processes short: Display the running processes
long: Displays the running processes. long: Displays the running processes.
usage: docker compose top usage: docker compose top [SERVICES...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
examples: "```\n$ docker compose top\nexample_foo_1\nUID PID PPID C STIME examples: "```\n$ docker compose top\nexample_foo_1\nUID PID PPID C STIME TTY TIME CMD\nroot 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5 \n```"
\ TTY TIME CMD\nroot 142353 142331 2 15:33 ? 00:00:00
\ ping localhost -c 5 \n```"
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false

372
docs/reference/docker_compose_up.yaml
View File

@ -1,206 +1,202 @@
command: docker compose up command: docker compose up
short: Create and start containers short: Create and start containers
long: "Builds, (re)creates, starts, and attaches to containers for a service.\n\nUnless long: "Builds, (re)creates, starts, and attaches to containers for a service.\n\nUnless they are already running, this command also starts any linked services.\n\nThe `docker compose up` command aggregates the output of each container (liked `docker compose logs --follow` does). \nWhen the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the \nbackground and leaves them running.\n\nIf there are existing containers for a service, and the service’s configuration or image was changed after the \ncontainer’s creation, `docker compose up` picks up the changes by stopping and recreating the containers \n(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.\n\nIf you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.\n\nIf the process encounters an error, the exit code for this command is `1`.\nIf the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`."
they are already running, this command also starts any linked services.\n\nThe
`docker compose up` command aggregates the output of each container (liked `docker
compose logs --follow` does). \nWhen the command exits, all containers are stopped.
Running `docker compose up --detach` starts the containers in the \nbackground
and leaves them running.\n\nIf there are existing containers for a service, and
the service’s configuration or image was changed after the \ncontainer’s creation,
`docker compose up` picks up the changes by stopping and recreating the containers
\n(preserving mounted volumes). To prevent Compose from picking up changes, use
the `--no-recreate` flag.\n\nIf you want to force Compose to stop and recreate
all containers, use the `--force-recreate` flag.\n\nIf the process encounters
an error, the exit code for this command is `1`.\nIf 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 [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml
options: options:
- option: abort-on-container-exit - option: abort-on-container-exit
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Stops all containers if any container was stopped. Incompatible with -d Stops all containers if any container was stopped. Incompatible with -d
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: always-recreate-deps - option: always-recreate-deps
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Recreate dependent containers. Incompatible with --no-recreate. Recreate dependent containers. Incompatible with --no-recreate.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: attach-dependencies - option: attach
value_type: bool value_type: stringArray
default_value: "false" default_value: '[]'
description: Attach to dependent containers. description: Attach to service output.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: build - option: attach-dependencies
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Build images before starting containers. description: Attach to dependent containers.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: detach - option: build
shorthand: d value_type: bool
value_type: bool default_value: "false"
default_value: "false" description: Build images before starting containers.
description: 'Detached mode: Run containers in the background' deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: detach
- option: environment shorthand: d
shorthand: e value_type: bool
value_type: stringArray default_value: "false"
default_value: '[]' description: 'Detached mode: Run containers in the background'
description: Environment variables deprecated: false
deprecated: false experimental: false
experimental: false experimentalcli: false
experimentalcli: false kubernetes: false
kubernetes: false swarm: false
swarm: false - option: environment
- option: exit-code-from shorthand: e
value_type: string value_type: stringArray
description: | default_value: '[]'
description: Environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: exit-code-from
value_type: string
description: |
Return the exit code of the selected service container. Implies --abort-on-container-exit Return the exit code of the selected service container. Implies --abort-on-container-exit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: force-recreate - option: force-recreate
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Recreate containers even if their configuration and image haven't changed. Recreate containers even if their configuration and image haven't changed.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-build - option: no-build
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't build an image, even if it's missing. description: Don't build an image, even if it's missing.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-color - option: no-color
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Produce monochrome output. description: Produce monochrome output.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-deps - option: no-deps
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't start linked services. description: Don't start linked services.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-log-prefix - option: no-log-prefix
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't print prefix in logs. description: Don't print prefix in logs.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-recreate - option: no-recreate
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
If containers already exist, don't recreate them. Incompatible with --force-recreate. If containers already exist, don't recreate them. Incompatible with --force-recreate.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: no-start - option: no-start
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't start the services after creating them. description: Don't start the services after creating them.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: quiet-pull - option: quiet-pull
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Pull without printing progress information. description: Pull without printing progress information.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: remove-orphans - option: remove-orphans
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Remove containers for services not defined in the Compose file. Remove containers for services not defined in the Compose file.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: renew-anon-volumes - option: renew-anon-volumes
shorthand: V shorthand: V
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: | description: |
Recreate anonymous volumes instead of retrieving data from the previous containers. Recreate anonymous volumes instead of retrieving data from the previous containers.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: scale - option: scale
value_type: stringArray value_type: stringArray
default_value: '[]' default_value: '[]'
description: | description: |
Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
- option: timeout - option: timeout
shorthand: t shorthand: t
value_type: int value_type: int
default_value: "10" default_value: "10"
description: | description: |
Use this timeout in seconds for container shutdown when attached or when containers are already running. Use this timeout in seconds for container shutdown when attached or when containers are already running.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false
kubernetes: false kubernetes: false
swarm: false swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false experimentalcli: false