Skip to content

Commit 3080d42

Browse files
vvolandvvoland
committed
cli: generate docker/cli v28.0.0-rc.1
Signed-off-by: Paweł Gronowski <[email protected]>
1 parent e267306 commit 3080d42

17 files changed

+352
-75
lines changed

‎data/engine-cli/docker_container_restart.yaml‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,22 @@ options:
1818
kubernetes: false
1919
swarm: false
2020
- option: time
21+
value_type: int
22+
default_value: "0"
23+
description: |
24+
Seconds to wait before killing the container (deprecated: use --timeout)
25+
deprecated: true
26+
hidden: true
27+
experimental: false
28+
experimentalcli: false
29+
kubernetes: false
30+
swarm: false
31+
- option: timeout
2132
shorthand: t
2233
value_type: int
2334
default_value: "0"
2435
description: Seconds to wait before killing the container
25-
details_url: '#time'
36+
details_url: '#timeout'
2637
deprecated: false
2738
hidden: false
2839
experimental: false
@@ -61,14 +72,14 @@ examples: |-
6172
option when creating the container. If no signal is configured for the
6273
container, `SIGTERM` is used as default.
6374
64-
### Stop container with timeout (-t, --timeout) {#time}
75+
### Stop container with timeout (-t, --timeout) {#timeout}
6576
66-
The `--time` flag sets the number of seconds to wait for the container
77+
The `--timeout` flag sets the number of seconds to wait for the container
6778
to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
6879
If the container does not exit after the timeout elapses, it's forcibly killed
6980
with a `SIGKILL` signal.
7081
71-
If you set `--time` to `-1`, no timeout is applied, and the daemon
82+
If you set `--timeout` to `-1`, no timeout is applied, and the daemon
7283
waits indefinitely for the container to exit.
7384
7485
The default timeout can be specified using the [`--stop-timeout`](/reference/cli/docker/container/run/#stop-timeout)

‎data/engine-cli/docker_container_run.yaml‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1718,15 +1718,16 @@ examples: |-
17181718
for the `--network` flag. Comma-separated options that can be specified in the extended
17191719
`--network` syntax are:
17201720
1721-
| Option | Top-level Equivalent | Description |
1722-
|-----------------|---------------------------------------|-------------------------------------------------|
1723-
| `name` | | The name of the network (mandatory) |
1724-
| `alias` | `--network-alias` | Add network-scoped alias for the container |
1725-
| `ip` | `--ip` | IPv4 address (e.g., 172.30.100.104) |
1726-
| `ip6` | `--ip6` | IPv6 address (e.g., 2001:db8::33) |
1727-
| `mac-address` | `--mac-address` | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
1728-
| `link-local-ip` | `--link-local-ip` | Container IPv4/IPv6 link-local addresses |
1729-
| `driver-opt` | `docker network connect --driver-opt` | Network driver options |
1721+
| Option | Top-level Equivalent | Description |
1722+
|-----------------|---------------------------------------|-----------------------------------------------------------------------------------------|
1723+
| `name` | | The name of the network (mandatory) |
1724+
| `alias` | `--network-alias` | Add network-scoped alias for the container |
1725+
| `ip` | `--ip` | IPv4 address (e.g., 172.30.100.104) |
1726+
| `ip6` | `--ip6` | IPv6 address (e.g., 2001:db8::33) |
1727+
| `mac-address` | `--mac-address` | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
1728+
| `link-local-ip` | `--link-local-ip` | Container IPv4/IPv6 link-local addresses |
1729+
| `driver-opt` | `docker network connect --driver-opt` | Network driver options |
1730+
| `gw-priority` | | Highest gw-priority provides the default gateway. Accepts positive and negative values. |
17301731
17311732
```console
17321733
$ docker network create --subnet 192.0.2.0/24 my-net1

‎data/engine-cli/docker_container_stop.yaml‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,22 @@ options:
2222
kubernetes: false
2323
swarm: false
2424
- option: time
25+
value_type: int
26+
default_value: "0"
27+
description: |
28+
Seconds to wait before killing the container (deprecated: use --timeout)
29+
deprecated: true
30+
hidden: true
31+
experimental: false
32+
experimentalcli: false
33+
kubernetes: false
34+
swarm: false
35+
- option: timeout
2536
shorthand: t
2637
value_type: int
2738
default_value: "0"
2839
description: Seconds to wait before killing the container
29-
details_url: '#time'
40+
details_url: '#timeout'
3041
deprecated: false
3142
hidden: false
3243
experimental: false
@@ -64,14 +75,14 @@ examples: |-
6475
option when creating the container. If no signal is configured for the
6576
container, `SIGTERM` is used as default.
6677
67-
### Stop container with timeout (-t, --timeout) {#time}
78+
### Stop container with timeout (-t, --timeout) {#timeout}
6879
69-
The `--time` flag sets the number of seconds to wait for the container
80+
The `--timeout` flag sets the number of seconds to wait for the container
7081
to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
7182
If the container does not exit after the timeout elapses, it's forcibly killed
7283
with a `SIGKILL` signal.
7384
74-
If you set `--time` to `-1`, no timeout is applied, and the daemon
85+
If you set `--timeout` to `-1`, no timeout is applied, and the daemon
7586
waits indefinitely for the container to exit.
7687
7788
The default timeout can be specified using the [`--stop-timeout`](/reference/cli/docker/container/run/#stop-timeout)

‎data/engine-cli/docker_history.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ options:
4242
experimentalcli: false
4343
kubernetes: false
4444
swarm: false
45+
- option: platform
46+
value_type: string
47+
description: |
48+
Show history for the given platform. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
49+
deprecated: false
50+
hidden: false
51+
min_api_version: "1.48"
52+
experimental: false
53+
experimentalcli: false
54+
kubernetes: false
55+
swarm: false
4556
- option: quiet
4657
shorthand: q
4758
value_type: bool

‎data/engine-cli/docker_image_history.yaml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ options:
4343
experimentalcli: false
4444
kubernetes: false
4545
swarm: false
46+
- option: platform
47+
value_type: string
48+
description: |
49+
Show history for the given platform. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
50+
details_url: '#platform'
51+
deprecated: false
52+
hidden: false
53+
min_api_version: "1.48"
54+
experimental: false
55+
experimentalcli: false
56+
kubernetes: false
57+
swarm: false
4658
- option: quiet
4759
shorthand: q
4860
value_type: bool
@@ -121,6 +133,57 @@ examples: |-
121133
f6e427c148a7: 4 weeks ago
122134
<missing>: 4 weeks ago
123135
```
136+
137+
### Show history for a specific platform (--platform) {#platform}
138+
139+
The `--platform` option allows you to specify which platform variant to show
140+
history for if multiple platforms are present. By default, `docker history`
141+
shows the history for the daemon's native platform or if not present, the
142+
first available platform.
143+
144+
If the local image store has multiple platform variants of an image, the
145+
`--platform` option selects which variant to show the history for. An error
146+
is produced if the given platform is not present in the local image cache.
147+
148+
The platform option takes the `os[/arch[/variant]]` format; for example,
149+
`linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
150+
and if omitted falls back to the daemon's defaults.
151+
152+
153+
The following example pulls the RISC-V variant of the `alpine:latest` image
154+
and shows its history.
155+
156+
157+
```console
158+
$ docker image pull --quiet --platform=linux/riscv64 alpine
159+
docker.io/library/alpine:latest
160+
161+
$ docker image history --platform=linux/s390x alpine
162+
IMAGE CREATED CREATED BY SIZE COMMENT
163+
beefdbd8a1da 3 weeks ago /bin/sh -c #(nop) CMD ["/bin/sh"] 0B
164+
<missing> 3 weeks ago /bin/sh -c #(nop) ADD file:ba2637314e600db5a… 8.46MB
165+
```
166+
167+
The following example attempts to show the history for a platform variant of
168+
`alpine:latest` that doesn't exist in the local image store, resulting in
169+
an error.
170+
171+
```console
172+
$ docker image ls --tree
173+
IMAGE ID DISK USAGE CONTENT SIZE IN USE
174+
alpine:latest beefdbd8a1da 10.6MB 3.37MB
175+
├─ linux/riscv64 80cde017a105 10.6MB 3.37MB
176+
├─ linux/amd64 33735bd63cf8 0B 0B
177+
├─ linux/arm/v6 50f635c8b04d 0B 0B
178+
├─ linux/arm/v7 f2f82d424957 0B 0B
179+
├─ linux/arm64/v8 9cee2b382fe2 0B 0B
180+
├─ linux/386 b3e87f642f5c 0B 0B
181+
├─ linux/ppc64le c7a6800e3dc5 0B 0B
182+
└─ linux/s390x 2b5b26e09ca2 0B 0B
183+
184+
$ docker image history --platform=linux/s390x alpine
185+
Error response from daemon: image with reference alpine:latest was found but does not match the specified platform: wanted linux/s390x
186+
```
124187
deprecated: false
125188
hidden: false
126189
experimental: false

‎data/engine-cli/docker_image_load.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ options:
1919
experimentalcli: false
2020
kubernetes: false
2121
swarm: false
22+
- option: platform
23+
value_type: string
24+
description: |
25+
Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
26+
details_url: '#platform'
27+
deprecated: false
28+
hidden: false
29+
min_api_version: "1.48"
30+
experimental: false
31+
experimentalcli: false
32+
kubernetes: false
33+
swarm: false
2234
- option: quiet
2335
shorthand: q
2436
value_type: bool
@@ -76,6 +88,35 @@ examples: |-
7688
fedora heisenbug 58394af37342 7 weeks ago 385.5 MB
7789
fedora latest 58394af37342 7 weeks ago 385.5 MB
7890
```
91+
92+
93+
### Load a specific platform (--platform) {#platform}
94+
95+
The `--platform` option allows you to specify which platform variant of the
96+
image to load. By default, `docker load` loads all platform variants that
97+
are present in the archive. Use the `--platform` option to specify which
98+
platform variant of the image to load. An error is produced if the given
99+
platform is not present in the archive.
100+
101+
The platform option takes the `os[/arch[/variant]]` format; for example,
102+
`linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
103+
and default to the daemon's native architecture if omitted.
104+
105+
The following example loads the `linux/amd64` variant of an `alpine` image
106+
from an archive that contains multiple platform variants.
107+
108+
```console
109+
$ docker image load -i image.tar --platform=linux/amd64
110+
Loaded image: alpine:latest
111+
```
112+
113+
The following example attempts to load a `linux/ppc64le` image from an
114+
archive, but the given platform is not present in the archive;
115+
116+
```console
117+
$ docker image load -i image.tar --platform=linux/ppc64le
118+
requested platform (linux/ppc64le) not found: image might be filtered out
119+
```
79120
deprecated: false
80121
hidden: false
81122
experimental: false

‎data/engine-cli/docker_image_save.yaml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ options:
1919
experimentalcli: false
2020
kubernetes: false
2121
swarm: false
22+
- option: platform
23+
value_type: string
24+
description: |
25+
Save only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
26+
details_url: '#platform'
27+
deprecated: false
28+
hidden: false
29+
min_api_version: "1.48"
30+
experimental: false
31+
experimentalcli: false
32+
kubernetes: false
33+
swarm: false
2234
inherited_options:
2335
- option: help
2436
value_type: bool
@@ -66,6 +78,55 @@ examples: |-
6678
```console
6779
$ docker save -o ubuntu.tar ubuntu:lucid ubuntu:saucy
6880
```
81+
82+
### Save a specific platform (--platform) {#platform}
83+
84+
The `--platform` option allows you to specify which platform variant of the
85+
image to save. By default, `docker save` saves all platform variants that
86+
are present in the daemon's image store. Use the `--platform` option
87+
to specify which platform variant of the image to save. An error is produced
88+
if the given platform is not present in the local image store.
89+
90+
The platform option takes the `os[/arch[/variant]]` format; for example,
91+
`linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
92+
and default to the daemon's native architecture if omitted.
93+
94+
The following example pulls the RISC-V variant of the `alpine:latest` image
95+
and saves it to a tar archive.
96+
97+
```console
98+
$ docker pull --platform=linux/riscv64 alpine:latest
99+
latest: Pulling from library/alpine
100+
8c4a05189a5f: Download complete
101+
Digest: sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d
102+
Status: Downloaded newer image for alpine:latest
103+
docker.io/library/alpine:latest
104+
105+
$ docker image save --platform=linux/riscv64 -o alpine-riscv.tar alpine:latest
106+
107+
$ ls -lh image.tar
108+
-rw------- 1 thajeztah staff 3.9M Oct 7 11:06 alpine-riscv.tar
109+
```
110+
111+
The following example attempts to save a platform variant of `alpine:latest`
112+
that doesn't exist in the local image store, resulting in an error.
113+
114+
```console
115+
$ docker image ls --tree
116+
IMAGE ID DISK USAGE CONTENT SIZE IN USE
117+
alpine:latest beefdbd8a1da 10.6MB 3.37MB
118+
├─ linux/riscv64 80cde017a105 10.6MB 3.37MB
119+
├─ linux/amd64 33735bd63cf8 0B 0B
120+
├─ linux/arm/v6 50f635c8b04d 0B 0B
121+
├─ linux/arm/v7 f2f82d424957 0B 0B
122+
├─ linux/arm64/v8 9cee2b382fe2 0B 0B
123+
├─ linux/386 b3e87f642f5c 0B 0B
124+
├─ linux/ppc64le c7a6800e3dc5 0B 0B
125+
└─ linux/s390x 2b5b26e09ca2 0B 0B
126+
127+
$ docker image save --platform=linux/s390x -o alpine-s390x.tar alpine:latest
128+
Error response from daemon: no suitable export target found for platform linux/s390x
129+
```
69130
deprecated: false
70131
hidden: false
71132
experimental: false

0 commit comments

Comments
 (0)