Skip to content

Commit d5b3272

Browse files
authored
Merge pull request #5612 from thaJeztah/27.x_backport_docs
[27.x backport] assorted docs updates
2 parents 2958a27 + 2734299 commit d5b3272

File tree

14 files changed

+80
-80
lines changed

14 files changed

+80
-80
lines changed

docs/reference/commandline/container_prune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The currently supported filters are:
4343
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove containers with (or without, in case `label!=...` is used) the specified labels.
4444

4545
The `until` filter can be Unix timestamps, date formatted
46-
timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
46+
timestamps, or Go duration strings supported by [ParseDuration](https://pkg.go.dev/time#ParseDuration) (e.g. `10m`, `1h30m`) computed
4747
relative to the daemon machine’s time. Supported formats for date
4848
formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
4949
`2006-01-02T15:04:05.999999999`, `2006-01-02T07:00`, and `2006-01-02`. The local

docs/reference/commandline/image_prune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The currently supported filters are:
6666
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove images with (or without, in case `label!=...` is used) the specified labels.
6767

6868
The `until` filter can be Unix timestamps, date formatted
69-
timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
69+
timestamps, or Go duration strings supported by [ParseDuration](https://pkg.go.dev/time#ParseDuration) (e.g. `10m`, `1h30m`) computed
7070
relative to the daemon machine’s time. Supported formats for date
7171
formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
7272
`2006-01-02T15:04:05.999999999`, `2006-01-02T07:00`, and `2006-01-02`. The local

docs/reference/commandline/network_prune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The currently supported filters are:
4141
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove networks with (or without, in case `label!=...` is used) the specified labels.
4242

4343
The `until` filter can be Unix timestamps, date formatted
44-
timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
44+
timestamps, or Go duration strings supported by [ParseDuration](https://pkg.go.dev/time#ParseDuration) (e.g. `10m`, `1h30m`) computed
4545
relative to the daemon machine’s time. Supported formats for date
4646
formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
4747
`2006-01-02T15:04:05.999999999`, `2006-01-02T07:00`, and `2006-01-02`. The local

docs/reference/commandline/node_ps.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ information about available filter options.
3434
$ docker node ps swarm-manager1
3535

3636
NAME IMAGE NODE DESIRED STATE CURRENT STATE
37-
redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:3.0.6 swarm-manager1 Running Running 5 hours
38-
redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 29 seconds
39-
redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds
40-
redis.9.dkkual96p4bb3s6b10r7coxxt redis:3.0.6 swarm-manager1 Running Running 5 seconds
41-
redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:3.0.6 swarm-manager1 Running Running 5 seconds
37+
redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:7.4.1 swarm-manager1 Running Running 5 hours
38+
redis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 29 seconds
39+
redis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 seconds
40+
redis.9.dkkual96p4bb3s6b10r7coxxt redis:7.4.1 swarm-manager1 Running Running 5 seconds
41+
redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:7.4.1 swarm-manager1 Running Running 5 seconds
4242
```
4343

4444
### <a name="filter"></a> Filtering (--filter)
@@ -64,11 +64,11 @@ The following filter matches all tasks with a name containing the `redis` string
6464
$ docker node ps -f name=redis swarm-manager1
6565

6666
NAME IMAGE NODE DESIRED STATE CURRENT STATE
67-
redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:3.0.6 swarm-manager1 Running Running 5 hours
68-
redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 29 seconds
69-
redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds
70-
redis.9.dkkual96p4bb3s6b10r7coxxt redis:3.0.6 swarm-manager1 Running Running 5 seconds
71-
redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:3.0.6 swarm-manager1 Running Running 5 seconds
67+
redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:7.4.1 swarm-manager1 Running Running 5 hours
68+
redis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 29 seconds
69+
redis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 seconds
70+
redis.9.dkkual96p4bb3s6b10r7coxxt redis:7.4.1 swarm-manager1 Running Running 5 seconds
71+
redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:7.4.1 swarm-manager1 Running Running 5 seconds
7272
```
7373

7474
#### id
@@ -79,7 +79,7 @@ The `id` filter matches a task's id.
7979
$ docker node ps -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1
8080

8181
NAME IMAGE NODE DESIRED STATE CURRENT STATE
82-
redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds
82+
redis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 seconds
8383
```
8484

8585
#### label
@@ -93,8 +93,8 @@ The following filter matches tasks with the `usage` label regardless of its valu
9393
$ docker node ps -f "label=usage"
9494

9595
NAME IMAGE NODE DESIRED STATE CURRENT STATE
96-
redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 10 minutes
97-
redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 9 minutes
96+
redis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 10 minutes
97+
redis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 9 minutes
9898
```
9999

100100

docs/reference/commandline/service_create.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,19 @@ Creates a service as described by the specified parameters.
9999
### Create a service
100100

101101
```console
102-
$ docker service create --name redis redis:3.0.6
102+
$ docker service create --name redis redis:7.4.1
103103

104104
dmu1ept4cxcfe8k8lhtux3ro3
105105

106-
$ docker service create --mode global --name redis2 redis:3.0.6
106+
$ docker service create --mode global --name redis2 redis:7.4.1
107107

108108
a8q9dasaafudfs8q8w32udass
109109

110110
$ docker service ls
111111

112112
ID NAME MODE REPLICAS IMAGE
113-
dmu1ept4cxcf redis replicated 1/1 redis:3.0.6
114-
a8q9dasaafud redis2 global 1/1 redis:3.0.6
113+
dmu1ept4cxcf redis replicated 1/1 redis:7.4.1
114+
a8q9dasaafud redis2 global 1/1 redis:7.4.1
115115
```
116116

117117
#### <a name="with-registry-auth"></a> Create a service using an image on a private registry (--with-registry-auth)
@@ -140,7 +140,7 @@ Use the `--replicas` flag to set the number of replica tasks for a replicated
140140
service. The following command creates a `redis` service with `5` replica tasks:
141141

142142
```console
143-
$ docker service create --name redis --replicas=5 redis:3.0.6
143+
$ docker service create --name redis --replicas=5 redis:7.4.1
144144

145145
4cdgfyky7ozwh3htjfw0d12qv
146146
```
@@ -157,7 +157,7 @@ number of `RUNNING` tasks is `3`:
157157
$ docker service ls
158158

159159
ID NAME MODE REPLICAS IMAGE
160-
4cdgfyky7ozw redis replicated 3/5 redis:3.0.7
160+
4cdgfyky7ozw redis replicated 3/5 redis:7.4.1
161161
```
162162

163163
Once all the tasks are created and `RUNNING`, the actual number of tasks is
@@ -167,7 +167,7 @@ equal to the desired number:
167167
$ docker service ls
168168

169169
ID NAME MODE REPLICAS IMAGE
170-
4cdgfyky7ozw redis replicated 5/5 redis:3.0.7
170+
4cdgfyky7ozw redis replicated 5/5 redis:7.4.1
171171
```
172172

173173
### <a name="secret"></a> Create a service with secrets (--secret)
@@ -178,7 +178,7 @@ Use the `--secret` flag to give a container access to a
178178
Create a service specifying a secret:
179179

180180
```console
181-
$ docker service create --name redis --secret secret.json redis:3.0.6
181+
$ docker service create --name redis --secret secret.json redis:7.4.1
182182

183183
4cdgfyky7ozwh3htjfw0d12qv
184184
```
@@ -189,7 +189,7 @@ Create a service specifying the secret, target, user/group ID, and mode:
189189
$ docker service create --name redis \
190190
--secret source=ssh-key,target=ssh \
191191
--secret source=app-key,target=app,uid=1000,gid=1001,mode=0400 \
192-
redis:3.0.6
192+
redis:7.4.1
193193

194194
4cdgfyky7ozwh3htjfw0d12qv
195195
```
@@ -215,14 +215,14 @@ pre-exist in the container. The `mode` is specified as a 4-number sequence such
215215
as `0755`.
216216

217217
```console
218-
$ docker service create --name=redis --config redis-conf redis:3.0.6
218+
$ docker service create --name=redis --config redis-conf redis:7.4.1
219219
```
220220

221221
Create a service with a config and specify the target location and file mode:
222222

223223
```console
224224
$ docker service create --name redis \
225-
--config source=redis-conf,target=/etc/redis/redis.conf,mode=0400 redis:3.0.6
225+
--config source=redis-conf,target=/etc/redis/redis.conf,mode=0400 redis:7.4.1
226226
```
227227

228228
To grant a service access to multiple configs, use multiple `--config` flags.
@@ -239,7 +239,7 @@ $ docker service create \
239239
--name redis \
240240
--update-delay 10s \
241241
--update-parallelism 2 \
242-
redis:3.0.6
242+
redis:7.4.1
243243
```
244244

245245
When you run a [service update](service_update.md), the scheduler updates a
@@ -256,7 +256,7 @@ $ docker service create \
256256
--name redis_2 \
257257
--replicas 5 \
258258
--env MYVAR=foo \
259-
redis:3.0.6
259+
redis:7.4.1
260260
```
261261

262262
To specify multiple environment variables, specify multiple `--env` flags, each
@@ -268,7 +268,7 @@ $ docker service create \
268268
--replicas 5 \
269269
--env MYVAR=foo \
270270
--env MYVAR2=bar \
271-
redis:3.0.6
271+
redis:7.4.1
272272
```
273273

274274
### <a name="hostname"></a> Create a service with specific hostname (--hostname)
@@ -277,7 +277,7 @@ This option sets the docker service containers hostname to a specific string.
277277
For example:
278278

279279
```console
280-
$ docker service create --name redis --hostname myredis redis:3.0.6
280+
$ docker service create --name redis --hostname myredis redis:7.4.1
281281
```
282282

283283
### <a name="label"></a> Set metadata on a service (-l, --label)
@@ -290,7 +290,7 @@ $ docker service create \
290290
--name redis_2 \
291291
--label com.example.foo="bar" \
292292
--label bar=baz \
293-
redis:3.0.6
293+
redis:7.4.1
294294
```
295295

296296
For more information about labels, refer to [apply custom
@@ -679,7 +679,7 @@ The following command creates a global service:
679679
$ docker service create \
680680
--name redis_2 \
681681
--mode global \
682-
redis:3.0.6
682+
redis:7.4.1
683683
```
684684

685685
### <a name="constraint"></a> Specify service constraints (--constraint)
@@ -712,7 +712,7 @@ $ docker service create \
712712
--name redis_2 \
713713
--constraint node.platform.os==linux \
714714
--constraint node.labels.type==queue \
715-
redis:3.0.6
715+
redis:7.4.1
716716
```
717717

718718
If the service constraints exclude all nodes in the cluster, a message is printed
@@ -760,7 +760,7 @@ $ docker service create \
760760
--replicas 9 \
761761
--name redis_2 \
762762
--placement-pref spread=node.labels.datacenter \
763-
redis:3.0.6
763+
redis:7.4.1
764764
```
765765

766766
This uses `--placement-pref` with a `spread` strategy (currently the only
@@ -812,7 +812,7 @@ $ docker service create \
812812
--name redis_2 \
813813
--placement-pref 'spread=node.labels.datacenter' \
814814
--placement-pref 'spread=node.labels.rack' \
815-
redis:3.0.6
815+
redis:7.4.1
816816
```
817817

818818
When updating a service with `docker service update`, `--placement-pref-add`

docs/reference/commandline/service_inspect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For example, given the following service;
4040
```console
4141
$ docker service ls
4242
ID NAME MODE REPLICAS IMAGE
43-
dmu1ept4cxcf redis replicated 3/3 redis:3.0.6
43+
dmu1ept4cxcf redis replicated 3/3 redis:7.4.1
4444
```
4545

4646
Both `docker service inspect redis`, and `docker service inspect dmu1ept4cxcf`
@@ -65,7 +65,7 @@ The output is in JSON format, for example:
6565
"Name": "redis",
6666
"TaskTemplate": {
6767
"ContainerSpec": {
68-
"Image": "redis:3.0.6"
68+
"Image": "redis:7.4.1"
6969
},
7070
"Resources": {
7171
"Limits": {},

docs/reference/commandline/service_ls.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ $ docker service ls
3737

3838
ID NAME MODE REPLICAS IMAGE
3939
c8wgl7q4ndfd frontend replicated 5/5 nginx:alpine
40-
dmu1ept4cxcf redis replicated 3/3 redis:3.0.6
40+
dmu1ept4cxcf redis replicated 3/3 redis:7.4.1
4141
iwe3278osahj mongo global 7/7 mongo:3.3
4242
hh08h9uu8uwr job replicated-job 1/1 (3/5 completed) nginx:latest
4343
```
@@ -68,7 +68,7 @@ The following filter matches services with an ID starting with `0bcjw`:
6868
```console
6969
$ docker service ls -f "id=0bcjw"
7070
ID NAME MODE REPLICAS IMAGE
71-
0bcjwfh8ychr redis replicated 1/1 redis:3.0.6
71+
0bcjwfh8ychr redis replicated 1/1 redis:7.4.1
7272
```
7373

7474
#### label
@@ -84,7 +84,7 @@ $ docker service ls --filter label=project
8484
ID NAME MODE REPLICAS IMAGE
8585
01sl1rp6nj5u frontend2 replicated 1/1 nginx:alpine
8686
36xvvwwauej0 frontend replicated 5/5 nginx:alpine
87-
74nzcxxjv6fq backend replicated 3/3 redis:3.0.6
87+
74nzcxxjv6fq backend replicated 3/3 redis:7.4.1
8888
```
8989

9090
The following filter matches only services with the `project` label with the
@@ -94,7 +94,7 @@ The following filter matches only services with the `project` label with the
9494
$ docker service ls --filter label=project=project-a
9595
ID NAME MODE REPLICAS IMAGE
9696
36xvvwwauej0 frontend replicated 5/5 nginx:alpine
97-
74nzcxxjv6fq backend replicated 3/3 redis:3.0.6
97+
74nzcxxjv6fq backend replicated 3/3 redis:7.4.1
9898
```
9999

100100
#### mode
@@ -118,7 +118,7 @@ The following filter matches services with a name starting with `redis`.
118118
```console
119119
$ docker service ls --filter name=redis
120120
ID NAME MODE REPLICAS IMAGE
121-
0bcjwfh8ychr redis replicated 1/1 redis:3.0.6
121+
0bcjwfh8ychr redis replicated 1/1 redis:7.4.1
122122
```
123123

124124
### <a name="format"></a> Format the output (--format)

0 commit comments

Comments
 (0)