From 5ed83f4c646655b2fd4a645a47ce52e9b970854e Mon Sep 17 00:00:00 2001 From: French Ben Date: Mon, 19 Dec 2016 14:37:35 -0800 Subject: [PATCH] Updated Yaml files (#922) Signed-off-by: French Ben --- _data/engine-cli/docker.yaml | 110 +++++++++++++++++- _data/engine-cli/docker_build.yaml | 7 ++ _data/engine-cli/docker_checkpoint.yaml | 14 +++ .../engine-cli/docker_checkpoint_create.yaml | 12 ++ _data/engine-cli/docker_checkpoint_ls.yaml | 9 ++ _data/engine-cli/docker_checkpoint_rm.yaml | 9 ++ _data/engine-cli/docker_container.yaml | 54 ++++++++- _data/engine-cli/docker_container_create.yaml | 26 ++++- _data/engine-cli/docker_container_exec.yaml | 4 + .../engine-cli/docker_container_inspect.yaml | 2 +- _data/engine-cli/docker_container_run.yaml | 26 ++++- _data/engine-cli/docker_container_start.yaml | 4 + _data/engine-cli/docker_container_update.yaml | 9 +- _data/engine-cli/docker_create.yaml | 26 ++++- _data/engine-cli/docker_deploy.yaml | 15 +++ _data/engine-cli/docker_events.yaml | 2 +- _data/engine-cli/docker_exec.yaml | 4 + _data/engine-cli/docker_image.yaml | 28 ++++- _data/engine-cli/docker_image_build.yaml | 7 ++ _data/engine-cli/docker_image_inspect.yaml | 2 +- _data/engine-cli/docker_image_tag.yaml | 6 +- _data/engine-cli/docker_info.yaml | 2 +- _data/engine-cli/docker_inspect.yaml | 8 +- _data/engine-cli/docker_login.yaml | 5 +- _data/engine-cli/docker_logout.yaml | 2 +- _data/engine-cli/docker_network.yaml | 18 ++- _data/engine-cli/docker_network_inspect.yaml | 2 +- _data/engine-cli/docker_network_ls.yaml | 2 +- _data/engine-cli/docker_network_prune.yaml | 11 ++ _data/engine-cli/docker_node.yaml | 18 ++- _data/engine-cli/docker_node_inspect.yaml | 2 +- _data/engine-cli/docker_node_rm.yaml | 3 +- _data/engine-cli/docker_plugin.yaml | 26 +++++ _data/engine-cli/docker_plugin_create.yaml | 10 ++ _data/engine-cli/docker_plugin_disable.yaml | 6 + _data/engine-cli/docker_plugin_enable.yaml | 10 ++ _data/engine-cli/docker_plugin_inspect.yaml | 10 ++ _data/engine-cli/docker_plugin_install.yaml | 13 +++ _data/engine-cli/docker_plugin_ls.yaml | 10 ++ _data/engine-cli/docker_plugin_push.yaml | 6 + _data/engine-cli/docker_plugin_rm.yaml | 11 ++ _data/engine-cli/docker_plugin_set.yaml | 6 + _data/engine-cli/docker_run.yaml | 26 ++++- _data/engine-cli/docker_secret.yaml | 16 +++ _data/engine-cli/docker_secret_create.yaml | 11 ++ _data/engine-cli/docker_secret_inspect.yaml | 10 ++ _data/engine-cli/docker_secret_ls.yaml | 11 ++ _data/engine-cli/docker_secret_rm.yaml | 6 + _data/engine-cli/docker_service.yaml | 20 +++- _data/engine-cli/docker_service_create.yaml | 60 ++++++++-- _data/engine-cli/docker_service_inspect.yaml | 2 +- _data/engine-cli/docker_service_logs.yaml | 26 +++++ _data/engine-cli/docker_service_ps.yaml | 4 + _data/engine-cli/docker_service_scale.yaml | 4 +- _data/engine-cli/docker_service_update.yaml | 88 +++++++++++--- _data/engine-cli/docker_stack.yaml | 18 +++ _data/engine-cli/docker_stack_deploy.yaml | 15 +++ _data/engine-cli/docker_stack_ls.yaml | 6 + _data/engine-cli/docker_stack_ps.yaml | 20 ++++ _data/engine-cli/docker_stack_rm.yaml | 6 + _data/engine-cli/docker_stack_services.yaml | 14 +++ _data/engine-cli/docker_start.yaml | 4 + _data/engine-cli/docker_swarm.yaml | 18 ++- _data/engine-cli/docker_swarm_init.yaml | 16 ++- _data/engine-cli/docker_swarm_leave.yaml | 5 +- _data/engine-cli/docker_swarm_unlock-key.yaml | 14 +++ _data/engine-cli/docker_swarm_unlock.yaml | 6 + _data/engine-cli/docker_swarm_update.yaml | 13 ++- _data/engine-cli/docker_system.yaml | 12 +- _data/engine-cli/docker_system_events.yaml | 2 +- _data/engine-cli/docker_system_info.yaml | 2 +- _data/engine-cli/docker_tag.yaml | 6 +- _data/engine-cli/docker_update.yaml | 9 +- _data/engine-cli/docker_version.yaml | 2 +- _data/engine-cli/docker_volume.yaml | 14 ++- _data/engine-cli/docker_volume_inspect.yaml | 2 +- 76 files changed, 954 insertions(+), 91 deletions(-) create mode 100644 _data/engine-cli/docker_checkpoint.yaml create mode 100644 _data/engine-cli/docker_checkpoint_create.yaml create mode 100644 _data/engine-cli/docker_checkpoint_ls.yaml create mode 100644 _data/engine-cli/docker_checkpoint_rm.yaml create mode 100644 _data/engine-cli/docker_deploy.yaml create mode 100644 _data/engine-cli/docker_network_prune.yaml create mode 100644 _data/engine-cli/docker_plugin.yaml create mode 100644 _data/engine-cli/docker_plugin_create.yaml create mode 100644 _data/engine-cli/docker_plugin_disable.yaml create mode 100644 _data/engine-cli/docker_plugin_enable.yaml create mode 100644 _data/engine-cli/docker_plugin_inspect.yaml create mode 100644 _data/engine-cli/docker_plugin_install.yaml create mode 100644 _data/engine-cli/docker_plugin_ls.yaml create mode 100644 _data/engine-cli/docker_plugin_push.yaml create mode 100644 _data/engine-cli/docker_plugin_rm.yaml create mode 100644 _data/engine-cli/docker_plugin_set.yaml create mode 100644 _data/engine-cli/docker_secret.yaml create mode 100644 _data/engine-cli/docker_secret_create.yaml create mode 100644 _data/engine-cli/docker_secret_inspect.yaml create mode 100644 _data/engine-cli/docker_secret_ls.yaml create mode 100644 _data/engine-cli/docker_secret_rm.yaml create mode 100644 _data/engine-cli/docker_service_logs.yaml create mode 100644 _data/engine-cli/docker_stack.yaml create mode 100644 _data/engine-cli/docker_stack_deploy.yaml create mode 100644 _data/engine-cli/docker_stack_ls.yaml create mode 100644 _data/engine-cli/docker_stack_ps.yaml create mode 100644 _data/engine-cli/docker_stack_rm.yaml create mode 100644 _data/engine-cli/docker_stack_services.yaml create mode 100644 _data/engine-cli/docker_swarm_unlock-key.yaml create mode 100644 _data/engine-cli/docker_swarm_unlock.yaml diff --git a/_data/engine-cli/docker.yaml b/_data/engine-cli/docker.yaml index 6c757ebb41..c214f7f9ed 100644 --- a/_data/engine-cli/docker.yaml +++ b/_data/engine-cli/docker.yaml @@ -1,3 +1,109 @@ command: docker -cname: docker wait -clink: docker_wait.yaml +cname: +- docker attach +- docker build +- docker checkpoint +- docker commit +- docker container +- docker cp +- docker create +- docker deploy +- docker diff +- docker events +- docker exec +- docker export +- docker history +- docker image +- docker images +- docker import +- docker info +- docker inspect +- docker kill +- docker load +- docker login +- docker logout +- docker logs +- docker network +- docker node +- docker pause +- docker plugin +- docker port +- docker ps +- docker pull +- docker push +- docker rename +- docker restart +- docker rm +- docker rmi +- docker run +- docker save +- docker search +- docker secret +- docker service +- docker stack +- docker start +- docker stats +- docker stop +- docker swarm +- docker system +- docker tag +- docker top +- docker unpause +- docker update +- docker version +- docker volume +- docker wait +clink: +- docker_attach.yaml +- docker_build.yaml +- docker_checkpoint.yaml +- docker_commit.yaml +- docker_container.yaml +- docker_cp.yaml +- docker_create.yaml +- docker_deploy.yaml +- docker_diff.yaml +- docker_events.yaml +- docker_exec.yaml +- docker_export.yaml +- docker_history.yaml +- docker_image.yaml +- docker_images.yaml +- docker_import.yaml +- docker_info.yaml +- docker_inspect.yaml +- docker_kill.yaml +- docker_load.yaml +- docker_login.yaml +- docker_logout.yaml +- docker_logs.yaml +- docker_network.yaml +- docker_node.yaml +- docker_pause.yaml +- docker_plugin.yaml +- docker_port.yaml +- docker_ps.yaml +- docker_pull.yaml +- docker_push.yaml +- docker_rename.yaml +- docker_restart.yaml +- docker_rm.yaml +- docker_rmi.yaml +- docker_run.yaml +- docker_save.yaml +- docker_search.yaml +- docker_secret.yaml +- docker_service.yaml +- docker_stack.yaml +- docker_start.yaml +- docker_stats.yaml +- docker_stop.yaml +- docker_swarm.yaml +- docker_system.yaml +- docker_tag.yaml +- docker_top.yaml +- docker_unpause.yaml +- docker_update.yaml +- docker_version.yaml +- docker_volume.yaml +- docker_wait.yaml diff --git a/_data/engine-cli/docker_build.yaml b/_data/engine-cli/docker_build.yaml index 0fcf8417f0..f77ffc4304 100644 --- a/_data/engine-cli/docker_build.yaml +++ b/_data/engine-cli/docker_build.yaml @@ -50,6 +50,10 @@ options: - option: memory-swap description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap +- option: network + default_value: default + description: | + Set the networking mode for the RUN instructions during build - option: no-cache default_value: "false" description: Do not use cache when building the image @@ -68,6 +72,9 @@ options: description: Security options - option: shm-size description: Size of /dev/shm, default value is 64MB +- option: squash + default_value: "false" + description: Squash newly built layers into a single new layer - option: tag shorthand: t default_value: '[]' diff --git a/_data/engine-cli/docker_checkpoint.yaml b/_data/engine-cli/docker_checkpoint.yaml new file mode 100644 index 0000000000..29a4441af1 --- /dev/null +++ b/_data/engine-cli/docker_checkpoint.yaml @@ -0,0 +1,14 @@ +command: docker checkpoint +short: Manage checkpoints +long: Manage checkpoints +usage: docker checkpoint +pname: docker +plink: docker.yaml +cname: +- docker checkpoint create +- docker checkpoint ls +- docker checkpoint rm +clink: +- docker_checkpoint_create.yaml +- docker_checkpoint_ls.yaml +- docker_checkpoint_rm.yaml diff --git a/_data/engine-cli/docker_checkpoint_create.yaml b/_data/engine-cli/docker_checkpoint_create.yaml new file mode 100644 index 0000000000..2e8f0a9529 --- /dev/null +++ b/_data/engine-cli/docker_checkpoint_create.yaml @@ -0,0 +1,12 @@ +command: docker checkpoint create +short: Create a checkpoint from a running container +long: Create a checkpoint from a running container +usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT +pname: docker checkpoint +plink: docker_checkpoint.yaml +options: +- option: checkpoint-dir + description: Use a custom checkpoint storage directory +- option: leave-running + default_value: "false" + description: Leave the container running after checkpoint diff --git a/_data/engine-cli/docker_checkpoint_ls.yaml b/_data/engine-cli/docker_checkpoint_ls.yaml new file mode 100644 index 0000000000..959ddf90c2 --- /dev/null +++ b/_data/engine-cli/docker_checkpoint_ls.yaml @@ -0,0 +1,9 @@ +command: docker checkpoint ls +short: List checkpoints for a container +long: List checkpoints for a container +usage: docker checkpoint ls [OPTIONS] CONTAINER +pname: docker checkpoint +plink: docker_checkpoint.yaml +options: +- option: checkpoint-dir + description: Use a custom checkpoint storage directory diff --git a/_data/engine-cli/docker_checkpoint_rm.yaml b/_data/engine-cli/docker_checkpoint_rm.yaml new file mode 100644 index 0000000000..0534b2d50b --- /dev/null +++ b/_data/engine-cli/docker_checkpoint_rm.yaml @@ -0,0 +1,9 @@ +command: docker checkpoint rm +short: Remove a checkpoint +long: Remove a checkpoint +usage: docker checkpoint rm [OPTIONS] CONTAINER CHECKPOINT +pname: docker checkpoint +plink: docker_checkpoint.yaml +options: +- option: checkpoint-dir + description: Use a custom checkpoint storage directory diff --git a/_data/engine-cli/docker_container.yaml b/_data/engine-cli/docker_container.yaml index b386fc034c..82d287f858 100644 --- a/_data/engine-cli/docker_container.yaml +++ b/_data/engine-cli/docker_container.yaml @@ -4,5 +4,55 @@ long: Manage containers usage: docker container pname: docker plink: docker.yaml -cname: docker container wait -clink: docker_container_wait.yaml +cname: +- docker container attach +- docker container commit +- docker container cp +- docker container create +- docker container diff +- docker container exec +- docker container export +- docker container inspect +- docker container kill +- docker container logs +- docker container ls +- docker container pause +- docker container port +- docker container prune +- docker container rename +- docker container restart +- docker container rm +- docker container run +- docker container start +- docker container stats +- docker container stop +- docker container top +- docker container unpause +- docker container update +- docker container wait +clink: +- docker_container_attach.yaml +- docker_container_commit.yaml +- docker_container_cp.yaml +- docker_container_create.yaml +- docker_container_diff.yaml +- docker_container_exec.yaml +- docker_container_export.yaml +- docker_container_inspect.yaml +- docker_container_kill.yaml +- docker_container_logs.yaml +- docker_container_ls.yaml +- docker_container_pause.yaml +- docker_container_port.yaml +- docker_container_prune.yaml +- docker_container_rename.yaml +- docker_container_restart.yaml +- docker_container_rm.yaml +- docker_container_run.yaml +- docker_container_start.yaml +- docker_container_stats.yaml +- docker_container_stop.yaml +- docker_container_top.yaml +- docker_container_unpause.yaml +- docker_container_update.yaml +- docker_container_wait.yaml diff --git a/_data/engine-cli/docker_container_create.yaml b/_data/engine-cli/docker_container_create.yaml index d0e5909601..a9eac33c40 100644 --- a/_data/engine-cli/docker_container_create.yaml +++ b/_data/engine-cli/docker_container_create.yaml @@ -14,7 +14,8 @@ options: description: Attach to STDIN, STDOUT or STDERR - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: blkio-weight-device default_value: '[]' description: Block IO weight (relative device weight) @@ -28,6 +29,9 @@ options: description: Optional parent cgroup for the container - option: cidfile description: Write the container ID to the file +- option: cpu-count + default_value: "0" + description: CPU count (Windows only) - option: cpu-percent default_value: "0" description: CPU percent (Windows only) @@ -37,10 +41,19 @@ options: - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" description: CPU shares (relative weight) +- option: cpus + default_value: "0.000" + description: Number of CPUs - option: cpuset-cpus description: CPUs in which to allow execution (0-3, 0,1) - option: cpuset-mems @@ -71,6 +84,9 @@ options: - option: dns-opt default_value: '[]' description: Set DNS options +- option: dns-option + default_value: '[]' + description: Set DNS options - option: dns-search default_value: '[]' description: Set custom DNS search domains @@ -93,13 +109,14 @@ options: description: Command to run to check health - option: health-interval default_value: "0" - description: Time between running the check + description: Time between running the check (ns|us|ms|s|m|h) (default 0s) - option: health-retries default_value: "0" description: Consecutive failures needed to report unhealthy - option: health-timeout default_value: "0" - description: Maximum time to allow one check to run + description: | + Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) - option: help default_value: "false" description: Print usage @@ -221,6 +238,9 @@ options: - option: stop-signal default_value: SIGTERM description: Signal to stop a container, SIGTERM by default +- option: stop-timeout + default_value: "0" + description: Timeout (in seconds) to stop a container - option: storage-opt default_value: '[]' description: Storage driver options for the container diff --git a/_data/engine-cli/docker_container_exec.yaml b/_data/engine-cli/docker_container_exec.yaml index 6ffd766538..95b544670b 100644 --- a/_data/engine-cli/docker_container_exec.yaml +++ b/_data/engine-cli/docker_container_exec.yaml @@ -11,6 +11,10 @@ options: description: 'Detached mode: run command in the background' - option: detach-keys description: Override the key sequence for detaching a container +- option: env + shorthand: e + default_value: '[]' + description: Set environment variables - option: interactive shorthand: i default_value: "false" diff --git a/_data/engine-cli/docker_container_inspect.yaml b/_data/engine-cli/docker_container_inspect.yaml index c275523a74..6590496cbd 100644 --- a/_data/engine-cli/docker_container_inspect.yaml +++ b/_data/engine-cli/docker_container_inspect.yaml @@ -7,7 +7,7 @@ plink: docker_container.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template - option: size shorthand: s default_value: "false" diff --git a/_data/engine-cli/docker_container_run.yaml b/_data/engine-cli/docker_container_run.yaml index 9a1e1a1684..71e201696f 100644 --- a/_data/engine-cli/docker_container_run.yaml +++ b/_data/engine-cli/docker_container_run.yaml @@ -14,7 +14,8 @@ options: description: Attach to STDIN, STDOUT or STDERR - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: blkio-weight-device default_value: '[]' description: Block IO weight (relative device weight) @@ -28,6 +29,9 @@ options: description: Optional parent cgroup for the container - option: cidfile description: Write the container ID to the file +- option: cpu-count + default_value: "0" + description: CPU count (Windows only) - option: cpu-percent default_value: "0" description: CPU percent (Windows only) @@ -37,10 +41,19 @@ options: - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" description: CPU shares (relative weight) +- option: cpus + default_value: "0.000" + description: Number of CPUs - option: cpuset-cpus description: CPUs in which to allow execution (0-3, 0,1) - option: cpuset-mems @@ -77,6 +90,9 @@ options: - option: dns-opt default_value: '[]' description: Set DNS options +- option: dns-option + default_value: '[]' + description: Set DNS options - option: dns-search default_value: '[]' description: Set custom DNS search domains @@ -99,13 +115,14 @@ options: description: Command to run to check health - option: health-interval default_value: "0" - description: Time between running the check + description: Time between running the check (ns|us|ms|s|m|h) (default 0s) - option: health-retries default_value: "0" description: Consecutive failures needed to report unhealthy - option: health-timeout default_value: "0" - description: Maximum time to allow one check to run + description: | + Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) - option: help default_value: "false" description: Print usage @@ -230,6 +247,9 @@ options: - option: stop-signal default_value: SIGTERM description: Signal to stop a container, SIGTERM by default +- option: stop-timeout + default_value: "0" + description: Timeout (in seconds) to stop a container - option: storage-opt default_value: '[]' description: Storage driver options for the container diff --git a/_data/engine-cli/docker_container_start.yaml b/_data/engine-cli/docker_container_start.yaml index ae09a8f6c9..abe60a60a9 100644 --- a/_data/engine-cli/docker_container_start.yaml +++ b/_data/engine-cli/docker_container_start.yaml @@ -9,6 +9,10 @@ options: shorthand: a default_value: "false" description: Attach STDOUT/STDERR and forward signals +- option: checkpoint + description: Restore from this checkpoint +- option: checkpoint-dir + description: Use a custom checkpoint storage directory - option: detach-keys description: Override the key sequence for detaching a container - option: interactive diff --git a/_data/engine-cli/docker_container_update.yaml b/_data/engine-cli/docker_container_update.yaml index e027ccb9cd..9cb1b78f60 100644 --- a/_data/engine-cli/docker_container_update.yaml +++ b/_data/engine-cli/docker_container_update.yaml @@ -7,13 +7,20 @@ plink: docker_container.yaml options: - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: cpu-period default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit the CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit the CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" diff --git a/_data/engine-cli/docker_create.yaml b/_data/engine-cli/docker_create.yaml index cde73859e0..5c9eb23150 100644 --- a/_data/engine-cli/docker_create.yaml +++ b/_data/engine-cli/docker_create.yaml @@ -14,7 +14,8 @@ options: description: Attach to STDIN, STDOUT or STDERR - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: blkio-weight-device default_value: '[]' description: Block IO weight (relative device weight) @@ -28,6 +29,9 @@ options: description: Optional parent cgroup for the container - option: cidfile description: Write the container ID to the file +- option: cpu-count + default_value: "0" + description: CPU count (Windows only) - option: cpu-percent default_value: "0" description: CPU percent (Windows only) @@ -37,10 +41,19 @@ options: - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" description: CPU shares (relative weight) +- option: cpus + default_value: "0.000" + description: Number of CPUs - option: cpuset-cpus description: CPUs in which to allow execution (0-3, 0,1) - option: cpuset-mems @@ -71,6 +84,9 @@ options: - option: dns-opt default_value: '[]' description: Set DNS options +- option: dns-option + default_value: '[]' + description: Set DNS options - option: dns-search default_value: '[]' description: Set custom DNS search domains @@ -93,13 +109,14 @@ options: description: Command to run to check health - option: health-interval default_value: "0" - description: Time between running the check + description: Time between running the check (ns|us|ms|s|m|h) (default 0s) - option: health-retries default_value: "0" description: Consecutive failures needed to report unhealthy - option: health-timeout default_value: "0" - description: Maximum time to allow one check to run + description: | + Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) - option: help default_value: "false" description: Print usage @@ -221,6 +238,9 @@ options: - option: stop-signal default_value: SIGTERM description: Signal to stop a container, SIGTERM by default +- option: stop-timeout + default_value: "0" + description: Timeout (in seconds) to stop a container - option: storage-opt default_value: '[]' description: Storage driver options for the container diff --git a/_data/engine-cli/docker_deploy.yaml b/_data/engine-cli/docker_deploy.yaml new file mode 100644 index 0000000000..a7347c7654 --- /dev/null +++ b/_data/engine-cli/docker_deploy.yaml @@ -0,0 +1,15 @@ +command: docker deploy +short: Deploy a new stack or update an existing stack +long: Deploy a new stack or update an existing stack +usage: docker deploy [OPTIONS] STACK +pname: docker +plink: docker.yaml +options: +- option: bundle-file + description: Path to a Distributed Application Bundle file +- option: compose-file + shorthand: c + description: Path to a Compose file +- option: with-registry-auth + default_value: "false" + description: Send registry authentication details to Swarm agents diff --git a/_data/engine-cli/docker_events.yaml b/_data/engine-cli/docker_events.yaml index dd5f665839..cd72ef56f8 100644 --- a/_data/engine-cli/docker_events.yaml +++ b/_data/engine-cli/docker_events.yaml @@ -9,7 +9,7 @@ options: shorthand: f description: Filter output based on conditions provided - option: format - description: Format the output using the given go template + description: Format the output using the given Go template - option: since description: Show all events created since timestamp - option: until diff --git a/_data/engine-cli/docker_exec.yaml b/_data/engine-cli/docker_exec.yaml index 9e48d6cbce..1bb3bb33c3 100644 --- a/_data/engine-cli/docker_exec.yaml +++ b/_data/engine-cli/docker_exec.yaml @@ -11,6 +11,10 @@ options: description: 'Detached mode: run command in the background' - option: detach-keys description: Override the key sequence for detaching a container +- option: env + shorthand: e + default_value: '[]' + description: Set environment variables - option: interactive shorthand: i default_value: "false" diff --git a/_data/engine-cli/docker_image.yaml b/_data/engine-cli/docker_image.yaml index 091c87d025..09ecfd7be7 100644 --- a/_data/engine-cli/docker_image.yaml +++ b/_data/engine-cli/docker_image.yaml @@ -4,5 +4,29 @@ long: Manage images usage: docker image pname: docker plink: docker.yaml -cname: docker image tag -clink: docker_image_tag.yaml +cname: +- docker image build +- docker image history +- docker image import +- docker image inspect +- docker image load +- docker image ls +- docker image prune +- docker image pull +- docker image push +- docker image rm +- docker image save +- docker image tag +clink: +- docker_image_build.yaml +- docker_image_history.yaml +- docker_image_import.yaml +- docker_image_inspect.yaml +- docker_image_load.yaml +- docker_image_ls.yaml +- docker_image_prune.yaml +- docker_image_pull.yaml +- docker_image_push.yaml +- docker_image_rm.yaml +- docker_image_save.yaml +- docker_image_tag.yaml diff --git a/_data/engine-cli/docker_image_build.yaml b/_data/engine-cli/docker_image_build.yaml index b6592dea33..8e35921eae 100644 --- a/_data/engine-cli/docker_image_build.yaml +++ b/_data/engine-cli/docker_image_build.yaml @@ -50,6 +50,10 @@ options: - option: memory-swap description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap +- option: network + default_value: default + description: | + Set the networking mode for the RUN instructions during build - option: no-cache default_value: "false" description: Do not use cache when building the image @@ -68,6 +72,9 @@ options: description: Security options - option: shm-size description: Size of /dev/shm, default value is 64MB +- option: squash + default_value: "false" + description: Squash newly built layers into a single new layer - option: tag shorthand: t default_value: '[]' diff --git a/_data/engine-cli/docker_image_inspect.yaml b/_data/engine-cli/docker_image_inspect.yaml index 31604b9d2e..f8b6ec854f 100644 --- a/_data/engine-cli/docker_image_inspect.yaml +++ b/_data/engine-cli/docker_image_inspect.yaml @@ -7,4 +7,4 @@ plink: docker_image.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_image_tag.yaml b/_data/engine-cli/docker_image_tag.yaml index f72136e696..dfcd8ec204 100644 --- a/_data/engine-cli/docker_image_tag.yaml +++ b/_data/engine-cli/docker_image_tag.yaml @@ -1,6 +1,6 @@ command: docker image tag -short: Tag an image into a repository -long: Tag an image into a repository -usage: docker image tag IMAGE[:TAG] IMAGE[:TAG] +short: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE +long: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE +usage: docker image tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] pname: docker image plink: docker_image.yaml diff --git a/_data/engine-cli/docker_info.yaml b/_data/engine-cli/docker_info.yaml index 6671b47b02..312c038684 100644 --- a/_data/engine-cli/docker_info.yaml +++ b/_data/engine-cli/docker_info.yaml @@ -7,4 +7,4 @@ plink: docker.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_inspect.yaml b/_data/engine-cli/docker_inspect.yaml index 46b641a878..65ee9396f3 100644 --- a/_data/engine-cli/docker_inspect.yaml +++ b/_data/engine-cli/docker_inspect.yaml @@ -1,13 +1,13 @@ command: docker inspect -short: Return low-level information on a container, image or task -long: Return low-level information on a container, image or task -usage: docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...] +short: Return low-level information on Docker objects +long: Return low-level information on Docker objects +usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] pname: docker plink: docker.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template - option: size shorthand: s default_value: "false" diff --git a/_data/engine-cli/docker_login.yaml b/_data/engine-cli/docker_login.yaml index fb6f7a4994..ba7c59590d 100644 --- a/_data/engine-cli/docker_login.yaml +++ b/_data/engine-cli/docker_login.yaml @@ -1,5 +1,5 @@ command: docker login -short: Log in to a Docker registry. +short: Log in to a Docker registry long: |- Log in to a Docker registry. If no server is specified, the default is defined by the daemon. @@ -7,9 +7,6 @@ usage: docker login [OPTIONS] [SERVER] pname: docker plink: docker.yaml options: -- option: email - shorthand: e - description: Email - option: password shorthand: p description: Password diff --git a/_data/engine-cli/docker_logout.yaml b/_data/engine-cli/docker_logout.yaml index ee9c02515e..61b23dd516 100644 --- a/_data/engine-cli/docker_logout.yaml +++ b/_data/engine-cli/docker_logout.yaml @@ -1,5 +1,5 @@ command: docker logout -short: Log out from a Docker registry. +short: Log out from a Docker registry long: |- Log out from a Docker registry. If no server is specified, the default is defined by the daemon. diff --git a/_data/engine-cli/docker_network.yaml b/_data/engine-cli/docker_network.yaml index bebc280da7..60b18974de 100644 --- a/_data/engine-cli/docker_network.yaml +++ b/_data/engine-cli/docker_network.yaml @@ -4,5 +4,19 @@ long: Manage networks usage: docker network pname: docker plink: docker.yaml -cname: docker network rm -clink: docker_network_rm.yaml +cname: +- docker network connect +- docker network create +- docker network disconnect +- docker network inspect +- docker network ls +- docker network prune +- docker network rm +clink: +- docker_network_connect.yaml +- docker_network_create.yaml +- docker_network_disconnect.yaml +- docker_network_inspect.yaml +- docker_network_ls.yaml +- docker_network_prune.yaml +- docker_network_rm.yaml diff --git a/_data/engine-cli/docker_network_inspect.yaml b/_data/engine-cli/docker_network_inspect.yaml index 4fb549a46e..733ceca4bc 100644 --- a/_data/engine-cli/docker_network_inspect.yaml +++ b/_data/engine-cli/docker_network_inspect.yaml @@ -95,4 +95,4 @@ plink: docker_network.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_network_ls.yaml b/_data/engine-cli/docker_network_ls.yaml index 598caffd5e..b500f1e13f 100644 --- a/_data/engine-cli/docker_network_ls.yaml +++ b/_data/engine-cli/docker_network_ls.yaml @@ -66,7 +66,7 @@ plink: docker_network.yaml options: - option: filter shorthand: f - description: Provide filter values (i.e. 'dangling=true') + description: Provide filter values (e.g. 'driver=bridge') - option: format description: Pretty-print networks using a Go template - option: no-trunc diff --git a/_data/engine-cli/docker_network_prune.yaml b/_data/engine-cli/docker_network_prune.yaml new file mode 100644 index 0000000000..3e51e70ac2 --- /dev/null +++ b/_data/engine-cli/docker_network_prune.yaml @@ -0,0 +1,11 @@ +command: docker network prune +short: Remove all unused networks +long: Remove all unused networks +usage: docker network prune [OPTIONS] +pname: docker network +plink: docker_network.yaml +options: +- option: force + shorthand: f + default_value: "false" + description: Do not prompt for confirmation diff --git a/_data/engine-cli/docker_node.yaml b/_data/engine-cli/docker_node.yaml index 31c39d0471..c079518a23 100644 --- a/_data/engine-cli/docker_node.yaml +++ b/_data/engine-cli/docker_node.yaml @@ -4,5 +4,19 @@ long: Manage Swarm nodes usage: docker node pname: docker plink: docker.yaml -cname: docker node update -clink: docker_node_update.yaml +cname: +- docker node demote +- docker node inspect +- docker node ls +- docker node promote +- docker node ps +- docker node rm +- docker node update +clink: +- docker_node_demote.yaml +- docker_node_inspect.yaml +- docker_node_ls.yaml +- docker_node_promote.yaml +- docker_node_ps.yaml +- docker_node_rm.yaml +- docker_node_update.yaml diff --git a/_data/engine-cli/docker_node_inspect.yaml b/_data/engine-cli/docker_node_inspect.yaml index b8d8aed856..7b3af8991f 100644 --- a/_data/engine-cli/docker_node_inspect.yaml +++ b/_data/engine-cli/docker_node_inspect.yaml @@ -7,7 +7,7 @@ plink: docker_node.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template - option: pretty default_value: "false" description: Print the information in a human friendly format. diff --git a/_data/engine-cli/docker_node_rm.yaml b/_data/engine-cli/docker_node_rm.yaml index 50a4d298c0..e400bbd91c 100644 --- a/_data/engine-cli/docker_node_rm.yaml +++ b/_data/engine-cli/docker_node_rm.yaml @@ -6,5 +6,6 @@ pname: docker node plink: docker_node.yaml options: - option: force + shorthand: f default_value: "false" - description: Force remove an active node + description: Force remove a node from the swarm diff --git a/_data/engine-cli/docker_plugin.yaml b/_data/engine-cli/docker_plugin.yaml new file mode 100644 index 0000000000..bd0e6572e5 --- /dev/null +++ b/_data/engine-cli/docker_plugin.yaml @@ -0,0 +1,26 @@ +command: docker plugin +short: Manage plugins +long: Manage plugins +usage: docker plugin +pname: docker +plink: docker.yaml +cname: +- docker plugin create +- docker plugin disable +- docker plugin enable +- docker plugin inspect +- docker plugin install +- docker plugin ls +- docker plugin push +- docker plugin rm +- docker plugin set +clink: +- docker_plugin_create.yaml +- docker_plugin_disable.yaml +- docker_plugin_enable.yaml +- docker_plugin_inspect.yaml +- docker_plugin_install.yaml +- docker_plugin_ls.yaml +- docker_plugin_push.yaml +- docker_plugin_rm.yaml +- docker_plugin_set.yaml diff --git a/_data/engine-cli/docker_plugin_create.yaml b/_data/engine-cli/docker_plugin_create.yaml new file mode 100644 index 0000000000..88f1d4cbd4 --- /dev/null +++ b/_data/engine-cli/docker_plugin_create.yaml @@ -0,0 +1,10 @@ +command: docker plugin create +short: Create a plugin from a rootfs and config +long: Create a plugin from a rootfs and config +usage: docker plugin create [OPTIONS] PLUGIN[:tag] PATH-TO-ROOTFS(rootfs + config.json) +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: compress + default_value: "false" + description: Compress the context using gzip diff --git a/_data/engine-cli/docker_plugin_disable.yaml b/_data/engine-cli/docker_plugin_disable.yaml new file mode 100644 index 0000000000..b0abd0a379 --- /dev/null +++ b/_data/engine-cli/docker_plugin_disable.yaml @@ -0,0 +1,6 @@ +command: docker plugin disable +short: Disable a plugin +long: Disable a plugin +usage: docker plugin disable PLUGIN +pname: docker plugin +plink: docker_plugin.yaml diff --git a/_data/engine-cli/docker_plugin_enable.yaml b/_data/engine-cli/docker_plugin_enable.yaml new file mode 100644 index 0000000000..1ba94b4185 --- /dev/null +++ b/_data/engine-cli/docker_plugin_enable.yaml @@ -0,0 +1,10 @@ +command: docker plugin enable +short: Enable a plugin +long: Enable a plugin +usage: docker plugin enable [OPTIONS] PLUGIN +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: timeout + default_value: "0" + description: HTTP client timeout (in seconds) diff --git a/_data/engine-cli/docker_plugin_inspect.yaml b/_data/engine-cli/docker_plugin_inspect.yaml new file mode 100644 index 0000000000..1a13a415f9 --- /dev/null +++ b/_data/engine-cli/docker_plugin_inspect.yaml @@ -0,0 +1,10 @@ +command: docker plugin inspect +short: Display detailed information on one or more plugins +long: Display detailed information on one or more plugins +usage: docker plugin inspect [OPTIONS] PLUGIN|ID [PLUGIN|ID...] +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: format + shorthand: f + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_plugin_install.yaml b/_data/engine-cli/docker_plugin_install.yaml new file mode 100644 index 0000000000..44e345248e --- /dev/null +++ b/_data/engine-cli/docker_plugin_install.yaml @@ -0,0 +1,13 @@ +command: docker plugin install +short: Install a plugin +long: Install a plugin +usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...] +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: disable + default_value: "false" + description: Do not enable the plugin on install +- option: grant-all-permissions + default_value: "false" + description: Grant all permissions necessary to run the plugin diff --git a/_data/engine-cli/docker_plugin_ls.yaml b/_data/engine-cli/docker_plugin_ls.yaml new file mode 100644 index 0000000000..d3c030429c --- /dev/null +++ b/_data/engine-cli/docker_plugin_ls.yaml @@ -0,0 +1,10 @@ +command: docker plugin ls +short: List plugins +long: List plugins +usage: docker plugin ls [OPTIONS] +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: no-trunc + default_value: "false" + description: Don't truncate output diff --git a/_data/engine-cli/docker_plugin_push.yaml b/_data/engine-cli/docker_plugin_push.yaml new file mode 100644 index 0000000000..79f8bda7b5 --- /dev/null +++ b/_data/engine-cli/docker_plugin_push.yaml @@ -0,0 +1,6 @@ +command: docker plugin push +short: Push a plugin to a registry +long: Push a plugin to a registry +usage: docker plugin push PLUGIN[:TAG] +pname: docker plugin +plink: docker_plugin.yaml diff --git a/_data/engine-cli/docker_plugin_rm.yaml b/_data/engine-cli/docker_plugin_rm.yaml new file mode 100644 index 0000000000..c131692ce3 --- /dev/null +++ b/_data/engine-cli/docker_plugin_rm.yaml @@ -0,0 +1,11 @@ +command: docker plugin rm +short: Remove one or more plugins +long: Remove one or more plugins +usage: docker plugin rm [OPTIONS] PLUGIN [PLUGIN...] +pname: docker plugin +plink: docker_plugin.yaml +options: +- option: force + shorthand: f + default_value: "false" + description: Force the removal of an active plugin diff --git a/_data/engine-cli/docker_plugin_set.yaml b/_data/engine-cli/docker_plugin_set.yaml new file mode 100644 index 0000000000..2aa6ff26b4 --- /dev/null +++ b/_data/engine-cli/docker_plugin_set.yaml @@ -0,0 +1,6 @@ +command: docker plugin set +short: Change settings for a plugin +long: Change settings for a plugin +usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...] +pname: docker plugin +plink: docker_plugin.yaml diff --git a/_data/engine-cli/docker_run.yaml b/_data/engine-cli/docker_run.yaml index 41317c15a6..560ef60bc4 100644 --- a/_data/engine-cli/docker_run.yaml +++ b/_data/engine-cli/docker_run.yaml @@ -14,7 +14,8 @@ options: description: Attach to STDIN, STDOUT or STDERR - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: blkio-weight-device default_value: '[]' description: Block IO weight (relative device weight) @@ -28,6 +29,9 @@ options: description: Optional parent cgroup for the container - option: cidfile description: Write the container ID to the file +- option: cpu-count + default_value: "0" + description: CPU count (Windows only) - option: cpu-percent default_value: "0" description: CPU percent (Windows only) @@ -37,10 +41,19 @@ options: - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" description: CPU shares (relative weight) +- option: cpus + default_value: "0.000" + description: Number of CPUs - option: cpuset-cpus description: CPUs in which to allow execution (0-3, 0,1) - option: cpuset-mems @@ -77,6 +90,9 @@ options: - option: dns-opt default_value: '[]' description: Set DNS options +- option: dns-option + default_value: '[]' + description: Set DNS options - option: dns-search default_value: '[]' description: Set custom DNS search domains @@ -99,13 +115,14 @@ options: description: Command to run to check health - option: health-interval default_value: "0" - description: Time between running the check + description: Time between running the check (ns|us|ms|s|m|h) (default 0s) - option: health-retries default_value: "0" description: Consecutive failures needed to report unhealthy - option: health-timeout default_value: "0" - description: Maximum time to allow one check to run + description: | + Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) - option: help default_value: "false" description: Print usage @@ -230,6 +247,9 @@ options: - option: stop-signal default_value: SIGTERM description: Signal to stop a container, SIGTERM by default +- option: stop-timeout + default_value: "0" + description: Timeout (in seconds) to stop a container - option: storage-opt default_value: '[]' description: Storage driver options for the container diff --git a/_data/engine-cli/docker_secret.yaml b/_data/engine-cli/docker_secret.yaml new file mode 100644 index 0000000000..bad1030e0e --- /dev/null +++ b/_data/engine-cli/docker_secret.yaml @@ -0,0 +1,16 @@ +command: docker secret +short: Manage Docker secrets +long: Manage Docker secrets +usage: docker secret +pname: docker +plink: docker.yaml +cname: +- docker secret create +- docker secret inspect +- docker secret ls +- docker secret rm +clink: +- docker_secret_create.yaml +- docker_secret_inspect.yaml +- docker_secret_ls.yaml +- docker_secret_rm.yaml diff --git a/_data/engine-cli/docker_secret_create.yaml b/_data/engine-cli/docker_secret_create.yaml new file mode 100644 index 0000000000..8094c584ee --- /dev/null +++ b/_data/engine-cli/docker_secret_create.yaml @@ -0,0 +1,11 @@ +command: docker secret create +short: Create a secret using stdin as content +long: Create a secret using stdin as content +usage: docker secret create [OPTIONS] SECRET +pname: docker secret +plink: docker_secret.yaml +options: +- option: label + shorthand: l + default_value: '[]' + description: Secret labels diff --git a/_data/engine-cli/docker_secret_inspect.yaml b/_data/engine-cli/docker_secret_inspect.yaml new file mode 100644 index 0000000000..6465702231 --- /dev/null +++ b/_data/engine-cli/docker_secret_inspect.yaml @@ -0,0 +1,10 @@ +command: docker secret inspect +short: Display detailed information on one or more secrets +long: Display detailed information on one or more secrets +usage: docker secret inspect [OPTIONS] SECRET [SECRET...] +pname: docker secret +plink: docker_secret.yaml +options: +- option: format + shorthand: f + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_secret_ls.yaml b/_data/engine-cli/docker_secret_ls.yaml new file mode 100644 index 0000000000..05aaa77849 --- /dev/null +++ b/_data/engine-cli/docker_secret_ls.yaml @@ -0,0 +1,11 @@ +command: docker secret ls +short: List secrets +long: List secrets +usage: docker secret ls [OPTIONS] +pname: docker secret +plink: docker_secret.yaml +options: +- option: quiet + shorthand: q + default_value: "false" + description: Only display IDs diff --git a/_data/engine-cli/docker_secret_rm.yaml b/_data/engine-cli/docker_secret_rm.yaml new file mode 100644 index 0000000000..69ea4cb8f0 --- /dev/null +++ b/_data/engine-cli/docker_secret_rm.yaml @@ -0,0 +1,6 @@ +command: docker secret rm +short: Remove one or more secrets +long: Remove one or more secrets +usage: docker secret rm SECRET [SECRET...] +pname: docker secret +plink: docker_secret.yaml diff --git a/_data/engine-cli/docker_service.yaml b/_data/engine-cli/docker_service.yaml index 194f40b217..9e919b0fc8 100644 --- a/_data/engine-cli/docker_service.yaml +++ b/_data/engine-cli/docker_service.yaml @@ -4,5 +4,21 @@ long: Manage services usage: docker service pname: docker plink: docker.yaml -cname: docker service update -clink: docker_service_update.yaml +cname: +- docker service create +- docker service inspect +- docker service logs +- docker service ls +- docker service ps +- docker service rm +- docker service scale +- docker service update +clink: +- docker_service_create.yaml +- docker_service_inspect.yaml +- docker_service_logs.yaml +- docker_service_ls.yaml +- docker_service_ps.yaml +- docker_service_rm.yaml +- docker_service_scale.yaml +- docker_service_update.yaml diff --git a/_data/engine-cli/docker_service_create.yaml b/_data/engine-cli/docker_service_create.yaml index aa15edbf39..363252542a 100644 --- a/_data/engine-cli/docker_service_create.yaml +++ b/_data/engine-cli/docker_service_create.yaml @@ -11,15 +11,43 @@ options: - option: container-label default_value: '[]' description: Container labels +- option: dns + default_value: '[]' + description: Set custom DNS servers +- option: dns-option + default_value: '[]' + description: Set DNS options +- option: dns-search + default_value: '[]' + description: Set custom DNS search domains - option: endpoint-mode description: Endpoint mode (vip or dnsrr) - option: env shorthand: e default_value: '[]' description: Set environment variables -- option: group-add +- option: env-file default_value: '[]' - description: Add additional user groups to the container + description: Read in a file of environment variables +- option: group + default_value: '[]' + description: Set one or more supplementary user groups for the container +- option: health-cmd + description: Command to run to check health +- option: health-interval + default_value: none + description: Time between running the check (ns|us|ms|s|m|h) +- option: health-retries + default_value: "0" + description: Consecutive failures needed to report unhealthy +- option: health-timeout + default_value: none + description: Maximum time to allow one check to run (ns|us|ms|s|m|h) +- option: host + default_value: '[]' + description: Set one or more custom host-to-IP mappings (host:ip) +- option: hostname + description: Container hostname - option: label shorthand: l default_value: '[]' @@ -39,15 +67,17 @@ options: default_value: replicated description: Service mode (replicated or global) - option: mount - description: Attach a mount to the service + description: Attach a filesystem mount to the service - option: name description: Service name - option: network default_value: '[]' description: Network attachments +- option: no-healthcheck + default_value: "false" + description: Disable any container-specified HEALTHCHECK - option: publish shorthand: p - default_value: '[]' description: Publish a port as a node port - option: replicas default_value: none @@ -62,22 +92,36 @@ options: description: Restart when condition is met (none, on-failure, or any) - option: restart-delay default_value: none - description: Delay between restart attempts + description: Delay between restart attempts (ns|us|ms|s|m|h) - option: restart-max-attempts default_value: none description: Maximum number of restarts before giving up - option: restart-window default_value: none - description: Window used to evaluate the restart policy + description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) +- option: secret + description: Specify secrets to expose to the service - option: stop-grace-period default_value: none - description: Time to wait before force killing a container + description: | + Time to wait before force killing a container (ns|us|ms|s|m|h) +- option: tty + shorthand: t + default_value: "false" + description: Allocate a pseudo-TTY - option: update-delay default_value: "0" - description: Delay between updates + description: Delay between updates (ns|us|ms|s|m|h) (default 0s) - option: update-failure-action default_value: pause description: Action on update failure (pause|continue) +- option: update-max-failure-ratio + default_value: "0" + description: Failure rate to tolerate during an update +- option: update-monitor + default_value: "0" + description: | + Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s) - option: update-parallelism default_value: "1" description: | diff --git a/_data/engine-cli/docker_service_inspect.yaml b/_data/engine-cli/docker_service_inspect.yaml index 0b5a450a42..05a9378687 100644 --- a/_data/engine-cli/docker_service_inspect.yaml +++ b/_data/engine-cli/docker_service_inspect.yaml @@ -7,7 +7,7 @@ plink: docker_service.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template - option: pretty default_value: "false" description: Print the information in a human friendly format. diff --git a/_data/engine-cli/docker_service_logs.yaml b/_data/engine-cli/docker_service_logs.yaml new file mode 100644 index 0000000000..adbacd1a4b --- /dev/null +++ b/_data/engine-cli/docker_service_logs.yaml @@ -0,0 +1,26 @@ +command: docker service logs +short: Fetch the logs of a service +long: Fetch the logs of a service +usage: docker service logs [OPTIONS] SERVICE +pname: docker service +plink: docker_service.yaml +options: +- option: details + default_value: "false" + description: Show extra details provided to logs +- option: follow + shorthand: f + default_value: "false" + description: Follow log output +- option: no-resolve + default_value: "false" + description: Do not map IDs to Names +- option: since + description: Show logs since timestamp +- option: tail + default_value: all + description: Number of lines to show from the end of the logs +- option: timestamps + shorthand: t + default_value: "false" + description: Show timestamps diff --git a/_data/engine-cli/docker_service_ps.yaml b/_data/engine-cli/docker_service_ps.yaml index 877a691275..384e118dff 100644 --- a/_data/engine-cli/docker_service_ps.yaml +++ b/_data/engine-cli/docker_service_ps.yaml @@ -14,3 +14,7 @@ options: - option: no-trunc default_value: "false" description: Do not truncate output +- option: quiet + shorthand: q + default_value: "false" + description: Only display task IDs diff --git a/_data/engine-cli/docker_service_scale.yaml b/_data/engine-cli/docker_service_scale.yaml index c1aefc0a5b..aa54631225 100644 --- a/_data/engine-cli/docker_service_scale.yaml +++ b/_data/engine-cli/docker_service_scale.yaml @@ -1,6 +1,6 @@ command: docker service scale -short: Scale one or multiple services -long: Scale one or multiple services +short: Scale one or multiple replicated services +long: Scale one or multiple replicated services usage: docker service scale SERVICE=REPLICAS [SERVICE=REPLICAS...] pname: docker service plink: docker_service.yaml diff --git a/_data/engine-cli/docker_service_update.yaml b/_data/engine-cli/docker_service_update.yaml index 6ff411c2d0..c227c16b54 100644 --- a/_data/engine-cli/docker_service_update.yaml +++ b/_data/engine-cli/docker_service_update.yaml @@ -9,35 +9,76 @@ options: description: Service command args - option: constraint-add default_value: '[]' - description: Add or update placement constraints + description: Add or update a placement constraint - option: constraint-rm default_value: '[]' description: Remove a constraint - option: container-label-add default_value: '[]' - description: Add or update container labels + description: Add or update a container label - option: container-label-rm default_value: '[]' description: Remove a container label by its key +- option: dns-add + default_value: '[]' + description: Add or update a custom DNS server +- option: dns-option-add + default_value: '[]' + description: Add or update a DNS option +- option: dns-option-rm + default_value: '[]' + description: Remove a DNS option +- option: dns-rm + default_value: '[]' + description: Remove a custom DNS server +- option: dns-search-add + default_value: '[]' + description: Add or update a custom DNS search domain +- option: dns-search-rm + default_value: '[]' + description: Remove a DNS search domain - option: endpoint-mode description: Endpoint mode (vip or dnsrr) - option: env-add default_value: '[]' - description: Add or update environment variables + description: Add or update an environment variable - option: env-rm default_value: '[]' description: Remove an environment variable +- option: force + default_value: "false" + description: Force update even if no changes require it - option: group-add default_value: '[]' - description: Add additional user groups to the container + description: Add an additional supplementary user group to the container - option: group-rm default_value: '[]' - description: Remove previously added user groups from the container + description: | + Remove a previously added supplementary user group from the container +- option: health-cmd + description: Command to run to check health +- option: health-interval + default_value: none + description: Time between running the check (ns|us|ms|s|m|h) +- option: health-retries + default_value: "0" + description: Consecutive failures needed to report unhealthy +- option: health-timeout + default_value: none + description: Maximum time to allow one check to run (ns|us|ms|s|m|h) +- option: host-add + default_value: '[]' + description: Add or update a custom host-to-IP mapping (host:ip) +- option: host-rm + default_value: '[]' + description: Remove a custom host-to-IP mapping (host:ip) +- option: hostname + description: Container hostname - option: image description: Service image tag - option: label-add default_value: '[]' - description: Add or update service labels + description: Add or update a service label - option: label-rm default_value: '[]' description: Remove a label by its key @@ -57,13 +98,12 @@ options: - option: mount-rm default_value: '[]' description: Remove a mount by its target path -- option: name - description: Service name +- option: no-healthcheck + default_value: "false" + description: Disable any container-specified HEALTHCHECK - option: publish-add - default_value: '[]' description: Add or update a published port - option: publish-rm - default_value: '[]' description: Remove a published port by its target port - option: replicas default_value: none @@ -78,22 +118,42 @@ options: description: Restart when condition is met (none, on-failure, or any) - option: restart-delay default_value: none - description: Delay between restart attempts + description: Delay between restart attempts (ns|us|ms|s|m|h) - option: restart-max-attempts default_value: none description: Maximum number of restarts before giving up - option: restart-window default_value: none - description: Window used to evaluate the restart policy + description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) +- option: rollback + default_value: "false" + description: Rollback to previous specification +- option: secret-add + description: Add or update a secret on a service +- option: secret-rm + default_value: '[]' + description: Remove a secret - option: stop-grace-period default_value: none - description: Time to wait before force killing a container + description: | + Time to wait before force killing a container (ns|us|ms|s|m|h) +- option: tty + shorthand: t + default_value: "false" + description: Allocate a pseudo-TTY - option: update-delay default_value: "0" - description: Delay between updates + description: Delay between updates (ns|us|ms|s|m|h) (default 0s) - option: update-failure-action default_value: pause description: Action on update failure (pause|continue) +- option: update-max-failure-ratio + default_value: "0" + description: Failure rate to tolerate during an update +- option: update-monitor + default_value: "0" + description: | + Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s) - option: update-parallelism default_value: "1" description: | diff --git a/_data/engine-cli/docker_stack.yaml b/_data/engine-cli/docker_stack.yaml new file mode 100644 index 0000000000..59f04a610d --- /dev/null +++ b/_data/engine-cli/docker_stack.yaml @@ -0,0 +1,18 @@ +command: docker stack +short: Manage Docker stacks +long: Manage Docker stacks +usage: docker stack +pname: docker +plink: docker.yaml +cname: +- docker stack deploy +- docker stack ls +- docker stack ps +- docker stack rm +- docker stack services +clink: +- docker_stack_deploy.yaml +- docker_stack_ls.yaml +- docker_stack_ps.yaml +- docker_stack_rm.yaml +- docker_stack_services.yaml diff --git a/_data/engine-cli/docker_stack_deploy.yaml b/_data/engine-cli/docker_stack_deploy.yaml new file mode 100644 index 0000000000..95bcba3474 --- /dev/null +++ b/_data/engine-cli/docker_stack_deploy.yaml @@ -0,0 +1,15 @@ +command: docker stack deploy +short: Deploy a new stack or update an existing stack +long: Deploy a new stack or update an existing stack +usage: docker stack deploy [OPTIONS] STACK +pname: docker stack +plink: docker_stack.yaml +options: +- option: bundle-file + description: Path to a Distributed Application Bundle file +- option: compose-file + shorthand: c + description: Path to a Compose file +- option: with-registry-auth + default_value: "false" + description: Send registry authentication details to Swarm agents diff --git a/_data/engine-cli/docker_stack_ls.yaml b/_data/engine-cli/docker_stack_ls.yaml new file mode 100644 index 0000000000..3176bcff3d --- /dev/null +++ b/_data/engine-cli/docker_stack_ls.yaml @@ -0,0 +1,6 @@ +command: docker stack ls +short: List stacks +long: List stacks +usage: docker stack ls +pname: docker stack +plink: docker_stack.yaml diff --git a/_data/engine-cli/docker_stack_ps.yaml b/_data/engine-cli/docker_stack_ps.yaml new file mode 100644 index 0000000000..3f46f59e39 --- /dev/null +++ b/_data/engine-cli/docker_stack_ps.yaml @@ -0,0 +1,20 @@ +command: docker stack ps +short: List the tasks in the stack +long: List the tasks in the stack +usage: docker stack ps [OPTIONS] STACK +pname: docker stack +plink: docker_stack.yaml +options: +- option: all + shorthand: a + default_value: "false" + description: Display all tasks +- option: filter + shorthand: f + description: Filter output based on conditions provided +- option: no-resolve + default_value: "false" + description: Do not map IDs to Names +- option: no-trunc + default_value: "false" + description: Do not truncate output diff --git a/_data/engine-cli/docker_stack_rm.yaml b/_data/engine-cli/docker_stack_rm.yaml new file mode 100644 index 0000000000..b6626648ca --- /dev/null +++ b/_data/engine-cli/docker_stack_rm.yaml @@ -0,0 +1,6 @@ +command: docker stack rm +short: Remove the stack +long: Remove the stack +usage: docker stack rm STACK +pname: docker stack +plink: docker_stack.yaml diff --git a/_data/engine-cli/docker_stack_services.yaml b/_data/engine-cli/docker_stack_services.yaml new file mode 100644 index 0000000000..40f2462815 --- /dev/null +++ b/_data/engine-cli/docker_stack_services.yaml @@ -0,0 +1,14 @@ +command: docker stack services +short: List the services in the stack +long: List the services in the stack +usage: docker stack services [OPTIONS] STACK +pname: docker stack +plink: docker_stack.yaml +options: +- option: filter + shorthand: f + description: Filter output based on conditions provided +- option: quiet + shorthand: q + default_value: "false" + description: Only display IDs diff --git a/_data/engine-cli/docker_start.yaml b/_data/engine-cli/docker_start.yaml index a142008f0e..8355419205 100644 --- a/_data/engine-cli/docker_start.yaml +++ b/_data/engine-cli/docker_start.yaml @@ -9,6 +9,10 @@ options: shorthand: a default_value: "false" description: Attach STDOUT/STDERR and forward signals +- option: checkpoint + description: Restore from this checkpoint +- option: checkpoint-dir + description: Use a custom checkpoint storage directory - option: detach-keys description: Override the key sequence for detaching a container - option: interactive diff --git a/_data/engine-cli/docker_swarm.yaml b/_data/engine-cli/docker_swarm.yaml index 8b1144a39e..b8935bd230 100644 --- a/_data/engine-cli/docker_swarm.yaml +++ b/_data/engine-cli/docker_swarm.yaml @@ -4,5 +4,19 @@ long: Manage Swarm usage: docker swarm pname: docker plink: docker.yaml -cname: docker swarm update -clink: docker_swarm_update.yaml +cname: +- docker swarm init +- docker swarm join +- docker swarm join-token +- docker swarm leave +- docker swarm unlock +- docker swarm unlock-key +- docker swarm update +clink: +- docker_swarm_init.yaml +- docker_swarm_join.yaml +- docker_swarm_join-token.yaml +- docker_swarm_leave.yaml +- docker_swarm_unlock.yaml +- docker_swarm_unlock-key.yaml +- docker_swarm_update.yaml diff --git a/_data/engine-cli/docker_swarm_init.yaml b/_data/engine-cli/docker_swarm_init.yaml index c1693565c9..6a2f930557 100644 --- a/_data/engine-cli/docker_swarm_init.yaml +++ b/_data/engine-cli/docker_swarm_init.yaml @@ -7,20 +7,30 @@ plink: docker_swarm.yaml options: - option: advertise-addr description: 'Advertised address (format: [:port])' +- option: autolock + default_value: "false" + description: | + Enable manager autolocking (requiring an unlock key to start a stopped manager) - option: cert-expiry default_value: 2160h0m0s - description: Validity period for node certificates + description: Validity period for node certificates (ns|us|ms|s|m|h) - option: dispatcher-heartbeat default_value: 5s - description: Dispatcher heartbeat period + description: Dispatcher heartbeat period (ns|us|ms|s|m|h) - option: external-ca description: Specifications of one or more certificate signing endpoints - option: force-new-cluster default_value: "false" - description: Force create a new cluster from current state. + description: Force create a new cluster from current state - option: listen-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' +- option: max-snapshots + default_value: "0" + description: Number of additional Raft snapshots to retain +- option: snapshot-interval + default_value: "10000" + description: Number of log entries between Raft snapshots - option: task-history-limit default_value: "5" description: Task history retention limit diff --git a/_data/engine-cli/docker_swarm_leave.yaml b/_data/engine-cli/docker_swarm_leave.yaml index 319b557b3f..d22cbd21b5 100644 --- a/_data/engine-cli/docker_swarm_leave.yaml +++ b/_data/engine-cli/docker_swarm_leave.yaml @@ -1,10 +1,11 @@ command: docker swarm leave -short: Leave the swarm (workers only) -long: Leave the swarm (workers only) +short: Leave the swarm +long: Leave the swarm usage: docker swarm leave [OPTIONS] pname: docker swarm plink: docker_swarm.yaml options: - option: force + shorthand: f default_value: "false" description: Force this node to leave the swarm, ignoring warnings diff --git a/_data/engine-cli/docker_swarm_unlock-key.yaml b/_data/engine-cli/docker_swarm_unlock-key.yaml new file mode 100644 index 0000000000..a5534d60a8 --- /dev/null +++ b/_data/engine-cli/docker_swarm_unlock-key.yaml @@ -0,0 +1,14 @@ +command: docker swarm unlock-key +short: Manage the unlock key +long: Manage the unlock key +usage: docker swarm unlock-key [OPTIONS] +pname: docker swarm +plink: docker_swarm.yaml +options: +- option: quiet + shorthand: q + default_value: "false" + description: Only display token +- option: rotate + default_value: "false" + description: Rotate unlock key diff --git a/_data/engine-cli/docker_swarm_unlock.yaml b/_data/engine-cli/docker_swarm_unlock.yaml new file mode 100644 index 0000000000..5155a4961b --- /dev/null +++ b/_data/engine-cli/docker_swarm_unlock.yaml @@ -0,0 +1,6 @@ +command: docker swarm unlock +short: Unlock swarm +long: Unlock swarm +usage: docker swarm unlock +pname: docker swarm +plink: docker_swarm.yaml diff --git a/_data/engine-cli/docker_swarm_update.yaml b/_data/engine-cli/docker_swarm_update.yaml index 448f47fc6e..0380cb850e 100644 --- a/_data/engine-cli/docker_swarm_update.yaml +++ b/_data/engine-cli/docker_swarm_update.yaml @@ -5,14 +5,23 @@ usage: docker swarm update [OPTIONS] pname: docker swarm plink: docker_swarm.yaml options: +- option: autolock + default_value: "false" + description: Change manager autolocking setting (true|false) - option: cert-expiry default_value: 2160h0m0s - description: Validity period for node certificates + description: Validity period for node certificates (ns|us|ms|s|m|h) - option: dispatcher-heartbeat default_value: 5s - description: Dispatcher heartbeat period + description: Dispatcher heartbeat period (ns|us|ms|s|m|h) - option: external-ca description: Specifications of one or more certificate signing endpoints +- option: max-snapshots + default_value: "0" + description: Number of additional Raft snapshots to retain +- option: snapshot-interval + default_value: "10000" + description: Number of log entries between Raft snapshots - option: task-history-limit default_value: "5" description: Task history retention limit diff --git a/_data/engine-cli/docker_system.yaml b/_data/engine-cli/docker_system.yaml index 391ae639da..9b3a9fa724 100644 --- a/_data/engine-cli/docker_system.yaml +++ b/_data/engine-cli/docker_system.yaml @@ -4,5 +4,13 @@ long: Manage Docker usage: docker system pname: docker plink: docker.yaml -cname: docker system prune -clink: docker_system_prune.yaml +cname: +- docker system df +- docker system events +- docker system info +- docker system prune +clink: +- docker_system_df.yaml +- docker_system_events.yaml +- docker_system_info.yaml +- docker_system_prune.yaml diff --git a/_data/engine-cli/docker_system_events.yaml b/_data/engine-cli/docker_system_events.yaml index 1339f648a8..7ac3a687a2 100644 --- a/_data/engine-cli/docker_system_events.yaml +++ b/_data/engine-cli/docker_system_events.yaml @@ -9,7 +9,7 @@ options: shorthand: f description: Filter output based on conditions provided - option: format - description: Format the output using the given go template + description: Format the output using the given Go template - option: since description: Show all events created since timestamp - option: until diff --git a/_data/engine-cli/docker_system_info.yaml b/_data/engine-cli/docker_system_info.yaml index f155e7cfe7..2636cfc87a 100644 --- a/_data/engine-cli/docker_system_info.yaml +++ b/_data/engine-cli/docker_system_info.yaml @@ -7,4 +7,4 @@ plink: docker_system.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_tag.yaml b/_data/engine-cli/docker_tag.yaml index cb5ee57a56..1f99378cca 100644 --- a/_data/engine-cli/docker_tag.yaml +++ b/_data/engine-cli/docker_tag.yaml @@ -1,6 +1,6 @@ command: docker tag -short: Tag an image into a repository -long: Tag an image into a repository -usage: docker tag IMAGE[:TAG] IMAGE[:TAG] +short: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE +long: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE +usage: docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] pname: docker plink: docker.yaml diff --git a/_data/engine-cli/docker_update.yaml b/_data/engine-cli/docker_update.yaml index fb4ee3405b..d129771c0a 100644 --- a/_data/engine-cli/docker_update.yaml +++ b/_data/engine-cli/docker_update.yaml @@ -7,13 +7,20 @@ plink: docker.yaml options: - option: blkio-weight default_value: "0" - description: Block IO (relative weight), between 10 and 1000 + description: | + Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - option: cpu-period default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period - option: cpu-quota default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota +- option: cpu-rt-period + default_value: "0" + description: Limit the CPU real-time period in microseconds +- option: cpu-rt-runtime + default_value: "0" + description: Limit the CPU real-time runtime in microseconds - option: cpu-shares shorthand: c default_value: "0" diff --git a/_data/engine-cli/docker_version.yaml b/_data/engine-cli/docker_version.yaml index 2d85f5d483..61451ec84d 100644 --- a/_data/engine-cli/docker_version.yaml +++ b/_data/engine-cli/docker_version.yaml @@ -18,4 +18,4 @@ plink: docker.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template diff --git a/_data/engine-cli/docker_volume.yaml b/_data/engine-cli/docker_volume.yaml index 784d495c2d..6903a13fa7 100644 --- a/_data/engine-cli/docker_volume.yaml +++ b/_data/engine-cli/docker_volume.yaml @@ -18,5 +18,15 @@ long: | usage: docker volume COMMAND pname: docker plink: docker.yaml -cname: docker volume rm -clink: docker_volume_rm.yaml +cname: +- docker volume create +- docker volume inspect +- docker volume ls +- docker volume prune +- docker volume rm +clink: +- docker_volume_create.yaml +- docker_volume_inspect.yaml +- docker_volume_ls.yaml +- docker_volume_prune.yaml +- docker_volume_rm.yaml diff --git a/_data/engine-cli/docker_volume_inspect.yaml b/_data/engine-cli/docker_volume_inspect.yaml index 38a9a2f36d..4ab9a7c847 100644 --- a/_data/engine-cli/docker_volume_inspect.yaml +++ b/_data/engine-cli/docker_volume_inspect.yaml @@ -11,4 +11,4 @@ plink: docker_volume.yaml options: - option: format shorthand: f - description: Format the output using the given go template + description: Format the output using the given Go template