2023-01-27 10:04:52 +01:00
|
|
|
command: docker compose config
|
|
|
|
aliases: docker compose config, docker compose convert
|
|
|
|
short: Parse, resolve and render compose file in canonical format
|
|
|
|
long: |-
|
2023-10-31 11:50:42 +01:00
|
|
|
`docker compose config` renders the actual data model to be applied on the Docker Engine.
|
|
|
|
It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
|
2023-01-27 10:04:52 +01:00
|
|
|
the canonical format.
|
|
|
|
usage: docker compose config [OPTIONS] [SERVICE...]
|
|
|
|
pname: docker compose
|
|
|
|
plink: docker_compose.yaml
|
|
|
|
options:
|
|
|
|
- option: format
|
|
|
|
value_type: string
|
|
|
|
default_value: yaml
|
|
|
|
description: 'Format the output. Values: [yaml | json]'
|
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: hash
|
|
|
|
value_type: string
|
2024-03-21 10:33:47 +01:00
|
|
|
description: Print the service config hash, one per line.
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: images
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-03-21 10:33:47 +01:00
|
|
|
description: Print the image names, one per line.
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: no-consistency
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
|
|
|
description: |
|
|
|
|
Don't check model consistency - warning: may produce invalid Compose output
|
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: no-interpolate
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-02-14 20:02:37 +01:00
|
|
|
description: Don't interpolate environment variables
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: no-normalize
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-02-14 20:02:37 +01:00
|
|
|
description: Don't normalize compose model
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
2023-05-11 11:47:47 +02:00
|
|
|
- option: no-path-resolution
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-02-14 20:02:37 +01:00
|
|
|
description: Don't resolve file paths
|
2023-05-11 11:47:47 +02:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
2023-01-27 10:04:52 +01:00
|
|
|
- option: output
|
|
|
|
shorthand: o
|
|
|
|
value_type: string
|
|
|
|
description: Save to file (default to stdout)
|
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: profiles
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-03-21 10:33:47 +01:00
|
|
|
description: Print the profile names, one per line.
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: quiet
|
|
|
|
shorthand: q
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-02-14 20:02:37 +01:00
|
|
|
description: Only validate the configuration, don't print anything
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: resolve-image-digests
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-02-14 20:02:37 +01:00
|
|
|
description: Pin image tags to digests
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: services
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-03-21 10:33:47 +01:00
|
|
|
description: Print the service names, one per line.
|
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: variables
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
|
|
|
description: Print model variables and default values.
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
- option: volumes
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
2024-03-21 10:33:47 +01:00
|
|
|
description: Print the volume names, one per line.
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
2023-05-05 12:43:27 +02:00
|
|
|
inherited_options:
|
|
|
|
- option: dry-run
|
|
|
|
value_type: bool
|
|
|
|
default_value: "false"
|
|
|
|
description: Execute command in dry run mode
|
|
|
|
deprecated: false
|
|
|
|
hidden: false
|
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
2023-01-27 10:04:52 +01:00
|
|
|
deprecated: false
|
2023-07-07 14:27:14 +02:00
|
|
|
hidden: false
|
2023-01-27 10:04:52 +01:00
|
|
|
experimental: false
|
|
|
|
experimentalcli: false
|
|
|
|
kubernetes: false
|
|
|
|
swarm: false
|
|
|
|
|