Skip to content

Update CLI reference yaml for 17.03.1 #2633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_container.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker container
short: Manage containers
long: Manage containers
long: Manage containers.
usage: docker container
pname: docker
plink: docker.yaml
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_image.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker image
short: Manage images
long: Manage images
long: Manage images.
usage: docker image
pname: docker
plink: docker.yaml
Expand Down
1 change: 1 addition & 0 deletions _data/engine-cli/docker_images.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ examples: |-
* label (`label=<key>` or `label=<key>=<value>`)
* before (`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - filter images created before given id or references
* since (`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - 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)

Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion _data/engine-cli/docker_network.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
command: docker network
short: Manage networks
long: Manage networks
long: |-
Manage networks. You can use subcommands to create, inspect, list, remove,
connect and disconnect networks.
usage: docker network
pname: docker
plink: docker.yaml
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_node.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_plugin.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker plugin
short: Manage plugins
long: Manage plugins
long: Manage plugins.
usage: docker plugin
pname: docker
plink: docker.yaml
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_ps.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ examples: |-
```

The following filter matches all containers that have exposed UDP port `80`:

```bash
$ docker ps --filter publish=80/udp

Expand Down
18 changes: 12 additions & 6 deletions _data/engine-cli/docker_push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,24 @@ 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.
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.
Killing the `docker push` process, for example by pressing `CTRL-c` while it
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
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
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.
usage: docker push [OPTIONS] NAME[:TAG]
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_secret.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 5 additions & 2 deletions _data/engine-cli/docker_secret_create.yaml
Original file line number Diff line number Diff line change
@@ -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.
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
Expand Down
2 changes: 2 additions & 0 deletions _data/engine-cli/docker_secret_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion _data/engine-cli/docker_secret_ls.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions _data/engine-cli/docker_secret_rm.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_service.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker service
short: Manage services
long: Manage services
long: Manage services.
usage: docker service
pname: docker
plink: docker.yaml
Expand Down
4 changes: 2 additions & 2 deletions _data/engine-cli/docker_service_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -605,8 +605,8 @@ examples: |-
<td><tt>node.hostname != node-2</tt></td>
</tr>
<tr>
<td<tt>node.role</tt></td>
<td><tt>node role: manager</tt></td>
<td><tt>node.role</tt></td>
<td>Node role</td>
<td><tt>node.role == manager</tt></td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_stack.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_swarm.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_system.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command: docker system
short: Manage Docker
long: Manage Docker
long: Manage Docker.
usage: docker system
pname: docker
plink: docker.yaml
Expand Down
20 changes: 3 additions & 17 deletions _data/engine-cli/docker_volume.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
command: docker volume
short: Manage volumes
long: |2+

The **docker volume** command has subcommands for managing data volumes. A data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we remove this section deliberately?

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 subcommands to create, inspect, list, remove
volumes.
usage: docker volume COMMAND
pname: docker
plink: docker.yaml
Expand Down