Update engine CLI docs, stubs, and TOC

This commit is contained in:
gbarr01 2018-02-07 10:46:12 -08:00 committed by Gwendolynne Barr
parent be8fd5413d
commit 4e4f59ad4b
24 changed files with 408 additions and 29 deletions

View File

@ -24,6 +24,7 @@ cname:
- docker login
- docker logout
- docker logs
- docker manifest
- docker network
- docker node
- docker pause
@ -80,6 +81,7 @@ clink:
- docker_login.yaml
- docker_logout.yaml
- docker_logs.yaml
- docker_manifest.yaml
- docker_network.yaml
- docker_node.yaml
- docker_pause.yaml

View File

@ -1,6 +1,6 @@
command: docker config create
short: Create a configuration file from a file or STDIN as content
long: Create a configuration file from a file or STDIN as content
short: Create a config from a file or STDIN
long: Create a config from a file or STDIN
usage: docker config create [OPTIONS] CONFIG file|-
pname: docker config
plink: docker_config.yaml

View File

@ -1,6 +1,6 @@
command: docker config inspect
short: Display detailed information on one or more configuration files
long: Display detailed information on one or more configuration files
short: Display detailed information on one or more configs
long: Display detailed information on one or more configs
usage: docker config inspect [OPTIONS] CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml

View File

@ -1,7 +1,7 @@
command: docker config rm
aliases: remove
short: Remove one or more configuration files
long: Remove one or more configuration files
short: Remove one or more configs
long: Remove one or more configs
usage: docker config rm CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml

View File

@ -121,5 +121,5 @@ min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
swarm: true

View File

@ -1,8 +1,8 @@
command: docker load
short: Load an image from a tar archive or STDIN
long: |-
`docker load` loads a tarred repository from a file or the standard input stream.
It restores both images and tags.
Load an image or repository from a tar archive (even if compressed with gzip,
bzip2, or xz) from a file or STDIN. It restores both images and tags.
usage: docker load [OPTIONS]
pname: docker
plink: docker.yaml
@ -28,7 +28,7 @@ options:
swarm: false
examples: |-
```bash
$ docker images
$ docker docker image ls
REPOSITORY TAG IMAGE ID CREATED SIZE

View File

@ -0,0 +1,133 @@
command: docker manifest
short: Manage Docker image manifests and manifest lists
long: "The `docker manifest` command by itself performs no action. In order to operate\non
a manifest or manifest list, one of the subcommands must be used.\n\nA single manifest
is information about an image, such as layers, size, and digest.\nThe docker manifest
command also gives users additional information such as the os\nand architecture
an image was built for.\n\nA manifest list is a list of image layers that is created
by specifying one or\nmore (ideally more than one) image names. It can then be used
in the same way as\nan image name in `docker pull` and `docker run` commands, for
example.\n\nIdeally a manifest list is created from images that are identical in
function for\ndifferent os/arch combinations. For this reason, manifest lists are
often referred to as\n\"multi-arch images.\" However, a user could create a manifest
list that points\nto two images -- one for windows on amd64, and one for darwin
on amd64.\n\n### manifest inspect\n\n```\nmanifest inspect --help\n\nUsage: docker
manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST\n\nisplay an image manifest,
or manifest list\n\nOptions:\n --help Print usage\n --insecure allow
communication with an insecure registry\n -v, --verbose Output additional info
including layers and platform\n```\n\n### manifest create \n\n```bash\nUsage: docker
manifest create MANFEST_LIST MANIFEST [MANIFEST...]\n\nCreate a local manifest list
for annotating and pushing to a registry\n\nOptions:\n -a, --amend Amend an existing
manifest list\n --insecure allow communication with an insecure registry\n
\ --help Print usage\n```\n\n### manifest annotate\n```bash\nUsage: docker
manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST\n\nAdd additional information
to a local image manifest\n\nOptions:\n --arch string Set architecture\n
\ --help Print usage\n --os string Set
operating system\n --os-features stringSlice Set operating system feature\n
\ --variant string Set architecture variant\n\n```\n\n### manifest
push\n```bash\nUsage: docker manifest push [OPTIONS] MANIFEST_LIST\n\nPush a manifest
list to a repository\n\nOptions:\n --help Print usage\n --insecure
\ allow push to an insecure registry\n -p, --purge Remove the local manifest
list after push\n```\n\n### Working with insecure registries\n\nThe manifest command
interacts solely with a Docker registry. Because of this, it has no way to query
the engine for the list of allowed insecure registries. To allow the CLI to interact
with an insecure registry, some `docker manifest` commands have an `--insecure`
flag. For each transaction, such as a `create`, which queries a registry, the `--insecure`
flag must be specified. This flag tells the CLI that this registry call may ignore
security concerns like missing or self-signed certificates. Likewise, on a `manifest
push` to an insecure registry, the `--insecure` flag must be specified. If this
is not used with an insecure registry, the manifest command fails to find a registry
that meets the default requirements."
usage: docker manifest COMMAND
pname: docker
plink: docker.yaml
cname:
- docker manifest annotate
- docker manifest create
- docker manifest inspect
- docker manifest push
clink:
- docker_manifest_annotate.yaml
- docker_manifest_create.yaml
- docker_manifest_inspect.yaml
- docker_manifest_push.yaml
examples: "### inspect an image's manifest object\n \n```bash\n$ docker manifest inspect
hello-world\n{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
\ \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n
\ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n
\ },\n \"layers\": [\n {\n \"mediaType\":
\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\":
972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n
\ }\n ]\n}\n```\n\n### Inspect an image's manifest and get
the os/arch info\n\nThe `docker manifest inspect` command takes an optional `--verbose`
flag\nthat gives you the image's name (Ref), and architecture and os (Platform).\n\nJust
as with other docker commands that take image names, you can refer to an image with
or\nwithout a tag, or by digest (e.g. hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f).\n\nHere
is an example of inspecting an image's manifest with the `--verbose` flag:\n\n```bash\n$
docker manifest inspect -v hello-world\n{\n \"Ref\": \"docker.io/library/hello-world:latest\",\n
\ \"Digest\": \"sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f\",\n
\ \"SchemaV2Manifest\": {\n \"schemaVersion\": 2,\n \"mediaType\":
\"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\":
{\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n
\ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n
\ },\n \"layers\": [\n {\n \"mediaType\":
\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\":
972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n
\ }\n ]\n },\n \"Platform\":
{\n \"architecture\": \"amd64\",\n \"os\": \"linux\"\n
\ }\n}\n```\n\n### Create and push a manifest list\n\nTo create a manifest
list, you first `create` the manifest list locally by specifying the constituent
images you would\nlike to have included in your manifest list. Keep in mind that
this is pushed to a registry, so if you want to push\nto a registry other than the
docker registry, you need to create your manifest list with the registry name or
IP and port.\nThis is similar to tagging an image and pushing it to a foreign registry.\n\nAfter
you have created your local copy of the manifest list, you may optionally\n`annotate`
it. Annotations allowed are the architecture and operating system (overriding the
image's current values),\nos features, and an archictecure variant. \n\nFinally,
you need to `push` your manifest list to the desired registry. Below are descriptions
of these three commands,\nand an example putting them all together.\n\n```bash\n$
docker manifest create 45.55.81.106:5000/coolapp:v1 \\\n 45.55.81.106:5000/coolapp-ppc64le-linux:v1
\\\n 45.55.81.106:5000/coolapp-arm-linux:v1 \\\n 45.55.81.106:5000/coolapp-amd64-linux:v1
\\\n 45.55.81.106:5000/coolapp-amd64-windows:v1\nCreated manifest list 45.55.81.106:5000/coolapp:v1\n```\n\n```bash\n$
docker manifest annotate 45.55.81.106:5000/coolapp:v1 45.55.81.106:5000/coolapp-arm-linux
--arch arm\n```\n\n```bash\n$ docker manifest push 45.55.81.106:5000/coolapp:v1\nPushed
manifest 45.55.81.106:5000/coolapp@sha256:9701edc932223a66e49dd6c894a11db8c2cf4eccd1414f1ec105a623bf16b426
with digest: sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\nPushed
manifest 45.55.81.106:5000/coolapp@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f
with digest: sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\nPushed
manifest 45.55.81.106:5000/coolapp@sha256:39dc41c658cf25f33681a41310372f02728925a54aac3598310bfb1770615fc9
with digest: sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\nPushed
manifest 45.55.81.106:5000/coolapp@sha256:f91b1145cd4ac800b28122313ae9e88ac340bb3f1e3a4cd3e59a3648650f3275
with digest: sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\nsha256:050b213d49d7673ba35014f21454c573dcbec75254a08f4a7c34f66a47c06aba\n\n```\n\n###
Inspect a manifest list\n\n```bash\n$ docker manifest inspect coolapp:v1\n{\n \"schemaVersion\":
2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.list.v2+json\",\n
\ \"manifests\": [\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
\ \"size\": 424,\n \"digest\": \"sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\",\n
\ \"platform\": {\n \"architecture\": \"arm\",\n \"os\":
\"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
\ \"size\": 424,\n \"digest\": \"sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\",\n
\ \"platform\": {\n \"architecture\": \"amd64\",\n \"os\":
\"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
\ \"size\": 425,\n \"digest\": \"sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\",\n
\ \"platform\": {\n \"architecture\": \"ppc64le\",\n \"os\":
\"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n
\ \"size\": 425,\n \"digest\": \"sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\",\n
\ \"platform\": {\n \"architecture\": \"s390x\",\n \"os\":
\"linux\"\n }\n }\n ]\n}\n```\n\n### Push to an insecure registry\n\nHere
is an example of creating and pushing a manifest list using a known insecure registry.\n\n```\n$
docker manifest create --insecure myprivateregistry.mycompany.com/repo/image:1.0
\\\n myprivateregistry.mycompany.com/repo/image-linux-ppc64le:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-s390x:1.0
\\\n myprivateregistry.mycompany.com/repo/image-linux-arm:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-armhf:1.0
\\\n myprivateregistry.mycompany.com/repo/image-windows-amd64:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-amd64:1.0\n```\n```\n$
docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag\n```\n\nNote
that the `--insecure` flag is not required to annotate a manifest list, since annotations
are to a locally-stored copy of a manifest list. You may also skip the `--insecure`
flag if you are performaing a `docker manifest inspect` on a locally-stored manifest
list. Be sure to keep in mind that locally-stored manifest lists are never used
by the engine on a `docker pull`."
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

View File

@ -0,0 +1,46 @@
command: docker manifest annotate
short: Add additional information to a local image manifest
long: Add additional information to a local image manifest
usage: docker manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST
pname: docker manifest
plink: docker_manifest.yaml
options:
- option: arch
value_type: string
description: Set architecture
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: os
value_type: string
description: Set operating system
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: os-features
value_type: stringSlice
default_value: '[]'
description: Set operating system feature
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: variant
value_type: string
description: Set architecture variant
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

View File

@ -0,0 +1,32 @@
command: docker manifest create
short: Create a local manifest list for annotating and pushing to a registry
long: Create a local manifest list for annotating and pushing to a registry
usage: docker manifest create MANFEST_LIST MANIFEST [MANIFEST...]
pname: docker manifest
plink: docker_manifest.yaml
options:
- option: amend
shorthand: a
value_type: bool
default_value: "false"
description: Amend an existing manifest list
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: insecure
value_type: bool
default_value: "false"
description: allow communication with an insecure registry
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

View File

@ -0,0 +1,32 @@
command: docker manifest inspect
short: Display an image manifest, or manifest list
long: Display an image manifest, or manifest list
usage: docker manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST
pname: docker manifest
plink: docker_manifest.yaml
options:
- option: insecure
value_type: bool
default_value: "false"
description: allow communication with an insecure registry
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose
shorthand: v
value_type: bool
default_value: "false"
description: Output additional info including layers and platform
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

View File

@ -0,0 +1,32 @@
command: docker manifest push
short: Push a manifest list to a repository
long: Push a manifest list to a repository
usage: docker manifest push [OPTIONS] MANIFEST_LIST
pname: docker manifest
plink: docker_manifest.yaml
options:
- option: insecure
value_type: bool
default_value: "false"
description: Allow push to an insecure registry
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: purge
shorthand: p
value_type: bool
default_value: "false"
description: Remove the local manifest list after push
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

View File

@ -871,13 +871,13 @@ examples: "### Create a service\n\n```bash\n$ docker service create --name redis
of using the long format\nfor the same service as above:\n\n```bash\n$ docker service
create --name my_web --replicas 3 --publish published=8080,target=80 nginx\n```\n\nThe
options you can specify are:\n\n<table>\n<thead>\n<tr>\n <th>Option</th>\n <th>Short
syntax</th>\n <th>Long syntax</th>\n <th>Description</th>\n</tr></thead>\n<tr>\n <td>published
and target port </td>\n <td><tt></tt></td>\n <td><tt></tt></td>\n <td></td>\n</tr>\n<tr>\n
\ <td>protocol</td>\n <td><tt>--publish 8080:80</tt></td>\n <td><tt>--publish
published=8080,target=80</tt></td>\n <td><p>\n The port to publish the service
to on the routing mesh or directly on\n the node, and the target port on the
container.\n </p></td>\n</tr>\n<tr>\n <td>mode</td>\n <td>Not possible to set
using short syntax.</td>\n <td><tt>--publish published=8080,target=80,mode=host</tt></td>\n
syntax</th>\n <th>Long syntax</th>\n <th>Description</th>\n</tr>\n</thead>\n<tr>\n
\ <td>published and target port </td>\n <td><tt></tt></td>\n <td><tt></tt></td>\n
\ <td></td>\n</tr>\n<tr>\n <td>protocol</td>\n <td><tt>--publish 8080:80</tt></td>\n
\ <td><tt>--publish published=8080,target=80</tt></td>\n <td><p>\n The port
to publish the service to on the routing mesh or directly on\n the node, and
the target port on the container.\n </p></td>\n</tr>\n<tr>\n <td>mode</td>\n <td>Not
possible to set using short syntax.</td>\n <td><tt>--publish published=8080,target=80,mode=host</tt></td>\n
\ <td><p>\n The mode to use for binding the port, either `ingress` or `host`.
Defaults\n to `ingress` to use the routing mesh.\n </p></td>\n</tr>\n<tr>\n
\ <td>protocol</td>\n <td><tt>--publish 8080:80/tcp</tt></td>\n <td><tt>--publish

View File

@ -38,6 +38,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -177,6 +177,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -70,6 +70,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -260,6 +260,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -65,6 +65,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -117,6 +117,6 @@ deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
kubernetes: true
swarm: true

View File

@ -1079,6 +1079,18 @@ reference:
title: docker logout
- path: /edge/engine/reference/commandline/logs/
title: docker logs
- sectiontitle: docker manifest *
section:
- path: /edge/engine/reference/commandline/manifest/
title: docker manifest
- path: /edge/engine/reference/commandline/manifest_annotate/
title: docker manifest annotate
- path: /edge/engine/reference/commandline/manifest_create/
title: docker manifest create
- path: /edge/engine/reference/commandline/manifest_inspect/
title: docker manifest inspect
- path: /edge/engine/reference/commandline/manifest_push/
title: docker manifest push
- sectiontitle: docker network *
section:
- path: /edge/engine/reference/commandline/network/

View File

@ -0,0 +1,18 @@
---
datafolder: engine-cli-edge
datafile: docker_manifest
title: docker manifest
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/cli
-->
{% if page.datafolder contains '-edge' %}
{% include edge_only.md section="cliref" %}
{% endif %}
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}

View File

@ -0,0 +1,18 @@
---
datafolder: engine-cli-edge
datafile: docker_manifest_annotate
title: docker manifest annotate
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/cli
-->
{% if page.datafolder contains '-edge' %}
{% include edge_only.md section="cliref" %}
{% endif %}
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}

View File

@ -0,0 +1,18 @@
---
datafolder: engine-cli-edge
datafile: docker_manifest_create
title: docker manifest create
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/cli
-->
{% if page.datafolder contains '-edge' %}
{% include edge_only.md section="cliref" %}
{% endif %}
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}

View File

@ -0,0 +1,18 @@
---
datafolder: engine-cli-edge
datafile: docker_manifest_inspect
title: docker manifest inspect
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/cli
-->
{% if page.datafolder contains '-edge' %}
{% include edge_only.md section="cliref" %}
{% endif %}
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}

View File

@ -0,0 +1,18 @@
---
datafolder: engine-cli-edge
datafile: docker_manifest_push
title: docker manifest push
---
<!--
Sorry, but the contents of this page are automatically generated from
Docker's source code. If you want to suggest a change to the text that appears
here, you'll need to find the string by searching this repo:
https://github.com/docker/cli
-->
{% if page.datafolder contains '-edge' %}
{% include edge_only.md section="cliref" %}
{% endif %}
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}