2022-03-09 12:57:07 +01:00
|
|
|
# docker compose convert
|
2021-03-11 16:20:30 +01:00
|
|
|
|
2022-03-09 12:57:07 +01:00
|
|
|
<!---MARKER_GEN_START-->
|
2023-10-31 11:50:42 +01:00
|
|
|
Parse, resolve and render compose file in canonical format
|
2022-03-09 12:57:07 +01:00
|
|
|
|
|
|
|
### Aliases
|
|
|
|
|
2023-01-27 10:04:52 +01:00
|
|
|
`docker compose config`, `docker compose convert`
|
2022-03-09 12:57:07 +01:00
|
|
|
|
|
|
|
### Options
|
|
|
|
|
2022-12-29 14:32:16 +01:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------|
|
2023-05-05 12:43:27 +02:00
|
|
|
| `--dry-run` | | | Execute command in dry run mode |
|
2022-12-29 14:32:16 +01:00
|
|
|
| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] |
|
|
|
|
| `--hash` | `string` | | Print the service config hash, one per line. |
|
|
|
|
| `--images` | | | Print the image names, one per line. |
|
|
|
|
| `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output |
|
|
|
|
| `--no-interpolate` | | | Don't interpolate environment variables. |
|
|
|
|
| `--no-normalize` | | | Don't normalize compose model. |
|
2023-05-11 11:47:47 +02:00
|
|
|
| `--no-path-resolution` | | | Don't resolve file paths. |
|
2022-12-29 14:32:16 +01:00
|
|
|
| `-o`, `--output` | `string` | | Save to file (default to stdout) |
|
|
|
|
| `--profiles` | | | Print the profile names, one per line. |
|
|
|
|
| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. |
|
|
|
|
| `--resolve-image-digests` | | | Pin image tags to digests. |
|
|
|
|
| `--services` | | | Print the service names, one per line. |
|
|
|
|
| `--volumes` | | | Print the volume names, one per line. |
|
2022-03-09 12:57:07 +01:00
|
|
|
|
|
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
2021-03-11 16:20:30 +01:00
|
|
|
|
|
|
|
## Description
|
|
|
|
|
2023-10-31 11:40:48 +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
|
2022-11-29 16:52:22 +01:00
|
|
|
the canonical format.
|