Skip to content

Commit 3d58974

Browse files
gloursglours
authored
Update Compose reference API to v2.17.0
Signed-off-by: GitHub <[email protected]>
1 parent 326cb37 commit 3d58974

5 files changed

Lines changed: 188 additions & 20 deletions

File tree

‎_config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ exclude:
4545
latest_engine_api_version: "1.42"
4646
docker_ce_version: "23.0.0"
4747
compose_v1_version: "1.29.2"
48-
compose_version: "v2.16.0"
48+
compose_version: "v2.17.0"
4949
compose_file_v3: "3.9"
5050
compose_file_v2: "2.4"
5151
machine_version: "0.16.0"

‎_data/compose-cli/docker_compose.yaml‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,19 @@ long: |-
6363
6464
### Use `-p` to specify a project name
6565
66-
Each configuration has a project name. If you supply a `-p` flag, you can specify a project name. If you don’t
67-
specify the flag, Compose uses the current directory name.
68-
Project name can also be set by `COMPOSE_PROJECT_NAME` environment variable.
69-
70-
Many Compose subcommands can be run without a Compose file by passing
71-
the project name.
66+
Each configuration has a project name. Compose sets the project name using
67+
the following mechanisms, in order of precedence:
68+
- The `-p` command line flag
69+
- The `COMPOSE_PROJECT_NAME` environment variable
70+
- The top level `name:` variable from the config file (or the last `name:`
71+
from a series of config files specified using `-f`)
72+
- The `basename` of the project directory containing the config file (or
73+
containing the first config file specified using `-f`)
74+
- The `basename` of the current directory if no config file is specified
75+
Project names must contain only lowercase letters, decimal digits, dashes,
76+
and underscores, and must begin with a lowercase letter or decimal digit. If
77+
the `basename` of the project directory or current directory violates this
78+
constraint, you must use one of the other mechanisms.
7279
7380
```console
7481
$ docker compose -p my_project ps -a
@@ -198,7 +205,8 @@ options:
198205
kubernetes: false
199206
swarm: false
200207
- option: env-file
201-
value_type: string
208+
value_type: stringArray
209+
default_value: '[]'
202210
description: Specify an alternate environment file.
203211
deprecated: false
204212
hidden: false

‎_data/compose-cli/docker_compose_convert.yaml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
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+

‎_data/compose-cli/docker_compose_restart.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ usage: docker compose restart [OPTIONS] [SERVICE...]
1515
pname: docker compose
1616
plink: docker_compose.yaml
1717
options:
18+
- option: no-deps
19+
value_type: bool
20+
default_value: "false"
21+
description: Don't restart dependent services.
22+
deprecated: false
23+
hidden: false
24+
experimental: false
25+
experimentalcli: false
26+
kubernetes: false
27+
swarm: false
1828
- option: timeout
1929
shorthand: t
2030
value_type: int

‎_data/compose-cli/docker_compose_up.yaml‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -231,18 +231,6 @@ options:
231231
experimentalcli: false
232232
kubernetes: false
233233
swarm: false
234-
- option: timeout
235-
shorthand: t
236-
value_type: int
237-
default_value: "10"
238-
description: |
239-
Use this timeout in seconds for container shutdown when attached or when containers are already running.
240-
deprecated: false
241-
hidden: false
242-
experimental: false
243-
experimentalcli: false
244-
kubernetes: false
245-
swarm: false
246234
- option: timestamps
247235
value_type: bool
248236
default_value: "false"
@@ -263,6 +251,28 @@ options:
263251
experimentalcli: false
264252
kubernetes: false
265253
swarm: false
254+
- option: wait-timeout
255+
value_type: int
256+
default_value: "0"
257+
description: timeout waiting for application to be running|healthy.
258+
deprecated: false
259+
hidden: false
260+
experimental: false
261+
experimentalcli: false
262+
kubernetes: false
263+
swarm: false
264+
- option: waitTimeout
265+
shorthand: t
266+
value_type: int
267+
default_value: "10"
268+
description: |
269+
Use this waitTimeout in seconds for container shutdown when attached or when containers are already running.
270+
deprecated: false
271+
hidden: false
272+
experimental: false
273+
experimentalcli: false
274+
kubernetes: false
275+
swarm: false
266276
deprecated: false
267277
experimental: false
268278
experimentalcli: false

0 commit comments

Comments
 (0)