Debian Codegraph @

docs/reference/docker_compose_config.yaml

raw
1 command: docker compose config
2 short: Parse, resolve and render compose file in canonical format
3 long: |-
4 `docker compose config` renders the actual data model to be applied on the Docker Engine.
5 It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
6 the canonical format.
7 usage: docker compose config [OPTIONS] [SERVICE...]
8 pname: docker compose
9 plink: docker_compose.yaml
10 options:
11 - option: environment
12 value_type: bool
13 default_value: "false"
14 description: Print environment used for interpolation.
15 deprecated: false
16 hidden: false
17 experimental: false
18 experimentalcli: false
19 kubernetes: false
20 swarm: false
21 - option: format
22 value_type: string
23 description: 'Format the output. Values: [yaml | json]'
24 deprecated: false
25 hidden: false
26 experimental: false
27 experimentalcli: false
28 kubernetes: false
29 swarm: false
30 - option: hash
31 value_type: string
32 description: Print the service config hash, one per line.
33 deprecated: false
34 hidden: false
35 experimental: false
36 experimentalcli: false
37 kubernetes: false
38 swarm: false
39 - option: images
40 value_type: bool
41 default_value: "false"
42 description: Print the image names, one per line.
43 deprecated: false
44 hidden: false
45 experimental: false
46 experimentalcli: false
47 kubernetes: false
48 swarm: false
49 - option: lock-image-digests
50 value_type: bool
51 default_value: "false"
52 description: Produces an override file with image digests
53 deprecated: false
54 hidden: false
55 experimental: false
56 experimentalcli: false
57 kubernetes: false
58 swarm: false
59 - option: models
60 value_type: bool
61 default_value: "false"
62 description: Print the model names, one per line.
63 deprecated: false
64 hidden: false
65 experimental: false
66 experimentalcli: false
67 kubernetes: false
68 swarm: false
69 - option: networks
70 value_type: bool
71 default_value: "false"
72 description: Print the network names, one per line.
73 deprecated: false
74 hidden: false
75 experimental: false
76 experimentalcli: false
77 kubernetes: false
78 swarm: false
79 - option: no-consistency
80 value_type: bool
81 default_value: "false"
82 description: |
83 Don't check model consistency - warning: may produce invalid Compose output
84 deprecated: false
85 hidden: false
86 experimental: false
87 experimentalcli: false
88 kubernetes: false
89 swarm: false
90 - option: no-env-resolution
91 value_type: bool
92 default_value: "false"
93 description: Don't resolve service env files
94 deprecated: false
95 hidden: false
96 experimental: false
97 experimentalcli: false
98 kubernetes: false
99 swarm: false
100 - option: no-interpolate
101 value_type: bool
102 default_value: "false"
103 description: Don't interpolate environment variables
104 deprecated: false
105 hidden: false
106 experimental: false
107 experimentalcli: false
108 kubernetes: false
109 swarm: false
110 - option: no-normalize
111 value_type: bool
112 default_value: "false"
113 description: Don't normalize compose model
114 deprecated: false
115 hidden: false
116 experimental: false
117 experimentalcli: false
118 kubernetes: false
119 swarm: false
120 - option: no-path-resolution
121 value_type: bool
122 default_value: "false"
123 description: Don't resolve file paths
124 deprecated: false
125 hidden: false
126 experimental: false
127 experimentalcli: false
128 kubernetes: false
129 swarm: false
130 - option: output
131 shorthand: o
132 value_type: string
133 description: Save to file (default to stdout)
134 deprecated: false
135 hidden: false
136 experimental: false
137 experimentalcli: false
138 kubernetes: false
139 swarm: false
140 - option: profiles
141 value_type: bool
142 default_value: "false"
143 description: Print the profile names, one per line.
144 deprecated: false
145 hidden: false
146 experimental: false
147 experimentalcli: false
148 kubernetes: false
149 swarm: false
150 - option: quiet
151 shorthand: q
152 value_type: bool
153 default_value: "false"
154 description: Only validate the configuration, don't print anything
155 deprecated: false
156 hidden: false
157 experimental: false
158 experimentalcli: false
159 kubernetes: false
160 swarm: false
161 - option: resolve-image-digests
162 value_type: bool
163 default_value: "false"
164 description: Pin image tags to digests
165 deprecated: false
166 hidden: false
167 experimental: false
168 experimentalcli: false
169 kubernetes: false
170 swarm: false
171 - option: services
172 value_type: bool
173 default_value: "false"
174 description: Print the service names, one per line.
175 deprecated: false
176 hidden: false
177 experimental: false
178 experimentalcli: false
179 kubernetes: false
180 swarm: false
181 - option: variables
182 value_type: bool
183 default_value: "false"
184 description: Print model variables and default values.
185 deprecated: false
186 hidden: false
187 experimental: false
188 experimentalcli: false
189 kubernetes: false
190 swarm: false
191 - option: volumes
192 value_type: bool
193 default_value: "false"
194 description: Print the volume names, one per line.
195 deprecated: false
196 hidden: false
197 experimental: false
198 experimentalcli: false
199 kubernetes: false
200 swarm: false
201 inherited_options:
202 - option: dry-run
203 value_type: bool
204 default_value: "false"
205 description: Execute command in dry run mode
206 deprecated: false
207 hidden: false
208 experimental: false
209 experimentalcli: false
210 kubernetes: false
211 swarm: false
212 deprecated: false
213 hidden: false
214 experimental: false
215 experimentalcli: false
216 kubernetes: false
217 swarm: false
218