docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "Update engine CLI docs, stubs, and TOC" 

This reverts commit 9e5ed3edd4.
This commit is contained in:
Joao Fernandes 2018-03-22 11:56:23 -07:00
parent c9dcb9733c
commit 03e09ed114
213 changed files with 450 additions and 4556 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_data/engine-cli-edge/docker_config_create.yaml
View File

@ -14,14 +14,6 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: template-driver
value_type: string
description: Template driver
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false

3
_data/engine-cli-edge/docker_deploy.yaml
View File

@ -17,8 +17,7 @@ options:
swarm: true
- option: compose-file
shorthand: c
value_type: stringSlice
default_value: '[]'
value_type: string
description: Path to a Compose file
deprecated: false
min_api_version: "1.25"

2
_data/engine-cli-edge/docker_events.yaml
View File

@ -150,7 +150,7 @@ long: |-
* container (`container=<name or id>`)
* daemon (`daemon=<name or id>`)
* event (`event=<event action>`)
* image (`image=<repository or tag>`)
* image (`image=<tag or id>`)
* label (`label=<key>` or `label=<key>=<value>`)
* network (`network=<name or id>`)
* node (`node=<id>`)

2
_data/engine-cli-edge/docker_export.yaml
View File

@ -22,7 +22,7 @@ options:
kubernetes: false
swarm: false
examples: |-
Each of these commands has the same result.
ch of these commands has the same result.
```bash
$ docker export red_panda > latest.tar

46
_data/engine-cli-edge/docker_image_prune.yaml
View File

@ -34,8 +34,8 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
Example output:
examples: |2-
output:
```bash
$ docker image prune -a
@ -97,19 +97,6 @@ examples: |-
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), which removes
images without the specified labels.
> **Predicting what will be removed**
>
> If you are using positive filtering (testing for the existence of a label or
> that a label has a specific value), you can use `docker image ls` with the
> same filtering syntax to see which images match your filter.
>
> However, if you are using negative filtering (testing for the absence of a
> label or that a label does *not* have a specific value), this type of filter
> does not work with `docker image ls` so you cannot easily predict which images
> will be removed. In addition, the confirmation prompt for `docker image prune`
> always warns that *all* dangling images will be removed, even if you are using
> `--filter`.
The following removes images created before `2017-01-04T00:00:00`:
```bash
@ -176,35 +163,6 @@ examples: |-
alpine latest 88e169ea8f46 8 days ago 3.98 MB
busybox latest e02e811dd08f 2 months ago 1.09 MB
```
The following example removes images with the label `deprecated`:
```bash
$ docker image prune --filter="label=deprecated"
```
The following example removes images with the label `maintainer` set to `john`:
```bash
$ docker image prune --filter="label=maintainer=john"
```
This example removes images which have no `maintainer` label:
```bash
$ docker image prune --filter="label!=maintainer"
```
This example removes images which have a maintainer label not set to `john`:
```bash
$ docker image prune --filter="label!=maintainer=john"
```
> **Note**: You are prompted for confirmation before the `prune` removes
> anything, but you are not shown a list of what will potentially be removed.
> In addition, `docker image ls` does not support negative filtering, so it
> difficult to predict what images will actually be removed.
deprecated: false
min_api_version: "1.25"
experimental: false

2
_data/engine-cli-edge/docker_inspect.yaml
View File

@ -1,7 +1,7 @@
command: docker inspect
short: Return low-level information on Docker objects
long: |-
Docker inspect provides detailed information on constructs controlled by Docker.
ker inspect provides detailed information on constructs controlled by Docker.
By default, `docker inspect` will render results in a JSON array.
usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...]

37
_data/engine-cli-edge/docker_kill.yaml
View File

@ -1,10 +1,8 @@
command: docker kill
short: Kill one or more running containers
long: |-
The `docker kill` subcommand kills one or more containers. The main process
inside the container is sent `SIGKILL` signal (default), or the signal that is
specified with the `--signal` option. You can kill a container using the
container's ID, ID-prefix, or name.
The main process inside the container will be sent `SIGKILL`, or any
signal specified with option `--signal`.
> **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of
> `/bin/sh -c`, which does not pass signals. This means that the executable is
@ -23,37 +21,6 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Send a KILL signal to a container
The following example sends the default `KILL` signal to the container named
`my_container`:
```bash
$ docker kill my_container
```
### Send a custom signal to a container
The following example sends a `SIGHUP` signal to the container named
`my_container`:
```bash
$ docker kill --signal=SIGHUP my_container
```
You can specify a custom signal either by _name_, or _number_. The `SIG` prefix
is optional, so the following examples are equivalent:
```bash
$ docker kill --signal=SIGHUP my_container
$ docker kill --signal=HUP my_container
$ docker kill --signal=1 my_container
```
Refer to the [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html)
man-page for a list of standard Linux signals.
deprecated: false
experimental: false
experimentalcli: false

25
_data/engine-cli-edge/docker_network_create.yaml
View File

@ -48,18 +48,6 @@ long: |-
Network names must be unique. The Docker daemon attempts to identify naming
conflicts but this is not guaranteed. It is the user's responsibility to avoid
name conflicts.
### Overlay network limitations
You should create overlay networks with `/24` blocks (the default), which limits
you to 256 IP addresses, when you create networks using the default VIP-based
endpoint-mode. This recommendation addresses
[limitations with swarm mode](https://github.com/moby/moby/issues/30820). If you
need more than 256 IP addresses, do not increase the IP block size. You can
either use `dnsrr` endpoint mode with an external load balancer, or use multiple
smaller overlay networks. See
[Configure service discovery](https://docs.docker.com/engine/swarm/networking/#configure-service-discovery)
for more information about different endpoint modes.
usage: docker network create [OPTIONS] NETWORK
pname: docker network
plink: docker_network.yaml
@ -260,16 +248,15 @@ examples: |-
If you omit the `--gateway` flag the Engine selects one for you from inside a
preferred pool. For `overlay` networks and for network driver plugins that
support it you can create multiple subnetworks. This example uses two `/25`
subnet mask to adhere to the current guidance of not having more than 256 IPs in
a single overlay network. Each of the subnetworks has 126 usable addresses.
support it you can create multiple subnetworks.
```bash
$ docker network create -d overlay \
--subnet=192.168.1.0/25 \
--subnet=192.170.2.0/25 \
--gateway=192.168.1.100 \
--gateway=192.170.2.100 \
--subnet=192.168.0.0/16 \
--subnet=192.170.0.0/16 \
--gateway=192.168.0.100 \
--gateway=192.170.0.100 \
--ip-range=192.168.1.0/24 \
--aux-address="my-router=192.168.1.5" --aux-address="my-switch=192.168.1.6" \
--aux-address="my-printer=192.170.1.5" --aux-address="my-nas=192.170.1.6" \
my-multihost-network

4
_data/engine-cli-edge/docker_network_disconnect.yaml
View File

@ -1,7 +1,7 @@
command: docker network disconnect
short: Disconnect a container from a network
long: |-
Disconnects a container from a network. The container must be running to
long: |2-
a container from a network. The container must be running to
disconnect it from the network.
usage: docker network disconnect [OPTIONS] NETWORK CONTAINER
pname: docker network

2
_data/engine-cli-edge/docker_node_demote.yaml
View File

@ -1,7 +1,7 @@
command: docker node demote
short: Demote one or more nodes from manager in the swarm
long: |-
Demotes an existing manager so that it is no longer a manager. This command
motes an existing manager so that it is no longer a manager. This command
targets a docker engine that is a manager in the swarm.
usage: docker node demote NODE [NODE...]
pname: docker node

14
_data/engine-cli-edge/docker_node_ls.yaml
View File

@ -77,13 +77,13 @@ examples: "```bash\n$ docker node ls\n\nID HOSTNAME
\ | Node status\n`.Availability` | Node availability (\"active\", \"pause\",
or \"drain\")\n`.ManagerStatus` | Manager status of the node\n`.TLSStatus` |
TLS status of the node (\"Ready\", or \"Needs Rotation\" has TLS certificate signed
by an old CA)\n`.EngineVersion` | Engine version\n\nWhen using the `--format` option,
the `node ls` command will either\noutput the data exactly as the template declares
or, when using the\n`table` directive, includes column headers as well.\n\nThe following
example uses a template without headers and outputs the\n`ID`, `Hostname`, and `TLS
Status` entries separated by a colon for all nodes:\n\n```bash\n$ docker node ls
--format \"{{.ID}}: {{.Hostname}} {{.TLSStatus}}\"\ne216jshn25ckzbvmwlnh5jr3g: swarm-manager1
Ready\n35o6tiywb700jesrt3dmllaza: swarm-worker1 Needs Rotation \n```"
by an old CA)\n\nWhen using the `--format` option, the `node ls` command will either\noutput
the data exactly as the template declares or, when using the\n`table` directive,
includes column headers as well.\n\nThe following example uses a template without
headers and outputs the\n`ID`, `Hostname`, and `TLS Status` entries separated by
a colon for all nodes:\n\n```bash\n$ docker node ls --format \"{{.ID}}: {{.Hostname}}
{{.TLSStatus}}\"\ne216jshn25ckzbvmwlnh5jr3g: swarm-manager1 Ready\n35o6tiywb700jesrt3dmllaza:
swarm-worker1 Needs Rotation \n```"
deprecated: false
min_api_version: "1.24"
experimental: false

2
_data/engine-cli-edge/docker_plugin_disable.yaml
View File

@ -1,7 +1,7 @@
command: docker plugin disable
short: Disable a plugin
long: |-
Disables a plugin. The plugin must be installed before it can be disabled,
ables a plugin. The plugin must be installed before it can be disabled,
see [`docker plugin install`](plugin_install.md). Without the `-f` option,
a plugin that has references (e.g., volumes, networks) cannot be disabled.
usage: docker plugin disable [OPTIONS] PLUGIN

2
_data/engine-cli-edge/docker_plugin_enable.yaml
View File

@ -9,7 +9,7 @@ plink: docker_plugin.yaml
options:
- option: timeout
value_type: int
default_value: "30"
default_value: "0"
description: HTTP client timeout (in seconds)
deprecated: false
experimental: false

2
_data/engine-cli-edge/docker_plugin_set.yaml
View File

@ -7,7 +7,7 @@ long: |-
* env variables
* source of mounts
* path of devices
* args
* arg
usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...]
pname: docker plugin
plink: docker_plugin.yaml

9
_data/engine-cli-edge/docker_run.yaml
View File

@ -1063,12 +1063,12 @@ examples: |-
### Publish or expose port (-p, --expose)
```bash
$ docker run -p 127.0.0.1:80:8080/tcp ubuntu bash
$ docker run -p 127.0.0.1:80:8080 ubuntu bash
```
This binds port `8080` of the container to TCP port `80` on `127.0.0.1` of the host
machine. You can also specify `udp` and `sctp` ports.
The [Docker User Guide](https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/)
This binds port `8080` of the container to port `80` on `127.0.0.1` of the host
machine. The [Docker User
Guide](https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/)
explains in detail how to manipulate ports in Docker.
```bash
@ -1312,7 +1312,6 @@ examples: |-
|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `no` | Do not automatically restart the container when it exits. This is the default. |
| `on-failure[:max-retries]` | Restart only if the container exits with a non-zero exit status. Optionally, limit the number of restart retries the Docker daemon attempts. |
| `unless-stopped` | Restart the container unless it is explicitly stopped or Docker itself is stopped or restarted. |
| `always` | Always restart the container regardless of the exit status. When you specify always, the Docker daemon will try to restart the container indefinitely. The container will also always start on daemon startup, regardless of the current state of the container. |
```bash

10
_data/engine-cli-edge/docker_secret_create.yaml
View File

@ -12,7 +12,7 @@ options:
value_type: string
description: Secret driver
deprecated: false
min_api_version: "1.37"
min_api_version: "1.31"
experimental: false
experimentalcli: false
kubernetes: false
@ -26,14 +26,6 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: template-driver
value_type: string
description: Template driver
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a secret

132
_data/engine-cli-edge/docker_service_create.yaml
View File

@ -587,42 +587,34 @@ examples: "### Create a service\n\n```bash\n$ docker service create --name redis
docker service create --mode global --name redis2 redis:3.0.6\n\na8q9dasaafudfs8q8w32udass\n\n$
docker service ls\n\nID NAME MODE REPLICAS IMAGE\ndmu1ept4cxcf
\ redis replicated 1/1 redis:3.0.6\na8q9dasaafud redis2 global 1/1
\ redis:3.0.6\n```\n\n#### Create a service using an image on a private registry\n\nIf
your image is available on a private registry which requires login, use the\n`--with-registry-auth`
flag with `docker service create`, after logging in. If\nyour image is stored on
`registry.example.com`, which is a private registry, use\na command like the following:\n\n```bash\n$
docker login registry.example.com\n\n$ docker service create \\\n --with-registry-auth
\\\n --name my_service \\\n registry.example.com/acme/my_image:latest\n```\n\nThis
passes the login token from your local client to the swarm nodes where the\nservice
is deployed, using the encrypted WAL logs. With this information, the\nnodes are
able to log into the registry and pull the image.\n\n### Create a service with 5
replica tasks (--replicas)\n\nUse the `--replicas` flag to set the number of replica
tasks for a replicated\nservice. The following command creates a `redis` service
with `5` replica tasks:\n\n```bash\n$ docker service create --name redis --replicas=5
redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nThe above command sets the *desired*
number of tasks for the service. Even\nthough the command returns immediately, actual
scaling of the service may take\nsome time. The `REPLICAS` column shows both the
*actual* and *desired* number\nof replica tasks for the service.\n\nIn the following
example the desired state is `5` replicas, but the current\nnumber of `RUNNING`
tasks is `3`:\n\n```bash\n$ docker service ls\n\nID NAME MODE REPLICAS
\ IMAGE\n4cdgfyky7ozw redis replicated 3/5 redis:3.0.7\n```\n\nOnce all
the tasks are created and `RUNNING`, the actual number of tasks is\nequal to the
desired number:\n\n```bash\n$ docker service ls\n\nID NAME MODE REPLICAS
\ IMAGE\n4cdgfyky7ozw redis replicated 5/5 redis:3.0.7\n```\n\n### Create
a service with secrets\n\nUse the `--secret` flag to give a container access to
a\n[secret](secret_create.md).\n\nCreate a service specifying a secret:\n\n```bash\n$
docker service create --name redis --secret secret.json redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nCreate
a service specifying the secret, target, user/group ID, and mode:\n\n```bash\n$
docker service create --name redis \\\n --secret source=ssh-key,target=ssh \\\n
\ --secret source=app-key,target=app,uid=1000,gid=1001,mode=0400 \\\n redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nTo
grant a service access to multiple secrets, use multiple `--secret` flags.\n\nSecrets
are located in `/run/secrets` in the container. If no target is\nspecified, the
name of the secret will be used as the in memory file in the\ncontainer. If a target
is specified, that will be the filename. In the\nexample above, two files will
be created: `/run/secrets/ssh` and\n`/run/secrets/app` for each of the secret targets
specified.\n\n### Create a service with a rolling update policy\n\n```bash\n$ docker
service create \\\n --replicas 10 \\\n --name redis \\\n --update-delay 10s \\\n
\ --update-parallelism 2 \\\n redis:3.0.6\n```\n\nWhen you run a [service update](service_update.md),
\ redis:3.0.6\n```\n\n### Create a service with 5 replica tasks (--replicas)\n\nUse
the `--replicas` flag to set the number of replica tasks for a replicated\nservice.
The following command creates a `redis` service with `5` replica tasks:\n\n```bash\n$
docker service create --name redis --replicas=5 redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nThe
above command sets the *desired* number of tasks for the service. Even\nthough the
command returns immediately, actual scaling of the service may take\nsome time.
The `REPLICAS` column shows both the *actual* and *desired* number\nof replica tasks
for the service.\n\nIn the following example the desired state is `5` replicas,
but the current\nnumber of `RUNNING` tasks is `3`:\n\n```bash\n$ docker service
ls\n\nID NAME MODE REPLICAS IMAGE\n4cdgfyky7ozw redis replicated
\ 3/5 redis:3.0.7\n```\n\nOnce all the tasks are created and `RUNNING`, the
actual number of tasks is\nequal to the desired number:\n\n```bash\n$ docker service
ls\n\nID NAME MODE REPLICAS IMAGE\n4cdgfyky7ozw redis replicated
\ 5/5 redis:3.0.7\n```\n\n### Create a service with secrets\n\nUse the `--secret`
flag to give a container access to a\n[secret](secret_create.md).\n\nCreate a service
specifying a secret:\n\n```bash\n$ docker service create --name redis --secret secret.json
redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nCreate a service specifying the
secret, target, user/group ID, and mode:\n\n```bash\n$ docker service create --name
redis \\\n --secret source=ssh-key,target=ssh \\\n --secret source=app-key,target=app,uid=1000,gid=1001,mode=0400
\\\n redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nTo grant a service access
to multiple secrets, use multiple `--secret` flags.\n\nSecrets are located in `/run/secrets`
in the container. If no target is\nspecified, the name of the secret will be used
as the in memory file in the\ncontainer. If a target is specified, that will be
the filename. In the\nexample above, two files will be created: `/run/secrets/ssh`
and\n`/run/secrets/app` for each of the secret targets specified.\n\n### Create
a service with a rolling update policy\n\n```bash\n$ docker service create \\\n
\ --replicas 10 \\\n --name redis \\\n --update-delay 10s \\\n --update-parallelism
2 \\\n redis:3.0.6\n```\n\nWhen you run a [service update](service_update.md),
the scheduler updates a\nmaximum of 2 tasks at a time, with `10s` between updates.
For more information,\nrefer to the [rolling updates\ntutorial](https://docs.docker.com/engine/swarm/swarm-tutorial/rolling-update/).\n\n###
Set environment variables (-e, --env)\n\nThis sets an environmental variable for
@ -863,45 +855,41 @@ examples: "### Create a service\n\n```bash\n$ docker service create --name redis
node the docker network create\ncommand:\n\n```bash\n$ docker network create --driver
overlay my-network\n\netjpu59cykrptrgw0z0hk5snf\n```\n\nAfter you create an overlay
network in swarm mode, all manager nodes have\naccess to the network.\n\nWhen you
create a service and pass the `--network` flag to attach the service to\nthe overlay
create a service and pass the --network flag to attach the service to\nthe overlay
network:\n\n```bash\n$ docker service create \\\n --replicas 3 \\\n --network
my-network \\\n --name my-web \\\n nginx\n\n716thylsndqma81j6kkkb5aus\n```\n\nThe
swarm extends my-network to each node running the service.\n\nContainers on the
same network can access each other using\n[service discovery](https://docs.docker.com/engine/swarm/networking/#use-swarm-mode-service-discovery).\n\nLong
form syntax of `--network` allows to specify list of aliases and driver options:
\ \n`--network name=my-network,alias=web1,driver-opt=field1=value1`\n\n### Publish
service ports externally to the swarm (-p, --publish)\n\nYou can publish service
ports to make them available externally to the swarm\nusing the `--publish` flag.
The `--publish` flag can take two different styles\nof arguments. The short version
is positional, and allows you to specify the\npublished port and target port separated
by a colon.\n\n```bash\n$ docker service create --name my_web --replicas 3 --publish
8080:80 nginx\n```\n\nThere is also a long format, which is easier to read and allows
you to specify\nmore options. The long format is preferred. You cannot specify the
service's\nmode when using the short format. Here is an example 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>\n</thead>\n<tr>\n <td>published
and target port</td>\n <td><tt>--publish 8080:80</tt></td>\n <td><tt>--publish
published=8080,target=80</tt></td>\n <td><p>\n The target port within the container
and the port to map it to on the\n nodes, using the routing mesh (<tt>ingress</tt>)
or host-level networking.\n More options are available, later in this table.
The key-value syntax is\n preferred, because it is somewhat self-documenting.\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 <tt>ingress</tt> or
<tt>host</tt>.\n Defaults to <tt>ingress</tt> to use the routing mesh.\n </p></td>\n</tr>\n<tr>\n
same network can access each other using\n[service discovery](https://docs.docker.com/engine/swarm/networking/#use-swarm-mode-service-discovery).\n\n###
Publish service ports externally to the swarm (-p, --publish)\n\nYou can publish
service ports to make them available externally to the swarm\nusing the `--publish`
flag. The `--publish` flag can take two different styles\nof arguments. The short
version is positional, and allows you to specify the\npublished port and target
port separated by a colon.\n\n```bash\n$ docker service create --name my_web --replicas
3 --publish 8080:80 nginx\n```\n\nThere is also a long format, which is easier to
read and allows you to specify\nmore options. The long format is preferred. You
cannot specify the service's\nmode when using the short format. Here is an example
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>\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
published=8080,target=80,protocol=tcp</tt></td>\n <td><p>\n The protocol to
use, <tt>tcp</tt> , <tt>udp</tt>, or <tt>sctp</tt>. Defaults to\n <tt>tcp</tt>.
To bind a port for both protocols, specify the <tt>-p</tt> or\n <tt>--publish</tt>
flag twice.\n </p></td>\n</tr>\n</table>\n\nWhen you publish a service port using
`ingress` mode, the swarm routing mesh\nmakes the service accessible at the published
port on every node regardless if\nthere is a task for the service running on the
node. If you use `host` mode,\nthe port is only bound on nodes where the service
is running, and a given port\non a node can only be bound once. You can only set
the publication mode using\nthe long syntax. For more information refer to\n[Use
swarm mode routing mesh](https://docs.docker.com/engine/swarm/ingress/).\n\n###
use, either `tcp` or `udp`. Defaults to `tcp`. To bind a\n port for both protocols,
specify the `-p` or `--publish` flag twice.\n </p></td>\n</tr>\n</table>\n\nWhen
you publish a service port using `ingres` mode, the swarm routing mesh\nmakes the
service accessible at the published port on every node regardless if\nthere is a
task for the service running on the node. If you use `host` mode,\nthe port is only
bound on nodes where the service is running, and a given port\non a node can only
be bound once. You can only set the publication mode using\nthe long syntax. For
more information refer to\n[Use swarm mode routing mesh](https://docs.docker.com/engine/swarm/ingress/).\n\n###
Provide credential specs for managed service accounts (Windows only)\n\nThis option
is only used for services using Windows containers. The\n`--credential-spec` must
be in the format `file://<filename>` or\n`registry://<value-name>`.\n\nWhen using
@ -933,8 +921,8 @@ examples: "### Create a service\n\n```bash\n$ docker service create --name redis
\ 2e7a8a9c4da2 Running Running about a minute ago\n\n$ docker inspect --format=\"{{.Config.Hostname}}\"
2e7a8a9c4da2-wo41w8hg8qanxwjwsg4kxpprj-hosttempl\n\nx3ti0erg11rjpg64m75kej2mz-hosttempl\n```\n\n###
Specify isolation mode (Windows)\n\nBy default, tasks scheduled on Windows nodes
are run using the default isolation mode\nconfigured for this particular node. To
force a specific isolation mode, you can use\nthe `--isolation` flag:\n\n```bash\n$
are run using the default isolation mode \nconfigured for this particular node.
To force a specific isolation mode, you can use \nthe `--isolation` flag: \n\n```bash\n$
docker service create --name myservice --isolation=process microsoft/nanoserver\n```\n\nSupported
isolation modes on Windows are:\n- `default`: use default settings specified on
the node running the task\n- `process`: use process isolation (Windows server only)\n-

18
_data/engine-cli-edge/docker_service_update.yaml
View File

@ -795,7 +795,7 @@ examples: |-
Use the `--publish-add` or `--publish-rm` flags to add or remove a published
port for a service. You can use the short or long syntax discussed in the
[docker service create](service_create/#publish-service-ports-externally-to-the-swarm)
[docker service create](service_create/#attach-a-service-to-an-existing-network-network)
reference.
The following example adds a published service port to an existing service.
@ -806,22 +806,6 @@ examples: |-
myservice
```
### Add or remove network
Use the `--network-add` or `--network-rm` flags to add or remove a network for
a service. You can use the short or long syntax discussed in the
[docker service create](service_create/#attach-a-service-to-an-existing-network-network)
reference.
The following example adds a new alias name to an existing service already connected to network my-network:
```bash
$ docker service update \
--network-rm my-network \
--network-add name=my-network,alias=web1 \
myservice
```
### Roll back to the previous version of a service
Use the `--rollback` option to roll back to the previous version of the service.

13
_data/engine-cli-edge/docker_stack_deploy.yaml
View File

@ -18,8 +18,7 @@ options:
swarm: true
- option: compose-file
shorthand: c
value_type: stringSlice
default_value: '[]'
value_type: string
description: Path to a Compose file
deprecated: false
min_api_version: "1.25"
@ -112,12 +111,14 @@ examples: |-
Creating service vossibility_lookupd
```
If your configuration is split between multiple Compose files, e.g. a base
configuration and environment-specific overrides, you can provide multiple
`--compose-file` flags.
Only a single Compose file is accepted. If your configuration is split between
multiple Compose files, e.g. a base configuration and environment-specific overrides,
you can combine these by passing them to `docker-compose config` with the `-f` option
and redirecting the merged output into a new file.
```bash
$ docker stack deploy --compose-file docker-compose.yml -f docker-compose.prod.yml vossibility
$ docker-compose -f docker-compose.yml -f docker-compose.prod.yml config > docker-stack.yml
$ docker stack deploy --compose-file docker-stack.yml vossibility
Ignoring unsupported options: links

12
_data/engine-cli-edge/docker_stats.yaml
View File

@ -59,18 +59,6 @@ examples: |-
4bda148efbc0 random.1.vnc8on831idyr42slu578u3cr 0.00% 1.672MiB / 1.952GiB 0.08% 110kB / 0B 578kB / 0B 2
```
If you don't [specify a format string using `--format`](#formatting), the
following columns are shown.
| Column name | Description |
|---------------------------|-----------------------------------------------------------------------------------------------|
| `CONTAINER ID` and `Name` | the ID and name of the container |
| `CPU %` and `MEM %` | the percentage of the host's CPU and memory the container is using |
| `MEM USAGE / LIMIT` | the total memory the container is using, and the total amount of memory it is allowed to use |
| `NET I/O` | The amount of data the container has sent and received over its network interface |
| `BLOCK I/O` | The amount of data the container has read to and written from block devices on the host |
| `PIDs` | the number of processes or threads the container has created |
Running `docker stats` on multiple containers by name and id against a Linux daemon.
```bash

2
_data/engine-cli-edge/docker_swarm_ca.yaml
View File

@ -139,7 +139,7 @@ examples: |-
The root CA rotation will not be completed until all registered nodes have
rotated their TLS certificates. If the rotation is not completing within a
reasonable amount of time, try running
`docker node ls --format '{{.ID}} {{.Hostname}} {{.Status}} {{.TLSStatus}}'` to
`docker node ls --format {{.ID}} {{.Hostname}} {{.Status}} {{.TLSStatus}}` to
see if any nodes are down or otherwise unable to rotate TLS certificates.

8
_data/engine-cli-edge/docker_trust.yaml
View File

@ -1,6 +1,6 @@
command: docker trust
short: Manage trust on Docker images
long: Manage trust on Docker images
short: Manage trust on Docker images (experimental)
long: Manage trust on Docker images (experimental)
usage: docker trust
pname: docker
plink: docker.yaml
@ -10,15 +10,17 @@ cname:
- docker trust revoke
- docker trust sign
- docker trust signer
- docker trust view
clink:
- docker_trust_inspect.yaml
- docker_trust_key.yaml
- docker_trust_revoke.yaml
- docker_trust_sign.yaml
- docker_trust_signer.yaml
- docker_trust_view.yaml
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

96
_data/engine-cli-edge/docker_trust_inspect.yaml
View File

@ -4,19 +4,14 @@ long: |-
`docker trust inspect` provides low-level JSON information on signed repositories.
This includes all image tags that are signed, who signed them, and who can sign
new tags.
`docker trust inspect` prints the trust information in a machine-readable format. Refer to
[`docker trust view`](trust_view.md) for a human-friendly output.
`docker trust inspect` is currently experimental.
usage: docker trust inspect IMAGE[:TAG] [IMAGE[:TAG]...]
pname: docker trust
plink: docker_trust.yaml
options:
- option: pretty
value_type: bool
default_value: "false"
description: Print the information in a human friendly format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Get low-level details about signatures for a single image tag\n\nUse
the `docker trust inspect` to get trust information about an image. The\nfollowing
example prints trust information for the `alpine:latest` image:\n\n```bash\n$ docker
@ -28,15 +23,16 @@ examples: "### Get low-level details about signatures for a single image tag\n\n
\ }\n ]\n },\n {\n \"Name\": \"Root\",\n \"Keys\":
[\n {\n \"ID\": \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n
\ }\n ]\n }\n ]\n }\n]\n```\n\nThe `SignedTags` key will
list the `SignedTag` name, its `Digest`,\nand the `Signers` responsible for the
signature.\n\n`AdministrativeKeys` will list the `Repository` and `Root` keys.\n\nIf
signers are set up for the repository via other `docker trust`\ncommands, `docker
trust inspect` includes a `Signers` key:\n\n```bash\n$ docker trust inspect my-image:purple\n[\n
\ {\n \"Name\": \"my-image:purple\",\n \"SignedTags\": [\n {\n \"SignedTag\":
\"purple\",\n \"Digest\": \"941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557\",\n
\ \"Signers\": [\n \"alice\",\n \"bob\",\n \"carol\"\n
\ ]\n }\n ],\n \"Signers\": [\n {\n \"Name\": \"alice\",\n
\ \"Keys\": [\n {\n \"ID\": \"04dd031411ed671ae1e12f47ddc8646d98f135090b01e54c3561e843084484a3\"\n
list the `SignedTag` name, its `Digest`, and the `Signers` responsible for the signature.\n\n`AdministrativeKeys`
will list the `Repository` and `Root` keys.\n\nThis format mirrors the output of
`docker trust view` \n\nIf signers are set up for the repository via other `docker
trust` commands, `docker trust inspect` includes a `Signers` key:\n\n```bash\n$
docker trust inspect my-image:purple\n[\n {\n \"Name\": \"my-image:purple\",\n
\ \"SignedTags\": [\n {\n \"SignedTag\": \"purple\",\n \"Digest\":
\"941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557\",\n \"Signers\":
[\n \"alice\",\n \"bob\",\n \"carol\"\n ]\n }\n
\ ],\n \"Signers\": [\n {\n \"Name\": \"alice\",\n \"Keys\":
[\n {\n \"ID\": \"04dd031411ed671ae1e12f47ddc8646d98f135090b01e54c3561e843084484a3\"\n
\ },\n {\n \"ID\": \"6a11e4898a4014d400332ab0e096308c844584ff70943cdd1d6628d577f45fd8\"\n
\ }\n ]\n },\n {\n \"Name\": \"bob\",\n \"Keys\":
[\n {\n \"ID\": \"433e245c656ae9733cdcc504bfa560f90950104442c4528c9616daa45824ccba\"\n
@ -49,9 +45,9 @@ examples: "### Get low-level details about signatures for a single image tag\n\n
\ ]\n },\n {\n \"Name\": \"Root\",\n \"Keys\": [\n
\ {\n \"ID\": \"40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\"\n
\ }\n ]\n }\n ]\n }\n]\n```\n\nIf the image tag is unsigned
or unavailable, `docker trust inspect` does not\ndisplay any signed tags.\n\n```bash\n$
or unavailable, `docker trust inspect` does not display any signed tags.\n\n```bash\n$
docker trust inspect unsigned-img\nNo signatures or cannot access unsigned-img\n```\n\nHowever,
if other tags are signed in the same image repository,\n`docker trust inspect` reports
if other tags are signed in the same image repository, `docker trust inspect` reports
relevant key information:\n\n```bash\n$ docker trust inspect alpine:unsigned\n[\n
\ {\n \"Name\": \"alpine:unsigned\",\n \"Signers\": [],\n \"AdminstrativeKeys\":
[\n {\n \"Name\": \"Repository\",\n \"Keys\": [\n {\n
@ -60,7 +56,7 @@ examples: "### Get low-level details about signatures for a single image tag\n\n
[\n {\n \"ID\": \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n
\ }\n ]\n }\n ]\n }\n]\n```\n\n### Get details about signatures
for all image tags in a repository\n\nIf no tag is specified, `docker trust inspect`
will report details for all\nsigned tags in the repository:\n\n```bash\n$ docker
will report details for all signed tags in the repository:\n\n```bash\n$ docker
trust inspect alpine\n[\n {\n \"Name\": \"alpine\",\n \"SignedTags\":
[\n {\n \"SignedTag\": \"3.5\",\n \"Digest\":
\"b007a354427e1880de9cdba533e8e57382b7f2853a68a478a17d447b302c219c\",\n \"Signers\":
@ -80,7 +76,7 @@ examples: "### Get low-level details about signatures for a single image tag\n\n
\"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n }\n
\ ]\n }\n ]\n }\n]\n```\n\n\n### Get details
about signatures for multiple images\n\n`docker trust inspect` can take multiple
repositories and images as arguments,\nand reports the results in an ordered list:\n\n```bash\n$
repositories and images as arguments, and reports the results in an ordered list:\n\n```bash\n$
docker trust inspect alpine notary\n[\n {\n \"Name\": \"alpine\",\n \"SignedTags\":
[\n {\n \"SignedTag\": \"3.5\",\n \"Digest\":
\"b007a354427e1880de9cdba533e8e57382b7f2853a68a478a17d447b302c219c\",\n \"Signers\":
@ -114,60 +110,10 @@ examples: "### Get low-level details about signatures for a single image tag\n\n
\ ]\n },\n {\n \"Name\": \"Repository\",\n
\ \"Keys\": [\n {\n \"ID\":
\"85bfd031017722f950d480a721f845a2944db26a3dc084040a70f1b0d9bbb3df\"\n }\n
\ ]\n }\n ]\n }\n]\n```\n\n### Formatting\n\nYou
can print the inspect output in a human-readable format instead of the default\nJSON
output, by using the `--pretty` option:\n\n### Get details about signatures for
a single image tag\n\n```bash\n$ docker trust inspect --pretty alpine:latest\n\nSIGNED
TAG DIGEST SIGNERS\nlatest
\ 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe (Repo
Admin)\n\nAdministrative keys for alpine:latest:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot
Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nThe
`SIGNED TAG` is the signed image tag with a unique content-addressable\n`DIGEST`.
`SIGNERS` lists all entities who have signed.\n\nThe administrative keys listed
specify the root key of trust, as well as\nthe administrative repository key. These
keys are responsible for modifying\nsigners, and rotating keys for the signed repository.\n\nIf
signers are set up for the repository via other `docker trust` commands,\n`docker
trust inspect --pretty` displays them appropriately as a `SIGNER`\nand specify their
`KEYS`:\n\n```bash\n$ docker trust inspect --pretty my-image:purple\nSIGNED TAG
\ DIGEST SIGNERS\npurple
\ 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557 alice,
bob, carol\n\nList of signers and their keys:\n\nSIGNER KEYS\nalice
\ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol
\ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot
Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```\n\nHowever,
if other tags are signed in the same image repository,\n`docker trust inspect` reports
relevant key information.\n\n```bash\n$ docker trust inspect --pretty alpine:unsigned\n\nNo
signatures for alpine:unsigned\n\n\nAdministrative keys for alpine:unsigned:\nRepository
Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\n###
Get details about signatures for all image tags in a repository\n\n```bash\n$ docker
trust inspect --pretty alpine\nSIGNED TAG DIGEST SIGNERS\n2.6
\ 9ace551613070689a12857d62c30ef0daa9a376107ec0fff0e34786cedb3399b
\ (Repo Admin)\n2.7 9f08005dff552038f0ad2f46b8e65ff3d25641747d3912e3ea8da6785046561a
\ (Repo Admin)\n3.1 d9477888b78e8c6392e0be8b2e73f8c67e2894ff9d4b8e467d1488fcceec21c8
\ (Repo Admin)\n3.2 19826d59171c2eb7e90ce52bfd822993bef6a6fe3ae6bb4a49f8c1d0a01e99c7
\ (Repo Admin)\n3.3 8fd4b76819e1e5baac82bd0a3d03abfe3906e034cc5ee32100d12aaaf3956dc7
\ (Repo Admin)\n3.4 833ad81ace8277324f3ca8c91c02bdcf1d13988d8ecf8a3f97ecdd69d0390ce9
\ (Repo Admin)\n3.5 af2a5bd2f8de8fc1ecabf1c76611cdc6a5f1ada1a2bdd7d3816e121b70300308
\ (Repo Admin)\n3.6 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe
\ (Repo Admin)\nedge 79d50d15bd7ea48ea00cf3dd343b0e740c1afaa8e899bee475236ef338e1b53b
\ (Repo Admin)\nlatest 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe
\ (Repo Admin)\n\nAdministrative keys for alpine:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot
Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nHere's
an example with signers that are set up by `docker trust` commands:\n\n```bash\n$
docker trust inspect --pretty my-image\nSIGNED TAG DIGEST SIGNERS\nred
\ 852cc04935f930a857b630edc4ed6131e91b22073bcc216698842e44f64d2943
\ alice\nblue f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197
\ alice, bob\ngreen cae8fedc840f90c8057e1c24637d11865743ab1e61a972c1c9da06ec2de9a139
\ alice, bob\nyellow 9cc65fc3126790e683d1b92f307a71f48f75fa7dd47a7b03145a123eaf0b45ba
\ carol\npurple 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557
\ alice, bob, carol\norange d6c271baa6d271bcc24ef1cbd65abf39123c17d2e83455bdab545a1a9093fc1c
\ alice\n\nList of signers and their keys for my-image:\n\nSIGNER KEYS\nalice
\ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol
\ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot
Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```"
\ ]\n }\n ]\n }\n]\n```"
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_trust_key.yaml
View File

@ -1,6 +1,6 @@
command: docker trust key
short: Manage keys for signing Docker images
long: Manage keys for signing Docker images
short: Manage keys for signing Docker images (experimental)
long: Manage keys for signing Docker images (experimental)
usage: docker trust key
pname: docker trust
plink: docker_trust.yaml
@ -12,7 +12,7 @@ clink:
- docker_trust_key_load.yaml
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

2
_data/engine-cli-edge/docker_trust_key_generate.yaml
View File

@ -15,7 +15,7 @@ options:
swarm: false
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

2
_data/engine-cli-edge/docker_trust_key_load.yaml
View File

@ -16,7 +16,7 @@ options:
swarm: false
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

7
_data/engine-cli-edge/docker_trust_revoke.yaml
View File

@ -1,6 +1,9 @@
command: docker trust revoke
short: Remove trust for an image
long: '`docker trust revoke` removes signatures from tags in signed repositories.'
long: |-
`docker trust revoke` removes signatures from tags in signed repositories.
`docker trust revoke` is currently experimental.
usage: docker trust revoke [OPTIONS] IMAGE[:TAG]
pname: docker trust
plink: docker_trust.yaml
@ -55,7 +58,7 @@ examples: "### Revoke signatures from a signed tag\n\nHere's an example of a rep
Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```"
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

7
_data/engine-cli-edge/docker_trust_sign.yaml
View File

@ -1,6 +1,9 @@
command: docker trust sign
short: Sign an image
long: '`docker trust sign` adds signatures to tags to create signed repositories.'
long: |-
`docker trust sign` adds signatures to tags to create signed repositories.
`docker trust sign` is currently experimental.
usage: docker trust sign IMAGE:TAG
pname: docker trust
plink: docker_trust.yaml
@ -54,7 +57,7 @@ examples: "### Sign a tag as a repo admin\n\nGiven an image:\n\n```bash\n$ docke
Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```"
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_trust_signer.yaml
View File

@ -1,6 +1,6 @@
command: docker trust signer
short: Manage entities who can sign Docker images
long: Manage entities who can sign Docker images
short: Manage entities who can sign Docker images (experimental)
long: Manage entities who can sign Docker images (experimental)
usage: docker trust signer
pname: docker trust
plink: docker_trust.yaml
@ -12,7 +12,7 @@ clink:
- docker_trust_signer_remove.yaml
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

2
_data/engine-cli-edge/docker_trust_signer_add.yaml
View File

@ -15,7 +15,7 @@ options:
swarm: false
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

2
_data/engine-cli-edge/docker_trust_signer_remove.yaml
View File

@ -18,7 +18,7 @@ options:
swarm: false
deprecated: false
experimental: false
experimentalcli: false
experimentalcli: true
kubernetes: false
swarm: false

69
_data/engine-cli-edge/docker_trust_view.yaml Normal file
View File

@ -0,0 +1,69 @@
command: docker trust view
short: Display detailed information about keys and signatures
long: |-
`docker trust view` provides detailed information on signed repositories.
This includes all image tags that are signed, who signed them, and who can sign
new tags.
By default, `docker trust view` renders results in a table.
`docker trust view` is currently experimental.
usage: docker trust view IMAGE[:TAG]
pname: docker trust
plink: docker_trust.yaml
examples: "### Get details about signatures for a single image tag\n\n\n```bash\n$
docker trust view alpine:latest\n\nSIGNED TAG DIGEST SIGNERS\nlatest
\ 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe (Repo
Admin)\n\nAdministrative keys for alpine:latest:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot
Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nThe
`SIGNED TAG` is the signed image tag with a unique content-addressable `DIGEST`.
`SIGNERS` lists all entities who have signed.\n\nThe administrative keys listed
specify the root key of trust, as well as the administrative repository key. These
keys are responsible for modifying signers, and rotating keys for the signed repository.\n\nIf
signers are set up for the repository via other `docker trust` commands, `docker
trust view` displays them appropriately as a `SIGNER` and specify their `KEYS`:\n\n```bash\n$
docker trust view my-image:purple\nSIGNED TAG DIGEST SIGNERS\npurple
\ 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557 alice,
bob, carol\n\nList of signers and their keys:\n\nSIGNER KEYS\nalice
\ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol
\ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot
Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```\n\nIf
the image tag is unsigned or unavailable, `docker trust view` does not display any
signed tags.\n\n```bash\n$ docker trust view unsigned-img\nNo signatures or cannot
access unsigned-img\n```\n\nHowever, if other tags are signed in the same image
repository, `docker trust view` reports relevant key information.\n\n```bash\n$
docker trust view alpine:unsigned\n\nNo signatures for alpine:unsigned\n\n\nAdministrative
keys for alpine:unsigned:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot
Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\n###
Get details about signatures for all image tags in a repository\n\n```bash\n$ docker
trust view alpine\nSIGNED TAG DIGEST SIGNERS\n2.6
\ 9ace551613070689a12857d62c30ef0daa9a376107ec0fff0e34786cedb3399b
\ (Repo Admin)\n2.7 9f08005dff552038f0ad2f46b8e65ff3d25641747d3912e3ea8da6785046561a
\ (Repo Admin)\n3.1 d9477888b78e8c6392e0be8b2e73f8c67e2894ff9d4b8e467d1488fcceec21c8
\ (Repo Admin)\n3.2 19826d59171c2eb7e90ce52bfd822993bef6a6fe3ae6bb4a49f8c1d0a01e99c7
\ (Repo Admin)\n3.3 8fd4b76819e1e5baac82bd0a3d03abfe3906e034cc5ee32100d12aaaf3956dc7
\ (Repo Admin)\n3.4 833ad81ace8277324f3ca8c91c02bdcf1d13988d8ecf8a3f97ecdd69d0390ce9
\ (Repo Admin)\n3.5 af2a5bd2f8de8fc1ecabf1c76611cdc6a5f1ada1a2bdd7d3816e121b70300308
\ (Repo Admin)\n3.6 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe
\ (Repo Admin)\nedge 79d50d15bd7ea48ea00cf3dd343b0e740c1afaa8e899bee475236ef338e1b53b
\ (Repo Admin)\nlatest 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe
\ (Repo Admin)\n\nAdministrative keys for alpine:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot
Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nHere's
an example with signers that are set up by `docker trust` commands:\n\n```bash\n$
docker trust view my-image\nSIGNED TAG DIGEST SIGNERS\nred
\ 852cc04935f930a857b630edc4ed6131e91b22073bcc216698842e44f64d2943
\ alice\nblue f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197
\ alice, bob\ngreen cae8fedc840f90c8057e1c24637d11865743ab1e61a972c1c9da06ec2de9a139
\ alice, bob\nyellow 9cc65fc3126790e683d1b92f307a71f48f75fa7dd47a7b03145a123eaf0b45ba
\ carol\npurple 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557
\ alice, bob, carol\norange d6c271baa6d271bcc24ef1cbd65abf39123c17d2e83455bdab545a1a9093fc1c
\ alice\n\nList of signers and their keys for my-image:\n\nSIGNER KEYS\nalice
\ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol
\ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot
Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```"
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

8
_data/engine-cli-edge/docker_volume_prune.yaml
View File

@ -1,7 +1,7 @@
command: docker volume prune
short: Remove all unused local volumes
long: Remove all unused local volumes. Unused local volumes are those which are not
referenced by any containers
short: Remove all unused volumes
long: Remove all unused volumes. Unused volumes are those which are not referenced
by any conta
usage: docker volume prune [OPTIONS]
pname: docker volume
plink: docker_volume.yaml
@ -28,7 +28,7 @@ examples: |-
```bash
$ docker volume prune
WARNING! This will remove all local volumes not used by at least one container.
WARNING! This will remove all volumes not used by at least one container.
Are you sure you want to continue? [y/N] y
Deleted Volumes:
07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e

5
_data/engine-cli/docker.yaml
View File

@ -24,7 +24,6 @@ cname:
- docker login
- docker logout
- docker logs
- docker manifest
- docker network
- docker node
- docker pause
@ -81,7 +80,6 @@ clink:
- docker_login.yaml
- docker_logout.yaml
- docker_logs.yaml
- docker_manifest.yaml
- docker_network.yaml
- docker_node.yaml
- docker_pause.yaml
@ -115,7 +113,4 @@ clink:
- docker_wait.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli/docker_attach.yaml
View File

@ -69,27 +69,18 @@ options:
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stdin
value_type: bool
default_value: "false"
description: Do not attach STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy all received signals to the process
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Attach to and detach from a running container
@ -160,7 +151,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

96
_data/engine-cli/docker_build.yaml
View File

@ -112,61 +112,40 @@ options:
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg
value_type: list
description: Set build-time variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from
value_type: stringSlice
default_value: '[]'
description: Images to consider as cache sources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: compress
value_type: bool
default_value: "false"
description: Compress the build context using gzip
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -174,76 +153,49 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm
value_type: bool
default_value: "false"
description: Always remove intermediate containers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: iidfile
value_type: string
description: Write the image ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
value_type: list
description: Set metadata for an image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -251,9 +203,6 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -261,9 +210,6 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
@ -272,36 +218,24 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -309,36 +243,24 @@ options:
description: Suppress the build output and print image ID on success
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "true"
description: Remove intermediate containers after a successful build
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: stringSlice
default_value: '[]'
description: Security options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: squash
value_type: bool
default_value: "false"
@ -346,9 +268,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: stream
value_type: bool
default_value: "false"
@ -356,35 +275,23 @@ options:
deprecated: false
min_api_version: "1.31"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: list
description: Name and optionally a tag in the 'name:tag' format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target
value_type: string
description: Set the target build stage to build.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240
bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284
MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh
@ -569,7 +476,4 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
make sure the `HELLO` envvar's value is `world`."
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_checkpoint.yaml
View File

@ -15,7 +15,4 @@ clink:
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_checkpoint_create.yaml
View File

@ -10,22 +10,13 @@ options:
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave-running
value_type: bool
default_value: "false"
description: Leave the container running after checkpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_checkpoint_ls.yaml
View File

@ -11,13 +11,7 @@ options:
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_checkpoint_rm.yaml
View File

@ -11,13 +11,7 @@ options:
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_commit.yaml
View File

@ -28,27 +28,18 @@ options:
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
@ -56,9 +47,6 @@ options:
description: Pause container during commit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Commit a container
@ -127,7 +115,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_config.yaml
View File

@ -17,7 +17,4 @@ clink:
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

18
_data/engine-cli/docker_config_create.yaml
View File

@ -1,6 +1,6 @@
command: docker config create
short: Create a config from a file or STDIN
long: Create a config from a file or STDIN
short: Create a configuration file from a file or STDIN as content
long: Create a configuration file from a file or STDIN as content
usage: docker config create [OPTIONS] CONFIG file|-
pname: docker config
plink: docker_config.yaml
@ -11,21 +11,7 @@ options:
description: Config labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: template-driver
value_type: string
description: Template driver
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

13
_data/engine-cli/docker_config_inspect.yaml
View File

@ -1,6 +1,6 @@
command: docker config inspect
short: Display detailed information on one or more configs
long: Display detailed information on one or more configs
short: Display detailed information on one or more configuration files
long: Display detailed information on one or more configuration files
usage: docker config inspect [OPTIONS] CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml
@ -11,22 +11,13 @@ options:
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pretty
value_type: bool
default_value: "false"
description: Print the information in a human friendly format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

12
_data/engine-cli/docker_config_ls.yaml
View File

@ -12,17 +12,11 @@ options:
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print configs using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -30,13 +24,7 @@ options:
description: Only display IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

7
_data/engine-cli/docker_config_rm.yaml
View File

@ -1,14 +1,11 @@
command: docker config rm
aliases: remove
short: Remove one or more configs
long: Remove one or more configs
short: Remove one or more configuration files
long: Remove one or more configuration files
usage: docker config rm CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

3
_data/engine-cli/docker_container.yaml
View File

@ -58,7 +58,4 @@ clink:
- docker_container_wait.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli/docker_container_attach.yaml
View File

@ -10,30 +10,18 @@ options:
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stdin
value_type: bool
default_value: "false"
description: Do not attach STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy all received signals to the process
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_container_commit.yaml
View File

@ -11,27 +11,18 @@ options:
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
@ -39,12 +30,6 @@ options:
description: Pause container during commit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_container_cp.yaml
View File

@ -19,9 +19,6 @@ options:
description: Archive mode (copy all uid/gid information)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link
shorthand: L
value_type: bool
@ -29,12 +26,6 @@ options:
description: Always follow symbol link in SRC_PATH
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

291
_data/engine-cli/docker_container_create.yaml
View File

@ -10,18 +10,12 @@ options:
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach
shorthand: a
value_type: list
description: Attach to STDIN, STDOUT or STDERR
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight
value_type: uint16
default_value: "0"
@ -29,86 +23,56 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device
value_type: list
default_value: '[]'
description: Block IO weight (relative device weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add
value_type: list
description: Add Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop
value_type: list
description: Drop Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile
value_type: string
description: Write the container ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count
value_type: int64
default_value: "0"
description: CPU count (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
@ -116,9 +80,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
@ -126,9 +87,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -136,194 +94,125 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device
value_type: list
description: Add a host device to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule
value_type: list
description: Add a rule to the cgroup allowed devices list
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps
value_type: list
default_value: '[]'
description: Limit read rate (bytes per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops
value_type: list
default_value: '[]'
description: Limit read rate (IO per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps
value_type: list
default_value: '[]'
description: Limit write rate (bytes per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops
value_type: list
default_value: '[]'
description: Limit write rate (IO per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns
value_type: list
description: Set custom DNS servers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search
value_type: list
description: Set custom DNS search domains
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: entrypoint
value_type: string
description: Overwrite the default ENTRYPOINT of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file
value_type: list
description: Read in a file of environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose
value_type: list
description: Expose a port or a range of ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: group-add
value_type: list
description: Add additional groups to join
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd
value_type: string
description: Command to run to check health
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval
value_type: duration
default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries
value_type: int
default_value: "0"
description: Consecutive failures needed to report unhealthy
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period
value_type: duration
default_value: 0s
@ -332,9 +221,6 @@ options:
deprecated: false
min_api_version: "1.29"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout
value_type: duration
default_value: 0s
@ -342,27 +228,18 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname
shorthand: h
value_type: string
description: Container host name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init
value_type: bool
default_value: "false"
@ -371,9 +248,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -381,9 +255,6 @@ options:
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth
value_type: bytes
default_value: "0"
@ -391,116 +262,74 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops
value_type: uint64
default_value: "0"
description: Maximum IOps limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip
value_type: string
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6
value_type: string
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc
value_type: string
description: IPC mode to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
shorthand: l
value_type: list
description: Set meta data on a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file
value_type: list
description: Read in a line delimited file of labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link
value_type: list
description: Add link to another container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip
value_type: list
description: Container IPv4/IPv6 link-local addresses
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver
value_type: string
description: Logging driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt
value_type: list
description: Log driver options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address
value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -508,18 +337,12 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -527,139 +350,91 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness
value_type: int64
default_value: "-1"
description: Tune container memory swappiness (0 to 100)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount
value_type: mount
description: Attach a filesystem mount to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Assign a name to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck
value_type: bool
default_value: "false"
description: Disable any container-specified HEALTHCHECK
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable
value_type: bool
default_value: "false"
description: Disable OOM Killer
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj
value_type: int
default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid
value_type: string
description: PID namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit
value_type: int64
default_value: "0"
description: Tune container pids limit (set -1 for unlimited)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish
shorthand: p
value_type: list
description: Publish a container's port(s) to the host
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all
shorthand: P
value_type: bool
@ -667,70 +442,46 @@ options:
description: Publish all exposed ports to random ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only
value_type: bool
default_value: "false"
description: Mount the container's root filesystem as read only
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart
value_type: string
default_value: "no"
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "false"
description: Automatically remove the container when it exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime
value_type: string
description: Runtime to use for this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: list
description: Security Options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal
value_type: string
default_value: SIGTERM
description: Signal to stop a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout
value_type: int
default_value: "0"
@ -738,34 +489,22 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt
value_type: list
description: Storage driver options for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl
value_type: map
default_value: map[]
description: Sysctl options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs
value_type: list
description: Mount a tmpfs directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
@ -773,80 +512,50 @@ options:
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns
value_type: string
description: User namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts
value_type: string
description: UTS namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
shorthand: v
value_type: list
description: Bind mount a volume
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver
value_type: string
description: Optional volume driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from
value_type: list
description: Mount volumes from the specified container(s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_diff.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

27
_data/engine-cli/docker_container_exec.yaml
View File

@ -12,17 +12,11 @@ options:
description: 'Detached mode: run command in the background'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
@ -30,9 +24,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -40,18 +31,12 @@ options:
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the command
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
@ -59,18 +44,12 @@ options:
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
@ -78,12 +57,6 @@ options:
deprecated: false
min_api_version: "1.35"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_container_export.yaml
View File

@ -11,12 +11,6 @@ options:
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_container_inspect.yaml
View File

@ -11,9 +11,6 @@ options:
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size
shorthand: s
value_type: bool
@ -21,12 +18,6 @@ options:
description: Display total file sizes
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_container_kill.yaml
View File

@ -12,12 +12,6 @@ options:
description: Signal to send to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

21
_data/engine-cli/docker_container_logs.yaml
View File

@ -11,9 +11,6 @@ options:
description: Show extra details provided to logs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow
shorthand: f
value_type: bool
@ -21,27 +18,18 @@ options:
description: Follow log output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tail
value_type: string
default_value: all
description: Number of lines to show from the end of the logs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps
shorthand: t
value_type: bool
@ -49,9 +37,6 @@ options:
description: Show timestamps
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until
value_type: string
description: |
@ -59,12 +44,6 @@ options:
deprecated: false
min_api_version: "1.35"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

27
_data/engine-cli/docker_container_ls.yaml
View File

@ -13,26 +13,17 @@ options:
description: Show all containers (default shows just running)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print containers using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: last
shorthand: "n"
value_type: int
@ -40,9 +31,6 @@ options:
description: Show n last created containers (includes all states)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: latest
shorthand: l
value_type: bool
@ -50,18 +38,12 @@ options:
description: Show the latest created container (includes all states)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -69,9 +51,6 @@ options:
description: Only display numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size
shorthand: s
value_type: bool
@ -79,12 +58,6 @@ options:
description: Display total file sizes
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_pause.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_port.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

11
_data/engine-cli/docker_container_prune.yaml
View File

@ -10,9 +10,6 @@ options:
description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force
shorthand: f
value_type: bool
@ -20,9 +17,6 @@ options:
description: Do not prompt for confirmation
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Prune containers
@ -39,7 +33,7 @@ examples: |-
### Filtering
The filtering flag (`--filter`) format is of "key=value". If there is more
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are:
@ -110,7 +104,4 @@ examples: |-
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_rename.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_container_restart.yaml
View File

@ -12,12 +12,6 @@ options:
description: Seconds to wait for stop before killing the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli/docker_container_rm.yaml
View File

@ -12,9 +12,6 @@ options:
description: Force the removal of a running container (uses SIGKILL)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link
shorthand: l
value_type: bool
@ -22,9 +19,6 @@ options:
description: Remove the specified link
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes
shorthand: v
value_type: bool
@ -32,12 +26,6 @@ options:
description: Remove the volumes associated with the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

300
_data/engine-cli/docker_container_run.yaml
View File

@ -10,18 +10,12 @@ options:
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach
shorthand: a
value_type: list
description: Attach to STDIN, STDOUT or STDERR
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight
value_type: uint16
default_value: "0"
@ -29,86 +23,56 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device
value_type: list
default_value: '[]'
description: Block IO weight (relative device weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add
value_type: list
description: Add Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop
value_type: list
description: Drop Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile
value_type: string
description: Write the container ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count
value_type: int64
default_value: "0"
description: CPU count (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
@ -116,9 +80,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
@ -126,9 +87,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -136,34 +94,22 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach
shorthand: d
value_type: bool
@ -171,177 +117,114 @@ options:
description: Run container in background and print container ID
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device
value_type: list
description: Add a host device to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule
value_type: list
description: Add a rule to the cgroup allowed devices list
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps
value_type: list
default_value: '[]'
description: Limit read rate (bytes per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops
value_type: list
default_value: '[]'
description: Limit read rate (IO per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps
value_type: list
default_value: '[]'
description: Limit write rate (bytes per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops
value_type: list
default_value: '[]'
description: Limit write rate (IO per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns
value_type: list
description: Set custom DNS servers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search
value_type: list
description: Set custom DNS search domains
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: entrypoint
value_type: string
description: Overwrite the default ENTRYPOINT of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file
value_type: list
description: Read in a file of environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose
value_type: list
description: Expose a port or a range of ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: group-add
value_type: list
description: Add additional groups to join
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd
value_type: string
description: Command to run to check health
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval
value_type: duration
default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries
value_type: int
default_value: "0"
description: Consecutive failures needed to report unhealthy
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period
value_type: duration
default_value: 0s
@ -350,9 +233,6 @@ options:
deprecated: false
min_api_version: "1.29"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout
value_type: duration
default_value: 0s
@ -360,27 +240,18 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname
shorthand: h
value_type: string
description: Container host name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init
value_type: bool
default_value: "false"
@ -389,9 +260,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -399,9 +267,6 @@ options:
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth
value_type: bytes
default_value: "0"
@ -409,116 +274,74 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops
value_type: uint64
default_value: "0"
description: Maximum IOps limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip
value_type: string
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6
value_type: string
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc
value_type: string
description: IPC mode to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
shorthand: l
value_type: list
description: Set meta data on a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file
value_type: list
description: Read in a line delimited file of labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link
value_type: list
description: Add link to another container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip
value_type: list
description: Container IPv4/IPv6 link-local addresses
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver
value_type: string
description: Logging driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt
value_type: list
description: Log driver options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address
value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -526,18 +349,12 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -545,139 +362,91 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness
value_type: int64
default_value: "-1"
description: Tune container memory swappiness (0 to 100)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount
value_type: mount
description: Attach a filesystem mount to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Assign a name to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck
value_type: bool
default_value: "false"
description: Disable any container-specified HEALTHCHECK
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable
value_type: bool
default_value: "false"
description: Disable OOM Killer
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj
value_type: int
default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid
value_type: string
description: PID namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit
value_type: int64
default_value: "0"
description: Tune container pids limit (set -1 for unlimited)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish
shorthand: p
value_type: list
description: Publish a container's port(s) to the host
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all
shorthand: P
value_type: bool
@ -685,79 +454,52 @@ options:
description: Publish all exposed ports to random ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only
value_type: bool
default_value: "false"
description: Mount the container's root filesystem as read only
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart
value_type: string
default_value: "no"
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "false"
description: Automatically remove the container when it exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime
value_type: string
description: Runtime to use for this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: list
description: Security Options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy received signals to the process
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal
value_type: string
default_value: SIGTERM
description: Signal to stop a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout
value_type: int
default_value: "0"
@ -765,34 +507,22 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt
value_type: list
description: Storage driver options for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl
value_type: map
default_value: map[]
description: Sysctl options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs
value_type: list
description: Mount a tmpfs directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
@ -800,80 +530,50 @@ options:
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns
value_type: string
description: User namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts
value_type: string
description: UTS namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
shorthand: v
value_type: list
description: Bind mount a volume
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver
value_type: string
description: Optional volume driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from
value_type: list
description: Mount volumes from the specified container(s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

18
_data/engine-cli/docker_container_start.yaml
View File

@ -12,33 +12,21 @@ options:
description: Attach STDOUT/STDERR and forward signals
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint
value_type: string
description: Restore from this checkpoint
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -46,12 +34,6 @@ options:
description: Attach container's STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_container_stats.yaml
View File

@ -12,38 +12,23 @@ options:
description: Show all containers (default shows just running)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stream
value_type: bool
default_value: "false"
description: Disable streaming stats and only pull the first result
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Do not truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_container_stop.yaml
View File

@ -12,12 +12,6 @@ options:
description: Seconds to wait for stop before killing it
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_top.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_unpause.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

45
_data/engine-cli/docker_container_update.yaml
View File

@ -12,27 +12,18 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
@ -40,9 +31,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
@ -50,9 +38,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -60,43 +45,28 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.29"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -104,18 +74,12 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -123,20 +87,11 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart
value_type: string
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_container_wait.yaml
View File

@ -6,7 +6,4 @@ pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_cp.yaml
View File

@ -95,9 +95,6 @@ options:
description: Archive mode (copy all uid/gid information)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link
shorthand: L
value_type: bool
@ -105,12 +102,6 @@ options:
description: Always follow symbol link in SRC_PATH
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

291
_data/engine-cli/docker_create.yaml
View File

@ -21,18 +21,12 @@ options:
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach
shorthand: a
value_type: list
description: Attach to STDIN, STDOUT or STDERR
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight
value_type: uint16
default_value: "0"
@ -40,86 +34,56 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device
value_type: list
default_value: '[]'
description: Block IO weight (relative device weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add
value_type: list
description: Add Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop
value_type: list
description: Drop Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile
value_type: string
description: Write the container ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count
value_type: int64
default_value: "0"
description: CPU count (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
@ -127,9 +91,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
@ -137,9 +98,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -147,194 +105,125 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device
value_type: list
description: Add a host device to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule
value_type: list
description: Add a rule to the cgroup allowed devices list
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps
value_type: list
default_value: '[]'
description: Limit read rate (bytes per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops
value_type: list
default_value: '[]'
description: Limit read rate (IO per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps
value_type: list
default_value: '[]'
description: Limit write rate (bytes per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops
value_type: list
default_value: '[]'
description: Limit write rate (IO per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns
value_type: list
description: Set custom DNS servers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search
value_type: list
description: Set custom DNS search domains
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: entrypoint
value_type: string
description: Overwrite the default ENTRYPOINT of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file
value_type: list
description: Read in a file of environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose
value_type: list
description: Expose a port or a range of ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: group-add
value_type: list
description: Add additional groups to join
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd
value_type: string
description: Command to run to check health
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval
value_type: duration
default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries
value_type: int
default_value: "0"
description: Consecutive failures needed to report unhealthy
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period
value_type: duration
default_value: 0s
@ -343,9 +232,6 @@ options:
deprecated: false
min_api_version: "1.29"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout
value_type: duration
default_value: 0s
@ -353,27 +239,18 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname
shorthand: h
value_type: string
description: Container host name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init
value_type: bool
default_value: "false"
@ -382,9 +259,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -392,9 +266,6 @@ options:
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth
value_type: bytes
default_value: "0"
@ -402,116 +273,74 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops
value_type: uint64
default_value: "0"
description: Maximum IOps limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip
value_type: string
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6
value_type: string
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc
value_type: string
description: IPC mode to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
shorthand: l
value_type: list
description: Set meta data on a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file
value_type: list
description: Read in a line delimited file of labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link
value_type: list
description: Add link to another container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip
value_type: list
description: Container IPv4/IPv6 link-local addresses
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver
value_type: string
description: Logging driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt
value_type: list
description: Log driver options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address
value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -519,18 +348,12 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -538,139 +361,91 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness
value_type: int64
default_value: "-1"
description: Tune container memory swappiness (0 to 100)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount
value_type: mount
description: Attach a filesystem mount to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Assign a name to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck
value_type: bool
default_value: "false"
description: Disable any container-specified HEALTHCHECK
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable
value_type: bool
default_value: "false"
description: Disable OOM Killer
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj
value_type: int
default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid
value_type: string
description: PID namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit
value_type: int64
default_value: "0"
description: Tune container pids limit (set -1 for unlimited)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish
shorthand: p
value_type: list
description: Publish a container's port(s) to the host
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all
shorthand: P
value_type: bool
@ -678,70 +453,46 @@ options:
description: Publish all exposed ports to random ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only
value_type: bool
default_value: "false"
description: Mount the container's root filesystem as read only
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart
value_type: string
default_value: "no"
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "false"
description: Automatically remove the container when it exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime
value_type: string
description: Runtime to use for this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: list
description: Security Options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal
value_type: string
default_value: SIGTERM
description: Signal to stop a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout
value_type: int
default_value: "0"
@ -749,34 +500,22 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt
value_type: list
description: Storage driver options for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl
value_type: map
default_value: map[]
description: Sysctl options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs
value_type: list
description: Mount a tmpfs directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
@ -784,77 +523,50 @@ options:
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns
value_type: string
description: User namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts
value_type: string
description: UTS namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
shorthand: v
value_type: list
description: Bind mount a volume
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver
value_type: string
description: Optional volume driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from
value_type: list
description: Mount volumes from the specified container(s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create and start a container
@ -965,7 +677,4 @@ examples: |-
the create/run command
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

21
_data/engine-cli/docker_deploy.yaml
View File

@ -12,20 +12,13 @@ options:
description: Path to a Distributed Application Bundle file
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: true
- option: compose-file
shorthand: c
value_type: stringSlice
default_value: '[]'
value_type: string
description: Path to a Compose file
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: prune
value_type: bool
default_value: "false"
@ -33,9 +26,6 @@ options:
deprecated: false
min_api_version: "1.27"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true
- option: resolve-image
value_type: string
default_value: always
@ -44,18 +34,12 @@ options:
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Send registry authentication details to Swarm agents
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: true
examples: |-
### Compose file
@ -120,7 +104,4 @@ examples: |-
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: true

3
_data/engine-cli/docker_diff.yaml
View File

@ -43,7 +43,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

17
_data/engine-cli/docker_events.yaml
View File

@ -150,7 +150,7 @@ long: |-
* container (`container=<name or id>`)
* daemon (`daemon=<name or id>`)
* event (`event=<event action>`)
* image (`image=<repository or tag>`)
* image (`image=<tag or id>`)
* label (`label=<key>` or `label=<key>=<value>`)
* network (`network=<name or id>`)
* node (`node=<id>`)
@ -180,33 +180,21 @@ options:
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since
value_type: string
description: Show all events created since timestamp
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until
value_type: string
description: Stream events until this timestamp
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Basic example
@ -418,7 +406,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

27
_data/engine-cli/docker_exec.yaml
View File

@ -25,17 +25,11 @@ options:
description: 'Detached mode: run command in the background'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
@ -43,9 +37,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
@ -53,18 +44,12 @@ options:
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the command
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
@ -72,18 +57,12 @@ options:
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
@ -91,9 +70,6 @@ options:
deprecated: false
min_api_version: "1.35"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$
docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a
container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command
@ -118,7 +94,4 @@ examples: "### Run `docker exec` on a running container\n\nFirst, start a contai
paused, unpause the container before exec\n\n$ echo $?\n1\n```"
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

7
_data/engine-cli/docker_export.yaml
View File

@ -18,9 +18,6 @@ options:
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
Each of these commands has the same result.
@ -33,7 +30,3 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_history.yaml
View File

@ -10,9 +10,6 @@ options:
description: Pretty-print images using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: human
shorthand: H
value_type: bool
@ -20,18 +17,12 @@ options:
description: Print sizes and dates in human readable format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -39,9 +30,6 @@ options:
description: Only show numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
To see how the `docker:latest` image was built:
@ -105,7 +93,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_image.yaml
View File

@ -32,7 +32,4 @@ clink:
- docker_image_tag.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

96
_data/engine-cli/docker_image_build.yaml
View File

@ -10,61 +10,40 @@ options:
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg
value_type: list
description: Set build-time variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from
value_type: stringSlice
default_value: '[]'
description: Images to consider as cache sources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: compress
value_type: bool
default_value: "false"
description: Compress the build context using gzip
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
@ -72,76 +51,49 @@ options:
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm
value_type: bool
default_value: "false"
description: Always remove intermediate containers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: iidfile
value_type: string
description: Write the image ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
value_type: list
description: Set metadata for an image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
@ -149,9 +101,6 @@ options:
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
@ -159,9 +108,6 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
@ -170,36 +116,24 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -207,36 +141,24 @@ options:
description: Suppress the build output and print image ID on success
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "true"
description: Remove intermediate containers after a successful build
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: stringSlice
default_value: '[]'
description: Security options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: squash
value_type: bool
default_value: "false"
@ -244,9 +166,6 @@ options:
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: stream
value_type: bool
default_value: "false"
@ -254,38 +173,23 @@ options:
deprecated: false
min_api_version: "1.31"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: list
description: Name and optionally a tag in the 'name:tag' format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target
value_type: string
description: Set the target build stage to build.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_image_history.yaml
View File

@ -10,9 +10,6 @@ options:
description: Pretty-print images using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: human
shorthand: H
value_type: bool
@ -20,18 +17,12 @@ options:
description: Print sizes and dates in human readable format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -39,12 +30,6 @@ options:
description: Only show numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_image_import.yaml
View File

@ -11,21 +11,12 @@ options:
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Set commit message for imported image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_image_inspect.yaml
View File

@ -11,12 +11,6 @@ options:
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_image_load.yaml
View File

@ -11,9 +11,6 @@ options:
description: Read from tar archive file, instead of STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -21,12 +18,6 @@ options:
description: Suppress the load output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

21
_data/engine-cli/docker_image_ls.yaml
View File

@ -13,44 +13,29 @@ options:
description: Show all images (default hides intermediate images)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: digests
value_type: bool
default_value: "false"
description: Show digests
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -58,12 +43,6 @@ options:
description: Only show numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

60
_data/engine-cli/docker_image_prune.yaml
View File

@ -13,17 +13,11 @@ options:
description: Remove all unused images, not just dangling ones
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
value_type: filter
description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force
shorthand: f
value_type: bool
@ -31,11 +25,8 @@ options:
description: Do not prompt for confirmation
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
Example output:
examples: |2-
output:
```bash
$ docker image prune -a
@ -72,7 +63,7 @@ examples: |-
### Filtering
The filtering flag (`--filter`) format is of "key=value". If there is more
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are:
@ -97,19 +88,6 @@ examples: |-
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), which removes
images without the specified labels.
> **Predicting what will be removed**
>
> If you are using positive filtering (testing for the existence of a label or
> that a label has a specific value), you can use `docker image ls` with the
> same filtering syntax to see which images match your filter.
>
> However, if you are using negative filtering (testing for the absence of a
> label or that a label does *not* have a specific value), this type of filter
> does not work with `docker image ls` so you cannot easily predict which images
> will be removed. In addition, the confirmation prompt for `docker image prune`
> always warns that *all* dangling images will be removed, even if you are using
> `--filter`.
The following removes images created before `2017-01-04T00:00:00`:
```bash
@ -176,39 +154,7 @@ examples: |-
alpine latest 88e169ea8f46 8 days ago 3.98 MB
busybox latest e02e811dd08f 2 months ago 1.09 MB
```
The following example removes images with the label `deprecated`:
```bash
$ docker image prune --filter="label=deprecated"
```
The following example removes images with the label `maintainer` set to `john`:
```bash
$ docker image prune --filter="label=maintainer=john"
```
This example removes images which have no `maintainer` label:
```bash
$ docker image prune --filter="label!=maintainer"
```
This example removes images which have a maintainer label not set to `john`:
```bash
$ docker image prune --filter="label!=maintainer=john"
```
> **Note**: You are prompted for confirmation before the `prune` removes
> anything, but you are not shown a list of what will potentially be removed.
> In addition, `docker image ls` does not support negative filtering, so it
> difficult to predict what images will actually be removed.
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli/docker_image_pull.yaml
View File

@ -12,30 +12,18 @@ options:
description: Download all tagged images in the repository
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_image_push.yaml
View File

@ -11,12 +11,6 @@ options:
description: Skip image signing
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_image_rm.yaml
View File

@ -13,21 +13,12 @@ options:
description: Force removal of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-prune
value_type: bool
default_value: "false"
description: Do not delete untagged parents
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_image_save.yaml
View File

@ -11,12 +11,6 @@ options:
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli/docker_image_tag.yaml
View File

@ -6,7 +6,4 @@ pname: docker image
plink: docker_image.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

21
_data/engine-cli/docker_images.yaml
View File

@ -27,44 +27,29 @@ options:
description: Show all images (default hides intermediate images)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: digests
value_type: bool
default_value: "false"
description: Show digests
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -72,9 +57,6 @@ options:
description: Only show numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### List the most recently created images
@ -364,7 +346,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli/docker_import.yaml
View File

@ -23,18 +23,12 @@ options:
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Set commit message for imported image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Import from a remote location
@ -82,7 +76,4 @@ examples: |-
tar, then the ownerships might not get preserved.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli/docker_info.yaml
View File

@ -28,9 +28,6 @@ options:
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Show output
@ -230,7 +227,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

14
_data/engine-cli/docker_inspect.yaml
View File

@ -1,7 +1,7 @@
command: docker inspect
short: Return low-level information on Docker objects
long: |-
Docker inspect provides detailed information on constructs controlled by Docker.
ker inspect provides detailed information on constructs controlled by Docker.
By default, `docker inspect` will render results in a JSON array.
usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...]
@ -14,9 +14,6 @@ options:
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size
shorthand: s
value_type: bool
@ -24,17 +21,11 @@ options:
description: Display total file sizes if the type is container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: type
value_type: string
description: Return JSON for specified type
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Get an instance's IP address
@ -98,7 +89,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

43
_data/engine-cli/docker_kill.yaml
View File

@ -1,10 +1,8 @@
command: docker kill
short: Kill one or more running containers
long: |-
The `docker kill` subcommand kills one or more containers. The main process
inside the container is sent `SIGKILL` signal (default), or the signal that is
specified with the `--signal` option. You can kill a container using the
container's ID, ID-prefix, or name.
The main process inside the container will be sent `SIGKILL`, or any
signal specified with option `--signal`.
> **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of
> `/bin/sh -c`, which does not pass signals. This means that the executable is
@ -20,43 +18,6 @@ options:
description: Signal to send to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Send a KILL signal to a container
The following example sends the default `KILL` signal to the container named
`my_container`:
```bash
$ docker kill my_container
```
### Send a custom signal to a container
The following example sends a `SIGHUP` signal to the container named
`my_container`:
```bash
$ docker kill --signal=SIGHUP my_container
```
You can specify a custom signal either by _name_, or _number_. The `SIG` prefix
is optional, so the following examples are equivalent:
```bash
$ docker kill --signal=SIGHUP my_container
$ docker kill --signal=HUP my_container
$ docker kill --signal=1 my_container
```
Refer to the [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html)
man-page for a list of standard Linux signals.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli/docker_load.yaml
View File

@ -1,8 +1,8 @@
command: docker load
short: Load an image from a tar archive or STDIN
long: |-
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.
`docker load` loads a tarred repository from a file or the standard input stream.
It restores both images and tags.
usage: docker load [OPTIONS]
pname: docker
plink: docker.yaml
@ -13,9 +13,6 @@ options:
description: Read from tar archive file, instead of STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
@ -23,12 +20,9 @@ options:
description: Suppress the load output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
```bash
$ docker docker image ls
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
@ -56,7 +50,4 @@ examples: |-
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

14
_data/engine-cli/docker_login.yaml
View File

@ -12,7 +12,7 @@ long: "Login to a registry.\n\n### Login to a self-hosted registry\n\nIf you wan
`root`, except when:\n\n1. connecting to a remote daemon, such as a `docker-machine`
provisioned `docker engine`.\n2. user is added to the `docker` group. This will
impact the security of your system; the `docker` group is `root` equivalent. See
[Docker Daemon Attack Surface](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface)
[Docker Daemon Attack Surface](https://docs.docker.com/security/security/#docker-daemon-attack-surface)
for details.\n\nYou can log into any public or private repository for which you
have\ncredentials. When you log in, the command stores credentials in\n`$HOME/.docker/config.json`
on Linux or `%USERPROFILE%/.docker/config.json` on\nWindows, via the procedure described
@ -78,30 +78,18 @@ options:
description: Password
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: password-stdin
value_type: bool
default_value: "false"
description: Take the password from stdin
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: username
shorthand: u
value_type: string
description: Username
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

Some files were not shown because too many files have changed in this diff Show More