mirror of
https://github.com/docker/compose.git
synced 2025-07-05 12:54:27 +02:00
9db79856be
This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
130 lines
3.7 KiB
YAML
130 lines
3.7 KiB
YAML
command: docker compose convert
|
|
aliases: docker compose convert, docker compose config
|
|
short: Converts the compose file to platform's canonical format
|
|
long: |-
|
|
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
|
|
it merges the Compose files set by `-f` flags, resolves variables in Compose file, and expands short-notation into
|
|
fully defined Compose model.
|
|
|
|
To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
|
|
usage: docker compose convert [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
|
|
description: Print the service config hash, one per line.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: images
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Print the image names, one per line.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: no-interpolate
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Don't interpolate environment variables.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: no-normalize
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Don't normalize compose model.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- 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"
|
|
description: Print the profile names, one per line.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: quiet
|
|
shorthand: q
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Only validate the configuration, don't print anything.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: resolve-image-digests
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Pin image tags to digests.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: services
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Print the service names, one per line.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: volumes
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Print the volume names, one per line.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|