Browse code

Merge pull request #32390 from thaJeztah/fixup-docs-cherry-pick

[17.03.x] cli reference fixes

Sebastiaan van Stijn authored on 2017/04/06 08:37:45
Showing 10 changed files
... ...
@@ -44,71 +44,6 @@ f98f9c2aa1eaf727e4ec9c0283bc7d4aa4762fbdba7f26191f26c97f64090360
44 44
 Total reclaimed space: 212 B
45 45
 ```
46 46
 
47
-### Filtering
48
-
49
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
50
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
51
-
52
-The currently supported filters are:
53
-
54
-* until (`<timestamp>`) - only remove containers created before given timestamp
55
-
56
-The `until` filter can be Unix timestamps, date formatted
57
-timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
58
-relative to the daemon machine’s time. Supported formats for date
59
-formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
60
-`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
61
-timezone on the daemon will be used if you do not provide either a `Z` or a
62
-`+-00:00` timezone offset at the end of the timestamp.  When providing Unix
63
-timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
64
-that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
65
-seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
66
-fraction of a second no more than nine digits long.
67
-
68
-The following removes containers created more than 5 minutes ago:
69
-
70
-```bash
71
-$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
72
-
73
-CONTAINER ID        IMAGE               COMMAND             CREATED AT                      STATUS
74
-61b9efa71024        busybox             "sh"                2017-01-04 13:23:33 -0800 PST   Exited (0) 41 seconds ago
75
-53a9bc23a516        busybox             "sh"                2017-01-04 13:11:59 -0800 PST   Exited (0) 12 minutes ago
76
-
77
-$ docker container prune --force --filter "until=5m"
78
-
79
-Deleted Containers:
80
-53a9bc23a5168b6caa2bfbefddf1b30f93c7ad57f3dec271fd32707497cb9369
81
-
82
-Total reclaimed space: 25 B
83
-
84
-$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
85
-
86
-CONTAINER ID        IMAGE               COMMAND             CREATED AT                      STATUS
87
-61b9efa71024        busybox             "sh"                2017-01-04 13:23:33 -0800 PST   Exited (0) 44 seconds ago
88
-```
89
-
90
-The following removes containers created before `2017-01-04T13:10:00`:
91
-
92
-```bash
93
-$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
94
-
95
-CONTAINER ID        IMAGE               COMMAND             CREATED AT                      STATUS
96
-53a9bc23a516        busybox             "sh"                2017-01-04 13:11:59 -0800 PST   Exited (0) 7 minutes ago
97
-4a75091a6d61        busybox             "sh"                2017-01-04 13:09:53 -0800 PST   Exited (0) 9 minutes ago
98
-
99
-$ docker container prune --force --filter "until=2017-01-04T13:10:00"
100
-
101
-Deleted Containers:
102
-4a75091a6d618526fcd8b33ccd6e5928ca2a64415466f768a6180004b0c72c6c
103
-
104
-Total reclaimed space: 27 B
105
-
106
-$ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}'
107
-
108
-CONTAINER ID        IMAGE               COMMAND             CREATED AT                      STATUS
109
-53a9bc23a516        busybox             "sh"                2017-01-04 13:11:59 -0800 PST   Exited (0) 9 minutes ago
110
-```
111
-
112 47
 ## Related commands
113 48
 
114 49
 * [system df](system_df.md)
... ...
@@ -67,94 +67,6 @@ deleted: sha256:2c675ee9ed53425e31a13e3390bf3f539bf8637000e4bcfbb85ee03ef4d910a1
67 67
 Total reclaimed space: 16.43 MB
68 68
 ```
69 69
 
70
-### Filtering
71
-
72
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
73
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
74
-
75
-The currently supported filters are:
76
-
77
-* until (`<timestamp>`) - only remove images created before given timestamp
78
-
79
-The `until` filter can be Unix timestamps, date formatted
80
-timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
81
-relative to the daemon machine’s time. Supported formats for date
82
-formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
83
-`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
84
-timezone on the daemon will be used if you do not provide either a `Z` or a
85
-`+-00:00` timezone offset at the end of the timestamp.  When providing Unix
86
-timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
87
-that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
88
-seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
89
-fraction of a second no more than nine digits long.
90
-
91
-The following removes images created before `2017-01-04T00:00:00`:
92
-
93
-```bash
94
-$ docker images --format 'table {{.Repository}}\t{{.Tag}}\t{{.ID}}\t{{.CreatedAt}}\t{{.Size}}'
95
-REPOSITORY          TAG                 IMAGE ID            CREATED AT                      SIZE
96
-foo                 latest              2f287ac753da        2017-01-04 13:42:23 -0800 PST   3.98 MB
97
-alpine              latest              88e169ea8f46        2016-12-27 10:17:25 -0800 PST   3.98 MB
98
-busybox             latest              e02e811dd08f        2016-10-07 14:03:58 -0700 PDT   1.09 MB
99
-
100
-$ docker image prune -a --force --filter "until=2017-01-04T00:00:00"
101
-
102
-Deleted Images:
103
-untagged: alpine:latest
104
-untagged: alpine@sha256:dfbd4a3a8ebca874ebd2474f044a0b33600d4523d03b0df76e5c5986cb02d7e8
105
-untagged: busybox:latest
106
-untagged: busybox@sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912
107
-deleted: sha256:e02e811dd08fd49e7f6032625495118e63f597eb150403d02e3238af1df240ba
108
-deleted: sha256:e88b3f82283bc59d5e0df427c824e9f95557e661fcb0ea15fb0fb6f97760f9d9
109
-
110
-Total reclaimed space: 1.093 MB
111
-
112
-$ docker images --format 'table {{.Repository}}\t{{.Tag}}\t{{.ID}}\t{{.CreatedAt}}\t{{.Size}}'
113
-
114
-REPOSITORY          TAG                 IMAGE ID            CREATED AT                      SIZE
115
-foo                 latest              2f287ac753da        2017-01-04 13:42:23 -0800 PST   3.98 MB
116
-```
117
-
118
-The following removes images created more than 10 days (`240h`) ago:
119
-
120
-```bash
121
-$ docker images
122
-
123
-REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
124
-foo                 latest              2f287ac753da        14 seconds ago      3.98 MB
125
-alpine              latest              88e169ea8f46        8 days ago          3.98 MB
126
-debian              jessie              7b0a06c805e8        2 months ago        123 MB
127
-busybox             latest              e02e811dd08f        2 months ago        1.09 MB
128
-golang              1.7.0               138c2e655421        4 months ago        670 MB
129
-
130
-$ docker image prune -a --force --filter "until=240h"
131
-
132
-Deleted Images:
133
-untagged: golang:1.7.0
134
-untagged: golang@sha256:6765038c2b8f407fd6e3ecea043b44580c229ccfa2a13f6d85866cf2b4a9628e
135
-deleted: sha256:138c2e6554219de65614d88c15521bfb2da674cbb0bf840de161f89ff4264b96
136
-deleted: sha256:ec353c2e1a673f456c4b78906d0d77f9d9456cfb5229b78c6a960bfb7496b76a
137
-deleted: sha256:fe22765feaf3907526b4921c73ea6643ff9e334497c9b7e177972cf22f68ee93
138
-deleted: sha256:ff845959c80148421a5c3ae11cc0e6c115f950c89bc949646be55ed18d6a2912
139
-deleted: sha256:a4320831346648c03db64149eafc83092e2b34ab50ca6e8c13112388f25899a7
140
-deleted: sha256:4c76020202ee1d9709e703b7c6de367b325139e74eebd6b55b30a63c196abaf3
141
-deleted: sha256:d7afd92fb07236c8a2045715a86b7d5f0066cef025018cd3ca9a45498c51d1d6
142
-deleted: sha256:9e63c5bce4585dd7038d830a1f1f4e44cb1a1515b00e620ac718e934b484c938
143
-untagged: debian:jessie
144
-untagged: debian@sha256:c1af755d300d0c65bb1194d24bce561d70c98a54fb5ce5b1693beb4f7988272f
145
-deleted: sha256:7b0a06c805e8f23807fb8856621c60851727e85c7bcb751012c813f122734c8d
146
-deleted: sha256:f96222d75c5563900bc4dd852179b720a0885de8f7a0619ba0ac76e92542bbc8
147
-
148
-Total reclaimed space: 792.6 MB
149
-
150
-$ docker images
151
-
152
-REPOSITORY          TAG                 IMAGE ID            CREATED              SIZE
153
-foo                 latest              2f287ac753da        About a minute ago   3.98 MB
154
-alpine              latest              88e169ea8f46        8 days ago           3.98 MB
155
-busybox             latest              e02e811dd08f        2 months ago         1.09 MB
156
-```
157
-
158 70
 ## Related commands
159 71
 
160 72
 * [system df](system_df.md)
... ...
@@ -33,54 +33,6 @@ n1
33 33
 n2
34 34
 ```
35 35
 
36
-### Filtering
37
-
38
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
39
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
40
-
41
-The currently supported filters are:
42
-
43
-* until (`<timestamp>`) - only remove networks created before given timestamp
44
-
45
-The `until` filter can be Unix timestamps, date formatted
46
-timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
47
-relative to the daemon machine’s time. Supported formats for date
48
-formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
49
-`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
50
-timezone on the daemon will be used if you do not provide either a `Z` or a
51
-`+-00:00` timezone offset at the end of the timestamp.  When providing Unix
52
-timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
53
-that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
54
-seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
55
-fraction of a second no more than nine digits long.
56
-
57
-The following removes networks created more than 5 minutes ago. Note that
58
-system networks such as `bridge`, `host`, and `none` will never be pruned:
59
-
60
-```none
61
-$ docker network ls
62
-
63
-NETWORK ID          NAME                DRIVER              SCOPE
64
-7430df902d7a        bridge              bridge              local
65
-ea92373fd499        foo-1-day-ago       bridge              local
66
-ab53663ed3c7        foo-1-min-ago       bridge              local
67
-97b91972bc3b        host                host                local
68
-f949d337b1f5        none                null                local
69
-
70
-$ docker network prune --force --filter until=5m
71
-
72
-Deleted Networks:
73
-foo-1-day-ago
74
-
75
-$ docker network ls
76
-
77
-NETWORK ID          NAME                DRIVER              SCOPE
78
-7430df902d7a        bridge              bridge              local
79
-ab53663ed3c7        foo-1-min-ago       bridge              local
80
-97b91972bc3b        host                host                local
81
-f949d337b1f5        none                null                local
82
-```
83
-
84 36
 ## Related commands
85 37
 
86 38
 * [network disconnect ](network_disconnect.md)
... ...
@@ -42,66 +42,6 @@ ID                  NAME                             TAG                 DESCRIP
42 42
 69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true
43 43
 ```
44 44
 
45
-### Filtering
46
-
47
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
48
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
49
-
50
-The currently supported filters are:
51
-
52
-* enabled (boolean - true or false, 0 or 1)
53
-* capability (string - currently `volumedriver`, `networkdriver`, `ipamdriver`, or `authz`)
54
-
55
-#### enabled
56
-
57
-The `enabled` filter matches on plugins enabled or disabled.
58
-
59
-#### capability
60
-
61
-The `capability` filter matches on plugin capabilities. One plugin
62
-might have multiple capabilities. Currently `volumedriver`, `networkdriver`,
63
-`ipamdriver`, and `authz` are supported capabilities.
64
-
65
-```bash
66
-$ docker plugin install --disable tiborvass/no-remove
67
-
68
-tiborvass/no-remove
69
-
70
-$ docker plugin ls --filter enabled=true
71
-
72
-NAME                  TAG                 DESCRIPTION                ENABLED
73
-```
74
-
75
-
76
-### Formatting
77
-
78
-The formatting options (`--format`) pretty-prints plugins output
79
-using a Go template.
80
-
81
-Valid placeholders for the Go template are listed below:
82
-
83
-Placeholder    | Description
84
-`.ID`              | Plugin ID
85
-`.Name`            | Plugin name
86
-`.Description`     | Plugin description
87
-`.Enabled`         | Whether plugin is enabled or not
88
-`.PluginReference` | The reference used to push/pull from a registry
89
-
90
-When using the `--format` option, the `plugin ls` command will either
91
-output the data exactly as the template declares or, when using the
92
-`table` directive, includes column headers as well.
93
-
94
-The following example uses a template without headers and outputs the
95
-`ID` and `Name` entries separated by a colon for all plugins:
96
-
97
-```bash
98
-$ docker plugin ls --format "{{.ID}}: {{.Name}}"
99
-
100
-4be01827a72e: tiborvass/no-remove
101
-```
102
-
103
-
104 45
 ## Related commands
105 46
 
106 47
 * [plugin create](plugin_create.md)
... ...
@@ -338,44 +338,6 @@ CONTAINER ID        IMAGE       COMMAND       CREATED             STATUS
338 338
 9d4893ed80fe        ubuntu      "top"         10 minutes ago      Up 10 minutes                           test1
339 339
 ```
340 340
 
341
-#### publish and expose
342
-
343
-The `publish` and `expose` filters show only containers that have published or exposed port with a given port
344
-number, port range, and/or protocol. The default protocol is `tcp` when not specified.
345
-
346
-The following filter matches all containers that have published port of 80:
347
-
348
-```bash
349
-$ docker run -d --publish=80 busybox top
350
-$ docker run -d --expose=8080 busybox top
351
-
352
-$ docker ps -a
353
-
354
-CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS                   NAMES
355
-9833437217a5        busybox             "top"               5 seconds ago       Up 4 seconds        8080/tcp                dreamy_mccarthy
356
-fc7e477723b7        busybox             "top"               50 seconds ago      Up 50 seconds       0.0.0.0:32768->80/tcp   admiring_roentgen
357
-
358
-$ docker ps --filter publish=80
359
-
360
-CONTAINER ID        IMAGE               COMMAND             CREATED              STATUS              PORTS                   NAMES
361
-fc7e477723b7        busybox             "top"               About a minute ago   Up About a minute   0.0.0.0:32768->80/tcp   admiring_roentgen
362
-```
363
-
364
-The following filter matches all containers that have exposed TCP port in the range of `8000-8080`:
365
-```bash
366
-$ docker ps --filter expose=8000-8080/tcp
367
-
368
-CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES
369
-9833437217a5        busybox             "top"               21 seconds ago      Up 19 seconds       8080/tcp            dreamy_mccarthy
370
-```
371
-
372
-The following filter matches all containers that have exposed UDP port `80`:
373
-```bash
374
-$ docker ps --filter publish=80/udp
375
-
376
-CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES
377
-```
378
-
379 341
 ### Formatting
380 342
 
381 343
 The formatting option (`--format`) pretty-prints container output using a Go
... ...
@@ -144,7 +144,7 @@ Options:
144 144
   -w, --workdir string              Working directory inside the container
145 145
 ```
146 146
 
147
-## Descriptino
147
+## Description
148 148
 
149 149
 The `docker run` command first `creates` a writeable container layer over the
150 150
 specified image, and then `starts` it using the specified command. That is,
... ...
@@ -109,40 +109,7 @@ ID            NAME   MODE        REPLICAS  IMAGE
109 109
 0bcjwfh8ychr  redis  replicated  1/1       redis:3.0.6
110 110
 ```
111 111
 
112
-<<<<<<< HEAD
113
-## Related information
114
-=======
115
-### Formatting
116
-
117
-The formatting options (`--format`) pretty-prints services output
118
-using a Go template.
119
-
120
-Valid placeholders for the Go template are listed below:
121
-
122
-Placeholder | Description
123
-`.ID`       | Service ID
124
-`.Name`     | Service name
125
-`.Mode`     | Service mode (replicated, global)
126
-`.Replicas` | Service replicas
127
-`.Image`    | Service image
128
-
129
-When using the `--format` option, the `service ls` command will either
130
-output the data exactly as the template declares or, when using the
131
-`table` directive, includes column headers as well.
132
-
133
-The following example uses a template without headers and outputs the
134
-`ID`, `Mode`, and `Replicas` entries separated by a colon for all services:
135
-
136
-```bash
137
-$ docker service ls --format "{{.ID}}: {{.Mode}} {{.Replicas}}"
138
-
139
-0zmvwuiu3vue: replicated 10/10
140
-fm6uf97exkul: global 5/5
141
-```
142
-
143 112
 ## Related commands
144
->>>>>>> 40dbbd3... Merge pull request #30804 from mstanleyjones/cli_fixups
145 113
 
146 114
 * [service create](service_create.md)
147 115
 * [service inspect](service_inspect.md)
... ...
@@ -66,36 +66,6 @@ The currently supported filters are:
66 66
 * name (`--filter name=myapp_web`)
67 67
 * label (`--filter label=key=value`)
68 68
 
69
-### Formatting
70
-
71
-The formatting options (`--format`) pretty-prints services output
72
-using a Go template.
73
-
74
-Valid placeholders for the Go template are listed below:
75
-
76
-Placeholder | Description
77
-`.ID`       | Service ID
78
-`.Name`     | Service name
79
-`.Mode`     | Service mode (replicated, global)
80
-`.Replicas` | Service replicas
81
-`.Image`    | Service image
82
-
83
-When using the `--format` option, the `stack services` command will either
84
-output the data exactly as the template declares or, when using the
85
-`table` directive, includes column headers as well.
86
-
87
-The following example uses a template without headers and outputs the
88
-`ID`, `Mode`, and `Replicas` entries separated by a colon for all services:
89
-
90
-```bash
91
-$ docker stack services --format "{{.ID}}: {{.Mode}} {{.Replicas}}"
92
-
93
-0zmvwuiu3vue: replicated 10/10
94
-fm6uf97exkul: global 5/5
95
-```
96
-
97
-
98 69
 ## Related commands
99 70
 
100 71
 * [stack deploy](stack_deploy.md)
... ...
@@ -136,16 +136,6 @@ Snapshots compact the Raft log and allow for more efficient transfer of the
136 136
 state to new managers. However, there is a performance cost to taking snapshots
137 137
 frequently.
138 138
 
139
-### `--availability`
140
-
141
-This flag specifies the availability of the node at the time the node joins a master.
142
-Possible availability values are `active`, `pause`, or `drain`.
143
-
144
-This flag is useful in certain situations. For example, a cluster may want to have
145
-dedicated manager nodes that are not served as worker nodes. This could be achieved
146
-by passing `--availability=drain` to `docker swarm init`.
147
-
148
-
149 139
 ## Related commands
150 140
 
151 141
 * [swarm join](swarm_join.md)
... ...
@@ -67,27 +67,6 @@ deleted: sha256:3a88a5c81eb5c283e72db2dbc6d65cbfd8e80b6c89bb6e714cfaaa0eed99c548
67 67
 Total reclaimed space: 13.5 MB
68 68
 ```
69 69
 
70
-### Filtering
71
-
72
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
73
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
74
-
75
-The currently supported filters are:
76
-
77
-* until (`<timestamp>`) - only remove containers, images, and networks created before given timestamp
78
-
79
-The `until` filter can be Unix timestamps, date formatted
80
-timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
81
-relative to the daemon machine’s time. Supported formats for date
82
-formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
83
-`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
84
-timezone on the daemon will be used if you do not provide either a `Z` or a
85
-`+-00:00` timezone offset at the end of the timestamp.  When providing Unix
86
-timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
87
-that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
88
-seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
89
-fraction of a second no more than nine digits long.
90
-
91 70
 ## Related commands
92 71
 
93 72
 * [volume create](volume_create.md)