Skip to content

Commit 27081f3

Browse files
gbarr01gbarr01
gbarr01
authored and
gbarr01
committed
Update CLI reference files
1 parent 907db13 commit 27081f3

8 files changed

+57
-57
lines changed

‎_data/engine-cli-edge/docker_build.yaml

+31-26
Original file line numberDiff line numberDiff line change
@@ -477,21 +477,27 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
477477
build an image on.\n\nA good example is `http_proxy` or source versions for pulling
478478
intermediate\nfiles. The `ARG` instruction lets Dockerfile authors define values
479479
that users\ncan set at build-time using the `--build-arg` flag:\n\n```bash\n$ docker
480-
build --build-arg HTTP_PROXY=http://10.20.30.2:1234 .\n```\n\nThis flag allows you
481-
to pass the build-time variables that are\naccessed like regular environment variables
482-
in the `RUN` instruction of the\nDockerfile. Also, these values don't persist in
483-
the intermediate or final images\nlike `ENV` values do.\n\nUsing this flag will
484-
not alter the output you see when the `ARG` lines from the\nDockerfile are echoed
485-
during the build process.\n\nFor detailed information on using `ARG` and `ENV` instructions,
486-
see the\n[Dockerfile reference](../builder.md).\n\n### Optional security options
487-
(--security-opt)\n\nThis flag is only supported on a daemon running on Windows,
488-
and only supports\nthe `credentialspec` option. The `credentialspec` must be in
489-
the format\n`file://spec.txt` or `registry://keyname`.\n\n### Specify isolation
490-
technology for container (--isolation)\n\nThis option is useful in situations where
491-
you are running Docker containers on\nWindows. The `--isolation=<value>` option
492-
sets a container's isolation\ntechnology. On Linux, the only supported is the `default`
493-
option which uses\nLinux namespaces. On Microsoft Windows, you can specify these
494-
values:\n\n\n| Value | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|
480+
build --build-arg HTTP_PROXY=http://10.20.30.2:1234 --build-arg FTP_PROXY=http://40.50.60.5:4567
481+
.\n```\n\nThis flag allows you to pass the build-time variables that are\naccessed
482+
like regular environment variables in the `RUN` instruction of the\nDockerfile.
483+
Also, these values don't persist in the intermediate or final images\nlike `ENV`
484+
values do. You must add `--build-arg` for each build argument. \n\nUsing this
485+
flag will not alter the output you see when the `ARG` lines from the\nDockerfile
486+
are echoed during the build process.\n\nFor detailed information on using `ARG`
487+
and `ENV` instructions, see the\n[Dockerfile reference](../builder.md).\n\nYou may
488+
also use the `--build-arg` flag without a value, in which case the value\nfrom the
489+
local environment will be propagated into the Docker container being\nbuilt:\n\n```bash\n$
490+
export HTTP_PROXY=http://10.20.30.2:1234\n$ docker build --build-arg HTTP_PROXY
491+
.\n```\n\nThis is similar to how `docker run -e` works. Refer to the [`docker run`
492+
documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)\nfor
493+
more information.\n\n### Optional security options (--security-opt)\n\nThis flag
494+
is only supported on a daemon running on Windows, and only supports\nthe `credentialspec`
495+
option. The `credentialspec` must be in the format\n`file://spec.txt` or `registry://keyname`.\n\n###
496+
Specify isolation technology for container (--isolation)\n\nThis option is useful
497+
in situations where you are running Docker containers on\nWindows. The `--isolation=<value>`
498+
option sets a container's isolation\ntechnology. On Linux, the only supported is
499+
the `default` option which uses\nLinux namespaces. On Microsoft Windows, you can
500+
specify these values:\n\n\n| Value | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|
495501
`default` | Use the value specified by the Docker daemon's `--exec-opt` . If the
496502
`daemon` does not specify an isolation technology, Microsoft Windows uses `process`
497503
as its default value. |\n| `process` | Namespace isolation only. |\n|
@@ -522,16 +528,15 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
522528
multi-stage builds](https://docs.docker.com/engine/userguide/eng-image/multistage-build/)\nsection
523529
in the userguide for more information.\n\n\n#### Known limitations\n\nThe `--squash`
524530
option has a number of known limitations:\n\n- When squashing layers, the resulting
525-
image cannot take advantage of layer \n sharing with other images, and may use
526-
significantly more space. Sharing the\n base image is still supported.\n- When
527-
using this option you may see significantly more space used due to\n storing two
528-
copies of the image, one for the build cache with all the cache\n layers in tact,
529-
and one for the squashed version.\n- While squashing layers may produce smaller
530-
images, it may have a negative\n impact on performance, as a single layer takes
531-
longer to extract, and\n downloading a single layer cannot be parallelized.\n-
532-
When attempting to squash an image that does not make changes to the\n filesystem
533-
(for example, the Dockerfile only contains `ENV` instructions),\n the squash step
534-
will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n####
531+
image cannot take advantage of layer\n sharing with other images, and may use significantly
532+
more space. Sharing the\n base image is still supported.\n- When using this option
533+
you may see significantly more space used due to\n storing two copies of the image,
534+
one for the build cache with all the cache\n layers in tact, and one for the squashed
535+
version.\n- While squashing layers may produce smaller images, it may have a negative\n
536+
\ impact on performance, as a single layer takes longer to extract, and\n downloading
537+
a single layer cannot be parallelized.\n- When attempting to squash an image that
538+
does not make changes to the\n filesystem (for example, the Dockerfile only contains
539+
`ENV` instructions),\n the squash step will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n####
535540
Prerequisites\n\nThe example on this page is using experimental mode in Docker 1.13.\n\nExperimental
536541
mode can be enabled by using the `--experimental` flag when starting the Docker
537542
daemon or setting `experimental: true` in the `daemon.json` configuration file.\n\nBy
@@ -551,7 +556,7 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
551556
>> /hello\nRUN touch remove_me /remove_me\nENV HELLO world\nRUN rm /remove_me\n```\n\nAn
552557
image named `test` is built with `--squash` argument.\n\n```bash\n$ docker build
553558
--squash -t test .\n\n[...]\n```\n\nIf everything is right, the history will look
554-
like this:\n\n```bash\n$ docker history test \n\nIMAGE CREATED CREATED
559+
like this:\n\n```bash\n$ docker history test\n\nIMAGE CREATED CREATED
555560
BY SIZE COMMENT\n4e10cb5b4cac
556561
\ 3 seconds ago 12 B
557562
\ merge sha256:88a7b0112a41826885df0e7072698006ee8f621c6ab99fca7fe9151d7b599702

‎_data/engine-cli-edge/docker_history.yaml

+4-10
Original file line numberDiff line numberDiff line change
@@ -89,19 +89,13 @@ examples: |-
8989
`table` directive, will include column headers as well.
9090
9191
The following example uses a template without headers and outputs the
92-
`ID` and `CreatedSince` entries separated by a colon for all images:
92+
`ID` and `CreatedSince` entries separated by a colon for the `busybox` image:
9393
9494
```bash
95-
$ docker images --format "{{.ID}}: {{.Created}} ago"
95+
$ docker history --format "{{.ID}}: {{.CreatedAt}}" busybox
9696
97-
cc1b61406712: 2 weeks ago
98-
<missing>: 2 weeks ago
99-
<missing>: 2 weeks ago
100-
<missing>: 2 weeks ago
101-
<missing>: 2 weeks ago
102-
<missing>: 3 weeks ago
103-
<missing>: 3 weeks ago
104-
<missing>: 3 weeks ago
97+
f6e427c148a7: 4 weeks ago
98+
<missing>: 4 weeks ago
10599
```
106100
deprecated: false
107101
experimental: false

‎_data/engine-cli-edge/docker_load.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ options:
2828
swarm: false
2929
examples: |-
3030
```bash
31-
$ docker docker image ls
31+
$ docker image ls
3232
3333
REPOSITORY TAG IMAGE ID CREATED SIZE
3434

‎_data/engine-cli-edge/docker_manifest.yaml

+12-12
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@ long: "The `docker manifest` command by itself performs no action. In order to o
99
in the same way as\nan image name in `docker pull` and `docker run` commands, for
1010
example.\n\nIdeally a manifest list is created from images that are identical in
1111
function for\ndifferent os/arch combinations. For this reason, manifest lists are
12-
often referred to as\n\"multi-arch images.\" However, a user could create a manifest
12+
often referred to as\n\"multi-arch images\". However, a user could create a manifest
1313
list that points\nto two images -- one for windows on amd64, and one for darwin
1414
on amd64.\n\n### manifest inspect\n\n```\nmanifest inspect --help\n\nUsage: docker
15-
manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST\n\nisplay an image manifest,
16-
or manifest list\n\nOptions:\n --help Print usage\n --insecure allow
15+
manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST\n\nDisplay an image manifest,
16+
or manifest list\n\nOptions:\n --help Print usage\n --insecure Allow
1717
communication with an insecure registry\n -v, --verbose Output additional info
1818
including layers and platform\n```\n\n### manifest create \n\n```bash\nUsage: docker
19-
manifest create MANFEST_LIST MANIFEST [MANIFEST...]\n\nCreate a local manifest list
20-
for annotating and pushing to a registry\n\nOptions:\n -a, --amend Amend an existing
21-
manifest list\n --insecure allow communication with an insecure registry\n
22-
\ --help Print usage\n```\n\n### manifest annotate\n```bash\nUsage: docker
23-
manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST\n\nAdd additional information
19+
manifest create MANIFEST_LIST MANIFEST [MANIFEST...]\n\nCreate a local manifest
20+
list for annotating and pushing to a registry\n\nOptions:\n -a, --amend Amend
21+
an existing manifest list\n --insecure Allow communication with an insecure
22+
registry\n --help Print usage\n```\n\n### manifest annotate\n```bash\nUsage:
23+
\ docker manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST\n\nAdd additional information
2424
to a local image manifest\n\nOptions:\n --arch string Set architecture\n
2525
\ --help Print usage\n --os string Set
2626
operating system\n --os-features stringSlice Set operating system feature\n
2727
\ --variant string Set architecture variant\n\n```\n\n### manifest
2828
push\n```bash\nUsage: docker manifest push [OPTIONS] MANIFEST_LIST\n\nPush a manifest
29-
list to a repository\n\nOptions:\n --help Print usage\n --insecure
30-
\ allow push to an insecure registry\n -p, --purge Remove the local manifest
29+
list to a repository\n\nOptions:\n --help Print usage\n --insecure
30+
\ Allow push to an insecure registry\n -p, --purge Remove the local manifest
3131
list after push\n```\n\n### Working with insecure registries\n\nThe manifest command
3232
interacts solely with a Docker registry. Because of this, it has no way to query
3333
the engine for the list of allowed insecure registries. To allow the CLI to interact
@@ -51,7 +51,7 @@ clink:
5151
- docker_manifest_create.yaml
5252
- docker_manifest_inspect.yaml
5353
- docker_manifest_push.yaml
54-
examples: "### inspect an image's manifest object\n \n```bash\n$ docker manifest inspect
54+
examples: "### Inspect an image's manifest object\n \n```bash\n$ docker manifest inspect
5555
hello-world\n{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
5656
\ \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n
5757
\ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n
@@ -64,7 +64,7 @@ examples: "### inspect an image's manifest object\n \n```bash\n$ docker manifest
6464
as with other docker commands that take image names, you can refer to an image with
6565
or\nwithout a tag, or by digest (e.g. hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f).\n\nHere
6666
is an example of inspecting an image's manifest with the `--verbose` flag:\n\n```bash\n$
67-
docker manifest inspect -v hello-world\n{\n \"Ref\": \"docker.io/library/hello-world:latest\",\n
67+
docker manifest inspect --verbose hello-world\n{\n \"Ref\": \"docker.io/library/hello-world:latest\",\n
6868
\ \"Digest\": \"sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f\",\n
6969
\ \"SchemaV2Manifest\": {\n \"schemaVersion\": 2,\n \"mediaType\":
7070
\"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\":

‎_data/engine-cli-edge/docker_manifest_create.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
command: docker manifest create
22
short: Create a local manifest list for annotating and pushing to a registry
33
long: Create a local manifest list for annotating and pushing to a registry
4-
usage: docker manifest create MANFEST_LIST MANIFEST [MANIFEST...]
4+
usage: docker manifest create MANIFEST_LIST MANIFEST [MANIFEST...]
55
pname: docker manifest
66
plink: docker_manifest.yaml
77
options:
@@ -18,7 +18,7 @@ options:
1818
- option: insecure
1919
value_type: bool
2020
default_value: "false"
21-
description: allow communication with an insecure registry
21+
description: Allow communication with an insecure registry
2222
deprecated: false
2323
experimental: false
2424
experimentalcli: false

‎_data/engine-cli-edge/docker_manifest_inspect.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ options:
88
- option: insecure
99
value_type: bool
1010
default_value: "false"
11-
description: allow communication with an insecure registry
11+
description: Allow communication with an insecure registry
1212
deprecated: false
1313
experimental: false
1414
experimentalcli: false

‎_data/engine-cli-edge/docker_secret_create.yaml

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
command: docker secret create
22
short: Create a secret from a file or STDIN as content
3-
long: "Creates a secret using standard input or from a file for the secret content.
4-
You must run this command on a manager node. \n\nFor detailed information about
5-
using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/)."
3+
long: |-
4+
Creates a secret using standard input or from a file for the secret content. You must run this command on a manager node.
5+
6+
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
67
usage: docker secret create [OPTIONS] SECRET [file|-]
78
pname: docker secret
89
plink: docker_secret.yaml
@@ -38,7 +39,7 @@ examples: |-
3839
### Create a secret
3940
4041
```bash
41-
$ echo <secret> | docker secret create my_secret -
42+
$ printf <secret> | docker secret create my_secret -
4243
4344
onakdyv307se2tl7nl20anokv
4445

‎_data/engine-cli-edge/docker_stack_deploy.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ examples: |-
117117
`--compose-file` flags.
118118
119119
```bash
120-
$ docker stack deploy --compose-file docker-compose.yml -f docker-compose.prod.yml vossibility
120+
$ docker stack deploy --compose-file docker-compose.yml -c docker-compose.prod.yml vossibility
121121
122122
Ignoring unsupported options: links
123123

0 commit comments

Comments
 (0)