From 5838d496b2e0dab6a84120bf466c1134740c6ce1 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Wed, 5 Apr 2017 09:10:55 -0700 Subject: [PATCH 1/4] Update CLI reference yaml for 17.03.1 --- _data/engine-cli/docker_commit.yaml | 2 +- _data/engine-cli/docker_container.yaml | 2 +- _data/engine-cli/docker_image.yaml | 2 +- _data/engine-cli/docker_images.yaml | 1 + _data/engine-cli/docker_inspect.yaml | 2 +- _data/engine-cli/docker_network.yaml | 4 ++- _data/engine-cli/docker_node.yaml | 2 +- _data/engine-cli/docker_plugin.yaml | 2 +- _data/engine-cli/docker_ps.yaml | 2 -- _data/engine-cli/docker_push.yaml | 30 +++++++++------------ _data/engine-cli/docker_secret.yaml | 2 +- _data/engine-cli/docker_secret_create.yaml | 6 ++--- _data/engine-cli/docker_secret_inspect.yaml | 2 ++ _data/engine-cli/docker_secret_ls.yaml | 5 +++- _data/engine-cli/docker_secret_rm.yaml | 2 ++ _data/engine-cli/docker_service.yaml | 2 +- _data/engine-cli/docker_service_create.yaml | 4 +-- _data/engine-cli/docker_stack.yaml | 2 +- _data/engine-cli/docker_swarm.yaml | 2 +- _data/engine-cli/docker_system.yaml | 2 +- _data/engine-cli/docker_volume.yaml | 20 +++----------- 21 files changed, 43 insertions(+), 55 deletions(-) diff --git a/_data/engine-cli/docker_commit.yaml b/_data/engine-cli/docker_commit.yaml index 54a54a90c60..affa9f2109b 100644 --- a/_data/engine-cli/docker_commit.yaml +++ b/_data/engine-cli/docker_commit.yaml @@ -61,7 +61,7 @@ examples: |- ```bash $ docker ps - ICONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton diff --git a/_data/engine-cli/docker_container.yaml b/_data/engine-cli/docker_container.yaml index 1b4eb1313f6..9906350b397 100644 --- a/_data/engine-cli/docker_container.yaml +++ b/_data/engine-cli/docker_container.yaml @@ -1,6 +1,6 @@ command: docker container short: Manage containers -long: Manage containers +long: Manage containers. usage: docker container pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_image.yaml b/_data/engine-cli/docker_image.yaml index 3dc4445aac2..29fa42091ec 100644 --- a/_data/engine-cli/docker_image.yaml +++ b/_data/engine-cli/docker_image.yaml @@ -1,6 +1,6 @@ command: docker image short: Manage images -long: Manage images +long: Manage images. usage: docker image pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_images.yaml b/_data/engine-cli/docker_images.yaml index 48f9f7ee307..d0c638c6d20 100644 --- a/_data/engine-cli/docker_images.yaml +++ b/_data/engine-cli/docker_images.yaml @@ -143,6 +143,7 @@ examples: |- * label (`label=` or `label==`) * before (`[:]`, `` or ``) - filter images created before given id or references * since (`[:]`, `` or ``) - filter images created since given id or references + * reference (pattern of an image reference) - filter images whose reference matches the specified pattern #### Show untagged images (dangling) diff --git a/_data/engine-cli/docker_inspect.yaml b/_data/engine-cli/docker_inspect.yaml index 2a468a92a1e..3c7619cbc07 100644 --- a/_data/engine-cli/docker_inspect.yaml +++ b/_data/engine-cli/docker_inspect.yaml @@ -45,7 +45,7 @@ examples: |- ### Get an instance's image name ```bash - $ docker inspect --format='{{.Container.Spec.Image}}' $INSTANCE_ID + $ docker inspect --format='{{.Config.Image}}' $INSTANCE_ID ``` ### List all port bindings diff --git a/_data/engine-cli/docker_network.yaml b/_data/engine-cli/docker_network.yaml index 6dc75571fcd..ce3dfb358b8 100644 --- a/_data/engine-cli/docker_network.yaml +++ b/_data/engine-cli/docker_network.yaml @@ -1,6 +1,8 @@ command: docker network short: Manage networks -long: Manage networks +long: |- + Manage networks. You can use subcommand to create, list, inspect, remove, + connect and disconnect networks. usage: docker network pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_node.yaml b/_data/engine-cli/docker_node.yaml index 450d959e0da..6fbd014c856 100644 --- a/_data/engine-cli/docker_node.yaml +++ b/_data/engine-cli/docker_node.yaml @@ -1,6 +1,6 @@ command: docker node short: Manage Swarm nodes -long: Manage Swarm nodes +long: Manage nodes. usage: docker node pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_plugin.yaml b/_data/engine-cli/docker_plugin.yaml index 52c3ade3af2..8ad61ccc913 100644 --- a/_data/engine-cli/docker_plugin.yaml +++ b/_data/engine-cli/docker_plugin.yaml @@ -1,6 +1,6 @@ command: docker plugin short: Manage plugins -long: Manage plugins +long: Manage plugins. usage: docker plugin pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_ps.yaml b/_data/engine-cli/docker_ps.yaml index 74051e49cd4..99028d42234 100644 --- a/_data/engine-cli/docker_ps.yaml +++ b/_data/engine-cli/docker_ps.yaml @@ -348,7 +348,6 @@ examples: |- ``` The following filter matches all containers that have exposed TCP port in the range of `8000-8080`: - ```bash $ docker ps --filter expose=8000-8080/tcp @@ -357,7 +356,6 @@ examples: |- ``` The following filter matches all containers that have exposed UDP port `80`: - ```bash $ docker ps --filter publish=80/udp diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index 90638cff359..ddbb5131256 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -1,23 +1,17 @@ command: docker push short: Push an image or a repository to a registry -long: |- - Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com) - registry or to a self-hosted one. - - Refer to the [`docker tag`](tag.md) reference for more information about valid - image and tag names. - - Killing the `docker push` process, for example by pressing `CTRL-c` while it is - running in a terminal, terminates the push operation. - - Registry credentials are managed by [docker login](login.md). - - ### Concurrent uploads - - By default the Docker daemon will push five layers of an image at a time. - If you are on a low bandwidth connection this may cause timeout issues and you may want to lower - this via the `--max-concurrent-uploads` daemon option. See the - [daemon documentation](dockerd.md) for more details. +long: "Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)\nregistry + or to a self-hosted one.\n\nRefer to the [`docker tag`](tag.md) reference for more + information about valid\nimage and tag names.\n\nKilling the `docker push` process, + for example by pressing `CTRL-c` while it is\nrunning in a terminal, terminates + the push operation.\n\nProgress bars are shown during docker push, which show the + uncompressed size. The \nactual amount of data that's pushed will be compressed + before sending, so the uploaded\n size will not be reflected by the progress bar. + \n\nRegistry credentials are managed by [docker login](login.md).\n\n### Concurrent + uploads\n\nBy default the Docker daemon will push five layers of an image at a time.\nIf + you are on a low bandwidth connection this may cause timeout issues and you may + want to lower\nthis via the `--max-concurrent-uploads` daemon option. See the\n[daemon + documentation](dockerd.md) for more details." usage: docker push [OPTIONS] NAME[:TAG] pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_secret.yaml b/_data/engine-cli/docker_secret.yaml index c2b4e247388..8e109712886 100644 --- a/_data/engine-cli/docker_secret.yaml +++ b/_data/engine-cli/docker_secret.yaml @@ -1,6 +1,6 @@ command: docker secret short: Manage Docker secrets -long: Manage Docker secrets +long: Manage secrets. usage: docker secret pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_secret_create.yaml b/_data/engine-cli/docker_secret_create.yaml index 373e6ea96a5..6187463ebd9 100644 --- a/_data/engine-cli/docker_secret_create.yaml +++ b/_data/engine-cli/docker_secret_create.yaml @@ -1,8 +1,8 @@ command: docker secret create short: Create a secret from a file or STDIN as content -long: |- - Creates a secret using standard input or from a file for the secret content. You must run this - command on a manager node. +long: "Creates a secret using standard input or from a file for the secret content. + You must run this command on a manager node. \n\nFor detailed information about + using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/)." usage: docker secret create [OPTIONS] SECRET file|- pname: docker secret plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_secret_inspect.yaml b/_data/engine-cli/docker_secret_inspect.yaml index 20ff6f9e8e1..c9a1789bdb2 100644 --- a/_data/engine-cli/docker_secret_inspect.yaml +++ b/_data/engine-cli/docker_secret_inspect.yaml @@ -9,6 +9,8 @@ long: |- Go's [text/template](http://golang.org/pkg/text/template/) package describes all the details of the format. + + For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). usage: docker secret inspect [OPTIONS] SECRET [SECRET...] pname: docker secret plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_secret_ls.yaml b/_data/engine-cli/docker_secret_ls.yaml index 0a58026df98..ef6fa96a30c 100644 --- a/_data/engine-cli/docker_secret_ls.yaml +++ b/_data/engine-cli/docker_secret_ls.yaml @@ -1,7 +1,10 @@ command: docker secret ls aliases: list short: List secrets -long: Run this command on a manager node to list the secrets in the swarm. +long: |- + Run this command on a manager node to list the secrets in the swarm. + + For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). usage: docker secret ls [OPTIONS] pname: docker secret plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_secret_rm.yaml b/_data/engine-cli/docker_secret_rm.yaml index b348215fb31..0759d3c98c9 100644 --- a/_data/engine-cli/docker_secret_rm.yaml +++ b/_data/engine-cli/docker_secret_rm.yaml @@ -4,6 +4,8 @@ short: Remove one or more secrets long: |- Removes the specified secrets from the swarm. This command has to be run targeting a manager node. + + For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). usage: docker secret rm SECRET [SECRET...] pname: docker secret plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_service.yaml b/_data/engine-cli/docker_service.yaml index 792d1111e8b..d99d94118da 100644 --- a/_data/engine-cli/docker_service.yaml +++ b/_data/engine-cli/docker_service.yaml @@ -1,6 +1,6 @@ command: docker service short: Manage services -long: Manage services +long: Manage services. usage: docker service pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_service_create.yaml b/_data/engine-cli/docker_service_create.yaml index 3c5d12b8176..575a8f88a5c 100644 --- a/_data/engine-cli/docker_service_create.yaml +++ b/_data/engine-cli/docker_service_create.yaml @@ -605,8 +605,8 @@ examples: |- node.hostname != node-2 - node.role - node role: manager + node.role + Node role node.role == manager diff --git a/_data/engine-cli/docker_stack.yaml b/_data/engine-cli/docker_stack.yaml index 7e40b311789..ad1d4ae6eff 100644 --- a/_data/engine-cli/docker_stack.yaml +++ b/_data/engine-cli/docker_stack.yaml @@ -1,6 +1,6 @@ command: docker stack short: Manage Docker stacks -long: Manage Docker stacks +long: Manage stacks. usage: docker stack pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_swarm.yaml b/_data/engine-cli/docker_swarm.yaml index eb05ffc45b1..fc839c0186a 100644 --- a/_data/engine-cli/docker_swarm.yaml +++ b/_data/engine-cli/docker_swarm.yaml @@ -1,6 +1,6 @@ command: docker swarm short: Manage Swarm -long: Manage Swarm +long: Manage the swarm. usage: docker swarm pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_system.yaml b/_data/engine-cli/docker_system.yaml index 4a4de17d27b..d3da32d99d8 100644 --- a/_data/engine-cli/docker_system.yaml +++ b/_data/engine-cli/docker_system.yaml @@ -1,6 +1,6 @@ command: docker system short: Manage Docker -long: Manage Docker +long: Manage docker. usage: docker system pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_volume.yaml b/_data/engine-cli/docker_volume.yaml index 31a08f2b61a..7df8a9b9270 100644 --- a/_data/engine-cli/docker_volume.yaml +++ b/_data/engine-cli/docker_volume.yaml @@ -1,22 +1,8 @@ command: docker volume short: Manage volumes -long: |2+ - - The **docker volume** command has subcommands for managing data volumes. A data - volume is a specially-designated directory that by-passes storage driver - management. - - Data volumes persist data independent of a container's life cycle. When you - delete a container, the Docker daemon does not delete any data volumes. You can - share volumes across multiple containers. Moreover, you can share data volumes - with other computing resources in your system. - - To see help for a subcommand, use: - - docker volume COMMAND --help - - For full details on using docker volume visit Docker's online documentation. - +long: |- + Manage volumes. You can use subcommand to create, list, inspect, remove + volumes. usage: docker volume COMMAND pname: docker plink: docker.yaml From a38f9b11901fcba473d34a88ec13629c3af2a402 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Wed, 5 Apr 2017 09:37:34 -0700 Subject: [PATCH 2/4] Manual edits --- _data/engine-cli/docker_network.yaml | 2 +- _data/engine-cli/docker_ps.yaml | 2 ++ _data/engine-cli/docker_push.yaml | 34 +++++++++++++++------- _data/engine-cli/docker_secret_create.yaml | 9 ++++-- _data/engine-cli/docker_system.yaml | 2 +- _data/engine-cli/docker_volume.yaml | 2 +- 6 files changed, 34 insertions(+), 17 deletions(-) diff --git a/_data/engine-cli/docker_network.yaml b/_data/engine-cli/docker_network.yaml index ce3dfb358b8..bf546219777 100644 --- a/_data/engine-cli/docker_network.yaml +++ b/_data/engine-cli/docker_network.yaml @@ -1,7 +1,7 @@ command: docker network short: Manage networks long: |- - Manage networks. You can use subcommand to create, list, inspect, remove, + Manage networks. You can use subcommands to create, inspect, list, remove, connect and disconnect networks. usage: docker network pname: docker diff --git a/_data/engine-cli/docker_ps.yaml b/_data/engine-cli/docker_ps.yaml index 99028d42234..5ea6ef952ec 100644 --- a/_data/engine-cli/docker_ps.yaml +++ b/_data/engine-cli/docker_ps.yaml @@ -348,6 +348,7 @@ examples: |- ``` The following filter matches all containers that have exposed TCP port in the range of `8000-8080`: + ```bash $ docker ps --filter expose=8000-8080/tcp @@ -356,6 +357,7 @@ examples: |- ``` The following filter matches all containers that have exposed UDP port `80`: + ```bash $ docker ps --filter publish=80/udp diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index ddbb5131256..bf03bc5e69f 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -1,17 +1,29 @@ command: docker push short: Push an image or a repository to a registry -long: "Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)\nregistry - or to a self-hosted one.\n\nRefer to the [`docker tag`](tag.md) reference for more - information about valid\nimage and tag names.\n\nKilling the `docker push` process, - for example by pressing `CTRL-c` while it is\nrunning in a terminal, terminates - the push operation.\n\nProgress bars are shown during docker push, which show the - uncompressed size. The \nactual amount of data that's pushed will be compressed - before sending, so the uploaded\n size will not be reflected by the progress bar. - \n\nRegistry credentials are managed by [docker login](login.md).\n\n### Concurrent - uploads\n\nBy default the Docker daemon will push five layers of an image at a time.\nIf +long: |- + Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com) + registry or to a self-hosted one. + + Refer to the [`docker tag`](tag.md) reference for more + information about valid\nimage and tag names. + + Killing the `docker push` process, for example by pressing `CTRL-c` while it + is\nrunning in a terminal, terminates the push operation. + + Progress bars are shown during docker push, which show the + uncompressed size. The actual amount of data that's pushed will be compressed + before sending, so the uploaded + size will not be reflected by the progress bar. + + Registry credentials are managed by [docker login](login.md). + + ### Concurrent uploads + + By default the Docker daemon will push five layers of an image at a time. If you are on a low bandwidth connection this may cause timeout issues and you may - want to lower\nthis via the `--max-concurrent-uploads` daemon option. See the\n[daemon - documentation](dockerd.md) for more details." + want to lower + this via the `--max-concurrent-uploads` daemon option. See the + [daemon documentation](dockerd.md) for more details. usage: docker push [OPTIONS] NAME[:TAG] pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_secret_create.yaml b/_data/engine-cli/docker_secret_create.yaml index 6187463ebd9..e5874492ed4 100644 --- a/_data/engine-cli/docker_secret_create.yaml +++ b/_data/engine-cli/docker_secret_create.yaml @@ -1,8 +1,11 @@ command: docker secret create short: Create a secret from a file or STDIN as content -long: "Creates a secret using standard input or from a file for the secret content. - You must run this command on a manager node. \n\nFor detailed information about - using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/)." +long: |- + Creates a secret using standard input or from a file for the secret content. + You must run this command on a manager node. + + For detailed information about + using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). usage: docker secret create [OPTIONS] SECRET file|- pname: docker secret plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_system.yaml b/_data/engine-cli/docker_system.yaml index d3da32d99d8..12a585ecf80 100644 --- a/_data/engine-cli/docker_system.yaml +++ b/_data/engine-cli/docker_system.yaml @@ -1,6 +1,6 @@ command: docker system short: Manage Docker -long: Manage docker. +long: Manage Docker. usage: docker system pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_volume.yaml b/_data/engine-cli/docker_volume.yaml index 7df8a9b9270..763e47da459 100644 --- a/_data/engine-cli/docker_volume.yaml +++ b/_data/engine-cli/docker_volume.yaml @@ -1,7 +1,7 @@ command: docker volume short: Manage volumes long: |- - Manage volumes. You can use subcommand to create, list, inspect, remove + Manage volumes. You can use subcommands to create, inspect, list, remove volumes. usage: docker volume COMMAND pname: docker From c36513b43c377e696bc4c46535fbe895f758b24d Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Wed, 5 Apr 2017 09:41:13 -0700 Subject: [PATCH 3/4] Update docker_push.yaml --- _data/engine-cli/docker_push.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index bf03bc5e69f..81a14be271f 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -5,7 +5,7 @@ long: |- registry or to a self-hosted one. Refer to the [`docker tag`](tag.md) reference for more - information about valid\nimage and tag names. + information about valid image and tag names. Killing the `docker push` process, for example by pressing `CTRL-c` while it is\nrunning in a terminal, terminates the push operation. From 6975d75484078f20b1c6b5d152823902550ee7cc Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Wed, 5 Apr 2017 09:41:44 -0700 Subject: [PATCH 4/4] Update docker_push.yaml --- _data/engine-cli/docker_push.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index 81a14be271f..04fb0ba8b31 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -8,7 +8,7 @@ long: |- information about valid image and tag names. Killing the `docker push` process, for example by pressing `CTRL-c` while it - is\nrunning in a terminal, terminates the push operation. + is running in a terminal, terminates the push operation. Progress bars are shown during docker push, which show the uncompressed size. The actual amount of data that's pushed will be compressed