diff --git a/_data/engine-cli-edge/docker_config_create.yaml b/_data/engine-cli-edge/docker_config_create.yaml index 28232f9a2fa..afb9df737f0 100644 --- a/_data/engine-cli-edge/docker_config_create.yaml +++ b/_data/engine-cli-edge/docker_config_create.yaml @@ -14,6 +14,14 @@ 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 diff --git a/_data/engine-cli-edge/docker_deploy.yaml b/_data/engine-cli-edge/docker_deploy.yaml index 3cbf5d0ac9d..0ec01f06df2 100644 --- a/_data/engine-cli-edge/docker_deploy.yaml +++ b/_data/engine-cli-edge/docker_deploy.yaml @@ -17,7 +17,8 @@ options: swarm: true - option: compose-file shorthand: c - value_type: string + value_type: stringSlice + default_value: '[]' description: Path to a Compose file deprecated: false min_api_version: "1.25" diff --git a/_data/engine-cli-edge/docker_events.yaml b/_data/engine-cli-edge/docker_events.yaml index a0a3110fe49..fd42f278c5a 100644 --- a/_data/engine-cli-edge/docker_events.yaml +++ b/_data/engine-cli-edge/docker_events.yaml @@ -150,7 +150,7 @@ long: |- * container (`container=`) * daemon (`daemon=`) * event (`event=`) - * image (`image=`) + * image (`image=`) * label (`label=` or `label==`) * network (`network=`) * node (`node=`) diff --git a/_data/engine-cli-edge/docker_export.yaml b/_data/engine-cli-edge/docker_export.yaml index 559fc888458..1959106442f 100644 --- a/_data/engine-cli-edge/docker_export.yaml +++ b/_data/engine-cli-edge/docker_export.yaml @@ -22,7 +22,7 @@ options: kubernetes: false swarm: false examples: |- - ch of these commands has the same result. + Each of these commands has the same result. ```bash $ docker export red_panda > latest.tar diff --git a/_data/engine-cli-edge/docker_image_prune.yaml b/_data/engine-cli-edge/docker_image_prune.yaml index e213b05261e..7271fc8cb87 100644 --- a/_data/engine-cli-edge/docker_image_prune.yaml +++ b/_data/engine-cli-edge/docker_image_prune.yaml @@ -34,8 +34,8 @@ options: experimentalcli: false kubernetes: false swarm: false -examples: |2- - output: +examples: |- + Example output: ```bash $ docker image prune -a @@ -97,6 +97,19 @@ examples: |2- format is the `label!=...` (`label!=` or `label!==`), 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 @@ -163,6 +176,35 @@ examples: |2- 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 diff --git a/_data/engine-cli-edge/docker_inspect.yaml b/_data/engine-cli-edge/docker_inspect.yaml index 9ff56778637..675803b038a 100644 --- a/_data/engine-cli-edge/docker_inspect.yaml +++ b/_data/engine-cli-edge/docker_inspect.yaml @@ -1,7 +1,7 @@ command: docker inspect short: Return low-level information on Docker objects long: |- - ker inspect provides detailed information on constructs controlled by Docker. + Docker 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...] diff --git a/_data/engine-cli-edge/docker_kill.yaml b/_data/engine-cli-edge/docker_kill.yaml index afc06c5be3c..cb12ba7d1da 100644 --- a/_data/engine-cli-edge/docker_kill.yaml +++ b/_data/engine-cli-edge/docker_kill.yaml @@ -1,8 +1,10 @@ command: docker kill short: Kill one or more running containers long: |- - The main process inside the container will be sent `SIGKILL`, or any - signal specified with option `--signal`. + 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. > **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 @@ -21,6 +23,37 @@ 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 diff --git a/_data/engine-cli-edge/docker_network_create.yaml b/_data/engine-cli-edge/docker_network_create.yaml index 8aeb01e6ca5..799e4b32282 100644 --- a/_data/engine-cli-edge/docker_network_create.yaml +++ b/_data/engine-cli-edge/docker_network_create.yaml @@ -48,6 +48,18 @@ 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 @@ -248,15 +260,16 @@ 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. + 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. ```bash $ docker network create -d overlay \ - --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 \ + --subnet=192.168.1.0/25 \ + --subnet=192.170.2.0/25 \ + --gateway=192.168.1.100 \ + --gateway=192.170.2.100 \ --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 diff --git a/_data/engine-cli-edge/docker_network_disconnect.yaml b/_data/engine-cli-edge/docker_network_disconnect.yaml index c0d1e39cb67..507b3056601 100644 --- a/_data/engine-cli-edge/docker_network_disconnect.yaml +++ b/_data/engine-cli-edge/docker_network_disconnect.yaml @@ -1,7 +1,7 @@ command: docker network disconnect short: Disconnect a container from a network -long: |2- - a container from a network. The container must be running to +long: |- + Disconnects 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 diff --git a/_data/engine-cli-edge/docker_node_demote.yaml b/_data/engine-cli-edge/docker_node_demote.yaml index 3e5228460c1..9d671e42a45 100644 --- a/_data/engine-cli-edge/docker_node_demote.yaml +++ b/_data/engine-cli-edge/docker_node_demote.yaml @@ -1,7 +1,7 @@ command: docker node demote short: Demote one or more nodes from manager in the swarm long: |- - motes an existing manager so that it is no longer a manager. This command + Demotes 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 diff --git a/_data/engine-cli-edge/docker_node_ls.yaml b/_data/engine-cli-edge/docker_node_ls.yaml index 241d5fc2acb..6e363374284 100644 --- a/_data/engine-cli-edge/docker_node_ls.yaml +++ b/_data/engine-cli-edge/docker_node_ls.yaml @@ -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\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`.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```" deprecated: false min_api_version: "1.24" experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_disable.yaml b/_data/engine-cli-edge/docker_plugin_disable.yaml index e7b711a2ea8..d77ce27dc23 100644 --- a/_data/engine-cli-edge/docker_plugin_disable.yaml +++ b/_data/engine-cli-edge/docker_plugin_disable.yaml @@ -1,7 +1,7 @@ command: docker plugin disable short: Disable a plugin long: |- - ables a plugin. The plugin must be installed before it can be disabled, + Disables 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 diff --git a/_data/engine-cli-edge/docker_plugin_enable.yaml b/_data/engine-cli-edge/docker_plugin_enable.yaml index 01c1ada05b8..30fa394e184 100644 --- a/_data/engine-cli-edge/docker_plugin_enable.yaml +++ b/_data/engine-cli-edge/docker_plugin_enable.yaml @@ -9,7 +9,7 @@ plink: docker_plugin.yaml options: - option: timeout value_type: int - default_value: "0" + default_value: "30" description: HTTP client timeout (in seconds) deprecated: false experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_set.yaml b/_data/engine-cli-edge/docker_plugin_set.yaml index 95a509d13e6..b8da2b11cbb 100644 --- a/_data/engine-cli-edge/docker_plugin_set.yaml +++ b/_data/engine-cli-edge/docker_plugin_set.yaml @@ -7,7 +7,7 @@ long: |- * env variables * source of mounts * path of devices - * arg + * args usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...] pname: docker plugin plink: docker_plugin.yaml diff --git a/_data/engine-cli-edge/docker_run.yaml b/_data/engine-cli-edge/docker_run.yaml index 7dce9a2f07b..d7b59fe2f2c 100644 --- a/_data/engine-cli-edge/docker_run.yaml +++ b/_data/engine-cli-edge/docker_run.yaml @@ -1063,12 +1063,12 @@ examples: |- ### Publish or expose port (-p, --expose) ```bash - $ docker run -p 127.0.0.1:80:8080 ubuntu bash + $ docker run -p 127.0.0.1:80:8080/tcp ubuntu bash ``` - 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/) + 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/) explains in detail how to manipulate ports in Docker. ```bash @@ -1312,6 +1312,7 @@ 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 diff --git a/_data/engine-cli-edge/docker_secret_create.yaml b/_data/engine-cli-edge/docker_secret_create.yaml index 67331e9a075..374afa3b74c 100644 --- a/_data/engine-cli-edge/docker_secret_create.yaml +++ b/_data/engine-cli-edge/docker_secret_create.yaml @@ -12,7 +12,7 @@ options: value_type: string description: Secret driver deprecated: false - min_api_version: "1.31" + min_api_version: "1.37" experimental: false experimentalcli: false kubernetes: false @@ -26,6 +26,14 @@ 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 diff --git a/_data/engine-cli-edge/docker_service_create.yaml b/_data/engine-cli-edge/docker_service_create.yaml index 8dc7ae89337..c980fd50385 100644 --- a/_data/engine-cli-edge/docker_service_create.yaml +++ b/_data/engine-cli-edge/docker_service_create.yaml @@ -587,34 +587,42 @@ 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 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 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), 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 @@ -855,41 +863,45 @@ 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\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\n\n\n \n \n \n \n\n\n\n - \ \n \n \n - \ \n\n\n \n \n - \ \n \n\n\n \n \n \n - \ \n\n\n + 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
OptionShort - syntaxLong syntaxDescription
published and target port
protocol--publish 8080:80--publish published=8080,target=80

\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

modeNot - possible to set using short syntax.--publish published=8080,target=80,mode=host

\n The mode to use for binding the port, either `ingress` or `host`. - Defaults\n to `ingress` to use the routing mesh.\n

\n\n\n \n \n + \ \n \n\n\n\n \n \n \n \n\n\n \n \n \n + \ \n\n\n \ \n \n \n \n\n
OptionShort syntaxLong syntaxDescription
published + and target port--publish 8080:80--publish + published=8080,target=80

\n The target port within the container + and the port to map it to on the\n nodes, using the routing mesh (ingress) + 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 + \

modeNot possible to set using short + syntax.--publish published=8080,target=80,mode=host

\n The mode to use for binding the port, either ingress or + host.\n Defaults to ingress to use the routing mesh.\n

protocol--publish 8080:80/tcp--publish published=8080,target=80,protocol=tcp

\n The protocol to - use, either `tcp` or `udp`. Defaults to `tcp`. To bind a\n port for both protocols, - specify the `-p` or `--publish` flag twice.\n

\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### + use, tcp , udp, or sctp. Defaults to\n tcp. + To bind a port for both protocols, specify the -p or\n --publish + flag twice.\n

\n\n\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### 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://` or\n`registry://`.\n\nWhen using @@ -921,8 +933,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- diff --git a/_data/engine-cli-edge/docker_service_update.yaml b/_data/engine-cli-edge/docker_service_update.yaml index d1ab6cfe68c..2769d0c3e2e 100644 --- a/_data/engine-cli-edge/docker_service_update.yaml +++ b/_data/engine-cli-edge/docker_service_update.yaml @@ -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/#attach-a-service-to-an-existing-network-network) + [docker service create](service_create/#publish-service-ports-externally-to-the-swarm) reference. The following example adds a published service port to an existing service. @@ -806,6 +806,22 @@ 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. diff --git a/_data/engine-cli-edge/docker_stack_deploy.yaml b/_data/engine-cli-edge/docker_stack_deploy.yaml index 619e8e9b7e3..1ad8c25cc02 100644 --- a/_data/engine-cli-edge/docker_stack_deploy.yaml +++ b/_data/engine-cli-edge/docker_stack_deploy.yaml @@ -18,7 +18,8 @@ options: swarm: true - option: compose-file shorthand: c - value_type: string + value_type: stringSlice + default_value: '[]' description: Path to a Compose file deprecated: false min_api_version: "1.25" @@ -111,14 +112,12 @@ examples: |- Creating service vossibility_lookupd ``` - 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. + 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. ```bash - $ docker-compose -f docker-compose.yml -f docker-compose.prod.yml config > docker-stack.yml - $ docker stack deploy --compose-file docker-stack.yml vossibility + $ docker stack deploy --compose-file docker-compose.yml -f docker-compose.prod.yml vossibility Ignoring unsupported options: links diff --git a/_data/engine-cli-edge/docker_stats.yaml b/_data/engine-cli-edge/docker_stats.yaml index d9f93292009..8940ff9911f 100644 --- a/_data/engine-cli-edge/docker_stats.yaml +++ b/_data/engine-cli-edge/docker_stats.yaml @@ -59,6 +59,18 @@ 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 diff --git a/_data/engine-cli-edge/docker_swarm_ca.yaml b/_data/engine-cli-edge/docker_swarm_ca.yaml index 508a79b922c..c4f4cac7dd7 100644 --- a/_data/engine-cli-edge/docker_swarm_ca.yaml +++ b/_data/engine-cli-edge/docker_swarm_ca.yaml @@ -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. diff --git a/_data/engine-cli-edge/docker_trust.yaml b/_data/engine-cli-edge/docker_trust.yaml index 3bf4f8c2540..d3219d74072 100644 --- a/_data/engine-cli-edge/docker_trust.yaml +++ b/_data/engine-cli-edge/docker_trust.yaml @@ -1,6 +1,6 @@ command: docker trust -short: Manage trust on Docker images (experimental) -long: Manage trust on Docker images (experimental) +short: Manage trust on Docker images +long: Manage trust on Docker images usage: docker trust pname: docker plink: docker.yaml @@ -10,17 +10,15 @@ 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: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_inspect.yaml b/_data/engine-cli-edge/docker_trust_inspect.yaml index c64fb4603b3..8e4034ce520 100644 --- a/_data/engine-cli-edge/docker_trust_inspect.yaml +++ b/_data/engine-cli-edge/docker_trust_inspect.yaml @@ -4,14 +4,19 @@ 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 @@ -23,16 +28,15 @@ 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`, 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 + 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 \ },\n {\n \"ID\": \"6a11e4898a4014d400332ab0e096308c844584ff70943cdd1d6628d577f45fd8\"\n \ }\n ]\n },\n {\n \"Name\": \"bob\",\n \"Keys\": [\n {\n \"ID\": \"433e245c656ae9733cdcc504bfa560f90950104442c4528c9616daa45824ccba\"\n @@ -45,9 +49,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 display any signed tags.\n\n```bash\n$ + or unavailable, `docker trust inspect` does not\ndisplay 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, `docker trust inspect` reports + 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 alpine:unsigned\n[\n \ {\n \"Name\": \"alpine:unsigned\",\n \"Signers\": [],\n \"AdminstrativeKeys\": [\n {\n \"Name\": \"Repository\",\n \"Keys\": [\n {\n @@ -56,7 +60,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 signed tags in the repository:\n\n```bash\n$ docker + will report details for all\nsigned 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\": @@ -76,7 +80,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, and reports the results in an ordered list:\n\n```bash\n$ + repositories and images as arguments,\nand 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\": @@ -110,10 +114,60 @@ 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 ]\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```" deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_key.yaml b/_data/engine-cli-edge/docker_trust_key.yaml index f183ce6eecc..c6bee2f411a 100644 --- a/_data/engine-cli-edge/docker_trust_key.yaml +++ b/_data/engine-cli-edge/docker_trust_key.yaml @@ -1,6 +1,6 @@ command: docker trust key -short: Manage keys for signing Docker images (experimental) -long: Manage keys for signing Docker images (experimental) +short: Manage keys for signing Docker images +long: Manage keys for signing Docker images 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: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_key_generate.yaml b/_data/engine-cli-edge/docker_trust_key_generate.yaml index 70215785fd8..6431db6305f 100644 --- a/_data/engine-cli-edge/docker_trust_key_generate.yaml +++ b/_data/engine-cli-edge/docker_trust_key_generate.yaml @@ -15,7 +15,7 @@ options: swarm: false deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_key_load.yaml b/_data/engine-cli-edge/docker_trust_key_load.yaml index a31d2597621..b215aaa98b8 100644 --- a/_data/engine-cli-edge/docker_trust_key_load.yaml +++ b/_data/engine-cli-edge/docker_trust_key_load.yaml @@ -16,7 +16,7 @@ options: swarm: false deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_revoke.yaml b/_data/engine-cli-edge/docker_trust_revoke.yaml index 61e4c8128a7..76a3aac27cf 100644 --- a/_data/engine-cli-edge/docker_trust_revoke.yaml +++ b/_data/engine-cli-edge/docker_trust_revoke.yaml @@ -1,9 +1,6 @@ command: docker trust revoke short: Remove trust for an image -long: |- - `docker trust revoke` removes signatures from tags in signed repositories. - - `docker trust revoke` is currently experimental. +long: '`docker trust revoke` removes signatures from tags in signed repositories.' usage: docker trust revoke [OPTIONS] IMAGE[:TAG] pname: docker trust plink: docker_trust.yaml @@ -58,7 +55,7 @@ examples: "### Revoke signatures from a signed tag\n\nHere's an example of a rep Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```" deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_sign.yaml b/_data/engine-cli-edge/docker_trust_sign.yaml index c3d806beb42..b42c46e27a2 100644 --- a/_data/engine-cli-edge/docker_trust_sign.yaml +++ b/_data/engine-cli-edge/docker_trust_sign.yaml @@ -1,9 +1,6 @@ command: docker trust sign short: Sign an image -long: |- - `docker trust sign` adds signatures to tags to create signed repositories. - - `docker trust sign` is currently experimental. +long: '`docker trust sign` adds signatures to tags to create signed repositories.' usage: docker trust sign IMAGE:TAG pname: docker trust plink: docker_trust.yaml @@ -57,7 +54,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: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_signer.yaml b/_data/engine-cli-edge/docker_trust_signer.yaml index 84869594275..b279973d20a 100644 --- a/_data/engine-cli-edge/docker_trust_signer.yaml +++ b/_data/engine-cli-edge/docker_trust_signer.yaml @@ -1,6 +1,6 @@ command: docker trust signer -short: Manage entities who can sign Docker images (experimental) -long: Manage entities who can sign Docker images (experimental) +short: Manage entities who can sign Docker images +long: Manage entities who can sign Docker images 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: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_signer_add.yaml b/_data/engine-cli-edge/docker_trust_signer_add.yaml index d1d011cb168..4133511d850 100644 --- a/_data/engine-cli-edge/docker_trust_signer_add.yaml +++ b/_data/engine-cli-edge/docker_trust_signer_add.yaml @@ -15,7 +15,7 @@ options: swarm: false deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_signer_remove.yaml b/_data/engine-cli-edge/docker_trust_signer_remove.yaml index 2c0fbf81ddb..bd9109e77db 100644 --- a/_data/engine-cli-edge/docker_trust_signer_remove.yaml +++ b/_data/engine-cli-edge/docker_trust_signer_remove.yaml @@ -18,7 +18,7 @@ options: swarm: false deprecated: false experimental: false -experimentalcli: true +experimentalcli: false kubernetes: false swarm: false diff --git a/_data/engine-cli-edge/docker_trust_view.yaml b/_data/engine-cli-edge/docker_trust_view.yaml deleted file mode 100644 index b77244ecd8f..00000000000 --- a/_data/engine-cli-edge/docker_trust_view.yaml +++ /dev/null @@ -1,69 +0,0 @@ -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 - diff --git a/_data/engine-cli-edge/docker_volume_prune.yaml b/_data/engine-cli-edge/docker_volume_prune.yaml index 19a83008fd8..1b1eabc858b 100644 --- a/_data/engine-cli-edge/docker_volume_prune.yaml +++ b/_data/engine-cli-edge/docker_volume_prune.yaml @@ -1,7 +1,7 @@ command: docker volume prune -short: Remove all unused volumes -long: Remove all unused volumes. Unused volumes are those which are not referenced - by any conta +short: Remove all unused local volumes +long: Remove all unused local volumes. Unused local volumes are those which are not + referenced by any containers 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 volumes not used by at least one container. + WARNING! This will remove all local volumes not used by at least one container. Are you sure you want to continue? [y/N] y Deleted Volumes: 07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e diff --git a/_data/engine-cli/docker.yaml b/_data/engine-cli/docker.yaml index 074fe34741a..cfed41624a1 100644 --- a/_data/engine-cli/docker.yaml +++ b/_data/engine-cli/docker.yaml @@ -24,6 +24,7 @@ cname: - docker login - docker logout - docker logs +- docker manifest - docker network - docker node - docker pause @@ -80,6 +81,7 @@ clink: - docker_login.yaml - docker_logout.yaml - docker_logs.yaml +- docker_manifest.yaml - docker_network.yaml - docker_node.yaml - docker_pause.yaml @@ -113,4 +115,7 @@ clink: - docker_wait.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_attach.yaml b/_data/engine-cli/docker_attach.yaml index 7f080109dba..9497cb5cb4d 100644 --- a/_data/engine-cli/docker_attach.yaml +++ b/_data/engine-cli/docker_attach.yaml @@ -69,18 +69,27 @@ 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 @@ -151,4 +160,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_build.yaml b/_data/engine-cli/docker_build.yaml index b6d95c8e2d7..66c4c2f474d 100644 --- a/_data/engine-cli/docker_build.yaml +++ b/_data/engine-cli/docker_build.yaml @@ -112,40 +112,61 @@ 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 @@ -153,49 +174,76 @@ 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 @@ -203,6 +251,9 @@ options: description: Memory limit deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: memory-swap value_type: bytes default_value: "0" @@ -210,6 +261,9 @@ 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 @@ -218,24 +272,36 @@ 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 @@ -243,24 +309,36 @@ 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" @@ -268,6 +346,9 @@ options: deprecated: false min_api_version: "1.25" experimental: true + experimentalcli: false + kubernetes: false + swarm: false - option: stream value_type: bool default_value: "false" @@ -275,23 +356,35 @@ 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 @@ -476,4 +569,7 @@ 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 diff --git a/_data/engine-cli/docker_checkpoint.yaml b/_data/engine-cli/docker_checkpoint.yaml index b18c9850c41..970f8016883 100644 --- a/_data/engine-cli/docker_checkpoint.yaml +++ b/_data/engine-cli/docker_checkpoint.yaml @@ -15,4 +15,7 @@ clink: deprecated: false min_api_version: "1.25" experimental: true +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_checkpoint_create.yaml b/_data/engine-cli/docker_checkpoint_create.yaml index 93c649d1d7e..c21eac46c22 100644 --- a/_data/engine-cli/docker_checkpoint_create.yaml +++ b/_data/engine-cli/docker_checkpoint_create.yaml @@ -10,13 +10,22 @@ 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 diff --git a/_data/engine-cli/docker_checkpoint_ls.yaml b/_data/engine-cli/docker_checkpoint_ls.yaml index 84ab852d592..4f37970d31a 100644 --- a/_data/engine-cli/docker_checkpoint_ls.yaml +++ b/_data/engine-cli/docker_checkpoint_ls.yaml @@ -11,7 +11,13 @@ 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 diff --git a/_data/engine-cli/docker_checkpoint_rm.yaml b/_data/engine-cli/docker_checkpoint_rm.yaml index d508944a9a8..95bcadddd42 100644 --- a/_data/engine-cli/docker_checkpoint_rm.yaml +++ b/_data/engine-cli/docker_checkpoint_rm.yaml @@ -11,7 +11,13 @@ 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 diff --git a/_data/engine-cli/docker_commit.yaml b/_data/engine-cli/docker_commit.yaml index d80b8960c3c..f3f4ffc39a8 100644 --- a/_data/engine-cli/docker_commit.yaml +++ b/_data/engine-cli/docker_commit.yaml @@ -28,18 +28,27 @@ options: description: Author (e.g., "John Hannibal Smith ") 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 @@ -47,6 +56,9 @@ options: description: Pause container during commit deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Commit a container @@ -115,4 +127,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_config.yaml b/_data/engine-cli/docker_config.yaml index c82416504a9..3689f3b2355 100644 --- a/_data/engine-cli/docker_config.yaml +++ b/_data/engine-cli/docker_config.yaml @@ -17,4 +17,7 @@ clink: deprecated: false min_api_version: "1.30" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_config_create.yaml b/_data/engine-cli/docker_config_create.yaml index a2a60b0306d..afb9df737f0 100644 --- a/_data/engine-cli/docker_config_create.yaml +++ b/_data/engine-cli/docker_config_create.yaml @@ -1,6 +1,6 @@ command: docker config create -short: Create a configuration file from a file or STDIN as content -long: Create a configuration file from a file or STDIN as content +short: Create a config from a file or STDIN +long: Create a config from a file or STDIN usage: docker config create [OPTIONS] CONFIG file|- pname: docker config plink: docker_config.yaml @@ -11,7 +11,21 @@ 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 diff --git a/_data/engine-cli/docker_config_inspect.yaml b/_data/engine-cli/docker_config_inspect.yaml index 4e58db9d88d..015af0db139 100644 --- a/_data/engine-cli/docker_config_inspect.yaml +++ b/_data/engine-cli/docker_config_inspect.yaml @@ -1,6 +1,6 @@ command: docker config inspect -short: Display detailed information on one or more configuration files -long: Display detailed information on one or more configuration files +short: Display detailed information on one or more configs +long: Display detailed information on one or more configs usage: docker config inspect [OPTIONS] CONFIG [CONFIG...] pname: docker config plink: docker_config.yaml @@ -11,13 +11,22 @@ 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 diff --git a/_data/engine-cli/docker_config_ls.yaml b/_data/engine-cli/docker_config_ls.yaml index be26eb61707..100f632f721 100644 --- a/_data/engine-cli/docker_config_ls.yaml +++ b/_data/engine-cli/docker_config_ls.yaml @@ -12,11 +12,17 @@ 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 @@ -24,7 +30,13 @@ 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 diff --git a/_data/engine-cli/docker_config_rm.yaml b/_data/engine-cli/docker_config_rm.yaml index 0ae5d9a0617..991ecfc9ece 100644 --- a/_data/engine-cli/docker_config_rm.yaml +++ b/_data/engine-cli/docker_config_rm.yaml @@ -1,11 +1,14 @@ command: docker config rm aliases: remove -short: Remove one or more configuration files -long: Remove one or more configuration files +short: Remove one or more configs +long: Remove one or more configs usage: docker config rm CONFIG [CONFIG...] pname: docker config plink: docker_config.yaml deprecated: false min_api_version: "1.30" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_container.yaml b/_data/engine-cli/docker_container.yaml index ade30491389..3c501b44873 100644 --- a/_data/engine-cli/docker_container.yaml +++ b/_data/engine-cli/docker_container.yaml @@ -58,4 +58,7 @@ clink: - docker_container_wait.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_attach.yaml b/_data/engine-cli/docker_container_attach.yaml index f33db47560c..95b4d3ede8b 100644 --- a/_data/engine-cli/docker_container_attach.yaml +++ b/_data/engine-cli/docker_container_attach.yaml @@ -10,18 +10,30 @@ 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 diff --git a/_data/engine-cli/docker_container_commit.yaml b/_data/engine-cli/docker_container_commit.yaml index 4f331239aab..8524a53a5bc 100644 --- a/_data/engine-cli/docker_container_commit.yaml +++ b/_data/engine-cli/docker_container_commit.yaml @@ -11,18 +11,27 @@ options: description: Author (e.g., "John Hannibal Smith ") 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 @@ -30,6 +39,12 @@ 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 diff --git a/_data/engine-cli/docker_container_cp.yaml b/_data/engine-cli/docker_container_cp.yaml index 66fd1f7412c..e308f4068a3 100644 --- a/_data/engine-cli/docker_container_cp.yaml +++ b/_data/engine-cli/docker_container_cp.yaml @@ -19,6 +19,9 @@ 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 @@ -26,6 +29,12 @@ 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 diff --git a/_data/engine-cli/docker_container_create.yaml b/_data/engine-cli/docker_container_create.yaml index 9fdba72ac03..e3f2a6790ad 100644 --- a/_data/engine-cli/docker_container_create.yaml +++ b/_data/engine-cli/docker_container_create.yaml @@ -10,12 +10,18 @@ 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" @@ -23,56 +29,86 @@ 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" @@ -80,6 +116,9 @@ 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" @@ -87,6 +126,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -94,125 +136,194 @@ 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 @@ -221,6 +332,9 @@ 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 @@ -228,18 +342,27 @@ 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" @@ -248,6 +371,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -255,6 +381,9 @@ 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" @@ -262,74 +391,116 @@ 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 @@ -337,12 +508,18 @@ 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" @@ -350,91 +527,139 @@ 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 @@ -442,46 +667,70 @@ 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" @@ -489,22 +738,34 @@ 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 @@ -512,50 +773,80 @@ 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: [:])' 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 diff --git a/_data/engine-cli/docker_container_diff.yaml b/_data/engine-cli/docker_container_diff.yaml index 6fef75b7c41..48c1ccf5d32 100644 --- a/_data/engine-cli/docker_container_diff.yaml +++ b/_data/engine-cli/docker_container_diff.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_exec.yaml b/_data/engine-cli/docker_container_exec.yaml index c9de3ca7287..7f6a1a5ea0b 100644 --- a/_data/engine-cli/docker_container_exec.yaml +++ b/_data/engine-cli/docker_container_exec.yaml @@ -12,11 +12,17 @@ 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 @@ -24,6 +30,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -31,12 +40,18 @@ 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 @@ -44,12 +59,18 @@ 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: [:])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: workdir shorthand: w value_type: string @@ -57,6 +78,12 @@ 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 diff --git a/_data/engine-cli/docker_container_export.yaml b/_data/engine-cli/docker_container_export.yaml index 21854dc5a0d..e45c77d971b 100644 --- a/_data/engine-cli/docker_container_export.yaml +++ b/_data/engine-cli/docker_container_export.yaml @@ -11,6 +11,12 @@ 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 diff --git a/_data/engine-cli/docker_container_inspect.yaml b/_data/engine-cli/docker_container_inspect.yaml index 1ee186a1b82..c27e4a45063 100644 --- a/_data/engine-cli/docker_container_inspect.yaml +++ b/_data/engine-cli/docker_container_inspect.yaml @@ -11,6 +11,9 @@ 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 @@ -18,6 +21,12 @@ 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 diff --git a/_data/engine-cli/docker_container_kill.yaml b/_data/engine-cli/docker_container_kill.yaml index d42f831e6fb..44c184add63 100644 --- a/_data/engine-cli/docker_container_kill.yaml +++ b/_data/engine-cli/docker_container_kill.yaml @@ -12,6 +12,12 @@ 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 diff --git a/_data/engine-cli/docker_container_logs.yaml b/_data/engine-cli/docker_container_logs.yaml index 9a13f7a6b3e..4bfb043e3ae 100644 --- a/_data/engine-cli/docker_container_logs.yaml +++ b/_data/engine-cli/docker_container_logs.yaml @@ -11,6 +11,9 @@ 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 @@ -18,18 +21,27 @@ 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 @@ -37,6 +49,9 @@ options: description: Show timestamps deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: until value_type: string description: | @@ -44,6 +59,12 @@ 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 diff --git a/_data/engine-cli/docker_container_ls.yaml b/_data/engine-cli/docker_container_ls.yaml index 17bd25cf170..59f445b59ad 100644 --- a/_data/engine-cli/docker_container_ls.yaml +++ b/_data/engine-cli/docker_container_ls.yaml @@ -13,17 +13,26 @@ 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 @@ -31,6 +40,9 @@ 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 @@ -38,12 +50,18 @@ 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 @@ -51,6 +69,9 @@ options: description: Only display numeric IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: size shorthand: s value_type: bool @@ -58,6 +79,12 @@ 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 diff --git a/_data/engine-cli/docker_container_pause.yaml b/_data/engine-cli/docker_container_pause.yaml index 64e8b1b8628..dd28f672aa2 100644 --- a/_data/engine-cli/docker_container_pause.yaml +++ b/_data/engine-cli/docker_container_pause.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_port.yaml b/_data/engine-cli/docker_container_port.yaml index efb47b0d3cd..e211a449a38 100644 --- a/_data/engine-cli/docker_container_port.yaml +++ b/_data/engine-cli/docker_container_port.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_prune.yaml b/_data/engine-cli/docker_container_prune.yaml index c81dd8cee65..b26f0e296e8 100644 --- a/_data/engine-cli/docker_container_prune.yaml +++ b/_data/engine-cli/docker_container_prune.yaml @@ -10,6 +10,9 @@ options: description: Provide filter values (e.g. 'until=') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force shorthand: f value_type: bool @@ -17,6 +20,9 @@ options: description: Do not prompt for confirmation deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Prune containers @@ -33,7 +39,7 @@ examples: |- ### Filtering - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more + The filtering flag (`--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: @@ -104,4 +110,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_rename.yaml b/_data/engine-cli/docker_container_rename.yaml index e67cd654cc2..088cfe0119d 100644 --- a/_data/engine-cli/docker_container_rename.yaml +++ b/_data/engine-cli/docker_container_rename.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_restart.yaml b/_data/engine-cli/docker_container_restart.yaml index 6602a718f19..74d8bbac860 100644 --- a/_data/engine-cli/docker_container_restart.yaml +++ b/_data/engine-cli/docker_container_restart.yaml @@ -12,6 +12,12 @@ 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 diff --git a/_data/engine-cli/docker_container_rm.yaml b/_data/engine-cli/docker_container_rm.yaml index 182b961a9a0..0dbfa786f05 100644 --- a/_data/engine-cli/docker_container_rm.yaml +++ b/_data/engine-cli/docker_container_rm.yaml @@ -12,6 +12,9 @@ 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 @@ -19,6 +22,9 @@ options: description: Remove the specified link deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: volumes shorthand: v value_type: bool @@ -26,6 +32,12 @@ 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 diff --git a/_data/engine-cli/docker_container_run.yaml b/_data/engine-cli/docker_container_run.yaml index e4dac8f5325..37c5e48681f 100644 --- a/_data/engine-cli/docker_container_run.yaml +++ b/_data/engine-cli/docker_container_run.yaml @@ -10,12 +10,18 @@ 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" @@ -23,56 +29,86 @@ 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" @@ -80,6 +116,9 @@ 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" @@ -87,6 +126,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -94,22 +136,34 @@ 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 @@ -117,114 +171,177 @@ 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 @@ -233,6 +350,9 @@ 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 @@ -240,18 +360,27 @@ 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" @@ -260,6 +389,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -267,6 +399,9 @@ 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" @@ -274,74 +409,116 @@ 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 @@ -349,12 +526,18 @@ 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" @@ -362,91 +545,139 @@ 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 @@ -454,52 +685,79 @@ 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" @@ -507,22 +765,34 @@ 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 @@ -530,50 +800,80 @@ 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: [:])' 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 diff --git a/_data/engine-cli/docker_container_start.yaml b/_data/engine-cli/docker_container_start.yaml index 4e8d117dee1..a14deea2972 100644 --- a/_data/engine-cli/docker_container_start.yaml +++ b/_data/engine-cli/docker_container_start.yaml @@ -12,21 +12,33 @@ 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 @@ -34,6 +46,12 @@ 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 diff --git a/_data/engine-cli/docker_container_stats.yaml b/_data/engine-cli/docker_container_stats.yaml index c7ee08219b5..d8f081e8b5d 100644 --- a/_data/engine-cli/docker_container_stats.yaml +++ b/_data/engine-cli/docker_container_stats.yaml @@ -12,23 +12,38 @@ 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 diff --git a/_data/engine-cli/docker_container_stop.yaml b/_data/engine-cli/docker_container_stop.yaml index 96e86648b61..80fa23dc990 100644 --- a/_data/engine-cli/docker_container_stop.yaml +++ b/_data/engine-cli/docker_container_stop.yaml @@ -12,6 +12,12 @@ 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 diff --git a/_data/engine-cli/docker_container_top.yaml b/_data/engine-cli/docker_container_top.yaml index e24f0a4eaab..c35656326d9 100644 --- a/_data/engine-cli/docker_container_top.yaml +++ b/_data/engine-cli/docker_container_top.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_unpause.yaml b/_data/engine-cli/docker_container_unpause.yaml index c6800c69504..fcd8612ee64 100644 --- a/_data/engine-cli/docker_container_unpause.yaml +++ b/_data/engine-cli/docker_container_unpause.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_container_update.yaml b/_data/engine-cli/docker_container_update.yaml index 19f47875682..cb09c7a05f0 100644 --- a/_data/engine-cli/docker_container_update.yaml +++ b/_data/engine-cli/docker_container_update.yaml @@ -12,18 +12,27 @@ 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" @@ -31,6 +40,9 @@ 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" @@ -38,6 +50,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -45,28 +60,43 @@ 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 @@ -74,12 +104,18 @@ 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" @@ -87,11 +123,20 @@ 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 diff --git a/_data/engine-cli/docker_container_wait.yaml b/_data/engine-cli/docker_container_wait.yaml index 0e33f3509a1..9edf8772ba7 100644 --- a/_data/engine-cli/docker_container_wait.yaml +++ b/_data/engine-cli/docker_container_wait.yaml @@ -6,4 +6,7 @@ pname: docker container plink: docker_container.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_cp.yaml b/_data/engine-cli/docker_cp.yaml index 8a1bfe0ff98..01bdd2205f6 100644 --- a/_data/engine-cli/docker_cp.yaml +++ b/_data/engine-cli/docker_cp.yaml @@ -95,6 +95,9 @@ 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 @@ -102,6 +105,12 @@ 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 diff --git a/_data/engine-cli/docker_create.yaml b/_data/engine-cli/docker_create.yaml index bc62179a01f..dac8c8f7f5a 100644 --- a/_data/engine-cli/docker_create.yaml +++ b/_data/engine-cli/docker_create.yaml @@ -21,12 +21,18 @@ 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" @@ -34,56 +40,86 @@ 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" @@ -91,6 +127,9 @@ 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" @@ -98,6 +137,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -105,125 +147,194 @@ 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 @@ -232,6 +343,9 @@ 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 @@ -239,18 +353,27 @@ 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" @@ -259,6 +382,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -266,6 +392,9 @@ 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" @@ -273,74 +402,116 @@ 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 @@ -348,12 +519,18 @@ 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" @@ -361,91 +538,139 @@ 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 @@ -453,46 +678,70 @@ 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" @@ -500,22 +749,34 @@ 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 @@ -523,50 +784,77 @@ 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: [:])' 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 @@ -677,4 +965,7 @@ examples: |- the create/run command deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_deploy.yaml b/_data/engine-cli/docker_deploy.yaml index a55dc1c0064..0ec01f06df2 100644 --- a/_data/engine-cli/docker_deploy.yaml +++ b/_data/engine-cli/docker_deploy.yaml @@ -12,13 +12,20 @@ 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: string + value_type: stringSlice + default_value: '[]' 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" @@ -26,6 +33,9 @@ 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 @@ -34,12 +44,18 @@ 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 @@ -104,4 +120,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: true +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_diff.yaml b/_data/engine-cli/docker_diff.yaml index acc47cca62d..4fd4fd4fa0e 100644 --- a/_data/engine-cli/docker_diff.yaml +++ b/_data/engine-cli/docker_diff.yaml @@ -43,4 +43,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_events.yaml b/_data/engine-cli/docker_events.yaml index 9ecd336ac85..fd42f278c5a 100644 --- a/_data/engine-cli/docker_events.yaml +++ b/_data/engine-cli/docker_events.yaml @@ -150,7 +150,7 @@ long: |- * container (`container=`) * daemon (`daemon=`) * event (`event=`) - * image (`image=`) + * image (`image=`) * label (`label=` or `label==`) * network (`network=`) * node (`node=`) @@ -180,21 +180,33 @@ 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 @@ -406,4 +418,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_exec.yaml b/_data/engine-cli/docker_exec.yaml index c2edeff7982..93602aeb0ec 100644 --- a/_data/engine-cli/docker_exec.yaml +++ b/_data/engine-cli/docker_exec.yaml @@ -25,11 +25,17 @@ 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 @@ -37,6 +43,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -44,12 +53,18 @@ 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 @@ -57,12 +72,18 @@ 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: [:])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: workdir shorthand: w value_type: string @@ -70,6 +91,9 @@ 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 @@ -94,4 +118,7 @@ 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 diff --git a/_data/engine-cli/docker_export.yaml b/_data/engine-cli/docker_export.yaml index 0a7cc37b030..1959106442f 100644 --- a/_data/engine-cli/docker_export.yaml +++ b/_data/engine-cli/docker_export.yaml @@ -18,6 +18,9 @@ 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. @@ -30,3 +33,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_history.yaml b/_data/engine-cli/docker_history.yaml index d9e95faf2fc..3ef2e2dceee 100644 --- a/_data/engine-cli/docker_history.yaml +++ b/_data/engine-cli/docker_history.yaml @@ -10,6 +10,9 @@ 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 @@ -17,12 +20,18 @@ 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 @@ -30,6 +39,9 @@ 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: @@ -93,4 +105,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_image.yaml b/_data/engine-cli/docker_image.yaml index ef8a1a107c6..c094b25a6fc 100644 --- a/_data/engine-cli/docker_image.yaml +++ b/_data/engine-cli/docker_image.yaml @@ -32,4 +32,7 @@ clink: - docker_image_tag.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_image_build.yaml b/_data/engine-cli/docker_image_build.yaml index dd72da1a112..8621343da42 100644 --- a/_data/engine-cli/docker_image_build.yaml +++ b/_data/engine-cli/docker_image_build.yaml @@ -10,40 +10,61 @@ 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 @@ -51,49 +72,76 @@ 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 @@ -101,6 +149,9 @@ options: description: Memory limit deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: memory-swap value_type: bytes default_value: "0" @@ -108,6 +159,9 @@ 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 @@ -116,24 +170,36 @@ 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 @@ -141,24 +207,36 @@ 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" @@ -166,6 +244,9 @@ options: deprecated: false min_api_version: "1.25" experimental: true + experimentalcli: false + kubernetes: false + swarm: false - option: stream value_type: bool default_value: "false" @@ -173,23 +254,38 @@ 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 diff --git a/_data/engine-cli/docker_image_history.yaml b/_data/engine-cli/docker_image_history.yaml index 6d46d2db9cb..265accf0968 100644 --- a/_data/engine-cli/docker_image_history.yaml +++ b/_data/engine-cli/docker_image_history.yaml @@ -10,6 +10,9 @@ 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 @@ -17,12 +20,18 @@ 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 @@ -30,6 +39,12 @@ 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 diff --git a/_data/engine-cli/docker_image_import.yaml b/_data/engine-cli/docker_image_import.yaml index 97bf004ecfc..fd63cfcf510 100644 --- a/_data/engine-cli/docker_image_import.yaml +++ b/_data/engine-cli/docker_image_import.yaml @@ -11,12 +11,21 @@ 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 diff --git a/_data/engine-cli/docker_image_inspect.yaml b/_data/engine-cli/docker_image_inspect.yaml index 55bbe2a61af..e79573128af 100644 --- a/_data/engine-cli/docker_image_inspect.yaml +++ b/_data/engine-cli/docker_image_inspect.yaml @@ -11,6 +11,12 @@ 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 diff --git a/_data/engine-cli/docker_image_load.yaml b/_data/engine-cli/docker_image_load.yaml index ce057a8545d..61d47dab9bf 100644 --- a/_data/engine-cli/docker_image_load.yaml +++ b/_data/engine-cli/docker_image_load.yaml @@ -11,6 +11,9 @@ 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 @@ -18,6 +21,12 @@ 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 diff --git a/_data/engine-cli/docker_image_ls.yaml b/_data/engine-cli/docker_image_ls.yaml index 5189d4e68f2..0e341e81fae 100644 --- a/_data/engine-cli/docker_image_ls.yaml +++ b/_data/engine-cli/docker_image_ls.yaml @@ -13,29 +13,44 @@ 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 @@ -43,6 +58,12 @@ 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 diff --git a/_data/engine-cli/docker_image_prune.yaml b/_data/engine-cli/docker_image_prune.yaml index 99403ed637f..7271fc8cb87 100644 --- a/_data/engine-cli/docker_image_prune.yaml +++ b/_data/engine-cli/docker_image_prune.yaml @@ -13,11 +13,17 @@ 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=') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force shorthand: f value_type: bool @@ -25,8 +31,11 @@ options: description: Do not prompt for confirmation deprecated: false experimental: false -examples: |2- - output: + experimentalcli: false + kubernetes: false + swarm: false +examples: |- + Example output: ```bash $ docker image prune -a @@ -63,7 +72,7 @@ examples: |2- ### Filtering - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more + The filtering flag (`--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: @@ -88,6 +97,19 @@ examples: |2- format is the `label!=...` (`label!=` or `label!==`), 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 @@ -154,7 +176,39 @@ examples: |2- 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 diff --git a/_data/engine-cli/docker_image_pull.yaml b/_data/engine-cli/docker_image_pull.yaml index 00c5daab4a3..0b70ac118ee 100644 --- a/_data/engine-cli/docker_image_pull.yaml +++ b/_data/engine-cli/docker_image_pull.yaml @@ -12,18 +12,30 @@ 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 diff --git a/_data/engine-cli/docker_image_push.yaml b/_data/engine-cli/docker_image_push.yaml index 9ad0cdda008..b4f5f22b86e 100644 --- a/_data/engine-cli/docker_image_push.yaml +++ b/_data/engine-cli/docker_image_push.yaml @@ -11,6 +11,12 @@ 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 diff --git a/_data/engine-cli/docker_image_rm.yaml b/_data/engine-cli/docker_image_rm.yaml index 6a49641db73..c60a4984296 100644 --- a/_data/engine-cli/docker_image_rm.yaml +++ b/_data/engine-cli/docker_image_rm.yaml @@ -13,12 +13,21 @@ 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 diff --git a/_data/engine-cli/docker_image_save.yaml b/_data/engine-cli/docker_image_save.yaml index 0f681f4635e..1fbdbb1a052 100644 --- a/_data/engine-cli/docker_image_save.yaml +++ b/_data/engine-cli/docker_image_save.yaml @@ -11,6 +11,12 @@ 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 diff --git a/_data/engine-cli/docker_image_tag.yaml b/_data/engine-cli/docker_image_tag.yaml index b4b4b401589..3830ef1b8d2 100644 --- a/_data/engine-cli/docker_image_tag.yaml +++ b/_data/engine-cli/docker_image_tag.yaml @@ -6,4 +6,7 @@ pname: docker image plink: docker_image.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_images.yaml b/_data/engine-cli/docker_images.yaml index 959dd64fcf5..1777872ac9b 100644 --- a/_data/engine-cli/docker_images.yaml +++ b/_data/engine-cli/docker_images.yaml @@ -27,29 +27,44 @@ 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 @@ -57,6 +72,9 @@ options: description: Only show numeric IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### List the most recently created images @@ -346,4 +364,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_import.yaml b/_data/engine-cli/docker_import.yaml index e53ba09e51b..b80b96792af 100644 --- a/_data/engine-cli/docker_import.yaml +++ b/_data/engine-cli/docker_import.yaml @@ -23,12 +23,18 @@ 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 @@ -76,4 +82,7 @@ examples: |- tar, then the ownerships might not get preserved. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_info.yaml b/_data/engine-cli/docker_info.yaml index 6e05e00f694..39af472a3e5 100644 --- a/_data/engine-cli/docker_info.yaml +++ b/_data/engine-cli/docker_info.yaml @@ -28,6 +28,9 @@ options: description: Format the output using the given Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Show output @@ -227,4 +230,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_inspect.yaml b/_data/engine-cli/docker_inspect.yaml index 4c8d0424280..675803b038a 100644 --- a/_data/engine-cli/docker_inspect.yaml +++ b/_data/engine-cli/docker_inspect.yaml @@ -1,7 +1,7 @@ command: docker inspect short: Return low-level information on Docker objects long: |- - ker inspect provides detailed information on constructs controlled by Docker. + Docker 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,6 +14,9 @@ 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,11 +24,17 @@ 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 @@ -89,4 +98,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_kill.yaml b/_data/engine-cli/docker_kill.yaml index 4c491ad6695..cb12ba7d1da 100644 --- a/_data/engine-cli/docker_kill.yaml +++ b/_data/engine-cli/docker_kill.yaml @@ -1,8 +1,10 @@ command: docker kill short: Kill one or more running containers long: |- - The main process inside the container will be sent `SIGKILL`, or any - signal specified with option `--signal`. + 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. > **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 @@ -18,6 +20,43 @@ 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 diff --git a/_data/engine-cli/docker_load.yaml b/_data/engine-cli/docker_load.yaml index cd21911eb21..5325b1e810e 100644 --- a/_data/engine-cli/docker_load.yaml +++ b/_data/engine-cli/docker_load.yaml @@ -1,8 +1,8 @@ command: docker load short: Load an image from a tar archive or STDIN long: |- - `docker load` loads a tarred repository from a file or the standard input stream. - It restores both images and tags. + Load an image or repository from a tar archive (even if compressed with gzip, + bzip2, or xz) from a file or STDIN. It restores both images and tags. usage: docker load [OPTIONS] pname: docker plink: docker.yaml @@ -13,6 +13,9 @@ 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 @@ -20,9 +23,12 @@ options: description: Suppress the load output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash - $ docker images + $ docker docker image ls REPOSITORY TAG IMAGE ID CREATED SIZE @@ -50,4 +56,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_login.yaml b/_data/engine-cli/docker_login.yaml index b706fcfcedc..c86ba0b06c2 100644 --- a/_data/engine-cli/docker_login.yaml +++ b/_data/engine-cli/docker_login.yaml @@ -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/security/security/#docker-daemon-attack-surface) + [Docker Daemon Attack Surface](https://docs.docker.com/engine/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,18 +78,30 @@ 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 diff --git a/_data/engine-cli/docker_logout.yaml b/_data/engine-cli/docker_logout.yaml index bceaedae93c..2c4f41b645a 100644 --- a/_data/engine-cli/docker_logout.yaml +++ b/_data/engine-cli/docker_logout.yaml @@ -10,4 +10,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_logs.yaml b/_data/engine-cli/docker_logs.yaml index 52adb6c7e0e..8750eee686e 100644 --- a/_data/engine-cli/docker_logs.yaml +++ b/_data/engine-cli/docker_logs.yaml @@ -46,6 +46,9 @@ 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 @@ -53,18 +56,27 @@ 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 @@ -72,6 +84,9 @@ options: description: Show timestamps deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: until value_type: string description: | @@ -79,6 +94,9 @@ options: deprecated: false min_api_version: "1.35" experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Retrieve logs until a specific point in time @@ -95,4 +113,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_manifest.yaml b/_data/engine-cli/docker_manifest.yaml new file mode 100644 index 00000000000..fa0fbdc177c --- /dev/null +++ b/_data/engine-cli/docker_manifest.yaml @@ -0,0 +1,133 @@ +command: docker manifest +short: Manage Docker image manifests and manifest lists +long: "The `docker manifest` command by itself performs no action. In order to operate\non + a manifest or manifest list, one of the subcommands must be used.\n\nA single manifest + is information about an image, such as layers, size, and digest.\nThe docker manifest + command also gives users additional information such as the os\nand architecture + an image was built for.\n\nA manifest list is a list of image layers that is created + by specifying one or\nmore (ideally more than one) image names. It can then be used + in the same way as\nan image name in `docker pull` and `docker run` commands, for + example.\n\nIdeally a manifest list is created from images that are identical in + function for\ndifferent os/arch combinations. For this reason, manifest lists are + often referred to as\n\"multi-arch images.\" However, a user could create a manifest + list that points\nto two images -- one for windows on amd64, and one for darwin + on amd64.\n\n### manifest inspect\n\n```\nmanifest inspect --help\n\nUsage: docker + manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST\n\nisplay an image manifest, + or manifest list\n\nOptions:\n --help Print usage\n --insecure allow + communication with an insecure registry\n -v, --verbose Output additional info + including layers and platform\n```\n\n### manifest create \n\n```bash\nUsage: docker + manifest create MANFEST_LIST MANIFEST [MANIFEST...]\n\nCreate a local manifest list + for annotating and pushing to a registry\n\nOptions:\n -a, --amend Amend an existing + manifest list\n --insecure allow communication with an insecure registry\n + \ --help Print usage\n```\n\n### manifest annotate\n```bash\nUsage: docker + manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST\n\nAdd additional information + to a local image manifest\n\nOptions:\n --arch string Set architecture\n + \ --help Print usage\n --os string Set + operating system\n --os-features stringSlice Set operating system feature\n + \ --variant string Set architecture variant\n\n```\n\n### manifest + push\n```bash\nUsage: docker manifest push [OPTIONS] MANIFEST_LIST\n\nPush a manifest + list to a repository\n\nOptions:\n --help Print usage\n --insecure + \ allow push to an insecure registry\n -p, --purge Remove the local manifest + list after push\n```\n\n### Working with insecure registries\n\nThe manifest command + interacts solely with a Docker registry. Because of this, it has no way to query + the engine for the list of allowed insecure registries. To allow the CLI to interact + with an insecure registry, some `docker manifest` commands have an `--insecure` + flag. For each transaction, such as a `create`, which queries a registry, the `--insecure` + flag must be specified. This flag tells the CLI that this registry call may ignore + security concerns like missing or self-signed certificates. Likewise, on a `manifest + push` to an insecure registry, the `--insecure` flag must be specified. If this + is not used with an insecure registry, the manifest command fails to find a registry + that meets the default requirements." +usage: docker manifest COMMAND +pname: docker +plink: docker.yaml +cname: +- docker manifest annotate +- docker manifest create +- docker manifest inspect +- docker manifest push +clink: +- docker_manifest_annotate.yaml +- docker_manifest_create.yaml +- docker_manifest_inspect.yaml +- docker_manifest_push.yaml +examples: "### inspect an image's manifest object\n \n```bash\n$ docker manifest inspect + hello-world\n{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n + \ \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n + \ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n + \ },\n \"layers\": [\n {\n \"mediaType\": + \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": + 972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n + \ }\n ]\n}\n```\n\n### Inspect an image's manifest and get + the os/arch info\n\nThe `docker manifest inspect` command takes an optional `--verbose` + flag\nthat gives you the image's name (Ref), and architecture and os (Platform).\n\nJust + as with other docker commands that take image names, you can refer to an image with + or\nwithout a tag, or by digest (e.g. hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f).\n\nHere + is an example of inspecting an image's manifest with the `--verbose` flag:\n\n```bash\n$ + docker manifest inspect -v hello-world\n{\n \"Ref\": \"docker.io/library/hello-world:latest\",\n + \ \"Digest\": \"sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f\",\n + \ \"SchemaV2Manifest\": {\n \"schemaVersion\": 2,\n \"mediaType\": + \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": + {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n + \ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n + \ },\n \"layers\": [\n {\n \"mediaType\": + \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": + 972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n + \ }\n ]\n },\n \"Platform\": + {\n \"architecture\": \"amd64\",\n \"os\": \"linux\"\n + \ }\n}\n```\n\n### Create and push a manifest list\n\nTo create a manifest + list, you first `create` the manifest list locally by specifying the constituent + images you would\nlike to have included in your manifest list. Keep in mind that + this is pushed to a registry, so if you want to push\nto a registry other than the + docker registry, you need to create your manifest list with the registry name or + IP and port.\nThis is similar to tagging an image and pushing it to a foreign registry.\n\nAfter + you have created your local copy of the manifest list, you may optionally\n`annotate` + it. Annotations allowed are the architecture and operating system (overriding the + image's current values),\nos features, and an archictecure variant. \n\nFinally, + you need to `push` your manifest list to the desired registry. Below are descriptions + of these three commands,\nand an example putting them all together.\n\n```bash\n$ + docker manifest create 45.55.81.106:5000/coolapp:v1 \\\n 45.55.81.106:5000/coolapp-ppc64le-linux:v1 + \\\n 45.55.81.106:5000/coolapp-arm-linux:v1 \\\n 45.55.81.106:5000/coolapp-amd64-linux:v1 + \\\n 45.55.81.106:5000/coolapp-amd64-windows:v1\nCreated manifest list 45.55.81.106:5000/coolapp:v1\n```\n\n```bash\n$ + docker manifest annotate 45.55.81.106:5000/coolapp:v1 45.55.81.106:5000/coolapp-arm-linux + --arch arm\n```\n\n```bash\n$ docker manifest push 45.55.81.106:5000/coolapp:v1\nPushed + manifest 45.55.81.106:5000/coolapp@sha256:9701edc932223a66e49dd6c894a11db8c2cf4eccd1414f1ec105a623bf16b426 + with digest: sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\nPushed + manifest 45.55.81.106:5000/coolapp@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f + with digest: sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\nPushed + manifest 45.55.81.106:5000/coolapp@sha256:39dc41c658cf25f33681a41310372f02728925a54aac3598310bfb1770615fc9 + with digest: sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\nPushed + manifest 45.55.81.106:5000/coolapp@sha256:f91b1145cd4ac800b28122313ae9e88ac340bb3f1e3a4cd3e59a3648650f3275 + with digest: sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\nsha256:050b213d49d7673ba35014f21454c573dcbec75254a08f4a7c34f66a47c06aba\n\n```\n\n### + Inspect a manifest list\n\n```bash\n$ docker manifest inspect coolapp:v1\n{\n \"schemaVersion\": + 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.list.v2+json\",\n + \ \"manifests\": [\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n + \ \"size\": 424,\n \"digest\": \"sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\",\n + \ \"platform\": {\n \"architecture\": \"arm\",\n \"os\": + \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n + \ \"size\": 424,\n \"digest\": \"sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\",\n + \ \"platform\": {\n \"architecture\": \"amd64\",\n \"os\": + \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n + \ \"size\": 425,\n \"digest\": \"sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\",\n + \ \"platform\": {\n \"architecture\": \"ppc64le\",\n \"os\": + \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n + \ \"size\": 425,\n \"digest\": \"sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\",\n + \ \"platform\": {\n \"architecture\": \"s390x\",\n \"os\": + \"linux\"\n }\n }\n ]\n}\n```\n\n### Push to an insecure registry\n\nHere + is an example of creating and pushing a manifest list using a known insecure registry.\n\n```\n$ + docker manifest create --insecure myprivateregistry.mycompany.com/repo/image:1.0 + \\\n myprivateregistry.mycompany.com/repo/image-linux-ppc64le:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-s390x:1.0 + \\\n myprivateregistry.mycompany.com/repo/image-linux-arm:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-armhf:1.0 + \\\n myprivateregistry.mycompany.com/repo/image-windows-amd64:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-amd64:1.0\n```\n```\n$ + docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag\n```\n\nNote + that the `--insecure` flag is not required to annotate a manifest list, since annotations + are to a locally-stored copy of a manifest list. You may also skip the `--insecure` + flag if you are performaing a `docker manifest inspect` on a locally-stored manifest + list. Be sure to keep in mind that locally-stored manifest lists are never used + by the engine on a `docker pull`." +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_manifest_annotate.yaml b/_data/engine-cli/docker_manifest_annotate.yaml new file mode 100644 index 00000000000..c1491c2e6b8 --- /dev/null +++ b/_data/engine-cli/docker_manifest_annotate.yaml @@ -0,0 +1,46 @@ +command: docker manifest annotate +short: Add additional information to a local image manifest +long: Add additional information to a local image manifest +usage: docker manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST +pname: docker manifest +plink: docker_manifest.yaml +options: +- option: arch + value_type: string + description: Set architecture + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: os + value_type: string + description: Set operating system + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: os-features + value_type: stringSlice + default_value: '[]' + description: Set operating system feature + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: variant + value_type: string + description: Set architecture variant + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_manifest_create.yaml b/_data/engine-cli/docker_manifest_create.yaml new file mode 100644 index 00000000000..fd49ff5614a --- /dev/null +++ b/_data/engine-cli/docker_manifest_create.yaml @@ -0,0 +1,32 @@ +command: docker manifest create +short: Create a local manifest list for annotating and pushing to a registry +long: Create a local manifest list for annotating and pushing to a registry +usage: docker manifest create MANFEST_LIST MANIFEST [MANIFEST...] +pname: docker manifest +plink: docker_manifest.yaml +options: +- option: amend + shorthand: a + value_type: bool + default_value: "false" + description: Amend an existing manifest list + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: insecure + value_type: bool + default_value: "false" + description: allow communication with an insecure registry + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_manifest_inspect.yaml b/_data/engine-cli/docker_manifest_inspect.yaml new file mode 100644 index 00000000000..c0a54bd0dbd --- /dev/null +++ b/_data/engine-cli/docker_manifest_inspect.yaml @@ -0,0 +1,32 @@ +command: docker manifest inspect +short: Display an image manifest, or manifest list +long: Display an image manifest, or manifest list +usage: docker manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST +pname: docker manifest +plink: docker_manifest.yaml +options: +- option: insecure + value_type: bool + default_value: "false" + description: allow communication with an insecure registry + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: verbose + shorthand: v + value_type: bool + default_value: "false" + description: Output additional info including layers and platform + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_manifest_push.yaml b/_data/engine-cli/docker_manifest_push.yaml new file mode 100644 index 00000000000..e286da6aee8 --- /dev/null +++ b/_data/engine-cli/docker_manifest_push.yaml @@ -0,0 +1,32 @@ +command: docker manifest push +short: Push a manifest list to a repository +long: Push a manifest list to a repository +usage: docker manifest push [OPTIONS] MANIFEST_LIST +pname: docker manifest +plink: docker_manifest.yaml +options: +- option: insecure + value_type: bool + default_value: "false" + description: Allow push to an insecure registry + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: purge + shorthand: p + value_type: bool + default_value: "false" + description: Remove the local manifest list after push + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/engine-cli/docker_network.yaml b/_data/engine-cli/docker_network.yaml index 9ee3ab5cd3e..01efb3d9028 100644 --- a/_data/engine-cli/docker_network.yaml +++ b/_data/engine-cli/docker_network.yaml @@ -24,4 +24,7 @@ clink: - docker_network_rm.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_connect.yaml b/_data/engine-cli/docker_network_connect.yaml index 06c79bac980..9c2fd439626 100644 --- a/_data/engine-cli/docker_network_connect.yaml +++ b/_data/engine-cli/docker_network_connect.yaml @@ -14,27 +14,42 @@ options: description: Add network-scoped alias for the container 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: 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: stringSlice default_value: '[]' description: Add a link-local address for the container deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Connect a running container to a network @@ -105,4 +120,7 @@ examples: |- You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_create.yaml b/_data/engine-cli/docker_network_create.yaml index 352b4dfb685..799e4b32282 100644 --- a/_data/engine-cli/docker_network_create.yaml +++ b/_data/engine-cli/docker_network_create.yaml @@ -48,6 +48,18 @@ 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 @@ -59,18 +71,27 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: aux-address value_type: map default_value: map[] description: Auxiliary IPv4 or IPv6 addresses used by Network driver deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: config-from value_type: string description: The network from which copying the configuration deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: config-only value_type: bool default_value: "false" @@ -78,6 +99,9 @@ options: deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: driver shorthand: d value_type: string @@ -85,12 +109,18 @@ options: description: Driver to manage the Network deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: gateway value_type: stringSlice default_value: '[]' description: IPv4 or IPv6 Gateway for the master subnet deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ingress value_type: bool default_value: "false" @@ -98,41 +128,62 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: internal value_type: bool default_value: "false" description: Restrict external access to the network deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ip-range value_type: stringSlice default_value: '[]' description: Allocate container ip from a sub-range deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ipam-driver value_type: string default_value: default description: IP Address Management Driver deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ipam-opt value_type: map default_value: map[] description: Set IPAM driver specific options deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ipv6 value_type: bool default_value: "false" description: Enable IPv6 networking deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label value_type: list description: Set metadata on a network deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: opt shorthand: o value_type: map @@ -140,18 +191,27 @@ options: description: Set driver specific options deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: scope value_type: string description: Control the network's scope deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: subnet value_type: stringSlice default_value: '[]' description: Subnet in CIDR format that represents a network segment deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Connect containers @@ -200,15 +260,16 @@ 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. + 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. ```bash $ docker network create -d overlay \ - --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 \ + --subnet=192.168.1.0/25 \ + --subnet=192.170.2.0/25 \ + --gateway=192.168.1.100 \ + --gateway=192.170.2.100 \ --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 @@ -276,4 +337,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_disconnect.yaml b/_data/engine-cli/docker_network_disconnect.yaml index 830bc556568..507b3056601 100644 --- a/_data/engine-cli/docker_network_disconnect.yaml +++ b/_data/engine-cli/docker_network_disconnect.yaml @@ -1,7 +1,7 @@ command: docker network disconnect short: Disconnect a container from a network -long: |2- - a container from a network. The container must be running to +long: |- + Disconnects 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 @@ -14,10 +14,16 @@ options: description: Force the container to disconnect from a network deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker network disconnect multi-host-network container1 ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_inspect.yaml b/_data/engine-cli/docker_network_inspect.yaml index 02245ed3b75..b29c872a265 100644 --- a/_data/engine-cli/docker_network_inspect.yaml +++ b/_data/engine-cli/docker_network_inspect.yaml @@ -13,6 +13,9 @@ options: description: Format the output using the given Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: verbose shorthand: v value_type: bool @@ -20,6 +23,12 @@ options: description: Verbose output for diagnostics deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_ls.yaml b/_data/engine-cli/docker_network_ls.yaml index 53263c45e83..6688affca90 100644 --- a/_data/engine-cli/docker_network_ls.yaml +++ b/_data/engine-cli/docker_network_ls.yaml @@ -14,17 +14,26 @@ options: description: Provide filter values (e.g. 'driver=bridge') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: format value_type: string description: Pretty-print networks using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-trunc value_type: bool default_value: "false" description: Do not truncate the output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -32,6 +41,9 @@ options: description: Only display network IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK ID \ NAME DRIVER SCOPE\n7fca4eb8c647 bridge \ bridge local\n9f904ee27bf5 none null @@ -114,4 +126,7 @@ examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK I {{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```" deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_prune.yaml b/_data/engine-cli/docker_network_prune.yaml index 5f399b58db6..251d0f3444b 100644 --- a/_data/engine-cli/docker_network_prune.yaml +++ b/_data/engine-cli/docker_network_prune.yaml @@ -12,6 +12,9 @@ options: description: Provide filter values (e.g. 'until=') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force shorthand: f value_type: bool @@ -19,6 +22,9 @@ options: description: Do not prompt for confirmation deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker network prune @@ -32,7 +38,7 @@ examples: |- ### Filtering - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more + The filtering flag (`--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: @@ -86,4 +92,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_network_rm.yaml b/_data/engine-cli/docker_network_rm.yaml index 3d9c5ff3023..9feeccce5e3 100644 --- a/_data/engine-cli/docker_network_rm.yaml +++ b/_data/engine-cli/docker_network_rm.yaml @@ -32,4 +32,7 @@ examples: |- deletion. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_node.yaml b/_data/engine-cli/docker_node.yaml index 4f88bad0fec..ca3e52bf5f3 100644 --- a/_data/engine-cli/docker_node.yaml +++ b/_data/engine-cli/docker_node.yaml @@ -23,4 +23,7 @@ clink: deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_demote.yaml b/_data/engine-cli/docker_node_demote.yaml index 3192cce9b78..9d671e42a45 100644 --- a/_data/engine-cli/docker_node_demote.yaml +++ b/_data/engine-cli/docker_node_demote.yaml @@ -1,7 +1,7 @@ command: docker node demote short: Demote one or more nodes from manager in the swarm long: |- - motes an existing manager so that it is no longer a manager. This command + Demotes 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 @@ -13,4 +13,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_inspect.yaml b/_data/engine-cli/docker_node_inspect.yaml index 07a3b67cd55..d0790e06173 100644 --- a/_data/engine-cli/docker_node_inspect.yaml +++ b/_data/engine-cli/docker_node_inspect.yaml @@ -16,12 +16,18 @@ 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 examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n \ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\": 10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\": @@ -61,4 +67,7 @@ examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\ deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_ls.yaml b/_data/engine-cli/docker_node_ls.yaml index 5241531e18b..6e363374284 100644 --- a/_data/engine-cli/docker_node_ls.yaml +++ b/_data/engine-cli/docker_node_ls.yaml @@ -15,11 +15,17 @@ 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 nodes using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -27,6 +33,9 @@ options: description: Only display IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: "```bash\n$ docker node ls\n\nID HOSTNAME STATUS \ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready \ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\ne216jshn25ckzbvmwlnh5jr3g @@ -68,14 +77,17 @@ 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\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`.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```" deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_promote.yaml b/_data/engine-cli/docker_node_promote.yaml index 360d89565a3..ddb6a702647 100644 --- a/_data/engine-cli/docker_node_promote.yaml +++ b/_data/engine-cli/docker_node_promote.yaml @@ -13,4 +13,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_ps.yaml b/_data/engine-cli/docker_node_ps.yaml index c81b1cac848..1d1dd220ca6 100644 --- a/_data/engine-cli/docker_node_ps.yaml +++ b/_data/engine-cli/docker_node_ps.yaml @@ -13,23 +13,35 @@ 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 tasks using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve value_type: bool default_value: "false" description: Do not map IDs to Names 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 - option: quiet shorthand: q value_type: bool @@ -37,6 +49,9 @@ options: description: Only display task IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker node ps swarm-manager1 @@ -142,4 +157,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_rm.yaml b/_data/engine-cli/docker_node_rm.yaml index 4a30b63e588..7133baa84ef 100644 --- a/_data/engine-cli/docker_node_rm.yaml +++ b/_data/engine-cli/docker_node_rm.yaml @@ -13,6 +13,9 @@ options: description: Force remove a node from the swarm deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Remove a stopped node from the swarm @@ -51,4 +54,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_node_update.yaml b/_data/engine-cli/docker_node_update.yaml index 254771aef1e..a5ba4451fd3 100644 --- a/_data/engine-cli/docker_node_update.yaml +++ b/_data/engine-cli/docker_node_update.yaml @@ -10,21 +10,33 @@ options: description: Availability of the node ("active"|"pause"|"drain") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label-add value_type: list description: Add or update a node label (key=value) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label-rm value_type: list description: Remove a node label if exists deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: role value_type: string description: Role of the node ("worker"|"manager") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Add label metadata to a node @@ -61,4 +73,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_pause.yaml b/_data/engine-cli/docker_pause.yaml index 0549229995f..49714e66c0c 100644 --- a/_data/engine-cli/docker_pause.yaml +++ b/_data/engine-cli/docker_pause.yaml @@ -20,4 +20,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin.yaml b/_data/engine-cli/docker_plugin.yaml index bfac06a6c45..23b9087eef8 100644 --- a/_data/engine-cli/docker_plugin.yaml +++ b/_data/engine-cli/docker_plugin.yaml @@ -29,4 +29,7 @@ clink: deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_create.yaml b/_data/engine-cli/docker_plugin_create.yaml index 197a68ce37e..4d666debcb3 100644 --- a/_data/engine-cli/docker_plugin_create.yaml +++ b/_data/engine-cli/docker_plugin_create.yaml @@ -14,6 +14,9 @@ options: description: Compress the context using gzip deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example shows how to create a sample `plugin`. @@ -38,4 +41,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_disable.yaml b/_data/engine-cli/docker_plugin_disable.yaml index c6adc132ec4..d77ce27dc23 100644 --- a/_data/engine-cli/docker_plugin_disable.yaml +++ b/_data/engine-cli/docker_plugin_disable.yaml @@ -1,7 +1,7 @@ command: docker plugin disable short: Disable a plugin long: |- - ables a plugin. The plugin must be installed before it can be disabled, + Disables 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 @@ -15,6 +15,9 @@ options: description: Force the disable of an active plugin deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example shows that the `sample-volume-plugin` plugin is installed and enabled: @@ -41,4 +44,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_enable.yaml b/_data/engine-cli/docker_plugin_enable.yaml index 7a0aa93a8be..30fa394e184 100644 --- a/_data/engine-cli/docker_plugin_enable.yaml +++ b/_data/engine-cli/docker_plugin_enable.yaml @@ -9,10 +9,13 @@ plink: docker_plugin.yaml options: - option: timeout value_type: int - default_value: "0" + default_value: "30" description: HTTP client timeout (in seconds) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example shows that the `sample-volume-plugin` plugin is installed, but disabled: @@ -39,4 +42,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_inspect.yaml b/_data/engine-cli/docker_plugin_inspect.yaml index ea00b69447d..acc6c747949 100644 --- a/_data/engine-cli/docker_plugin_inspect.yaml +++ b/_data/engine-cli/docker_plugin_inspect.yaml @@ -13,6 +13,9 @@ options: description: Format the output using the given Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```none $ docker plugin inspect tiborvass/sample-volume-plugin:latest @@ -136,4 +139,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_install.yaml b/_data/engine-cli/docker_plugin_install.yaml index 6fc1ae8cad8..255f44cedb7 100644 --- a/_data/engine-cli/docker_plugin_install.yaml +++ b/_data/engine-cli/docker_plugin_install.yaml @@ -14,24 +14,36 @@ options: description: Local name for plugin deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: disable value_type: bool default_value: "false" description: Do not enable the plugin on install 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: grant-all-permissions value_type: bool default_value: "false" description: Grant all permissions necessary to run the plugin deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its `DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker @@ -60,4 +72,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_ls.yaml b/_data/engine-cli/docker_plugin_ls.yaml index 6dbf4907aaa..dc5e399f564 100644 --- a/_data/engine-cli/docker_plugin_ls.yaml +++ b/_data/engine-cli/docker_plugin_ls.yaml @@ -16,17 +16,26 @@ options: description: Provide filter values (e.g. 'enabled=true') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: format value_type: string description: Pretty-print plugins 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 @@ -34,6 +43,9 @@ options: description: Only display plugin IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker plugin ls @@ -102,4 +114,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_push.yaml b/_data/engine-cli/docker_plugin_push.yaml index 6d1b9b02151..5cbf90b0082 100644 --- a/_data/engine-cli/docker_plugin_push.yaml +++ b/_data/engine-cli/docker_plugin_push.yaml @@ -16,6 +16,9 @@ options: description: Skip image signing deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example shows how to push a sample `user/plugin`. @@ -30,4 +33,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_rm.yaml b/_data/engine-cli/docker_plugin_rm.yaml index c914d6948dd..e6222f4a78a 100644 --- a/_data/engine-cli/docker_plugin_rm.yaml +++ b/_data/engine-cli/docker_plugin_rm.yaml @@ -17,6 +17,9 @@ options: description: Force the removal of an active plugin deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example disables and removes the `sample-volume-plugin:latest` plugin: @@ -33,4 +36,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_set.yaml b/_data/engine-cli/docker_plugin_set.yaml index d7c2c8e42ab..b8da2b11cbb 100644 --- a/_data/engine-cli/docker_plugin_set.yaml +++ b/_data/engine-cli/docker_plugin_set.yaml @@ -7,7 +7,7 @@ long: |- * env variables * source of mounts * path of devices - * arg + * args usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...] pname: docker plugin plink: docker_plugin.yaml @@ -83,4 +83,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_plugin_upgrade.yaml b/_data/engine-cli/docker_plugin_upgrade.yaml index b5430d30a32..7a5baff06d9 100644 --- a/_data/engine-cli/docker_plugin_upgrade.yaml +++ b/_data/engine-cli/docker_plugin_upgrade.yaml @@ -15,12 +15,18 @@ options: description: Skip image verification deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: grant-all-permissions value_type: bool default_value: "false" description: Grant all permissions necessary to run the plugin deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: skip-remote-check value_type: bool default_value: "false" @@ -28,6 +34,9 @@ options: Do not check if specified remote plugin matches existing plugin image deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- The following example installs `vieus/sshfs` plugin, uses it to create and use a volume, then upgrades the plugin. @@ -82,4 +91,7 @@ examples: |- deprecated: false min_api_version: "1.26" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_port.yaml b/_data/engine-cli/docker_port.yaml index cdf9306cac2..7ee8782a838 100644 --- a/_data/engine-cli/docker_port.yaml +++ b/_data/engine-cli/docker_port.yaml @@ -26,4 +26,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_ps.yaml b/_data/engine-cli/docker_ps.yaml index 217240a6f79..248e20a8aa8 100644 --- a/_data/engine-cli/docker_ps.yaml +++ b/_data/engine-cli/docker_ps.yaml @@ -12,17 +12,26 @@ 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 @@ -30,6 +39,9 @@ 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 @@ -37,12 +49,18 @@ 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 @@ -50,6 +68,9 @@ options: description: Only display numeric IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: size shorthand: s value_type: bool @@ -57,6 +78,9 @@ options: description: Display total file sizes deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Prevent truncating output @@ -442,4 +466,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_pull.yaml b/_data/engine-cli/docker_pull.yaml index 446ad630b2d..7b9768e9cf7 100644 --- a/_data/engine-cli/docker_pull.yaml +++ b/_data/engine-cli/docker_pull.yaml @@ -36,18 +36,27 @@ 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 examples: |- ### Pull an image from Docker Hub @@ -248,4 +257,7 @@ examples: |- > lost for other reasons than a manual interaction, the pull is also aborted. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index 54b2098d16f..519980cc258 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -22,6 +22,9 @@ options: description: Skip image signing deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Push a new image to a registry @@ -54,4 +57,7 @@ examples: |- listed. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_rename.yaml b/_data/engine-cli/docker_rename.yaml index b3df21d236c..c57ea4b5b82 100644 --- a/_data/engine-cli/docker_rename.yaml +++ b/_data/engine-cli/docker_rename.yaml @@ -10,4 +10,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_restart.yaml b/_data/engine-cli/docker_restart.yaml index 7b21af4c1dc..90ff107560d 100644 --- a/_data/engine-cli/docker_restart.yaml +++ b/_data/engine-cli/docker_restart.yaml @@ -12,10 +12,16 @@ options: description: Seconds to wait for stop before killing the container deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker restart my_container ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_rm.yaml b/_data/engine-cli/docker_rm.yaml index df4efed1def..889a62aca89 100644 --- a/_data/engine-cli/docker_rm.yaml +++ b/_data/engine-cli/docker_rm.yaml @@ -12,6 +12,9 @@ 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 @@ -19,6 +22,9 @@ options: description: Remove the specified link deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: volumes shorthand: v value_type: bool @@ -26,6 +32,9 @@ options: description: Remove the volumes associated with the container deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Remove a container @@ -98,4 +107,7 @@ examples: |- `--volumes-from`. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_rmi.yaml b/_data/engine-cli/docker_rmi.yaml index 3fc2af9c4f0..e21b2d3d46a 100644 --- a/_data/engine-cli/docker_rmi.yaml +++ b/_data/engine-cli/docker_rmi.yaml @@ -12,12 +12,18 @@ 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 examples: |- You can remove an image using its short or long ID, its tag, or its digest. If an image has one or more tags referencing it, you must remove all of them before @@ -96,4 +102,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_run.yaml b/_data/engine-cli/docker_run.yaml index 92c64e1f566..d7b59fe2f2c 100644 --- a/_data/engine-cli/docker_run.yaml +++ b/_data/engine-cli/docker_run.yaml @@ -21,12 +21,18 @@ 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" @@ -34,56 +40,86 @@ 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" @@ -91,6 +127,9 @@ 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" @@ -98,6 +137,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -105,22 +147,34 @@ 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 @@ -128,114 +182,177 @@ 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 @@ -244,6 +361,9 @@ 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 @@ -251,18 +371,27 @@ 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" @@ -271,6 +400,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: interactive shorthand: i value_type: bool @@ -278,6 +410,9 @@ 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" @@ -285,74 +420,116 @@ 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 @@ -360,12 +537,18 @@ 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" @@ -373,91 +556,139 @@ 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 @@ -465,52 +696,79 @@ 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" @@ -518,22 +776,34 @@ 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 @@ -541,50 +811,77 @@ 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: [:])' 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: |- ### Assign name and allocate pseudo-TTY (--name, -it) @@ -766,12 +1063,12 @@ examples: |- ### Publish or expose port (-p, --expose) ```bash - $ docker run -p 127.0.0.1:80:8080 ubuntu bash + $ docker run -p 127.0.0.1:80:8080/tcp ubuntu bash ``` - 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/) + 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/) explains in detail how to manipulate ports in Docker. ```bash @@ -1015,6 +1312,7 @@ 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 @@ -1238,4 +1536,7 @@ examples: |- If you use the `--network=host` option using these sysctls will not be allowed. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_save.yaml b/_data/engine-cli/docker_save.yaml index 6b1222fa636..5a23a1236b3 100644 --- a/_data/engine-cli/docker_save.yaml +++ b/_data/engine-cli/docker_save.yaml @@ -14,6 +14,9 @@ options: description: Write to a file, instead of STDOUT deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Create a backup that can then be used with `docker load`. @@ -44,4 +47,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_search.yaml b/_data/engine-cli/docker_search.yaml index 0a1813aace4..1244637a864 100644 --- a/_data/engine-cli/docker_search.yaml +++ b/_data/engine-cli/docker_search.yaml @@ -17,29 +17,44 @@ options: description: Only show automated builds deprecated: true 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 search using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: limit value_type: int default_value: "25" description: Max number of search results 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: stars shorthand: s value_type: uint @@ -47,6 +62,9 @@ options: description: Only displays with at least x stars deprecated: true experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: "### Search images by name\n\nThis example displays images with a name containing 'busybox':\n\n```none\n$ docker search busybox\n\nNAME DESCRIPTION \ STARS OFFICIAL AUTOMATED\nbusybox Busybox @@ -130,4 +148,7 @@ examples: "### Search images by name\n\nThis example displays images with a name \ \n{% endraw %}\n```" deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_secret.yaml b/_data/engine-cli/docker_secret.yaml index d1b319727e5..9ec8a706218 100644 --- a/_data/engine-cli/docker_secret.yaml +++ b/_data/engine-cli/docker_secret.yaml @@ -17,4 +17,7 @@ clink: deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_secret_create.yaml b/_data/engine-cli/docker_secret_create.yaml index 904eb723c35..374afa3b74c 100644 --- a/_data/engine-cli/docker_secret_create.yaml +++ b/_data/engine-cli/docker_secret_create.yaml @@ -12,14 +12,28 @@ options: value_type: string description: Secret driver deprecated: false - min_api_version: "1.31" + min_api_version: "1.37" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label shorthand: l value_type: list description: Secret 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 examples: |- ### Create a secret @@ -81,4 +95,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_secret_inspect.yaml b/_data/engine-cli/docker_secret_inspect.yaml index 14e3e94bd95..e0b3a6c01a1 100644 --- a/_data/engine-cli/docker_secret_inspect.yaml +++ b/_data/engine-cli/docker_secret_inspect.yaml @@ -21,12 +21,18 @@ 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 examples: |- ### Inspect a secret by name or ID @@ -77,4 +83,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_secret_ls.yaml b/_data/engine-cli/docker_secret_ls.yaml index 17ab912ec5e..9fba65db2ff 100644 --- a/_data/engine-cli/docker_secret_ls.yaml +++ b/_data/engine-cli/docker_secret_ls.yaml @@ -15,11 +15,17 @@ 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 secrets using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -27,6 +33,9 @@ options: description: Only display IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker secret ls @@ -142,4 +151,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_secret_rm.yaml b/_data/engine-cli/docker_secret_rm.yaml index 6cdd3b3c3ef..1f5f500508c 100644 --- a/_data/engine-cli/docker_secret_rm.yaml +++ b/_data/engine-cli/docker_secret_rm.yaml @@ -22,4 +22,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service.yaml b/_data/engine-cli/docker_service.yaml index bb4ae9be149..918bd3b6b94 100644 --- a/_data/engine-cli/docker_service.yaml +++ b/_data/engine-cli/docker_service.yaml @@ -27,4 +27,7 @@ clink: deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_create.yaml b/_data/engine-cli/docker_service_create.yaml index 3fa03674d19..c980fd50385 100644 --- a/_data/engine-cli/docker_service_create.yaml +++ b/_data/engine-cli/docker_service_create.yaml @@ -13,22 +13,34 @@ options: deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: constraint value_type: list description: Placement constraints deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: container-label value_type: list description: Container labels deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: credential-spec value_type: credential-spec description: Credential spec for managed service account (Windows only) deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: detach shorthand: d value_type: bool @@ -38,69 +50,105 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns value_type: list description: Set custom DNS servers deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-option value_type: list description: Set DNS options deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-search value_type: list description: Set custom DNS search domains deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: endpoint-mode value_type: string default_value: vip description: Endpoint mode (vip or dnsrr) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: entrypoint value_type: command 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: generic-resource value_type: list description: User defined resources deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: group value_type: list description: Set one or more supplementary user groups for the container deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-cmd value_type: string description: Command to run to check health deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-interval value_type: duration description: Time between running the check (ms|s|m|h) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-retries value_type: int default_value: "0" @@ -108,6 +156,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-start-period value_type: duration description: | @@ -115,78 +166,120 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-timeout value_type: duration description: Maximum time to allow one check to run (ms|s|m|h) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: host value_type: list description: Set one or more custom host-to-IP mappings (host:ip) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: hostname value_type: string description: Container hostname deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: isolation value_type: string description: Service container isolation mode deprecated: false min_api_version: "1.35" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label shorthand: l value_type: list description: Service labels deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: limit-cpu value_type: decimal description: Limit CPUs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: limit-memory value_type: bytes default_value: "0" description: Limit Memory deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: log-driver value_type: string description: Logging driver for service deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: log-opt value_type: list description: Logging driver options deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mode value_type: string default_value: replicated description: Service mode (replicated or global) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mount value_type: mount description: Attach a filesystem mount to the service deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: name value_type: string description: Service name deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: network value_type: network description: Network attachments deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-healthcheck value_type: bool default_value: "false" @@ -194,6 +287,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve-image value_type: bool default_value: "false" @@ -202,18 +298,27 @@ options: deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: placement-pref value_type: pref description: Add a placement preference deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: publish shorthand: p value_type: port description: Publish a port as a node port deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -221,6 +326,9 @@ options: description: Suppress progress output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: read-only value_type: bool default_value: "false" @@ -228,43 +336,67 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: replicas value_type: uint description: Number of tasks deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: reserve-cpu value_type: decimal description: Reserve CPUs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: reserve-memory value_type: bytes default_value: "0" description: Reserve Memory deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-condition value_type: string description: | Restart when condition is met ("none"|"on-failure"|"any") (default "any") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-delay value_type: duration description: Delay between restart attempts (ns|us|ms|s|m|h) (default 5s) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-max-attempts value_type: uint description: Maximum number of restarts before giving up deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-window value_type: duration description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-delay value_type: duration default_value: 0s @@ -272,6 +404,9 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-failure-action value_type: string description: | @@ -279,6 +414,9 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-max-failure-ratio value_type: float default_value: "0" @@ -286,6 +424,9 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-monitor value_type: duration default_value: 0s @@ -294,6 +435,9 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-order value_type: string description: | @@ -301,6 +445,9 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-parallelism value_type: uint64 default_value: "1" @@ -309,24 +456,36 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: secret value_type: secret description: Specify secrets to expose to the service deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: stop-grace-period value_type: duration description: | Time to wait before force killing a container (ns|us|ms|s|m|h) (default 10s) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: stop-signal value_type: string description: Signal to stop the container deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: tty shorthand: t value_type: bool @@ -335,18 +494,27 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-delay value_type: duration default_value: 0s description: Delay between updates (ns|us|ms|s|m|h) (default 0s) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-failure-action value_type: string description: | Action on update failure ("pause"|"continue"|"rollback") (default "pause") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-max-failure-ratio value_type: float default_value: "0" @@ -354,6 +522,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-monitor value_type: duration default_value: 0s @@ -362,6 +533,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-order value_type: string description: | @@ -369,6 +543,9 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-parallelism value_type: uint64 default_value: "1" @@ -376,56 +553,76 @@ options: Maximum number of tasks updated simultaneously (0 to update all at once) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: user shorthand: u value_type: string description: 'Username or UID (format: [:])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - 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: 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 a service\n\n```bash\n$ docker service create --name redis redis:3.0.6\n\ndmu1ept4cxcfe8k8lhtux3ro3\n\n$ 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 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 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), 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 @@ -666,41 +863,45 @@ 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\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\n\n\n \n \n \n \n\n\n \n \n \n \n\n\n - \ \n \n \n \n\n\n \n \n \n - \ \n\n\n + 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
OptionShort - syntaxLong syntaxDescription
published - and target port
protocol--publish 8080:80--publish - published=8080,target=80

\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

modeNot possible to set - using short syntax.--publish published=8080,target=80,mode=host

\n The mode to use for binding the port, either `ingress` or `host`. - Defaults\n to `ingress` to use the routing mesh.\n

\n\n\n \n \n + \ \n \n\n\n\n \n \n \n \n\n\n \n \n \n + \ \n\n\n \ \n \n \n \n\n
OptionShort syntaxLong syntaxDescription
published + and target port--publish 8080:80--publish + published=8080,target=80

\n The target port within the container + and the port to map it to on the\n nodes, using the routing mesh (ingress) + 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 + \

modeNot possible to set using short + syntax.--publish published=8080,target=80,mode=host

\n The mode to use for binding the port, either ingress or + host.\n Defaults to ingress to use the routing mesh.\n

protocol--publish 8080:80/tcp--publish published=8080,target=80,protocol=tcp

\n The protocol to - use, either `tcp` or `udp`. Defaults to `tcp`. To bind a\n port for both protocols, - specify the `-p` or `--publish` flag twice.\n

\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### + use, tcp , udp, or sctp. Defaults to\n tcp. + To bind a port for both protocols, specify the -p or\n --publish + flag twice.\n

\n\n\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### 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://` or\n`registry://`.\n\nWhen using @@ -732,8 +933,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- @@ -745,4 +946,7 @@ examples: "### Create a service\n\n```bash\n$ docker service create --name redis deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_inspect.yaml b/_data/engine-cli/docker_service_inspect.yaml index f23c0cb8b48..98bd4741b5c 100644 --- a/_data/engine-cli/docker_service_inspect.yaml +++ b/_data/engine-cli/docker_service_inspect.yaml @@ -19,12 +19,18 @@ 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 examples: "### Inspect a service by name or ID\n\nYou can inspect a service, either by its *name*, or *ID*\n\nFor example, given the following service;\n\n```bash\n$ docker service ls\nID NAME MODE REPLICAS IMAGE\ndmu1ept4cxcf @@ -59,4 +65,7 @@ examples: "### Inspect a service by name or ID\n\nYou can inspect a service, eit deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_logs.yaml b/_data/engine-cli/docker_service_logs.yaml index 282c55f1aa5..d6a75a07bb9 100644 --- a/_data/engine-cli/docker_service_logs.yaml +++ b/_data/engine-cli/docker_service_logs.yaml @@ -52,6 +52,9 @@ options: deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: follow shorthand: f value_type: bool @@ -59,24 +62,36 @@ options: description: Follow log output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve value_type: bool default_value: "false" description: Do not map IDs to Names in output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-task-ids value_type: bool default_value: "false" description: Do not include task IDs in output 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 - option: raw value_type: bool default_value: "false" @@ -84,18 +99,27 @@ options: deprecated: false min_api_version: "1.30" 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 @@ -103,7 +127,13 @@ options: description: Show timestamps deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false min_api_version: "1.29" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_ls.yaml b/_data/engine-cli/docker_service_ls.yaml index 9366499ebdd..0407b5088f5 100644 --- a/_data/engine-cli/docker_service_ls.yaml +++ b/_data/engine-cli/docker_service_ls.yaml @@ -14,11 +14,17 @@ 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 services using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -26,6 +32,9 @@ options: description: Only display IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- On a manager node: @@ -145,4 +154,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_ps.yaml b/_data/engine-cli/docker_service_ps.yaml index 5af577d78f8..1b61790b9d8 100644 --- a/_data/engine-cli/docker_service_ps.yaml +++ b/_data/engine-cli/docker_service_ps.yaml @@ -13,23 +13,35 @@ 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 tasks using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve value_type: bool default_value: "false" description: Do not map IDs to Names 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 - option: quiet shorthand: q value_type: bool @@ -37,6 +49,9 @@ options: description: Only display task IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### List the tasks that are part of a service @@ -186,4 +201,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_rm.yaml b/_data/engine-cli/docker_service_rm.yaml index 228a1011a1a..8d1e623d942 100644 --- a/_data/engine-cli/docker_service_rm.yaml +++ b/_data/engine-cli/docker_service_rm.yaml @@ -25,4 +25,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_rollback.yaml b/_data/engine-cli/docker_service_rollback.yaml index 5cf3cfab93f..29e80c391e1 100644 --- a/_data/engine-cli/docker_service_rollback.yaml +++ b/_data/engine-cli/docker_service_rollback.yaml @@ -16,6 +16,9 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -23,6 +26,9 @@ options: description: Suppress progress output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Roll back to the previous version of a service @@ -75,4 +81,7 @@ examples: |- deprecated: false min_api_version: "1.31" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_scale.yaml b/_data/engine-cli/docker_service_scale.yaml index ab8146778ac..f1208dbc242 100644 --- a/_data/engine-cli/docker_service_scale.yaml +++ b/_data/engine-cli/docker_service_scale.yaml @@ -19,6 +19,9 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Scale a single service @@ -81,4 +84,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_service_update.yaml b/_data/engine-cli/docker_service_update.yaml index b5ce72a0f5d..2769d0c3e2e 100644 --- a/_data/engine-cli/docker_service_update.yaml +++ b/_data/engine-cli/docker_service_update.yaml @@ -19,44 +19,68 @@ options: description: Service command args deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: config-add value_type: config description: Add or update a config file on a service deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: config-rm value_type: list description: Remove a configuration file deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: constraint-add value_type: list description: Add or update a placement constraint deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: constraint-rm value_type: list description: Remove a constraint deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: container-label-add value_type: list description: Add or update a container label deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: container-label-rm value_type: list description: Remove a container label by its key deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: credential-spec value_type: credential-spec description: Credential spec for managed service account (Windows only) deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: detach shorthand: d value_type: bool @@ -66,62 +90,95 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-add value_type: list description: Add or update a custom DNS server deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-option-add value_type: list description: Add or update a DNS option deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-option-rm value_type: list description: Remove a DNS option deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-rm value_type: list description: Remove a custom DNS server deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-search-add value_type: list description: Add or update a custom DNS search domain deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dns-search-rm value_type: list description: Remove a DNS search domain deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: endpoint-mode value_type: string description: Endpoint mode (vip or dnsrr) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: entrypoint value_type: command description: Overwrite the default ENTRYPOINT of the image deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: env-add value_type: list description: Add or update an environment variable deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: env-rm value_type: list description: Remove an environment variable deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force value_type: bool default_value: "false" @@ -129,22 +186,34 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: generic-resource-add value_type: list description: Add a Generic resource deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: generic-resource-rm value_type: list description: Remove a Generic resource deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: group-add value_type: list description: Add an additional supplementary user group to the container deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: group-rm value_type: list description: | @@ -152,18 +221,27 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-cmd value_type: string description: Command to run to check health deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-interval value_type: duration description: Time between running the check (ms|s|m|h) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-retries value_type: int default_value: "0" @@ -171,6 +249,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-start-period value_type: duration description: | @@ -178,94 +259,145 @@ options: deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: health-timeout value_type: duration description: Maximum time to allow one check to run (ms|s|m|h) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: host-add value_type: list description: Add a custom host-to-IP mapping (host:ip) deprecated: false min_api_version: "1.32" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: host-rm value_type: list description: Remove a custom host-to-IP mapping (host:ip) deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: hostname value_type: string description: Container hostname deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: image value_type: string description: Service image tag deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: isolation value_type: string description: Service container isolation mode deprecated: false min_api_version: "1.35" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label-add value_type: list description: Add or update a service label deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label-rm value_type: list description: Remove a label by its key deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: limit-cpu value_type: decimal description: Limit CPUs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: limit-memory value_type: bytes default_value: "0" description: Limit Memory deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: log-driver value_type: string description: Logging driver for service deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: log-opt value_type: list description: Logging driver options deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mount-add value_type: mount description: Add or update a mount on a service deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mount-rm value_type: list description: Remove a mount by its target path deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: network-add value_type: network description: Add a network deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: network-rm value_type: list description: Remove a network deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-healthcheck value_type: bool default_value: "false" @@ -273,6 +405,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve-image value_type: bool default_value: "false" @@ -281,28 +416,43 @@ options: deprecated: false min_api_version: "1.30" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: placement-pref-add value_type: pref description: Add a placement preference deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: placement-pref-rm value_type: pref description: Remove a placement preference deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: publish-add value_type: port description: Add or update a published port deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: publish-rm value_type: port description: Remove a published port by its target port deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -310,6 +460,9 @@ options: description: Suppress progress output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: read-only value_type: bool default_value: "false" @@ -317,42 +470,66 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: replicas value_type: uint description: Number of tasks deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: reserve-cpu value_type: decimal description: Reserve CPUs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: reserve-memory value_type: bytes default_value: "0" description: Reserve Memory deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-condition value_type: string description: Restart when condition is met ("none"|"on-failure"|"any") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-delay value_type: duration description: Delay between restart attempts (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-max-attempts value_type: uint description: Maximum number of restarts before giving up deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: restart-window value_type: duration description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback value_type: bool default_value: "false" @@ -360,6 +537,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-delay value_type: duration default_value: 0s @@ -367,12 +547,18 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-failure-action value_type: string description: Action on rollback failure ("pause"|"continue") deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-max-failure-ratio value_type: float default_value: "0" @@ -380,6 +566,9 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-monitor value_type: duration default_value: 0s @@ -388,12 +577,18 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-order value_type: string description: Rollback order ("start-first"|"stop-first") deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rollback-parallelism value_type: uint64 default_value: "0" @@ -402,30 +597,45 @@ options: deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: secret-add value_type: secret description: Add or update a secret on a service deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: secret-rm value_type: list description: Remove a secret deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: stop-grace-period value_type: duration description: | Time to wait before force killing a container (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: stop-signal value_type: string description: Signal to stop the container deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: tty shorthand: t value_type: bool @@ -434,17 +644,26 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-delay value_type: duration default_value: 0s description: Delay between updates (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-failure-action value_type: string description: Action on update failure ("pause"|"continue"|"rollback") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-max-failure-ratio value_type: float default_value: "0" @@ -452,6 +671,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-monitor value_type: duration default_value: 0s @@ -460,12 +682,18 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-order value_type: string description: Update order ("start-first"|"stop-first") deprecated: false min_api_version: "1.29" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: update-parallelism value_type: uint64 default_value: "0" @@ -473,24 +701,36 @@ options: Maximum number of tasks updated simultaneously (0 to update all at once) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: user shorthand: u value_type: string description: 'Username or UID (format: [:])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - 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: 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: |- ### Update a service @@ -555,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/#attach-a-service-to-an-existing-network-network) + [docker service create](service_create/#publish-service-ports-externally-to-the-swarm) reference. The following example adds a published service port to an existing service. @@ -566,6 +806,22 @@ 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. @@ -658,4 +914,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_stack.yaml b/_data/engine-cli/docker_stack.yaml index f0e2903f713..ed80ae25186 100644 --- a/_data/engine-cli/docker_stack.yaml +++ b/_data/engine-cli/docker_stack.yaml @@ -16,7 +16,28 @@ clink: - docker_stack_ps.yaml - docker_stack_rm.yaml - docker_stack_services.yaml +options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_stack_deploy.yaml b/_data/engine-cli/docker_stack_deploy.yaml index cb165c85de4..1ad8c25cc02 100644 --- a/_data/engine-cli/docker_stack_deploy.yaml +++ b/_data/engine-cli/docker_stack_deploy.yaml @@ -13,13 +13,20 @@ 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: string + value_type: stringSlice + default_value: '[]' 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" @@ -27,6 +34,9 @@ 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 @@ -35,12 +45,36 @@ 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 +inherited_options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false examples: |- ### Compose file @@ -78,14 +112,12 @@ examples: |- Creating service vossibility_lookupd ``` - 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. + 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. ```bash - $ docker-compose -f docker-compose.yml -f docker-compose.prod.yml config > docker-stack.yml - $ docker stack deploy --compose-file docker-stack.yml vossibility + $ docker stack deploy --compose-file docker-compose.yml -f docker-compose.prod.yml vossibility Ignoring unsupported options: links @@ -143,4 +175,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_stack_ls.yaml b/_data/engine-cli/docker_stack_ls.yaml index 7afdf7e84fe..830b1d16a1e 100644 --- a/_data/engine-cli/docker_stack_ls.yaml +++ b/_data/engine-cli/docker_stack_ls.yaml @@ -11,6 +11,27 @@ options: description: Pretty-print stacks using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false examples: |- The following command shows all stacks and some additional information: @@ -48,4 +69,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_stack_ps.yaml b/_data/engine-cli/docker_stack_ps.yaml index 5d4c65d35f0..843816ca781 100644 --- a/_data/engine-cli/docker_stack_ps.yaml +++ b/_data/engine-cli/docker_stack_ps.yaml @@ -13,23 +13,35 @@ options: description: Filter output based on conditions provided deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: true - option: format value_type: string description: Pretty-print tasks using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-resolve value_type: bool default_value: "false" description: Do not map IDs to Names 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 - option: quiet shorthand: q value_type: bool @@ -37,6 +49,27 @@ options: description: Only display task IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false examples: |- ### List the tasks that are part of a stack @@ -226,4 +259,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_stack_rm.yaml b/_data/engine-cli/docker_stack_rm.yaml index e32c67671e8..2e95860df7f 100644 --- a/_data/engine-cli/docker_stack_rm.yaml +++ b/_data/engine-cli/docker_stack_rm.yaml @@ -7,6 +7,24 @@ long: |- usage: docker stack rm STACK [STACK...] pname: docker stack plink: docker_stack.yaml +inherited_options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false examples: |- ### Remove a stack @@ -46,4 +64,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_stack_services.yaml b/_data/engine-cli/docker_stack_services.yaml index 526c6829ff3..13d2741388d 100644 --- a/_data/engine-cli/docker_stack_services.yaml +++ b/_data/engine-cli/docker_stack_services.yaml @@ -13,11 +13,17 @@ options: description: Filter output based on conditions provided deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: true - option: format value_type: string description: Pretty-print services using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -25,6 +31,27 @@ options: description: Only display IDs deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: kubeconfig + value_type: string + description: Kubernetes config file + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false +- option: namespace + value_type: string + default_value: default + description: Kubernetes namespace to use + deprecated: false + experimental: false + experimentalcli: true + kubernetes: true + swarm: false examples: |- The following command shows all services in the `myapp` stack: @@ -89,4 +116,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: true +swarm: true diff --git a/_data/engine-cli/docker_start.yaml b/_data/engine-cli/docker_start.yaml index b87b37dd836..a78f25143fe 100644 --- a/_data/engine-cli/docker_start.yaml +++ b/_data/engine-cli/docker_start.yaml @@ -12,21 +12,33 @@ 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 @@ -34,10 +46,16 @@ options: description: Attach container's STDIN deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker start my_container ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_stats.yaml b/_data/engine-cli/docker_stats.yaml index 6ed2a164013..8940ff9911f 100644 --- a/_data/engine-cli/docker_stats.yaml +++ b/_data/engine-cli/docker_stats.yaml @@ -17,23 +17,35 @@ 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 examples: |- Running `docker stats` on all running containers against a Linux daemon. @@ -47,6 +59,18 @@ 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 @@ -158,4 +182,7 @@ examples: |- > stead of `{{.ID}}\t{{.Name}}`. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_stop.yaml b/_data/engine-cli/docker_stop.yaml index 8667f6ad7b3..3d775e86e35 100644 --- a/_data/engine-cli/docker_stop.yaml +++ b/_data/engine-cli/docker_stop.yaml @@ -14,10 +14,16 @@ options: description: Seconds to wait for stop before killing it deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker stop my_container ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_swarm.yaml b/_data/engine-cli/docker_swarm.yaml index 86d210cdfd0..e5e071d76cd 100644 --- a/_data/engine-cli/docker_swarm.yaml +++ b/_data/engine-cli/docker_swarm.yaml @@ -25,4 +25,7 @@ clink: deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_ca.yaml b/_data/engine-cli/docker_swarm_ca.yaml index 153b0f97608..c4f4cac7dd7 100644 --- a/_data/engine-cli/docker_swarm_ca.yaml +++ b/_data/engine-cli/docker_swarm_ca.yaml @@ -12,18 +12,27 @@ options: Path to the PEM-formatted root CA certificate to use for the new cluster deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: ca-key value_type: pem-file description: | Path to the PEM-formatted root CA key to use for the new cluster deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cert-expiry value_type: duration default_value: 2160h0m0s description: Validity period for node certificates (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: detach shorthand: d value_type: bool @@ -32,11 +41,17 @@ options: Exit immediately instead of waiting for the root rotation to converge deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: external-ca value_type: external-ca description: Specifications of one or more certificate signing endpoints deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -44,6 +59,9 @@ options: description: Suppress progress output deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rotate value_type: bool default_value: "false" @@ -51,6 +69,9 @@ options: Rotate the swarm CA - if no certificate or key are provided, new ones will be generated deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- Run the `docker swarm ca` command without any options to view the current root CA certificate in PEM format. @@ -118,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. @@ -129,4 +150,7 @@ examples: |- deprecated: false min_api_version: "1.30" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_init.yaml b/_data/engine-cli/docker_swarm_init.yaml index 788a34aa27e..c1f175d0c08 100644 --- a/_data/engine-cli/docker_swarm_init.yaml +++ b/_data/engine-cli/docker_swarm_init.yaml @@ -12,6 +12,9 @@ options: description: 'Advertised address (format: [:port])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: autolock value_type: bool default_value: "false" @@ -19,47 +22,71 @@ options: Enable manager autolocking (requiring an unlock key to start a stopped manager) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: availability value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cert-expiry value_type: duration default_value: 2160h0m0s description: Validity period for node certificates (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: data-path-addr value_type: string description: | Address or interface to use for data path traffic (format: ) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dispatcher-heartbeat value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: external-ca value_type: external-ca description: Specifications of one or more certificate signing endpoints deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force-new-cluster value_type: bool default_value: "false" description: Force create a new cluster from current state deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: listen-addr value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: max-snapshots value_type: uint64 default_value: "0" @@ -67,6 +94,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: snapshot-interval value_type: uint64 default_value: "10000" @@ -74,12 +104,18 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: task-history-limit value_type: int64 default_value: "5" description: Task history retention limit deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker swarm init --advertise-addr 192.168.99.121 @@ -196,4 +232,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_join-token.yaml b/_data/engine-cli/docker_swarm_join-token.yaml index 25f87affb6c..61a73127df3 100644 --- a/_data/engine-cli/docker_swarm_join-token.yaml +++ b/_data/engine-cli/docker_swarm_join-token.yaml @@ -12,13 +12,22 @@ options: description: Only display token deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rotate value_type: bool default_value: "false" description: Rotate join token deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_join.yaml b/_data/engine-cli/docker_swarm_join.yaml index cf5d91219ff..8fdbcf5e598 100644 --- a/_data/engine-cli/docker_swarm_join.yaml +++ b/_data/engine-cli/docker_swarm_join.yaml @@ -13,29 +13,44 @@ options: description: 'Advertised address (format: [:port])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: availability value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: data-path-addr value_type: string description: | Address or interface to use for data path traffic (format: ) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: listen-addr value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: token value_type: string description: Token for entry into the swarm deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Join a node to swarm as a manager @@ -123,4 +138,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_leave.yaml b/_data/engine-cli/docker_swarm_leave.yaml index 826ece6c16d..fa9a9f2f3fc 100644 --- a/_data/engine-cli/docker_swarm_leave.yaml +++ b/_data/engine-cli/docker_swarm_leave.yaml @@ -20,6 +20,9 @@ options: description: Force this node to leave the swarm, ignoring warnings deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- Consider the following swarm, as seen from the manager: @@ -45,4 +48,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_unlock-key.yaml b/_data/engine-cli/docker_swarm_unlock-key.yaml index faad356aba9..a714bccf67e 100644 --- a/_data/engine-cli/docker_swarm_unlock-key.yaml +++ b/_data/engine-cli/docker_swarm_unlock-key.yaml @@ -12,13 +12,22 @@ options: description: Only display token deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rotate value_type: bool default_value: "false" description: Rotate unlock key deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_unlock.yaml b/_data/engine-cli/docker_swarm_unlock.yaml index fd7e84e23df..1c35a0d5967 100644 --- a/_data/engine-cli/docker_swarm_unlock.yaml +++ b/_data/engine-cli/docker_swarm_unlock.yaml @@ -16,4 +16,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_swarm_update.yaml b/_data/engine-cli/docker_swarm_update.yaml index 30e889b1540..b0dcdd28157 100644 --- a/_data/engine-cli/docker_swarm_update.yaml +++ b/_data/engine-cli/docker_swarm_update.yaml @@ -12,23 +12,35 @@ options: description: Change manager autolocking setting (true|false) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cert-expiry value_type: duration default_value: 2160h0m0s description: Validity period for node certificates (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: dispatcher-heartbeat value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: external-ca value_type: external-ca description: Specifications of one or more certificate signing endpoints deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: max-snapshots value_type: uint64 default_value: "0" @@ -36,6 +48,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: snapshot-interval value_type: uint64 default_value: "10000" @@ -43,12 +58,18 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: task-history-limit value_type: int64 default_value: "5" description: Task history retention limit deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker swarm update --cert-expiry 720h @@ -56,4 +77,7 @@ examples: |- deprecated: false min_api_version: "1.24" experimental: false +experimentalcli: false +kubernetes: false +swarm: true diff --git a/_data/engine-cli/docker_system.yaml b/_data/engine-cli/docker_system.yaml index f6b66a9168c..a1bc57fcf2b 100644 --- a/_data/engine-cli/docker_system.yaml +++ b/_data/engine-cli/docker_system.yaml @@ -16,4 +16,7 @@ clink: - docker_system_prune.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_system_df.yaml b/_data/engine-cli/docker_system_df.yaml index 03fe99e4590..99954d3d5b8 100644 --- a/_data/engine-cli/docker_system_df.yaml +++ b/_data/engine-cli/docker_system_df.yaml @@ -12,6 +12,9 @@ options: description: Pretty-print images using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: verbose shorthand: v value_type: bool @@ -19,6 +22,9 @@ options: description: Show detailed information on space usage deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- By default the command will just show a summary of the data used: @@ -67,4 +73,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_system_events.yaml b/_data/engine-cli/docker_system_events.yaml index db71b662df8..8f584ace552 100644 --- a/_data/engine-cli/docker_system_events.yaml +++ b/_data/engine-cli/docker_system_events.yaml @@ -142,21 +142,33 @@ 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 @@ -339,4 +351,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_system_info.yaml b/_data/engine-cli/docker_system_info.yaml index 1fac9a80882..9662751bf0d 100644 --- a/_data/engine-cli/docker_system_info.yaml +++ b/_data/engine-cli/docker_system_info.yaml @@ -11,6 +11,12 @@ 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 diff --git a/_data/engine-cli/docker_system_prune.yaml b/_data/engine-cli/docker_system_prune.yaml index 9a8bc40e525..2cad5d8db4f 100644 --- a/_data/engine-cli/docker_system_prune.yaml +++ b/_data/engine-cli/docker_system_prune.yaml @@ -14,12 +14,18 @@ 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. 'label==') deprecated: false min_api_version: "1.28" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: force shorthand: f value_type: bool @@ -27,12 +33,18 @@ options: description: Do not prompt for confirmation deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: volumes value_type: bool default_value: "false" description: Prune volumes deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker system prune @@ -141,4 +153,7 @@ examples: |- deprecated: false min_api_version: "1.25" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_tag.yaml b/_data/engine-cli/docker_tag.yaml index 84dc216c056..969be4c94a0 100644 --- a/_data/engine-cli/docker_tag.yaml +++ b/_data/engine-cli/docker_tag.yaml @@ -60,4 +60,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_top.yaml b/_data/engine-cli/docker_top.yaml index 40ec70aad50..100de43b61f 100644 --- a/_data/engine-cli/docker_top.yaml +++ b/_data/engine-cli/docker_top.yaml @@ -6,4 +6,7 @@ pname: docker plink: docker.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust.yaml b/_data/engine-cli/docker_trust.yaml index 924f02004ae..d3219d74072 100644 --- a/_data/engine-cli/docker_trust.yaml +++ b/_data/engine-cli/docker_trust.yaml @@ -1,6 +1,6 @@ command: docker trust -short: Manage trust on Docker images (experimental) -long: Manage trust on Docker images (experimental) +short: Manage trust on Docker images +long: Manage trust on Docker images usage: docker trust pname: docker plink: docker.yaml @@ -10,14 +10,15 @@ 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 +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_inspect.yaml b/_data/engine-cli/docker_trust_inspect.yaml index 8b253b63861..8e4034ce520 100644 --- a/_data/engine-cli/docker_trust_inspect.yaml +++ b/_data/engine-cli/docker_trust_inspect.yaml @@ -4,14 +4,19 @@ 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 @@ -23,16 +28,15 @@ 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`, 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 + 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 \ },\n {\n \"ID\": \"6a11e4898a4014d400332ab0e096308c844584ff70943cdd1d6628d577f45fd8\"\n \ }\n ]\n },\n {\n \"Name\": \"bob\",\n \"Keys\": [\n {\n \"ID\": \"433e245c656ae9733cdcc504bfa560f90950104442c4528c9616daa45824ccba\"\n @@ -45,9 +49,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 display any signed tags.\n\n```bash\n$ + or unavailable, `docker trust inspect` does not\ndisplay 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, `docker trust inspect` reports + 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 alpine:unsigned\n[\n \ {\n \"Name\": \"alpine:unsigned\",\n \"Signers\": [],\n \"AdminstrativeKeys\": [\n {\n \"Name\": \"Repository\",\n \"Keys\": [\n {\n @@ -56,7 +60,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 signed tags in the repository:\n\n```bash\n$ docker + will report details for all\nsigned 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\": @@ -76,7 +80,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, and reports the results in an ordered list:\n\n```bash\n$ + repositories and images as arguments,\nand 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\": @@ -110,7 +114,60 @@ 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 ]\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```" deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_key.yaml b/_data/engine-cli/docker_trust_key.yaml index 5ac2396e32f..c6bee2f411a 100644 --- a/_data/engine-cli/docker_trust_key.yaml +++ b/_data/engine-cli/docker_trust_key.yaml @@ -1,6 +1,6 @@ command: docker trust key -short: Manage keys for signing Docker images (experimental) -long: Manage keys for signing Docker images (experimental) +short: Manage keys for signing Docker images +long: Manage keys for signing Docker images usage: docker trust key pname: docker trust plink: docker_trust.yaml @@ -12,4 +12,7 @@ clink: - docker_trust_key_load.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_key_generate.yaml b/_data/engine-cli/docker_trust_key_generate.yaml index ac49054d00c..6431db6305f 100644 --- a/_data/engine-cli/docker_trust_key_generate.yaml +++ b/_data/engine-cli/docker_trust_key_generate.yaml @@ -10,6 +10,12 @@ options: description: Directory to generate key in, defaults to current directory deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_key_load.yaml b/_data/engine-cli/docker_trust_key_load.yaml index 34bf5c06456..b215aaa98b8 100644 --- a/_data/engine-cli/docker_trust_key_load.yaml +++ b/_data/engine-cli/docker_trust_key_load.yaml @@ -11,6 +11,12 @@ options: description: Name for the loaded key deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_revoke.yaml b/_data/engine-cli/docker_trust_revoke.yaml index b5d8362c27d..76a3aac27cf 100644 --- a/_data/engine-cli/docker_trust_revoke.yaml +++ b/_data/engine-cli/docker_trust_revoke.yaml @@ -1,9 +1,6 @@ command: docker trust revoke short: Remove trust for an image -long: |- - `docker trust revoke` removes signatures from tags in signed repositories. - - `docker trust revoke` is currently experimental. +long: '`docker trust revoke` removes signatures from tags in signed repositories.' usage: docker trust revoke [OPTIONS] IMAGE[:TAG] pname: docker trust plink: docker_trust.yaml @@ -15,6 +12,9 @@ options: description: Do not prompt for confirmation deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: "### Revoke signatures from a signed tag\n\nHere's an example of a repo with two signed tags:\n\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED TAG DIGEST SIGNERS\nred @@ -55,4 +55,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 +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_sign.yaml b/_data/engine-cli/docker_trust_sign.yaml index 50282ca2e2e..b42c46e27a2 100644 --- a/_data/engine-cli/docker_trust_sign.yaml +++ b/_data/engine-cli/docker_trust_sign.yaml @@ -1,9 +1,6 @@ command: docker trust sign short: Sign an image -long: |- - `docker trust sign` adds signatures to tags to create signed repositories. - - `docker trust sign` is currently experimental. +long: '`docker trust sign` adds signatures to tags to create signed repositories.' usage: docker trust sign IMAGE:TAG pname: docker trust plink: docker_trust.yaml @@ -14,6 +11,9 @@ options: description: Sign a locally tagged image deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: "### Sign a tag as a repo admin\n\nGiven an image:\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED TAG DIGEST SIGNERS\nv1 \ c24134c079c35e698060beabe110bb83ab285d0d978de7d92fed2c8c83570a41 @@ -54,4 +54,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 +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_signer.yaml b/_data/engine-cli/docker_trust_signer.yaml index b8aa4aa1a9f..b279973d20a 100644 --- a/_data/engine-cli/docker_trust_signer.yaml +++ b/_data/engine-cli/docker_trust_signer.yaml @@ -1,6 +1,6 @@ command: docker trust signer -short: Manage entities who can sign Docker images (experimental) -long: Manage entities who can sign Docker images (experimental) +short: Manage entities who can sign Docker images +long: Manage entities who can sign Docker images usage: docker trust signer pname: docker trust plink: docker_trust.yaml @@ -12,4 +12,7 @@ clink: - docker_trust_signer_remove.yaml deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_signer_add.yaml b/_data/engine-cli/docker_trust_signer_add.yaml index 489792e0844..4133511d850 100644 --- a/_data/engine-cli/docker_trust_signer_add.yaml +++ b/_data/engine-cli/docker_trust_signer_add.yaml @@ -10,6 +10,12 @@ options: description: Path to the signer's public key file deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_signer_remove.yaml b/_data/engine-cli/docker_trust_signer_remove.yaml index 4bc94d911c9..bd9109e77db 100644 --- a/_data/engine-cli/docker_trust_signer_remove.yaml +++ b/_data/engine-cli/docker_trust_signer_remove.yaml @@ -13,6 +13,12 @@ options: Do not prompt for confirmation before removing the most recent signer deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_trust_view.yaml b/_data/engine-cli/docker_trust_view.yaml deleted file mode 100644 index aa3e8b8b305..00000000000 --- a/_data/engine-cli/docker_trust_view.yaml +++ /dev/null @@ -1,66 +0,0 @@ -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 - diff --git a/_data/engine-cli/docker_unpause.yaml b/_data/engine-cli/docker_unpause.yaml index 3a23e131e2b..284bd5f2e9b 100644 --- a/_data/engine-cli/docker_unpause.yaml +++ b/_data/engine-cli/docker_unpause.yaml @@ -17,4 +17,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_update.yaml b/_data/engine-cli/docker_update.yaml index 8cbc0e612d5..23c9bd665b9 100644 --- a/_data/engine-cli/docker_update.yaml +++ b/_data/engine-cli/docker_update.yaml @@ -26,18 +26,27 @@ 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" @@ -45,6 +54,9 @@ 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" @@ -52,6 +64,9 @@ options: deprecated: false min_api_version: "1.25" experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: cpu-shares shorthand: c value_type: int64 @@ -59,28 +74,43 @@ 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 @@ -88,12 +118,18 @@ 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" @@ -101,11 +137,17 @@ 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 examples: |- The following sections illustrate ways to use this command. @@ -177,4 +219,7 @@ examples: |- container. deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_version.yaml b/_data/engine-cli/docker_version.yaml index c77c34532dd..b83c8675d7a 100644 --- a/_data/engine-cli/docker_version.yaml +++ b/_data/engine-cli/docker_version.yaml @@ -16,6 +16,9 @@ options: description: Format the output using the given Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Default output @@ -56,4 +59,7 @@ examples: |- ``` deprecated: false experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_volume.yaml b/_data/engine-cli/docker_volume.yaml index e1cc74a696e..26aead51942 100644 --- a/_data/engine-cli/docker_volume.yaml +++ b/_data/engine-cli/docker_volume.yaml @@ -21,4 +21,7 @@ clink: deprecated: false min_api_version: "1.21" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_volume_create.yaml b/_data/engine-cli/docker_volume_create.yaml index 7b5dc2266fa..cba2d0084d3 100644 --- a/_data/engine-cli/docker_volume_create.yaml +++ b/_data/engine-cli/docker_volume_create.yaml @@ -14,16 +14,25 @@ options: description: Specify volume driver name deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: label value_type: list description: Set metadata for a volume deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: name value_type: string description: Specify volume name deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: opt shorthand: o value_type: map @@ -31,6 +40,9 @@ options: description: Set driver specific options deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- Create a volume and then configure the container to use it: @@ -116,4 +128,7 @@ examples: |- deprecated: false min_api_version: "1.21" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_volume_inspect.yaml b/_data/engine-cli/docker_volume_inspect.yaml index 4af3cf3b62d..36c69979bd0 100644 --- a/_data/engine-cli/docker_volume_inspect.yaml +++ b/_data/engine-cli/docker_volume_inspect.yaml @@ -16,6 +16,9 @@ options: description: Format the output using the given Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ```bash $ docker volume create @@ -36,4 +39,7 @@ examples: |- deprecated: false min_api_version: "1.21" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_volume_ls.yaml b/_data/engine-cli/docker_volume_ls.yaml index 1f55ae1d940..7d843627c86 100644 --- a/_data/engine-cli/docker_volume_ls.yaml +++ b/_data/engine-cli/docker_volume_ls.yaml @@ -15,11 +15,17 @@ options: description: Provide filter values (e.g. 'dangling=true') deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: format value_type: string description: Pretty-print volumes using a Go template deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool @@ -27,6 +33,9 @@ options: description: Only display volume names deprecated: false experimental: false + experimentalcli: false + kubernetes: false + swarm: false examples: |- ### Create a volume ```bash @@ -178,4 +187,7 @@ examples: |- deprecated: false min_api_version: "1.21" experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/_data/engine-cli/docker_volume_prune.yaml b/_data/engine-cli/docker_volume_prune.yaml index 920b3f54dd7..1b1eabc858b 100644 --- a/_data/engine-cli/docker_volume_prune.yaml +++ b/_data/engine-cli/docker_volume_prune.yaml @@ -1,7 +1,7 @@ command: docker volume prune -short: Remove all unused volumes -long: Remove all unused volumes. Unused volumes are those which are not referenced - by any conta +short: Remove all unused local volumes +long: Remove all unused local volumes. Unused local volumes are those which are not + referenced by any containers usage: docker volume prune [OPTIONS] pname: docker volume plink: docker_volume.yaml @@ -11,6 +11,9 @@ options: description: Provide filter values (e.g. 'label=