Debian Codegraph @

docs/reference/docker_compose_convert.yaml

raw
1 command: docker compose convert
2 aliases: docker compose convert, docker compose config
3 short: Converts the compose file to platform's canonical format
4 long: |-
5 `docker compose convert` renders the actual data model to be applied on the target platform. When used with the Docker engine,
6 it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
7 the canonical format.
8
9 To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
10 usage: docker compose convert [OPTIONS] [SERVICE...]
11 pname: docker compose
12 plink: docker_compose.yaml
13 options:
14 - option: format
15 value_type: string
16 default_value: yaml
17 description: 'Format the output. Values: [yaml | json]'
18 deprecated: false
19 hidden: false
20 experimental: false
21 experimentalcli: false
22 kubernetes: false
23 swarm: false
24 - option: hash
25 value_type: string
26 description: Print the service config hash, one per line.
27 deprecated: false
28 hidden: false
29 experimental: false
30 experimentalcli: false
31 kubernetes: false
32 swarm: false
33 - option: images
34 value_type: bool
35 default_value: "false"
36 description: Print the image names, one per line.
37 deprecated: false
38 hidden: false
39 experimental: false
40 experimentalcli: false
41 kubernetes: false
42 swarm: false
43 - option: no-consistency
44 value_type: bool
45 default_value: "false"
46 description: |
47 Don't check model consistency - warning: may produce invalid Compose output
48 deprecated: false
49 hidden: false
50 experimental: false
51 experimentalcli: false
52 kubernetes: false
53 swarm: false
54 - option: no-interpolate
55 value_type: bool
56 default_value: "false"
57 description: Don't interpolate environment variables.
58 deprecated: false
59 hidden: false
60 experimental: false
61 experimentalcli: false
62 kubernetes: false
63 swarm: false
64 - option: no-normalize
65 value_type: bool
66 default_value: "false"
67 description: Don't normalize compose model.
68 deprecated: false
69 hidden: false
70 experimental: false
71 experimentalcli: false
72 kubernetes: false
73 swarm: false
74 - option: output
75 shorthand: o
76 value_type: string
77 description: Save to file (default to stdout)
78 deprecated: false
79 hidden: false
80 experimental: false
81 experimentalcli: false
82 kubernetes: false
83 swarm: false
84 - option: profiles
85 value_type: bool
86 default_value: "false"
87 description: Print the profile names, one per line.
88 deprecated: false
89 hidden: false
90 experimental: false
91 experimentalcli: false
92 kubernetes: false
93 swarm: false
94 - option: quiet
95 shorthand: q
96 value_type: bool
97 default_value: "false"
98 description: Only validate the configuration, don't print anything.
99 deprecated: false
100 hidden: false
101 experimental: false
102 experimentalcli: false
103 kubernetes: false
104 swarm: false
105 - option: resolve-image-digests
106 value_type: bool
107 default_value: "false"
108 description: Pin image tags to digests.
109 deprecated: false
110 hidden: false
111 experimental: false
112 experimentalcli: false
113 kubernetes: false
114 swarm: false
115 - option: services
116 value_type: bool
117 default_value: "false"
118 description: Print the service names, one per line.
119 deprecated: false
120 hidden: false
121 experimental: false
122 experimentalcli: false
123 kubernetes: false
124 swarm: false
125 - option: volumes
126 value_type: bool
127 default_value: "false"
128 description: Print the volume names, one per line.
129 deprecated: false
130 hidden: false
131 experimental: false
132 experimentalcli: false
133 kubernetes: false
134 swarm: false
135 deprecated: false
136 experimental: false
137 experimentalcli: false
138 kubernetes: false
139 swarm: false
140