From 500f1816b10e75930859dbf10860df52e479bc8b Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Fri, 22 Sep 2017 14:12:27 -0700 Subject: [PATCH] Update YAML files for CLI refs --- _data/engine-cli-edge/docker.yaml | 2 + _data/engine-cli-edge/docker_attach.yaml | 11 + _data/engine-cli-edge/docker_build.yaml | 97 +++- _data/engine-cli-edge/docker_checkpoint.yaml | 3 + .../docker_checkpoint_create.yaml | 9 + .../engine-cli-edge/docker_checkpoint_ls.yaml | 6 + .../engine-cli-edge/docker_checkpoint_rm.yaml | 6 + _data/engine-cli-edge/docker_commit.yaml | 14 + _data/engine-cli-edge/docker_config.yaml | 3 + .../engine-cli-edge/docker_config_create.yaml | 6 + .../docker_config_inspect.yaml | 9 + _data/engine-cli-edge/docker_config_ls.yaml | 12 + _data/engine-cli-edge/docker_config_rm.yaml | 3 + _data/engine-cli-edge/docker_container.yaml | 2 + .../docker_container_attach.yaml | 11 + .../docker_container_commit.yaml | 14 + .../engine-cli-edge/docker_container_cp.yaml | 8 + .../docker_container_create.yaml | 295 ++++++++++- .../docker_container_diff.yaml | 2 + .../docker_container_exec.yaml | 24 + .../docker_container_export.yaml | 5 + .../docker_container_inspect.yaml | 8 + .../docker_container_kill.yaml | 5 + .../docker_container_logs.yaml | 17 + .../engine-cli-edge/docker_container_ls.yaml | 26 + .../docker_container_pause.yaml | 2 + .../docker_container_port.yaml | 2 + .../docker_container_prune.yaml | 9 + .../docker_container_rename.yaml | 2 + .../docker_container_restart.yaml | 5 + .../engine-cli-edge/docker_container_rm.yaml | 11 + .../engine-cli-edge/docker_container_run.yaml | 304 ++++++++++- .../docker_container_start.yaml | 17 + .../docker_container_stats.yaml | 11 + .../docker_container_stop.yaml | 5 + .../engine-cli-edge/docker_container_top.yaml | 2 + .../docker_container_unpause.yaml | 2 + .../docker_container_update.yaml | 47 ++ .../docker_container_wait.yaml | 2 + _data/engine-cli-edge/docker_cp.yaml | 16 +- _data/engine-cli-edge/docker_create.yaml | 295 ++++++++++- _data/engine-cli-edge/docker_deploy.yaml | 21 + _data/engine-cli-edge/docker_diff.yaml | 2 + _data/engine-cli-edge/docker_events.yaml | 20 + _data/engine-cli-edge/docker_exec.yaml | 24 + _data/engine-cli-edge/docker_export.yaml | 5 + _data/engine-cli-edge/docker_history.yaml | 14 + _data/engine-cli-edge/docker_image.yaml | 2 + _data/engine-cli-edge/docker_image_build.yaml | 95 ++++ .../engine-cli-edge/docker_image_history.yaml | 14 + .../engine-cli-edge/docker_image_import.yaml | 8 + .../engine-cli-edge/docker_image_inspect.yaml | 5 + _data/engine-cli-edge/docker_image_load.yaml | 8 + _data/engine-cli-edge/docker_image_ls.yaml | 20 + _data/engine-cli-edge/docker_image_prune.yaml | 12 + _data/engine-cli-edge/docker_image_pull.yaml | 8 + _data/engine-cli-edge/docker_image_push.yaml | 5 + _data/engine-cli-edge/docker_image_rm.yaml | 8 + _data/engine-cli-edge/docker_image_save.yaml | 5 + _data/engine-cli-edge/docker_image_tag.yaml | 2 + _data/engine-cli-edge/docker_images.yaml | 20 + _data/engine-cli-edge/docker_import.yaml | 8 + _data/engine-cli-edge/docker_info.yaml | 5 + _data/engine-cli-edge/docker_inspect.yaml | 11 + _data/engine-cli-edge/docker_kill.yaml | 5 + _data/engine-cli-edge/docker_load.yaml | 8 + _data/engine-cli-edge/docker_login.yaml | 27 +- _data/engine-cli-edge/docker_logout.yaml | 2 + _data/engine-cli-edge/docker_logs.yaml | 17 + _data/engine-cli-edge/docker_network.yaml | 2 + .../docker_network_connect.yaml | 17 + .../docker_network_create.yaml | 57 ++- .../docker_network_disconnect.yaml | 5 + .../docker_network_inspect.yaml | 8 + _data/engine-cli-edge/docker_network_ls.yaml | 14 + .../engine-cli-edge/docker_network_prune.yaml | 9 + _data/engine-cli-edge/docker_network_rm.yaml | 2 + _data/engine-cli-edge/docker_node.yaml | 3 + _data/engine-cli-edge/docker_node_demote.yaml | 3 + .../engine-cli-edge/docker_node_inspect.yaml | 9 + _data/engine-cli-edge/docker_node_ls.yaml | 14 +- .../engine-cli-edge/docker_node_promote.yaml | 3 + _data/engine-cli-edge/docker_node_ps.yaml | 18 + _data/engine-cli-edge/docker_node_rm.yaml | 6 + _data/engine-cli-edge/docker_node_update.yaml | 15 + _data/engine-cli-edge/docker_pause.yaml | 2 + _data/engine-cli-edge/docker_plugin.yaml | 3 + .../engine-cli-edge/docker_plugin_create.yaml | 6 + .../docker_plugin_disable.yaml | 6 + .../engine-cli-edge/docker_plugin_enable.yaml | 6 + .../docker_plugin_inspect.yaml | 6 + .../docker_plugin_install.yaml | 15 + _data/engine-cli-edge/docker_plugin_ls.yaml | 21 +- _data/engine-cli-edge/docker_plugin_push.yaml | 6 + _data/engine-cli-edge/docker_plugin_rm.yaml | 6 + _data/engine-cli-edge/docker_plugin_set.yaml | 3 + .../docker_plugin_upgrade.yaml | 12 + _data/engine-cli-edge/docker_port.yaml | 2 + _data/engine-cli-edge/docker_ps.yaml | 51 +- _data/engine-cli-edge/docker_pull.yaml | 8 + _data/engine-cli-edge/docker_push.yaml | 5 + _data/engine-cli-edge/docker_rename.yaml | 2 + _data/engine-cli-edge/docker_restart.yaml | 5 + _data/engine-cli-edge/docker_rm.yaml | 11 + _data/engine-cli-edge/docker_rmi.yaml | 8 + _data/engine-cli-edge/docker_run.yaml | 315 +++++++++++- _data/engine-cli-edge/docker_save.yaml | 5 + _data/engine-cli-edge/docker_search.yaml | 45 +- _data/engine-cli-edge/docker_secret.yaml | 3 + .../engine-cli-edge/docker_secret_create.yaml | 6 + .../docker_secret_inspect.yaml | 9 + _data/engine-cli-edge/docker_secret_ls.yaml | 12 + _data/engine-cli-edge/docker_secret_rm.yaml | 3 + _data/engine-cli-edge/docker_service.yaml | 5 + .../docker_service_create.yaml | 246 ++++++++- .../docker_service_inspect.yaml | 9 + .../engine-cli-edge/docker_service_logs.yaml | 32 ++ _data/engine-cli-edge/docker_service_ls.yaml | 12 + _data/engine-cli-edge/docker_service_ps.yaml | 18 + _data/engine-cli-edge/docker_service_rm.yaml | 3 + .../docker_service_rollback.yaml | 78 +++ .../engine-cli-edge/docker_service_scale.yaml | 7 + .../docker_service_update.yaml | 471 ++++++++++++++++-- _data/engine-cli-edge/docker_stack.yaml | 3 + .../engine-cli-edge/docker_stack_deploy.yaml | 38 ++ _data/engine-cli-edge/docker_stack_ls.yaml | 6 + _data/engine-cli-edge/docker_stack_ps.yaml | 18 + _data/engine-cli-edge/docker_stack_rm.yaml | 3 + .../docker_stack_services.yaml | 12 + _data/engine-cli-edge/docker_start.yaml | 17 + _data/engine-cli-edge/docker_stats.yaml | 11 + _data/engine-cli-edge/docker_stop.yaml | 5 + _data/engine-cli-edge/docker_swarm.yaml | 3 + _data/engine-cli-edge/docker_swarm_ca.yaml | 24 + _data/engine-cli-edge/docker_swarm_init.yaml | 41 ++ .../docker_swarm_join-token.yaml | 9 + _data/engine-cli-edge/docker_swarm_join.yaml | 18 + _data/engine-cli-edge/docker_swarm_leave.yaml | 6 + .../docker_swarm_unlock-key.yaml | 9 + .../engine-cli-edge/docker_swarm_unlock.yaml | 3 + .../engine-cli-edge/docker_swarm_update.yaml | 26 + _data/engine-cli-edge/docker_system.yaml | 2 + _data/engine-cli-edge/docker_system_df.yaml | 9 + .../engine-cli-edge/docker_system_events.yaml | 14 + _data/engine-cli-edge/docker_system_info.yaml | 5 + .../engine-cli-edge/docker_system_prune.yaml | 16 + _data/engine-cli-edge/docker_tag.yaml | 2 + _data/engine-cli-edge/docker_top.yaml | 2 + _data/engine-cli-edge/docker_unpause.yaml | 2 + _data/engine-cli-edge/docker_update.yaml | 51 ++ _data/engine-cli-edge/docker_version.yaml | 5 + _data/engine-cli-edge/docker_volume.yaml | 3 + .../engine-cli-edge/docker_volume_create.yaml | 15 + .../docker_volume_inspect.yaml | 6 + _data/engine-cli-edge/docker_volume_ls.yaml | 22 +- .../engine-cli-edge/docker_volume_prune.yaml | 9 + _data/engine-cli-edge/docker_volume_rm.yaml | 7 + _data/engine-cli-edge/docker_wait.yaml | 2 + _data/engine-cli/docker.yaml | 2 + _data/engine-cli/docker_attach.yaml | 11 + _data/engine-cli/docker_build.yaml | 100 +++- _data/engine-cli/docker_checkpoint.yaml | 3 + .../engine-cli/docker_checkpoint_create.yaml | 9 + _data/engine-cli/docker_checkpoint_ls.yaml | 6 + _data/engine-cli/docker_checkpoint_rm.yaml | 6 + _data/engine-cli/docker_commit.yaml | 14 + _data/engine-cli/docker_config.yaml | 3 + _data/engine-cli/docker_config_create.yaml | 6 + _data/engine-cli/docker_config_inspect.yaml | 9 + _data/engine-cli/docker_config_ls.yaml | 12 + _data/engine-cli/docker_config_rm.yaml | 3 + _data/engine-cli/docker_container.yaml | 2 + _data/engine-cli/docker_container_attach.yaml | 11 + _data/engine-cli/docker_container_commit.yaml | 14 + _data/engine-cli/docker_container_cp.yaml | 8 + _data/engine-cli/docker_container_create.yaml | 295 ++++++++++- _data/engine-cli/docker_container_diff.yaml | 2 + _data/engine-cli/docker_container_exec.yaml | 24 + _data/engine-cli/docker_container_export.yaml | 5 + .../engine-cli/docker_container_inspect.yaml | 8 + _data/engine-cli/docker_container_kill.yaml | 5 + _data/engine-cli/docker_container_logs.yaml | 17 + _data/engine-cli/docker_container_ls.yaml | 26 + _data/engine-cli/docker_container_pause.yaml | 2 + _data/engine-cli/docker_container_port.yaml | 2 + _data/engine-cli/docker_container_prune.yaml | 9 + _data/engine-cli/docker_container_rename.yaml | 2 + .../engine-cli/docker_container_restart.yaml | 5 + _data/engine-cli/docker_container_rm.yaml | 11 + _data/engine-cli/docker_container_run.yaml | 304 ++++++++++- _data/engine-cli/docker_container_start.yaml | 17 + _data/engine-cli/docker_container_stats.yaml | 11 + _data/engine-cli/docker_container_stop.yaml | 5 + _data/engine-cli/docker_container_top.yaml | 2 + .../engine-cli/docker_container_unpause.yaml | 2 + _data/engine-cli/docker_container_update.yaml | 47 ++ _data/engine-cli/docker_container_wait.yaml | 2 + _data/engine-cli/docker_cp.yaml | 12 +- _data/engine-cli/docker_create.yaml | 295 ++++++++++- _data/engine-cli/docker_deploy.yaml | 21 + _data/engine-cli/docker_diff.yaml | 2 + _data/engine-cli/docker_events.yaml | 20 + _data/engine-cli/docker_exec.yaml | 24 + _data/engine-cli/docker_export.yaml | 5 + _data/engine-cli/docker_history.yaml | 14 + _data/engine-cli/docker_image.yaml | 2 + _data/engine-cli/docker_image_build.yaml | 98 ++++ _data/engine-cli/docker_image_history.yaml | 14 + _data/engine-cli/docker_image_import.yaml | 8 + _data/engine-cli/docker_image_inspect.yaml | 5 + _data/engine-cli/docker_image_load.yaml | 8 + _data/engine-cli/docker_image_ls.yaml | 20 + _data/engine-cli/docker_image_prune.yaml | 12 + _data/engine-cli/docker_image_pull.yaml | 8 + _data/engine-cli/docker_image_push.yaml | 5 + _data/engine-cli/docker_image_rm.yaml | 8 + _data/engine-cli/docker_image_save.yaml | 5 + _data/engine-cli/docker_image_tag.yaml | 2 + _data/engine-cli/docker_images.yaml | 20 + _data/engine-cli/docker_import.yaml | 8 + _data/engine-cli/docker_info.yaml | 5 + _data/engine-cli/docker_inspect.yaml | 11 + _data/engine-cli/docker_kill.yaml | 5 + _data/engine-cli/docker_load.yaml | 8 + _data/engine-cli/docker_login.yaml | 30 +- _data/engine-cli/docker_logout.yaml | 2 + _data/engine-cli/docker_logs.yaml | 17 + _data/engine-cli/docker_network.yaml | 2 + _data/engine-cli/docker_network_connect.yaml | 17 + _data/engine-cli/docker_network_create.yaml | 57 ++- .../engine-cli/docker_network_disconnect.yaml | 5 + _data/engine-cli/docker_network_inspect.yaml | 8 + _data/engine-cli/docker_network_ls.yaml | 14 + _data/engine-cli/docker_network_prune.yaml | 9 + _data/engine-cli/docker_network_rm.yaml | 2 + _data/engine-cli/docker_node.yaml | 3 + _data/engine-cli/docker_node_demote.yaml | 3 + _data/engine-cli/docker_node_inspect.yaml | 9 + _data/engine-cli/docker_node_ls.yaml | 14 +- _data/engine-cli/docker_node_promote.yaml | 3 + _data/engine-cli/docker_node_ps.yaml | 18 + _data/engine-cli/docker_node_rm.yaml | 6 + _data/engine-cli/docker_node_update.yaml | 15 + _data/engine-cli/docker_pause.yaml | 2 + _data/engine-cli/docker_plugin.yaml | 3 + _data/engine-cli/docker_plugin_create.yaml | 6 + _data/engine-cli/docker_plugin_disable.yaml | 6 + _data/engine-cli/docker_plugin_enable.yaml | 6 + _data/engine-cli/docker_plugin_inspect.yaml | 6 + _data/engine-cli/docker_plugin_install.yaml | 15 + _data/engine-cli/docker_plugin_ls.yaml | 21 +- _data/engine-cli/docker_plugin_push.yaml | 6 + _data/engine-cli/docker_plugin_rm.yaml | 6 + _data/engine-cli/docker_plugin_set.yaml | 3 + _data/engine-cli/docker_plugin_upgrade.yaml | 12 + _data/engine-cli/docker_port.yaml | 2 + _data/engine-cli/docker_ps.yaml | 51 +- _data/engine-cli/docker_pull.yaml | 8 + _data/engine-cli/docker_push.yaml | 5 + _data/engine-cli/docker_rename.yaml | 2 + _data/engine-cli/docker_restart.yaml | 5 + _data/engine-cli/docker_rm.yaml | 11 + _data/engine-cli/docker_rmi.yaml | 8 + _data/engine-cli/docker_run.yaml | 315 +++++++++++- _data/engine-cli/docker_save.yaml | 5 + _data/engine-cli/docker_search.yaml | 45 +- _data/engine-cli/docker_secret.yaml | 3 + _data/engine-cli/docker_secret_create.yaml | 6 + _data/engine-cli/docker_secret_inspect.yaml | 9 + _data/engine-cli/docker_secret_ls.yaml | 12 + _data/engine-cli/docker_secret_rm.yaml | 3 + _data/engine-cli/docker_service.yaml | 5 + _data/engine-cli/docker_service_create.yaml | 246 ++++++++- _data/engine-cli/docker_service_inspect.yaml | 9 + _data/engine-cli/docker_service_logs.yaml | 32 ++ _data/engine-cli/docker_service_ls.yaml | 12 + _data/engine-cli/docker_service_ps.yaml | 18 + _data/engine-cli/docker_service_rm.yaml | 3 + _data/engine-cli/docker_service_rollback.yaml | 78 +++ _data/engine-cli/docker_service_scale.yaml | 13 + _data/engine-cli/docker_service_update.yaml | 471 ++++++++++++++++-- _data/engine-cli/docker_stack.yaml | 3 + _data/engine-cli/docker_stack_deploy.yaml | 38 ++ _data/engine-cli/docker_stack_ls.yaml | 6 + _data/engine-cli/docker_stack_ps.yaml | 18 + _data/engine-cli/docker_stack_rm.yaml | 3 + _data/engine-cli/docker_stack_services.yaml | 12 + _data/engine-cli/docker_start.yaml | 17 + _data/engine-cli/docker_stats.yaml | 11 + _data/engine-cli/docker_stop.yaml | 5 + _data/engine-cli/docker_swarm.yaml | 3 + _data/engine-cli/docker_swarm_ca.yaml | 26 +- _data/engine-cli/docker_swarm_init.yaml | 41 ++ _data/engine-cli/docker_swarm_join-token.yaml | 9 + _data/engine-cli/docker_swarm_join.yaml | 18 + _data/engine-cli/docker_swarm_leave.yaml | 6 + _data/engine-cli/docker_swarm_unlock-key.yaml | 9 + _data/engine-cli/docker_swarm_unlock.yaml | 3 + _data/engine-cli/docker_swarm_update.yaml | 26 + _data/engine-cli/docker_system.yaml | 2 + _data/engine-cli/docker_system_df.yaml | 9 + _data/engine-cli/docker_system_events.yaml | 14 + _data/engine-cli/docker_system_info.yaml | 5 + _data/engine-cli/docker_system_prune.yaml | 16 + _data/engine-cli/docker_tag.yaml | 2 + _data/engine-cli/docker_top.yaml | 2 + _data/engine-cli/docker_unpause.yaml | 2 + _data/engine-cli/docker_update.yaml | 51 ++ _data/engine-cli/docker_version.yaml | 5 + _data/engine-cli/docker_volume.yaml | 3 + _data/engine-cli/docker_volume_create.yaml | 15 + _data/engine-cli/docker_volume_inspect.yaml | 6 + _data/engine-cli/docker_volume_ls.yaml | 12 + _data/engine-cli/docker_volume_prune.yaml | 9 + _data/engine-cli/docker_volume_rm.yaml | 7 + _data/engine-cli/docker_wait.yaml | 2 + _data/toc.yaml | 4 + .../reference/commandline/service_rollback.md | 18 + .../reference/commandline/service_rollback.md | 18 + 319 files changed, 7398 insertions(+), 211 deletions(-) create mode 100644 _data/engine-cli-edge/docker_service_rollback.yaml create mode 100644 _data/engine-cli/docker_service_rollback.yaml create mode 100644 edge/engine/reference/commandline/service_rollback.md create mode 100644 engine/reference/commandline/service_rollback.md diff --git a/_data/engine-cli-edge/docker.yaml b/_data/engine-cli-edge/docker.yaml index 0203b52077..a9a9c353ae 100644 --- a/_data/engine-cli-edge/docker.yaml +++ b/_data/engine-cli-edge/docker.yaml @@ -109,4 +109,6 @@ clink: - docker_version.yaml - docker_volume.yaml - docker_wait.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_attach.yaml b/_data/engine-cli-edge/docker_attach.yaml index 7262330f2a..7f080109db 100644 --- a/_data/engine-cli-edge/docker_attach.yaml +++ b/_data/engine-cli-edge/docker_attach.yaml @@ -65,13 +65,22 @@ pname: docker plink: docker.yaml options: - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: no-stdin + value_type: bool default_value: "false" description: Do not attach STDIN + deprecated: false + experimental: false - option: sig-proxy + value_type: bool default_value: "true" description: Proxy all received signals to the process + deprecated: false + experimental: false examples: |- ### Attach to and detach from a running container @@ -140,4 +149,6 @@ examples: |- 275c44472aeb debian:7 "/bin/bash" 26 seconds ago Exited (13) 17 seconds ago test ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_build.yaml b/_data/engine-cli-edge/docker_build.yaml index 1d670e628b..691f6a7cd4 100644 --- a/_data/engine-cli-edge/docker_build.yaml +++ b/_data/engine-cli-edge/docker_build.yaml @@ -16,7 +16,7 @@ long: |- repository acts as the build context. The system recursively fetches the repository and its submodules. The commit history is not preserved. A repository is first pulled into a temporary directory on your local host. After - the that succeeds, the directory is sent to the Docker daemon as the context. + that succeeds, the directory is sent to the Docker daemon as the context. Local copy gives you the ability to access private repositories using local user credentials, VPN's, and so forth. @@ -108,91 +108,184 @@ pname: docker plink: docker.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: build-arg + value_type: list description: Set build-time variables + deprecated: false + experimental: false - option: cache-from + value_type: stringSlice default_value: '[]' description: Images to consider as cache sources + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: compress + value_type: bool default_value: "false" description: Compress the build context using gzip + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit the CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit the CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: file shorthand: f + value_type: string description: Name of the Dockerfile (Default is 'PATH/Dockerfile') + deprecated: false + experimental: false - option: force-rm + value_type: bool default_value: "false" description: Always remove intermediate containers + deprecated: false + experimental: false - option: iidfile + value_type: string description: Write the image ID to the file + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: label + value_type: list description: Set metadata for an image + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: | Set the networking mode for the RUN instructions during build + deprecated: false + min_api_version: "1.25" + experimental: false - option: no-cache + value_type: bool default_value: "false" description: Do not use cache when building the image + deprecated: false + experimental: false - option: pull + value_type: bool default_value: "false" description: Always attempt to pull a newer version of the image + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress the build output and print image ID on success + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "true" description: Remove intermediate containers after a successful build + deprecated: false + experimental: false - option: security-opt + value_type: stringSlice default_value: '[]' description: Security options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: squash + value_type: bool default_value: "false" description: Squash newly built layers into a single new layer + deprecated: false + min_api_version: "1.25" + experimental: true - option: stream + value_type: bool default_value: "false" description: Stream attaches to server to negotiate build context + deprecated: false + min_api_version: "1.31" + experimental: true - option: tag shorthand: t + value_type: list description: Name and optionally a tag in the 'name:tag' format + deprecated: false + experimental: false - option: target + value_type: string description: Set the target build stage to build. + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: 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 @@ -358,4 +451,6 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context layer's name is ``, and there is a new layer with COMMENT `merge`.\n\nTest the image, check for `/remove_me` being gone, make sure `hello\\nworld` is in `/hello`, make sure the `HELLO` envvar's value is `world`." +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_checkpoint.yaml b/_data/engine-cli-edge/docker_checkpoint.yaml index 9dfa42eea4..b18c9850c4 100644 --- a/_data/engine-cli-edge/docker_checkpoint.yaml +++ b/_data/engine-cli-edge/docker_checkpoint.yaml @@ -12,4 +12,7 @@ clink: - docker_checkpoint_create.yaml - docker_checkpoint_ls.yaml - docker_checkpoint_rm.yaml +deprecated: false +min_api_version: "1.25" +experimental: true diff --git a/_data/engine-cli-edge/docker_checkpoint_create.yaml b/_data/engine-cli-edge/docker_checkpoint_create.yaml index fb9dad58c9..93c649d1d7 100644 --- a/_data/engine-cli-edge/docker_checkpoint_create.yaml +++ b/_data/engine-cli-edge/docker_checkpoint_create.yaml @@ -6,8 +6,17 @@ pname: docker checkpoint plink: docker_checkpoint.yaml options: - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: false - option: leave-running + value_type: bool default_value: "false" description: Leave the container running after checkpoint + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.25" +experimental: true diff --git a/_data/engine-cli-edge/docker_checkpoint_ls.yaml b/_data/engine-cli-edge/docker_checkpoint_ls.yaml index aa1108e044..84ab852d59 100644 --- a/_data/engine-cli-edge/docker_checkpoint_ls.yaml +++ b/_data/engine-cli-edge/docker_checkpoint_ls.yaml @@ -7,5 +7,11 @@ pname: docker checkpoint plink: docker_checkpoint.yaml options: - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.25" +experimental: true diff --git a/_data/engine-cli-edge/docker_checkpoint_rm.yaml b/_data/engine-cli-edge/docker_checkpoint_rm.yaml index b65e833c63..d508944a9a 100644 --- a/_data/engine-cli-edge/docker_checkpoint_rm.yaml +++ b/_data/engine-cli-edge/docker_checkpoint_rm.yaml @@ -7,5 +7,11 @@ pname: docker checkpoint plink: docker_checkpoint.yaml options: - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.25" +experimental: true diff --git a/_data/engine-cli-edge/docker_commit.yaml b/_data/engine-cli-edge/docker_commit.yaml index beab5228e8..d80b8960c3 100644 --- a/_data/engine-cli-edge/docker_commit.yaml +++ b/_data/engine-cli-edge/docker_commit.yaml @@ -24,17 +24,29 @@ plink: docker.yaml options: - option: author shorthand: a + value_type: string description: Author (e.g., "John Hannibal Smith ") + deprecated: false + experimental: false - option: change shorthand: c + value_type: list description: Apply Dockerfile instruction to the created image + deprecated: false + experimental: false - option: message shorthand: m + value_type: string description: Commit message + deprecated: false + experimental: false - option: pause shorthand: p + value_type: bool default_value: "true" description: Pause container during commit + deprecated: false + experimental: false examples: |- ### Commit a container @@ -101,4 +113,6 @@ examples: |- c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_config.yaml b/_data/engine-cli-edge/docker_config.yaml index b2d23a90a7..c82416504a 100644 --- a/_data/engine-cli-edge/docker_config.yaml +++ b/_data/engine-cli-edge/docker_config.yaml @@ -14,4 +14,7 @@ clink: - docker_config_inspect.yaml - docker_config_ls.yaml - docker_config_rm.yaml +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_config_create.yaml b/_data/engine-cli-edge/docker_config_create.yaml index f8d8ff4576..a2a60b0306 100644 --- a/_data/engine-cli-edge/docker_config_create.yaml +++ b/_data/engine-cli-edge/docker_config_create.yaml @@ -7,5 +7,11 @@ plink: docker_config.yaml options: - option: label shorthand: l + value_type: list description: Config labels + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_config_inspect.yaml b/_data/engine-cli-edge/docker_config_inspect.yaml index a441c92260..4e58db9d88 100644 --- a/_data/engine-cli-edge/docker_config_inspect.yaml +++ b/_data/engine-cli-edge/docker_config_inspect.yaml @@ -7,8 +7,17 @@ plink: docker_config.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: pretty + value_type: bool default_value: "false" description: Print the information in a human friendly format + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_config_ls.yaml b/_data/engine-cli-edge/docker_config_ls.yaml index 541c9f836c..be26eb6170 100644 --- a/_data/engine-cli-edge/docker_config_ls.yaml +++ b/_data/engine-cli-edge/docker_config_ls.yaml @@ -8,11 +8,23 @@ plink: docker_config.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print configs using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_config_rm.yaml b/_data/engine-cli-edge/docker_config_rm.yaml index 09b0193ba3..0ae5d9a061 100644 --- a/_data/engine-cli-edge/docker_config_rm.yaml +++ b/_data/engine-cli-edge/docker_config_rm.yaml @@ -5,4 +5,7 @@ long: Remove one or more configuration files usage: docker config rm CONFIG [CONFIG...] pname: docker config plink: docker_config.yaml +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_container.yaml b/_data/engine-cli-edge/docker_container.yaml index 9906350b39..ade3049138 100644 --- a/_data/engine-cli-edge/docker_container.yaml +++ b/_data/engine-cli-edge/docker_container.yaml @@ -56,4 +56,6 @@ clink: - docker_container_unpause.yaml - docker_container_update.yaml - docker_container_wait.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_attach.yaml b/_data/engine-cli-edge/docker_container_attach.yaml index 57bfb30d8a..f33db47560 100644 --- a/_data/engine-cli-edge/docker_container_attach.yaml +++ b/_data/engine-cli-edge/docker_container_attach.yaml @@ -6,11 +6,22 @@ pname: docker container plink: docker_container.yaml options: - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: no-stdin + value_type: bool default_value: "false" description: Do not attach STDIN + deprecated: false + experimental: false - option: sig-proxy + value_type: bool default_value: "true" description: Proxy all received signals to the process + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_commit.yaml b/_data/engine-cli-edge/docker_container_commit.yaml index 20eb407f47..4f331239aa 100644 --- a/_data/engine-cli-edge/docker_container_commit.yaml +++ b/_data/engine-cli-edge/docker_container_commit.yaml @@ -7,15 +7,29 @@ plink: docker_container.yaml options: - option: author shorthand: a + value_type: string description: Author (e.g., "John Hannibal Smith ") + deprecated: false + experimental: false - option: change shorthand: c + value_type: list description: Apply Dockerfile instruction to the created image + deprecated: false + experimental: false - option: message shorthand: m + value_type: string description: Commit message + deprecated: false + experimental: false - option: pause shorthand: p + value_type: bool default_value: "true" description: Pause container during commit + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_cp.yaml b/_data/engine-cli-edge/docker_container_cp.yaml index 0f00d09eec..66fd1f7412 100644 --- a/_data/engine-cli-edge/docker_container_cp.yaml +++ b/_data/engine-cli-edge/docker_container_cp.yaml @@ -14,10 +14,18 @@ plink: docker_container.yaml options: - option: archive shorthand: a + value_type: bool default_value: "false" description: Archive mode (copy all uid/gid information) + deprecated: false + experimental: false - option: follow-link shorthand: L + value_type: bool default_value: "false" description: Always follow symbol link in SRC_PATH + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_create.yaml b/_data/engine-cli-edge/docker_container_create.yaml index 108c51a863..e58bc7b13e 100644 --- a/_data/engine-cli-edge/docker_container_create.yaml +++ b/_data/engine-cli-edge/docker_container_create.yaml @@ -6,257 +6,550 @@ pname: docker container plink: docker_container.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: attach shorthand: a + value_type: list description: Attach to STDIN, STDOUT or STDERR + deprecated: false + experimental: false - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: blkio-weight-device + value_type: list default_value: '[]' description: Block IO weight (relative device weight) + deprecated: false + experimental: false - option: cap-add + value_type: list description: Add Linux capabilities + deprecated: false + experimental: false - option: cap-drop + value_type: list description: Drop Linux capabilities + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: cidfile + value_type: string description: Write the container ID to the file + deprecated: false + experimental: false - option: cpu-count + value_type: int64 default_value: "0" description: CPU count (Windows only) + deprecated: false + experimental: false - option: cpu-percent + value_type: int64 default_value: "0" description: CPU percent (Windows only) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: device + value_type: list description: Add a host device to the container + deprecated: false + experimental: false - option: device-cgroup-rule + value_type: list description: Add a rule to the cgroup allowed devices list + deprecated: false + experimental: false - option: device-read-bps + value_type: list default_value: '[]' description: Limit read rate (bytes per second) from a device + deprecated: false + experimental: false - option: device-read-iops + value_type: list default_value: '[]' description: Limit read rate (IO per second) from a device + deprecated: false + experimental: false - option: device-write-bps + value_type: list default_value: '[]' description: Limit write rate (bytes per second) to a device + deprecated: false + experimental: false - option: device-write-iops + value_type: list default_value: '[]' description: Limit write rate (IO per second) to a device + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: dns + value_type: list description: Set custom DNS servers + deprecated: false + experimental: false - option: dns-opt + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-option + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-search + value_type: list description: Set custom DNS search domains + deprecated: false + experimental: false - option: entrypoint + value_type: string description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + experimental: false - option: env-file + value_type: list description: Read in a file of environment variables + deprecated: false + experimental: false - option: expose + value_type: list description: Expose a port or a range of ports + deprecated: false + experimental: false - option: group-add + value_type: list description: Add additional groups to join + deprecated: false + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + experimental: false - option: health-start-period + value_type: duration default_value: 0s description: | Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) + deprecated: false + min_api_version: "1.29" + experimental: false - option: health-timeout + value_type: duration default_value: 0s description: | Maximum time to allow one check to run (ms|s|m|h) (default 0s) + deprecated: false + experimental: false - option: help + value_type: bool default_value: "false" description: Print usage + deprecated: false + experimental: false - option: hostname shorthand: h + value_type: string description: Container host name + deprecated: false + experimental: false - option: init + value_type: bool default_value: "false" description: | Run an init inside the container that forwards signals and reaps processes + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: io-maxbandwidth + value_type: bytes default_value: "0" description: | Maximum IO bandwidth limit for the system drive (Windows only) + deprecated: false + experimental: false - option: io-maxiops + value_type: uint64 default_value: "0" description: Maximum IOps limit for the system drive (Windows only) + deprecated: false + experimental: false - option: ip + value_type: string description: IPv4 address (e.g., 172.30.100.104) + deprecated: false + experimental: false - option: ip6 + value_type: string description: IPv6 address (e.g., 2001:db8::33) + deprecated: false + experimental: false - option: ipc - description: IPC namespace to use + value_type: string + description: IPC mode to use + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: label shorthand: l + value_type: list description: Set meta data on a container + deprecated: false + experimental: false - option: label-file + value_type: list description: Read in a line delimited file of labels + deprecated: false + experimental: false - option: link + value_type: list description: Add link to another container + deprecated: false + experimental: false - option: link-local-ip + value_type: list description: Container IPv4/IPv6 link-local addresses + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for the container + deprecated: false + experimental: false - option: log-opt + value_type: list description: Log driver options + deprecated: false + experimental: false - option: mac-address + value_type: string description: Container MAC address (e.g., 92:d0:c6:0a:29:33) + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: memory-swappiness + value_type: int64 default_value: "-1" description: Tune container memory swappiness (0 to 100) + deprecated: false + experimental: false - option: mount + value_type: mount description: Attach a filesystem mount to the container + deprecated: false + experimental: false - option: name + value_type: string description: Assign a name to the container + deprecated: false + experimental: false - option: net + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: net-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: network-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + experimental: false - option: oom-kill-disable + value_type: bool default_value: "false" description: Disable OOM Killer + deprecated: false + experimental: false - option: oom-score-adj + value_type: int default_value: "0" description: Tune host's OOM preferences (-1000 to 1000) + deprecated: false + experimental: false - option: pid + value_type: string description: PID namespace to use + deprecated: false + experimental: false - option: pids-limit + value_type: int64 default_value: "0" description: Tune container pids limit (set -1 for unlimited) + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to this container + deprecated: false + experimental: false - option: publish shorthand: p + value_type: list description: Publish a container's port(s) to the host + deprecated: false + experimental: false - option: publish-all shorthand: P + value_type: bool default_value: "false" description: Publish all exposed ports to random ports + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + experimental: false - option: restart + value_type: string default_value: "no" description: Restart policy to apply when a container exits + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "false" description: Automatically remove the container when it exits + deprecated: false + experimental: false - option: runtime + value_type: string description: Runtime to use for this container + deprecated: false + experimental: false - option: security-opt + value_type: list description: Security Options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: stop-signal + value_type: string default_value: SIGTERM description: Signal to stop a container + deprecated: false + experimental: false - option: stop-timeout + value_type: int default_value: "0" description: Timeout (in seconds) to stop a container + deprecated: false + min_api_version: "1.25" + experimental: false - option: storage-opt + value_type: list description: Storage driver options for the container + deprecated: false + experimental: false - option: sysctl + value_type: map default_value: map[] description: Sysctl options + deprecated: false + experimental: false - option: tmpfs + value_type: list description: Mount a tmpfs directory + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: userns + value_type: string description: User namespace to use + deprecated: false + experimental: false - option: uts + value_type: string description: UTS namespace to use + deprecated: false + experimental: false - option: volume shorthand: v + value_type: list description: Bind mount a volume + deprecated: false + experimental: false - option: volume-driver + value_type: string description: Optional volume driver for the container + deprecated: false + experimental: false - option: volumes-from + value_type: list description: Mount volumes from the specified container(s) + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_diff.yaml b/_data/engine-cli-edge/docker_container_diff.yaml index 425e2321ef..6fef75b7c4 100644 --- a/_data/engine-cli-edge/docker_container_diff.yaml +++ b/_data/engine-cli-edge/docker_container_diff.yaml @@ -4,4 +4,6 @@ long: Inspect changes to files or directories on a container's filesystem usage: docker container diff CONTAINER pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_exec.yaml b/_data/engine-cli-edge/docker_container_exec.yaml index 8d74e2738c..fe128ec007 100644 --- a/_data/engine-cli-edge/docker_container_exec.yaml +++ b/_data/engine-cli-edge/docker_container_exec.yaml @@ -7,25 +7,49 @@ plink: docker_container.yaml options: - option: detach shorthand: d + value_type: bool default_value: "false" description: 'Detached mode: run command in the background' + deprecated: false + experimental: false - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to the command + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_export.yaml b/_data/engine-cli-edge/docker_container_export.yaml index 64ed34da1a..21854dc5a0 100644 --- a/_data/engine-cli-edge/docker_container_export.yaml +++ b/_data/engine-cli-edge/docker_container_export.yaml @@ -7,5 +7,10 @@ plink: docker_container.yaml options: - option: output shorthand: o + value_type: string description: Write to a file, instead of STDOUT + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_inspect.yaml b/_data/engine-cli-edge/docker_container_inspect.yaml index 5a90b6ee5b..1ee186a1b8 100644 --- a/_data/engine-cli-edge/docker_container_inspect.yaml +++ b/_data/engine-cli-edge/docker_container_inspect.yaml @@ -7,9 +7,17 @@ plink: docker_container.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: size shorthand: s + value_type: bool default_value: "false" description: Display total file sizes + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_kill.yaml b/_data/engine-cli-edge/docker_container_kill.yaml index 01d3d699fb..d42f831e6f 100644 --- a/_data/engine-cli-edge/docker_container_kill.yaml +++ b/_data/engine-cli-edge/docker_container_kill.yaml @@ -7,6 +7,11 @@ plink: docker_container.yaml options: - option: signal shorthand: s + value_type: string default_value: KILL description: Signal to send to the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_logs.yaml b/_data/engine-cli-edge/docker_container_logs.yaml index 456295e7c6..68d4b2d9a4 100644 --- a/_data/engine-cli-edge/docker_container_logs.yaml +++ b/_data/engine-cli-edge/docker_container_logs.yaml @@ -6,20 +6,37 @@ pname: docker container plink: docker_container.yaml options: - option: details + value_type: bool default_value: "false" description: Show extra details provided to logs + deprecated: false + experimental: false - option: follow shorthand: f + value_type: bool default_value: "false" description: Follow log output + deprecated: false + experimental: 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 - option: tail + value_type: string default_value: all description: Number of lines to show from the end of the logs + deprecated: false + experimental: false - option: timestamps shorthand: t + value_type: bool default_value: "false" description: Show timestamps + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_ls.yaml b/_data/engine-cli-edge/docker_container_ls.yaml index 02afb6b983..17bd25cf17 100644 --- a/_data/engine-cli-edge/docker_container_ls.yaml +++ b/_data/engine-cli-edge/docker_container_ls.yaml @@ -8,30 +8,56 @@ plink: docker_container.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all containers (default shows just running) + deprecated: false + experimental: false - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print containers using a Go template + deprecated: false + experimental: false - option: last shorthand: "n" + value_type: int default_value: "-1" description: Show n last created containers (includes all states) + deprecated: false + experimental: false - option: latest shorthand: l + value_type: bool default_value: "false" description: Show the latest created container (includes all states) + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display numeric IDs + deprecated: false + experimental: false - option: size shorthand: s + value_type: bool default_value: "false" description: Display total file sizes + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_pause.yaml b/_data/engine-cli-edge/docker_container_pause.yaml index 731aa812eb..64e8b1b862 100644 --- a/_data/engine-cli-edge/docker_container_pause.yaml +++ b/_data/engine-cli-edge/docker_container_pause.yaml @@ -4,4 +4,6 @@ long: Pause all processes within one or more containers usage: docker container pause CONTAINER [CONTAINER...] pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_port.yaml b/_data/engine-cli-edge/docker_container_port.yaml index fa70cdd164..efb47b0d3c 100644 --- a/_data/engine-cli-edge/docker_container_port.yaml +++ b/_data/engine-cli-edge/docker_container_port.yaml @@ -4,4 +4,6 @@ long: List port mappings or a specific mapping for the container usage: docker container port CONTAINER [PRIVATE_PORT[/PROTO]] pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_prune.yaml b/_data/engine-cli-edge/docker_container_prune.yaml index 5185350289..c81dd8cee6 100644 --- a/_data/engine-cli-edge/docker_container_prune.yaml +++ b/_data/engine-cli-edge/docker_container_prune.yaml @@ -6,11 +6,17 @@ pname: docker container plink: docker_container.yaml options: - option: filter + value_type: filter description: Provide filter values (e.g. 'until=') + deprecated: false + experimental: false - option: force shorthand: f + value_type: bool default_value: "false" description: Do not prompt for confirmation + deprecated: false + experimental: false examples: |- ### Prune containers @@ -95,4 +101,7 @@ examples: |- CONTAINER ID IMAGE COMMAND CREATED AT STATUS 53a9bc23a516 busybox "sh" 2017-01-04 13:11:59 -0800 PST Exited (0) 9 minutes ago ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_container_rename.yaml b/_data/engine-cli-edge/docker_container_rename.yaml index 44d38a7ef3..e67cd654cc 100644 --- a/_data/engine-cli-edge/docker_container_rename.yaml +++ b/_data/engine-cli-edge/docker_container_rename.yaml @@ -4,4 +4,6 @@ long: Rename a container usage: docker container rename CONTAINER NEW_NAME pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_restart.yaml b/_data/engine-cli-edge/docker_container_restart.yaml index c6113f330a..6602a718f1 100644 --- a/_data/engine-cli-edge/docker_container_restart.yaml +++ b/_data/engine-cli-edge/docker_container_restart.yaml @@ -7,6 +7,11 @@ plink: docker_container.yaml options: - option: time shorthand: t + value_type: int default_value: "10" description: Seconds to wait for stop before killing the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_rm.yaml b/_data/engine-cli-edge/docker_container_rm.yaml index 153455c4de..182b961a9a 100644 --- a/_data/engine-cli-edge/docker_container_rm.yaml +++ b/_data/engine-cli-edge/docker_container_rm.yaml @@ -7,14 +7,25 @@ plink: docker_container.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force the removal of a running container (uses SIGKILL) + deprecated: false + experimental: false - option: link shorthand: l + value_type: bool default_value: "false" description: Remove the specified link + deprecated: false + experimental: false - option: volumes shorthand: v + value_type: bool default_value: "false" description: Remove the volumes associated with the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_run.yaml b/_data/engine-cli-edge/docker_container_run.yaml index 3afcc0d5b9..c49190416f 100644 --- a/_data/engine-cli-edge/docker_container_run.yaml +++ b/_data/engine-cli-edge/docker_container_run.yaml @@ -6,266 +6,568 @@ pname: docker container plink: docker_container.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: attach shorthand: a + value_type: list description: Attach to STDIN, STDOUT or STDERR + deprecated: false + experimental: false - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: blkio-weight-device + value_type: list default_value: '[]' description: Block IO weight (relative device weight) + deprecated: false + experimental: false - option: cap-add + value_type: list description: Add Linux capabilities + deprecated: false + experimental: false - option: cap-drop + value_type: list description: Drop Linux capabilities + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: cidfile + value_type: string description: Write the container ID to the file + deprecated: false + experimental: false - option: cpu-count + value_type: int64 default_value: "0" description: CPU count (Windows only) + deprecated: false + experimental: false - option: cpu-percent + value_type: int64 default_value: "0" description: CPU percent (Windows only) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: detach shorthand: d + value_type: bool default_value: "false" description: Run container in background and print container ID + deprecated: false + experimental: false - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: device + value_type: list description: Add a host device to the container + deprecated: false + experimental: false - option: device-cgroup-rule + value_type: list description: Add a rule to the cgroup allowed devices list + deprecated: false + experimental: false - option: device-read-bps + value_type: list default_value: '[]' description: Limit read rate (bytes per second) from a device + deprecated: false + experimental: false - option: device-read-iops + value_type: list default_value: '[]' description: Limit read rate (IO per second) from a device + deprecated: false + experimental: false - option: device-write-bps + value_type: list default_value: '[]' description: Limit write rate (bytes per second) to a device + deprecated: false + experimental: false - option: device-write-iops + value_type: list default_value: '[]' description: Limit write rate (IO per second) to a device + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: dns + value_type: list description: Set custom DNS servers + deprecated: false + experimental: false - option: dns-opt + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-option + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-search + value_type: list description: Set custom DNS search domains + deprecated: false + experimental: false - option: entrypoint + value_type: string description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + experimental: false - option: env-file + value_type: list description: Read in a file of environment variables + deprecated: false + experimental: false - option: expose + value_type: list description: Expose a port or a range of ports + deprecated: false + experimental: false - option: group-add + value_type: list description: Add additional groups to join + deprecated: false + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + experimental: false - option: health-start-period + value_type: duration default_value: 0s description: | Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) + deprecated: false + min_api_version: "1.29" + experimental: false - option: health-timeout + value_type: duration default_value: 0s description: | Maximum time to allow one check to run (ms|s|m|h) (default 0s) + deprecated: false + experimental: false - option: help + value_type: bool default_value: "false" description: Print usage + deprecated: false + experimental: false - option: hostname shorthand: h + value_type: string description: Container host name + deprecated: false + experimental: false - option: init + value_type: bool default_value: "false" description: | Run an init inside the container that forwards signals and reaps processes + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: io-maxbandwidth + value_type: bytes default_value: "0" description: | Maximum IO bandwidth limit for the system drive (Windows only) + deprecated: false + experimental: false - option: io-maxiops + value_type: uint64 default_value: "0" description: Maximum IOps limit for the system drive (Windows only) + deprecated: false + experimental: false - option: ip + value_type: string description: IPv4 address (e.g., 172.30.100.104) + deprecated: false + experimental: false - option: ip6 + value_type: string description: IPv6 address (e.g., 2001:db8::33) + deprecated: false + experimental: false - option: ipc - description: IPC namespace to use + value_type: string + description: IPC mode to use + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: label shorthand: l + value_type: list description: Set meta data on a container + deprecated: false + experimental: false - option: label-file + value_type: list description: Read in a line delimited file of labels + deprecated: false + experimental: false - option: link + value_type: list description: Add link to another container + deprecated: false + experimental: false - option: link-local-ip + value_type: list description: Container IPv4/IPv6 link-local addresses + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for the container + deprecated: false + experimental: false - option: log-opt + value_type: list description: Log driver options + deprecated: false + experimental: false - option: mac-address + value_type: string description: Container MAC address (e.g., 92:d0:c6:0a:29:33) + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: memory-swappiness + value_type: int64 default_value: "-1" description: Tune container memory swappiness (0 to 100) + deprecated: false + experimental: false - option: mount + value_type: mount description: Attach a filesystem mount to the container + deprecated: false + experimental: false - option: name + value_type: string description: Assign a name to the container + deprecated: false + experimental: false - option: net + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: net-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: network-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + experimental: false - option: oom-kill-disable + value_type: bool default_value: "false" description: Disable OOM Killer + deprecated: false + experimental: false - option: oom-score-adj + value_type: int default_value: "0" description: Tune host's OOM preferences (-1000 to 1000) + deprecated: false + experimental: false - option: pid + value_type: string description: PID namespace to use + deprecated: false + experimental: false - option: pids-limit + value_type: int64 default_value: "0" description: Tune container pids limit (set -1 for unlimited) + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to this container + deprecated: false + experimental: false - option: publish shorthand: p + value_type: list description: Publish a container's port(s) to the host + deprecated: false + experimental: false - option: publish-all shorthand: P + value_type: bool default_value: "false" description: Publish all exposed ports to random ports + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + experimental: false - option: restart + value_type: string default_value: "no" description: Restart policy to apply when a container exits + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "false" description: Automatically remove the container when it exits + deprecated: false + experimental: false - option: runtime + value_type: string description: Runtime to use for this container + deprecated: false + experimental: false - option: security-opt + value_type: list description: Security Options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: sig-proxy + value_type: bool default_value: "true" description: Proxy received signals to the process + deprecated: false + experimental: false - option: stop-signal + value_type: string default_value: SIGTERM description: Signal to stop a container + deprecated: false + experimental: false - option: stop-timeout + value_type: int default_value: "0" description: Timeout (in seconds) to stop a container + deprecated: false + min_api_version: "1.25" + experimental: false - option: storage-opt + value_type: list description: Storage driver options for the container + deprecated: false + experimental: false - option: sysctl + value_type: map default_value: map[] description: Sysctl options + deprecated: false + experimental: false - option: tmpfs + value_type: list description: Mount a tmpfs directory + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: userns + value_type: string description: User namespace to use + deprecated: false + experimental: false - option: uts + value_type: string description: UTS namespace to use + deprecated: false + experimental: false - option: volume shorthand: v + value_type: list description: Bind mount a volume + deprecated: false + experimental: false - option: volume-driver + value_type: string description: Optional volume driver for the container + deprecated: false + experimental: false - option: volumes-from + value_type: list description: Mount volumes from the specified container(s) + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_start.yaml b/_data/engine-cli-edge/docker_container_start.yaml index 2fc04a0978..4e8d117dee 100644 --- a/_data/engine-cli-edge/docker_container_start.yaml +++ b/_data/engine-cli-edge/docker_container_start.yaml @@ -7,16 +7,33 @@ plink: docker_container.yaml options: - option: attach shorthand: a + value_type: bool default_value: "false" description: Attach STDOUT/STDERR and forward signals + deprecated: false + experimental: false - option: checkpoint + value_type: string description: Restore from this checkpoint + deprecated: false + experimental: true - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: true - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Attach container's STDIN + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_stats.yaml b/_data/engine-cli-edge/docker_container_stats.yaml index 0599ed97d0..89b4f1f170 100644 --- a/_data/engine-cli-edge/docker_container_stats.yaml +++ b/_data/engine-cli-edge/docker_container_stats.yaml @@ -7,11 +7,22 @@ plink: docker_container.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all containers (default shows just running) + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: no-stream + value_type: bool default_value: "false" description: Disable streaming stats and only pull the first result + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_stop.yaml b/_data/engine-cli-edge/docker_container_stop.yaml index ab7aaf96db..96e86648b6 100644 --- a/_data/engine-cli-edge/docker_container_stop.yaml +++ b/_data/engine-cli-edge/docker_container_stop.yaml @@ -7,6 +7,11 @@ plink: docker_container.yaml options: - option: time shorthand: t + value_type: int default_value: "10" description: Seconds to wait for stop before killing it + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_top.yaml b/_data/engine-cli-edge/docker_container_top.yaml index 1611ccdd44..e24f0a4eaa 100644 --- a/_data/engine-cli-edge/docker_container_top.yaml +++ b/_data/engine-cli-edge/docker_container_top.yaml @@ -4,4 +4,6 @@ long: Display the running processes of a container usage: docker container top CONTAINER [ps OPTIONS] pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_unpause.yaml b/_data/engine-cli-edge/docker_container_unpause.yaml index 62ca83c7aa..c6800c6950 100644 --- a/_data/engine-cli-edge/docker_container_unpause.yaml +++ b/_data/engine-cli-edge/docker_container_unpause.yaml @@ -4,4 +4,6 @@ long: Unpause all processes within one or more containers usage: docker container unpause CONTAINER [CONTAINER...] pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_update.yaml b/_data/engine-cli-edge/docker_container_update.yaml index 1c7137cd96..19f4787568 100644 --- a/_data/engine-cli-edge/docker_container_update.yaml +++ b/_data/engine-cli-edge/docker_container_update.yaml @@ -6,45 +6,92 @@ pname: docker container plink: docker_container.yaml options: - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit the CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit the CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.29" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: restart + value_type: string description: Restart policy to apply when a container exits + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_container_wait.yaml b/_data/engine-cli-edge/docker_container_wait.yaml index 3f5e051103..0e33f3509a 100644 --- a/_data/engine-cli-edge/docker_container_wait.yaml +++ b/_data/engine-cli-edge/docker_container_wait.yaml @@ -4,4 +4,6 @@ long: Block until one or more containers stop, then print their exit codes usage: docker container wait CONTAINER [CONTAINER...] pname: docker container plink: docker_container.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_cp.yaml b/_data/engine-cli-edge/docker_cp.yaml index 839416c24e..8a1bfe0ff9 100644 --- a/_data/engine-cli-edge/docker_cp.yaml +++ b/_data/engine-cli-edge/docker_cp.yaml @@ -21,7 +21,9 @@ long: |- the user and primary group at the destination. For example, files copied to a container are created with `UID:GID` of the root user. Files copied to the local machine are created with the `UID:GID` of the user which invoked the `docker cp` - command. If you specify the `-L` option, `docker cp` follows any symbolic link + command. However, if you specify the `-a` option, `docker cp` sets the ownership + to the user and primary group at the source. + If you specify the `-L` option, `docker cp` follows any symbolic link in the `SRC_PATH`. `docker cp` does *not* create parent directories for `DEST_PATH` if they do not exist. @@ -70,11 +72,11 @@ long: |- in different ways (consider `SRC_PATH` and `DEST_PATH` are directories): ```bash - $ docker exec foo tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | tar Cxf DEST_PATH - + $ docker exec CONTAINER tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | tar Cxf DEST_PATH - ``` ```bash - $ tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | docker exec -i foo tar Cxf DEST_PATH - + $ tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | docker exec -i CONTAINER tar Cxf DEST_PATH - ``` Using `-` as the `SRC_PATH` streams the contents of `STDIN` as a tar archive. @@ -88,10 +90,18 @@ plink: docker.yaml options: - option: archive shorthand: a + value_type: bool default_value: "false" description: Archive mode (copy all uid/gid information) + deprecated: false + experimental: false - option: follow-link shorthand: L + value_type: bool default_value: "false" description: Always follow symbol link in SRC_PATH + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_create.yaml b/_data/engine-cli-edge/docker_create.yaml index 8529e8ff2a..07f1c75830 100644 --- a/_data/engine-cli-edge/docker_create.yaml +++ b/_data/engine-cli-edge/docker_create.yaml @@ -17,259 +17,550 @@ pname: docker plink: docker.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: attach shorthand: a + value_type: list description: Attach to STDIN, STDOUT or STDERR + deprecated: false + experimental: false - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: blkio-weight-device + value_type: list default_value: '[]' description: Block IO weight (relative device weight) + deprecated: false + experimental: false - option: cap-add + value_type: list description: Add Linux capabilities + deprecated: false + experimental: false - option: cap-drop + value_type: list description: Drop Linux capabilities + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: cidfile + value_type: string description: Write the container ID to the file + deprecated: false + experimental: false - option: cpu-count + value_type: int64 default_value: "0" description: CPU count (Windows only) + deprecated: false + experimental: false - option: cpu-percent + value_type: int64 default_value: "0" description: CPU percent (Windows only) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: device + value_type: list description: Add a host device to the container + deprecated: false + experimental: false - option: device-cgroup-rule + value_type: list description: Add a rule to the cgroup allowed devices list + deprecated: false + experimental: false - option: device-read-bps + value_type: list default_value: '[]' description: Limit read rate (bytes per second) from a device + deprecated: false + experimental: false - option: device-read-iops + value_type: list default_value: '[]' description: Limit read rate (IO per second) from a device + deprecated: false + experimental: false - option: device-write-bps + value_type: list default_value: '[]' description: Limit write rate (bytes per second) to a device + deprecated: false + experimental: false - option: device-write-iops + value_type: list default_value: '[]' description: Limit write rate (IO per second) to a device + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: dns + value_type: list description: Set custom DNS servers + deprecated: false + experimental: false - option: dns-opt + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-option + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-search + value_type: list description: Set custom DNS search domains + deprecated: false + experimental: false - option: entrypoint + value_type: string description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + experimental: false - option: env-file + value_type: list description: Read in a file of environment variables + deprecated: false + experimental: false - option: expose + value_type: list description: Expose a port or a range of ports + deprecated: false + experimental: false - option: group-add + value_type: list description: Add additional groups to join + deprecated: false + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + experimental: false - option: health-start-period + value_type: duration default_value: 0s description: | Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) + deprecated: false + min_api_version: "1.29" + experimental: false - option: health-timeout + value_type: duration default_value: 0s description: | Maximum time to allow one check to run (ms|s|m|h) (default 0s) + deprecated: false + experimental: false - option: help + value_type: bool default_value: "false" description: Print usage + deprecated: false + experimental: false - option: hostname shorthand: h + value_type: string description: Container host name + deprecated: false + experimental: false - option: init + value_type: bool default_value: "false" description: | Run an init inside the container that forwards signals and reaps processes + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: io-maxbandwidth + value_type: bytes default_value: "0" description: | Maximum IO bandwidth limit for the system drive (Windows only) + deprecated: false + experimental: false - option: io-maxiops + value_type: uint64 default_value: "0" description: Maximum IOps limit for the system drive (Windows only) + deprecated: false + experimental: false - option: ip + value_type: string description: IPv4 address (e.g., 172.30.100.104) + deprecated: false + experimental: false - option: ip6 + value_type: string description: IPv6 address (e.g., 2001:db8::33) + deprecated: false + experimental: false - option: ipc - description: IPC namespace to use + value_type: string + description: IPC mode to use + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: label shorthand: l + value_type: list description: Set meta data on a container + deprecated: false + experimental: false - option: label-file + value_type: list description: Read in a line delimited file of labels + deprecated: false + experimental: false - option: link + value_type: list description: Add link to another container + deprecated: false + experimental: false - option: link-local-ip + value_type: list description: Container IPv4/IPv6 link-local addresses + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for the container + deprecated: false + experimental: false - option: log-opt + value_type: list description: Log driver options + deprecated: false + experimental: false - option: mac-address + value_type: string description: Container MAC address (e.g., 92:d0:c6:0a:29:33) + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: memory-swappiness + value_type: int64 default_value: "-1" description: Tune container memory swappiness (0 to 100) + deprecated: false + experimental: false - option: mount + value_type: mount description: Attach a filesystem mount to the container + deprecated: false + experimental: false - option: name + value_type: string description: Assign a name to the container + deprecated: false + experimental: false - option: net + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: net-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: network-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + experimental: false - option: oom-kill-disable + value_type: bool default_value: "false" description: Disable OOM Killer + deprecated: false + experimental: false - option: oom-score-adj + value_type: int default_value: "0" description: Tune host's OOM preferences (-1000 to 1000) + deprecated: false + experimental: false - option: pid + value_type: string description: PID namespace to use + deprecated: false + experimental: false - option: pids-limit + value_type: int64 default_value: "0" description: Tune container pids limit (set -1 for unlimited) + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to this container + deprecated: false + experimental: false - option: publish shorthand: p + value_type: list description: Publish a container's port(s) to the host + deprecated: false + experimental: false - option: publish-all shorthand: P + value_type: bool default_value: "false" description: Publish all exposed ports to random ports + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + experimental: false - option: restart + value_type: string default_value: "no" description: Restart policy to apply when a container exits + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "false" description: Automatically remove the container when it exits + deprecated: false + experimental: false - option: runtime + value_type: string description: Runtime to use for this container + deprecated: false + experimental: false - option: security-opt + value_type: list description: Security Options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: stop-signal + value_type: string default_value: SIGTERM description: Signal to stop a container + deprecated: false + experimental: false - option: stop-timeout + value_type: int default_value: "0" description: Timeout (in seconds) to stop a container + deprecated: false + min_api_version: "1.25" + experimental: false - option: storage-opt + value_type: list description: Storage driver options for the container + deprecated: false + experimental: false - option: sysctl + value_type: map default_value: map[] description: Sysctl options + deprecated: false + experimental: false - option: tmpfs + value_type: list description: Mount a tmpfs directory + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: userns + value_type: string description: User namespace to use + deprecated: false + experimental: false - option: uts + value_type: string description: UTS namespace to use + deprecated: false + experimental: false - option: volume shorthand: v + value_type: list description: Bind mount a volume + deprecated: false + experimental: false - option: volume-driver + value_type: string description: Optional volume driver for the container + deprecated: false + experimental: false - option: volumes-from + value_type: list description: Mount volumes from the specified container(s) + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container + deprecated: false + experimental: false examples: |- ### Create and start a container @@ -378,4 +669,6 @@ examples: |- NOTE: initially present devices still need to be explicitely added to the create/run command +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_deploy.yaml b/_data/engine-cli-edge/docker_deploy.yaml index d5b75cc979..a55dc1c006 100644 --- a/_data/engine-cli-edge/docker_deploy.yaml +++ b/_data/engine-cli-edge/docker_deploy.yaml @@ -8,20 +8,38 @@ pname: docker plink: docker.yaml options: - option: bundle-file + value_type: string description: Path to a Distributed Application Bundle file + deprecated: false + experimental: true - option: compose-file shorthand: c + value_type: string description: Path to a Compose file + deprecated: false + min_api_version: "1.25" + experimental: false - option: prune + value_type: bool default_value: "false" description: Prune services that are no longer referenced + deprecated: false + min_api_version: "1.27" + experimental: false - option: resolve-image + value_type: string default_value: always description: | Query the registry to resolve image digest and supported platforms ("always"|"changed"|"never") + deprecated: false + min_api_version: "1.30" + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to Swarm agents + deprecated: false + experimental: false examples: |- ### Compose file @@ -83,4 +101,7 @@ examples: |- 9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba ``` +deprecated: false +min_api_version: "1.25" +experimental: true diff --git a/_data/engine-cli-edge/docker_diff.yaml b/_data/engine-cli-edge/docker_diff.yaml index d0b9b7a2af..acc47cca62 100644 --- a/_data/engine-cli-edge/docker_diff.yaml +++ b/_data/engine-cli-edge/docker_diff.yaml @@ -41,4 +41,6 @@ examples: |- A /var/log/nginx/access.log A /var/log/nginx/error.log ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_events.yaml b/_data/engine-cli-edge/docker_events.yaml index 819e19964e..b6dda97e95 100644 --- a/_data/engine-cli-edge/docker_events.yaml +++ b/_data/engine-cli-edge/docker_events.yaml @@ -172,13 +172,25 @@ plink: docker.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: since + value_type: string description: Show all events created since timestamp + deprecated: false + experimental: false - option: until + value_type: string description: Stream events until this timestamp + deprecated: false + experimental: false examples: |- ### Basic example @@ -257,6 +269,12 @@ examples: |- 2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) 2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) 2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) + + $ docker events --since '2017-01-05T00:35:30' --until '2017-01-05T00:36:05' + 2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local) + 2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test) + 2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge) + 2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) ``` ### Filter events by criteria @@ -382,4 +400,6 @@ examples: |- {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_exec.yaml b/_data/engine-cli-edge/docker_exec.yaml index 88782ad7e9..451fe05a2b 100644 --- a/_data/engine-cli-edge/docker_exec.yaml +++ b/_data/engine-cli-edge/docker_exec.yaml @@ -20,27 +20,49 @@ plink: docker.yaml options: - option: detach shorthand: d + value_type: bool default_value: "false" description: 'Detached mode: run command in the background' + deprecated: false + experimental: false - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to the command + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: 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 @@ -60,4 +82,6 @@ examples: "### Run `docker exec` on a running container\n\nFirst, start a contai (Paused) test\n\n$ docker exec test ls\n\nFATA[0000] Error response from daemon: Container test is paused, unpause the container before exec\n\n$ echo $?\n1\n```" +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_export.yaml b/_data/engine-cli-edge/docker_export.yaml index ea2b3c0177..89c64f8e6f 100644 --- a/_data/engine-cli-edge/docker_export.yaml +++ b/_data/engine-cli-edge/docker_export.yaml @@ -14,7 +14,10 @@ plink: docker.yaml options: - option: output shorthand: o + value_type: string description: Write to a file, instead of STDOUT + deprecated: false + experimental: false examples: |- ch of these commands has the same result. @@ -25,4 +28,6 @@ examples: |- ```bash $ docker export --output="latest.tar" red_panda ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_history.yaml b/_data/engine-cli-edge/docker_history.yaml index e3ed71efb7..d9e95faf2f 100644 --- a/_data/engine-cli-edge/docker_history.yaml +++ b/_data/engine-cli-edge/docker_history.yaml @@ -6,18 +6,30 @@ pname: docker plink: docker.yaml options: - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: human shorthand: H + value_type: bool default_value: "true" description: Print sizes and dates in human readable format + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only show numeric IDs + deprecated: false + experimental: false examples: |- To see how the `docker:latest` image was built: @@ -79,4 +91,6 @@ examples: |- : 3 weeks ago : 3 weeks ago ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image.yaml b/_data/engine-cli-edge/docker_image.yaml index 29fa42091e..ef8a1a107c 100644 --- a/_data/engine-cli-edge/docker_image.yaml +++ b/_data/engine-cli-edge/docker_image.yaml @@ -30,4 +30,6 @@ clink: - docker_image_rm.yaml - docker_image_save.yaml - docker_image_tag.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_build.yaml b/_data/engine-cli-edge/docker_image_build.yaml index 3e98a83c64..52d2f12335 100644 --- a/_data/engine-cli-edge/docker_image_build.yaml +++ b/_data/engine-cli-edge/docker_image_build.yaml @@ -6,89 +6,184 @@ pname: docker image plink: docker_image.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: build-arg + value_type: list description: Set build-time variables + deprecated: false + experimental: false - option: cache-from + value_type: stringSlice default_value: '[]' description: Images to consider as cache sources + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: compress + value_type: bool default_value: "false" description: Compress the build context using gzip + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit the CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit the CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: file shorthand: f + value_type: string description: Name of the Dockerfile (Default is 'PATH/Dockerfile') + deprecated: false + experimental: false - option: force-rm + value_type: bool default_value: "false" description: Always remove intermediate containers + deprecated: false + experimental: false - option: iidfile + value_type: string description: Write the image ID to the file + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: label + value_type: list description: Set metadata for an image + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: | Set the networking mode for the RUN instructions during build + deprecated: false + min_api_version: "1.25" + experimental: false - option: no-cache + value_type: bool default_value: "false" description: Do not use cache when building the image + deprecated: false + experimental: false - option: pull + value_type: bool default_value: "false" description: Always attempt to pull a newer version of the image + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress the build output and print image ID on success + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "true" description: Remove intermediate containers after a successful build + deprecated: false + experimental: false - option: security-opt + value_type: stringSlice default_value: '[]' description: Security options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: squash + value_type: bool default_value: "false" description: Squash newly built layers into a single new layer + deprecated: false + min_api_version: "1.25" + experimental: true - option: stream + value_type: bool default_value: "false" description: Stream attaches to server to negotiate build context + deprecated: false + min_api_version: "1.31" + experimental: true - option: tag shorthand: t + value_type: list description: Name and optionally a tag in the 'name:tag' format + deprecated: false + experimental: false - option: target + value_type: string description: Set the target build stage to build. + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_history.yaml b/_data/engine-cli-edge/docker_image_history.yaml index 4e8969f884..6d46d2db9c 100644 --- a/_data/engine-cli-edge/docker_image_history.yaml +++ b/_data/engine-cli-edge/docker_image_history.yaml @@ -6,16 +6,30 @@ pname: docker image plink: docker_image.yaml options: - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: human shorthand: H + value_type: bool default_value: "true" description: Print sizes and dates in human readable format + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only show numeric IDs + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_import.yaml b/_data/engine-cli-edge/docker_image_import.yaml index 592be058b4..97bf004ecf 100644 --- a/_data/engine-cli-edge/docker_image_import.yaml +++ b/_data/engine-cli-edge/docker_image_import.yaml @@ -7,8 +7,16 @@ plink: docker_image.yaml options: - option: change shorthand: c + value_type: list description: Apply Dockerfile instruction to the created image + deprecated: false + experimental: false - option: message shorthand: m + value_type: string description: Set commit message for imported image + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_inspect.yaml b/_data/engine-cli-edge/docker_image_inspect.yaml index a83a013b1c..55bbe2a61a 100644 --- a/_data/engine-cli-edge/docker_image_inspect.yaml +++ b/_data/engine-cli-edge/docker_image_inspect.yaml @@ -7,5 +7,10 @@ plink: docker_image.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_load.yaml b/_data/engine-cli-edge/docker_image_load.yaml index 36d0a846bc..ce057a8545 100644 --- a/_data/engine-cli-edge/docker_image_load.yaml +++ b/_data/engine-cli-edge/docker_image_load.yaml @@ -7,9 +7,17 @@ plink: docker_image.yaml options: - option: input shorthand: i + value_type: string description: Read from tar archive file, instead of STDIN + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress the load output + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_ls.yaml b/_data/engine-cli-edge/docker_image_ls.yaml index 6849815e10..5189d4e68f 100644 --- a/_data/engine-cli-edge/docker_image_ls.yaml +++ b/_data/engine-cli-edge/docker_image_ls.yaml @@ -8,21 +8,41 @@ plink: docker_image.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all images (default hides intermediate images) + deprecated: false + experimental: false - option: digests + value_type: bool default_value: "false" description: Show digests + deprecated: false + experimental: false - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only show numeric IDs + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_prune.yaml b/_data/engine-cli-edge/docker_image_prune.yaml index 7bbe239313..99403ed637 100644 --- a/_data/engine-cli-edge/docker_image_prune.yaml +++ b/_data/engine-cli-edge/docker_image_prune.yaml @@ -8,14 +8,23 @@ plink: docker_image.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Remove all unused images, not just dangling ones + deprecated: false + experimental: false - option: filter + value_type: filter description: Provide filter values (e.g. 'until=') + deprecated: false + experimental: false - option: force shorthand: f + value_type: bool default_value: "false" description: Do not prompt for confirmation + deprecated: false + experimental: false examples: |2- output: @@ -145,4 +154,7 @@ examples: |2- alpine latest 88e169ea8f46 8 days ago 3.98 MB busybox latest e02e811dd08f 2 months ago 1.09 MB ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_image_pull.yaml b/_data/engine-cli-edge/docker_image_pull.yaml index 068ef8c44c..f70927af33 100644 --- a/_data/engine-cli-edge/docker_image_pull.yaml +++ b/_data/engine-cli-edge/docker_image_pull.yaml @@ -7,9 +7,17 @@ plink: docker_image.yaml options: - option: all-tags shorthand: a + value_type: bool default_value: "false" description: Download all tagged images in the repository + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_push.yaml b/_data/engine-cli-edge/docker_image_push.yaml index 970b82a064..9ad0cdda00 100644 --- a/_data/engine-cli-edge/docker_image_push.yaml +++ b/_data/engine-cli-edge/docker_image_push.yaml @@ -6,6 +6,11 @@ pname: docker image plink: docker_image.yaml options: - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image signing + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_rm.yaml b/_data/engine-cli-edge/docker_image_rm.yaml index b9acdd8e73..6a49641db7 100644 --- a/_data/engine-cli-edge/docker_image_rm.yaml +++ b/_data/engine-cli-edge/docker_image_rm.yaml @@ -8,9 +8,17 @@ plink: docker_image.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force removal of the image + deprecated: false + experimental: false - option: no-prune + value_type: bool default_value: "false" description: Do not delete untagged parents + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_save.yaml b/_data/engine-cli-edge/docker_image_save.yaml index 61984707d5..0f681f4635 100644 --- a/_data/engine-cli-edge/docker_image_save.yaml +++ b/_data/engine-cli-edge/docker_image_save.yaml @@ -7,5 +7,10 @@ plink: docker_image.yaml options: - option: output shorthand: o + value_type: string description: Write to a file, instead of STDOUT + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_image_tag.yaml b/_data/engine-cli-edge/docker_image_tag.yaml index 586650fc8e..b4b4b40158 100644 --- a/_data/engine-cli-edge/docker_image_tag.yaml +++ b/_data/engine-cli-edge/docker_image_tag.yaml @@ -4,4 +4,6 @@ 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 +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_images.yaml b/_data/engine-cli-edge/docker_images.yaml index a3e1f6f308..959dd64fcf 100644 --- a/_data/engine-cli-edge/docker_images.yaml +++ b/_data/engine-cli-edge/docker_images.yaml @@ -22,23 +22,41 @@ plink: docker.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all images (default hides intermediate images) + deprecated: false + experimental: false - option: digests + value_type: bool default_value: "false" description: Show digests + deprecated: false + experimental: false - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only show numeric IDs + deprecated: false + experimental: false examples: |- ### List the most recently created images @@ -326,4 +344,6 @@ examples: |- 746b819f315e postgres 9.3.5 746b819f315e postgres latest ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_import.yaml b/_data/engine-cli-edge/docker_import.yaml index b4c53995f6..e53ba09e51 100644 --- a/_data/engine-cli-edge/docker_import.yaml +++ b/_data/engine-cli-edge/docker_import.yaml @@ -19,10 +19,16 @@ plink: docker.yaml options: - option: change shorthand: c + value_type: list description: Apply Dockerfile instruction to the created image + deprecated: false + experimental: false - option: message shorthand: m + value_type: string description: Set commit message for imported image + deprecated: false + experimental: false examples: |- ### Import from a remote location @@ -68,4 +74,6 @@ examples: |- the ownership of the files (especially root ownership) during the archiving with tar. If you are not root (or the sudo command) when you tar, then the ownerships might not get preserved. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_info.yaml b/_data/engine-cli-edge/docker_info.yaml index aed92af008..6e05e00f69 100644 --- a/_data/engine-cli-edge/docker_info.yaml +++ b/_data/engine-cli-edge/docker_info.yaml @@ -24,7 +24,10 @@ plink: docker.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ### Show output @@ -222,4 +225,6 @@ examples: |- http://registry-mirror.example.com:5000/ Live Restore Enabled: false ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_inspect.yaml b/_data/engine-cli-edge/docker_inspect.yaml index aab3239159..4c8d042428 100644 --- a/_data/engine-cli-edge/docker_inspect.yaml +++ b/_data/engine-cli-edge/docker_inspect.yaml @@ -10,13 +10,22 @@ plink: docker.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: size shorthand: s + value_type: bool default_value: "false" description: Display total file sizes if the type is container + deprecated: false + experimental: false - option: type + value_type: string description: Return JSON for specified type + deprecated: false + experimental: false examples: |- ### Get an instance's IP address @@ -78,4 +87,6 @@ examples: |- ```bash $ docker inspect --format='{{json .Config}}' $INSTANCE_ID ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_kill.yaml b/_data/engine-cli-edge/docker_kill.yaml index da59327d25..4c491ad669 100644 --- a/_data/engine-cli-edge/docker_kill.yaml +++ b/_data/engine-cli-edge/docker_kill.yaml @@ -13,6 +13,11 @@ plink: docker.yaml options: - option: signal shorthand: s + value_type: string default_value: KILL description: Signal to send to the container + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_load.yaml b/_data/engine-cli-edge/docker_load.yaml index c8b0446e39..cd21911eb2 100644 --- a/_data/engine-cli-edge/docker_load.yaml +++ b/_data/engine-cli-edge/docker_load.yaml @@ -9,11 +9,17 @@ plink: docker.yaml options: - option: input shorthand: i + value_type: string description: Read from tar archive file, instead of STDIN + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress the load output + deprecated: false + experimental: false examples: |- ```bash $ docker images @@ -42,4 +48,6 @@ examples: |- fedora heisenbug 58394af37342 7 weeks ago 385.5 MB fedora latest 58394af37342 7 weeks ago 385.5 MB ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_login.yaml b/_data/engine-cli-edge/docker_login.yaml index b75081e1c6..6b467bd54c 100644 --- a/_data/engine-cli-edge/docker_login.yaml +++ b/_data/engine-cli-edge/docker_login.yaml @@ -2,11 +2,17 @@ command: docker login short: Log in to a Docker registry long: "Login to a registry.\n\n### Login to a self-hosted registry\n\nIf you want to login to a self-hosted registry you can specify this by\nadding the server name.\n\n```bash\n$ - docker login localhost:8080\n```\n\n### Privileged user requirement\n\n`docker login` - requires user to use `sudo` or be `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 login localhost:8080\n```\n\n### Provide a password using STDIN\n\nTo run + the `docker login` command non-interactively, you can set the\n`--password-stdin` + flag to provide a password through `STDIN`. Using\n`STDIN` prevents the password + from ending up in the shell's history,\nor log-files.\n\nThe following example reads + a password from a file, and passes it to the\n`docker login` command using `STDIN`:\n\n```bash\n$ + cat ~/my_password.txt | docker login --username foo --password-stdin\n```\n\n### + Privileged user requirement\n\n`docker login` requires user to use `sudo` or be + `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) for details.\n\nYou can log into any public or private repository for which you have\ncredentials. When you log in, the command stores encoded credentials in\n`$HOME/.docker/config.json` on Linux or `%USERPROFILE%/.docker/config.json` on Windows.\n\n### Credentials store\n\nThe @@ -61,11 +67,22 @@ plink: docker.yaml options: - option: password shorthand: p + value_type: string description: Password + deprecated: false + experimental: false - option: password-stdin + value_type: bool default_value: "false" description: Take the password from stdin + deprecated: false + experimental: false - option: username shorthand: u + value_type: string description: Username + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_logout.yaml b/_data/engine-cli-edge/docker_logout.yaml index 082c8fcf44..bceaedae93 100644 --- a/_data/engine-cli-edge/docker_logout.yaml +++ b/_data/engine-cli-edge/docker_logout.yaml @@ -8,4 +8,6 @@ examples: |- ```bash $ docker logout localhost:8080 ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_logs.yaml b/_data/engine-cli-edge/docker_logs.yaml index 72bea5f281..dcefcae4af 100644 --- a/_data/engine-cli-edge/docker_logs.yaml +++ b/_data/engine-cli-edge/docker_logs.yaml @@ -41,20 +41,37 @@ pname: docker plink: docker.yaml options: - option: details + value_type: bool default_value: "false" description: Show extra details provided to logs + deprecated: false + experimental: false - option: follow shorthand: f + value_type: bool default_value: "false" description: Follow log output + deprecated: false + experimental: 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 - option: tail + value_type: string default_value: all description: Number of lines to show from the end of the logs + deprecated: false + experimental: false - option: timestamps shorthand: t + value_type: bool default_value: "false" description: Show timestamps + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network.yaml b/_data/engine-cli-edge/docker_network.yaml index d5d9d7991d..9ee3ab5cd3 100644 --- a/_data/engine-cli-edge/docker_network.yaml +++ b/_data/engine-cli-edge/docker_network.yaml @@ -22,4 +22,6 @@ clink: - docker_network_ls.yaml - docker_network_prune.yaml - docker_network_rm.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network_connect.yaml b/_data/engine-cli-edge/docker_network_connect.yaml index 3f1556cc43..06c79bac98 100644 --- a/_data/engine-cli-edge/docker_network_connect.yaml +++ b/_data/engine-cli-edge/docker_network_connect.yaml @@ -9,17 +9,32 @@ pname: docker network plink: docker_network.yaml options: - option: alias + value_type: stringSlice default_value: '[]' description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: ip + value_type: string description: IPv4 address (e.g., 172.30.100.104) + deprecated: false + experimental: false - option: ip6 + value_type: string description: IPv6 address (e.g., 2001:db8::33) + deprecated: false + experimental: false - option: link + value_type: list description: Add link to another container + deprecated: false + experimental: false - option: link-local-ip + value_type: stringSlice default_value: '[]' description: Add a link-local address for the container + deprecated: false + experimental: false examples: |- ### Connect a running container to a network @@ -88,4 +103,6 @@ examples: |- network but launched from different Engines can also communicate in this way. 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 diff --git a/_data/engine-cli-edge/docker_network_create.yaml b/_data/engine-cli-edge/docker_network_create.yaml index d97c0292a1..241ae215be 100644 --- a/_data/engine-cli-edge/docker_network_create.yaml +++ b/_data/engine-cli-edge/docker_network_create.yaml @@ -53,52 +53,105 @@ pname: docker network plink: docker_network.yaml options: - option: attachable + value_type: bool default_value: "false" description: Enable manual container attachment + deprecated: false + min_api_version: "1.25" + experimental: false - option: aux-address + value_type: map default_value: map[] description: Auxiliary IPv4 or IPv6 addresses used by Network driver + deprecated: false + experimental: false - option: config-from + value_type: string description: The network from which copying the configuration + deprecated: false + min_api_version: "1.30" + experimental: false - option: config-only + value_type: bool default_value: "false" description: Create a configuration only network + deprecated: false + min_api_version: "1.30" + experimental: false - option: driver shorthand: d + value_type: string default_value: bridge description: Driver to manage the Network + deprecated: false + experimental: false - option: gateway + value_type: stringSlice default_value: '[]' description: IPv4 or IPv6 Gateway for the master subnet + deprecated: false + experimental: false - option: ingress + value_type: bool default_value: "false" description: Create swarm routing-mesh network + deprecated: false + min_api_version: "1.29" + experimental: false - option: internal + value_type: bool default_value: "false" description: Restrict external access to the network + deprecated: false + experimental: false - option: ip-range + value_type: stringSlice default_value: '[]' description: Allocate container ip from a sub-range + deprecated: false + experimental: false - option: ipam-driver + value_type: string default_value: default description: IP Address Management Driver + deprecated: false + experimental: false - option: ipam-opt + value_type: map default_value: map[] description: Set IPAM driver specific options + deprecated: false + experimental: false - option: ipv6 + value_type: bool default_value: "false" description: Enable IPv6 networking + deprecated: false + experimental: false - option: label + value_type: list description: Set metadata on a network + deprecated: false + experimental: false - option: opt shorthand: o + value_type: map default_value: map[] description: Set driver specific options + deprecated: false + experimental: false - option: scope + value_type: string description: Control the network's scope + deprecated: false + min_api_version: "1.30" + experimental: false - option: subnet + value_type: stringSlice default_value: '[]' description: Subnet in CIDR format that represents a network segment + deprecated: false + experimental: false examples: |- ### Connect containers @@ -217,8 +270,10 @@ examples: |- $ docker network create -d overlay \ --subnet=10.11.0.0/16 \ --ingress \ - --opt com.docker.network.mtu=9216 \ + --opt com.docker.network.driver.mtu=9216 \ --opt encrypted=true \ my-ingress-network ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network_disconnect.yaml b/_data/engine-cli-edge/docker_network_disconnect.yaml index 27f7dab03c..830bc55656 100644 --- a/_data/engine-cli-edge/docker_network_disconnect.yaml +++ b/_data/engine-cli-edge/docker_network_disconnect.yaml @@ -9,10 +9,15 @@ plink: docker_network.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force the container to disconnect from a network + deprecated: false + experimental: false examples: |- ```bash $ docker network disconnect multi-host-network container1 ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network_inspect.yaml b/_data/engine-cli-edge/docker_network_inspect.yaml index f9ff99a9f8..02245ed3b7 100644 --- a/_data/engine-cli-edge/docker_network_inspect.yaml +++ b/_data/engine-cli-edge/docker_network_inspect.yaml @@ -9,9 +9,17 @@ plink: docker_network.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: verbose shorthand: v + value_type: bool default_value: "false" description: Verbose output for diagnostics + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network_ls.yaml b/_data/engine-cli-edge/docker_network_ls.yaml index 33f8f629a2..53263c45e8 100644 --- a/_data/engine-cli-edge/docker_network_ls.yaml +++ b/_data/engine-cli-edge/docker_network_ls.yaml @@ -10,16 +10,28 @@ plink: docker_network.yaml options: - option: filter shorthand: f + value_type: filter description: Provide filter values (e.g. 'driver=bridge') + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print networks using a Go template + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate the output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display network IDs + deprecated: false + experimental: 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 @@ -100,4 +112,6 @@ examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK I uses a template without headers and outputs the\n`ID` and `Driver` entries separated by a colon for all networks:\n\n```bash\n$ docker network ls --format \"{{.ID}}: {{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```" +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_network_prune.yaml b/_data/engine-cli-edge/docker_network_prune.yaml index 9eb5589d0d..5f399b58db 100644 --- a/_data/engine-cli-edge/docker_network_prune.yaml +++ b/_data/engine-cli-edge/docker_network_prune.yaml @@ -8,11 +8,17 @@ pname: docker network plink: docker_network.yaml options: - option: filter + value_type: filter description: Provide filter values (e.g. 'until=') + deprecated: false + experimental: false - option: force shorthand: f + value_type: bool default_value: "false" description: Do not prompt for confirmation + deprecated: false + experimental: false examples: |- ```bash $ docker network prune @@ -77,4 +83,7 @@ examples: |- 97b91972bc3b host host local f949d337b1f5 none null local ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_network_rm.yaml b/_data/engine-cli-edge/docker_network_rm.yaml index 9fa72dde9e..3d9c5ff302 100644 --- a/_data/engine-cli-edge/docker_network_rm.yaml +++ b/_data/engine-cli-edge/docker_network_rm.yaml @@ -30,4 +30,6 @@ examples: |- If the deletion of one network fails, the command continues to the next on the list and tries to delete that. The command reports success or failure for each deletion. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_node.yaml b/_data/engine-cli-edge/docker_node.yaml index 6fbd014c85..4f88bad0fe 100644 --- a/_data/engine-cli-edge/docker_node.yaml +++ b/_data/engine-cli-edge/docker_node.yaml @@ -20,4 +20,7 @@ clink: - docker_node_ps.yaml - docker_node_rm.yaml - docker_node_update.yaml +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_demote.yaml b/_data/engine-cli-edge/docker_node_demote.yaml index 24247f0c0c..3192cce9b7 100644 --- a/_data/engine-cli-edge/docker_node_demote.yaml +++ b/_data/engine-cli-edge/docker_node_demote.yaml @@ -10,4 +10,7 @@ examples: |- ```bash $ docker node demote ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_inspect.yaml b/_data/engine-cli-edge/docker_node_inspect.yaml index 934f396c51..07a3b67cd5 100644 --- a/_data/engine-cli-edge/docker_node_inspect.yaml +++ b/_data/engine-cli-edge/docker_node_inspect.yaml @@ -12,10 +12,16 @@ plink: docker_node.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: pretty + value_type: bool default_value: "false" description: Print the information in a human friendly format + deprecated: false + experimental: 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\": @@ -52,4 +58,7 @@ examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\ Version: 17.06.0-ce\nTLS Info:\n TrustRoot:\n-----BEGIN CERTIFICATE-----\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\n-----END CERTIFICATE-----\n\n Issuer Public Key:\tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==\n Issuer Subject:\tMBMxETAPBgNVBAMTCHN3YXJtLWNh\n```" +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_ls.yaml b/_data/engine-cli-edge/docker_node_ls.yaml index 5c21ee2720..5241531e18 100644 --- a/_data/engine-cli-edge/docker_node_ls.yaml +++ b/_data/engine-cli-edge/docker_node_ls.yaml @@ -11,13 +11,22 @@ plink: docker_node.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print nodes using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: 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 @@ -65,5 +74,8 @@ examples: "```bash\n$ docker node ls\n\nID HOSTNAME 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``" + swarm-worker1 Needs Rotation \n```" +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_promote.yaml b/_data/engine-cli-edge/docker_node_promote.yaml index c6daf98e76..360d89565a 100644 --- a/_data/engine-cli-edge/docker_node_promote.yaml +++ b/_data/engine-cli-edge/docker_node_promote.yaml @@ -10,4 +10,7 @@ examples: |- ```bash $ docker node promote ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_ps.yaml b/_data/engine-cli-edge/docker_node_ps.yaml index f77939ad32..c81b1cac84 100644 --- a/_data/engine-cli-edge/docker_node_ps.yaml +++ b/_data/engine-cli-edge/docker_node_ps.yaml @@ -9,19 +9,34 @@ plink: docker_node.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print tasks using a Go template + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display task IDs + deprecated: false + experimental: false examples: |- ```bash $ docker node ps swarm-manager1 @@ -124,4 +139,7 @@ examples: |- top.2: busybox top.3: busybox ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_rm.yaml b/_data/engine-cli-edge/docker_node_rm.yaml index be7dff3bf5..4a30b63e58 100644 --- a/_data/engine-cli-edge/docker_node_rm.yaml +++ b/_data/engine-cli-edge/docker_node_rm.yaml @@ -8,8 +8,11 @@ plink: docker_node.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force remove a node from the swarm + deprecated: false + experimental: false examples: |- ### Remove a stopped node from the swarm @@ -45,4 +48,7 @@ examples: |- A manager node must be demoted to a worker node (using `docker node demote`) before you can remove it from the swarm. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_node_update.yaml b/_data/engine-cli-edge/docker_node_update.yaml index 520e1573f5..254771aef1 100644 --- a/_data/engine-cli-edge/docker_node_update.yaml +++ b/_data/engine-cli-edge/docker_node_update.yaml @@ -6,13 +6,25 @@ pname: docker node plink: docker_node.yaml options: - option: availability + value_type: string description: Availability of the node ("active"|"pause"|"drain") + deprecated: false + experimental: false - option: label-add + value_type: list description: Add or update a node label (key=value) + deprecated: false + experimental: false - option: label-rm + value_type: list description: Remove a node label if exists + deprecated: false + experimental: false - option: role + value_type: string description: Role of the node ("worker"|"manager") + deprecated: false + experimental: false examples: |- ### Add label metadata to a node @@ -46,4 +58,7 @@ examples: |- For more information about labels, refer to [apply custom metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/). +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_pause.yaml b/_data/engine-cli-edge/docker_pause.yaml index 1552d106f1..0549229995 100644 --- a/_data/engine-cli-edge/docker_pause.yaml +++ b/_data/engine-cli-edge/docker_pause.yaml @@ -18,4 +18,6 @@ examples: |- ```bash $ docker pause my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin.yaml b/_data/engine-cli-edge/docker_plugin.yaml index 8ad61ccc91..bfac06a6c4 100644 --- a/_data/engine-cli-edge/docker_plugin.yaml +++ b/_data/engine-cli-edge/docker_plugin.yaml @@ -26,4 +26,7 @@ clink: - docker_plugin_rm.yaml - docker_plugin_set.yaml - docker_plugin_upgrade.yaml +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_create.yaml b/_data/engine-cli-edge/docker_plugin_create.yaml index 7cb959e5cb..197a68ce37 100644 --- a/_data/engine-cli-edge/docker_plugin_create.yaml +++ b/_data/engine-cli-edge/docker_plugin_create.yaml @@ -9,8 +9,11 @@ pname: docker plugin plink: docker_plugin.yaml options: - option: compress + value_type: bool default_value: "false" description: Compress the context using gzip + deprecated: false + experimental: false examples: |- The following example shows how to create a sample `plugin`. @@ -32,4 +35,7 @@ examples: |- ``` The plugin can subsequently be enabled for local use or pushed to the public registry. +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_disable.yaml b/_data/engine-cli-edge/docker_plugin_disable.yaml index 456a33217e..c6adc132ec 100644 --- a/_data/engine-cli-edge/docker_plugin_disable.yaml +++ b/_data/engine-cli-edge/docker_plugin_disable.yaml @@ -10,8 +10,11 @@ plink: docker_plugin.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force the disable of an active plugin + deprecated: false + experimental: false examples: |- The following example shows that the `sample-volume-plugin` plugin is installed and enabled: @@ -35,4 +38,7 @@ examples: |- ID NAME TAG DESCRIPTION ENABLED 69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_enable.yaml b/_data/engine-cli-edge/docker_plugin_enable.yaml index 0f8610a4b0..7a0aa93a8b 100644 --- a/_data/engine-cli-edge/docker_plugin_enable.yaml +++ b/_data/engine-cli-edge/docker_plugin_enable.yaml @@ -8,8 +8,11 @@ pname: docker plugin plink: docker_plugin.yaml options: - option: timeout + value_type: int default_value: "0" description: HTTP client timeout (in seconds) + deprecated: false + experimental: false examples: |- The following example shows that the `sample-volume-plugin` plugin is installed, but disabled: @@ -33,4 +36,7 @@ examples: |- ID NAME TAG DESCRIPTION ENABLED 69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_inspect.yaml b/_data/engine-cli-edge/docker_plugin_inspect.yaml index 48396e0755..ea00b69447 100644 --- a/_data/engine-cli-edge/docker_plugin_inspect.yaml +++ b/_data/engine-cli-edge/docker_plugin_inspect.yaml @@ -9,7 +9,10 @@ plink: docker_plugin.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ```none $ docker plugin inspect tiborvass/sample-volume-plugin:latest @@ -130,4 +133,7 @@ examples: |- 8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21 ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_install.yaml b/_data/engine-cli-edge/docker_plugin_install.yaml index babae66dce..6fc1ae8cad 100644 --- a/_data/engine-cli-edge/docker_plugin_install.yaml +++ b/_data/engine-cli-edge/docker_plugin_install.yaml @@ -10,16 +10,28 @@ pname: docker plugin plink: docker_plugin.yaml options: - option: alias + value_type: string description: Local name for plugin + deprecated: false + experimental: false - option: disable + value_type: bool default_value: "false" description: Do not enable the plugin on install + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: grant-all-permissions + value_type: bool default_value: "false" description: Grant all permissions necessary to run the plugin + deprecated: false + experimental: 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 @@ -45,4 +57,7 @@ examples: |- ID NAME TAG DESCRIPTION ENABLED 69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_ls.yaml b/_data/engine-cli-edge/docker_plugin_ls.yaml index 1748ad20a5..6dbf4907aa 100644 --- a/_data/engine-cli-edge/docker_plugin_ls.yaml +++ b/_data/engine-cli-edge/docker_plugin_ls.yaml @@ -12,16 +12,28 @@ plink: docker_plugin.yaml options: - option: filter shorthand: f + value_type: filter description: Provide filter values (e.g. 'enabled=true') + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print plugins using a Go template + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display plugin IDs + deprecated: false + experimental: false examples: |- ```bash $ docker plugin ls @@ -51,9 +63,9 @@ examples: |- `ipamdriver`, `logdriver`, `metricscollector`, and `authz` are supported capabilities. ```bash - $ docker plugin install --disable tiborvass/no-remove + $ docker plugin install --disable vieux/sshfs - tiborvass/no-remove + Installed plugin vieux/sshfs $ docker plugin ls --filter enabled=true @@ -85,6 +97,9 @@ examples: |- ```bash $ docker plugin ls --format "{{.ID}}: {{.Name}}" - 4be01827a72e: tiborvass/no-remove + 4be01827a72e: vieux/sshfs:latest ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_push.yaml b/_data/engine-cli-edge/docker_plugin_push.yaml index d0d1b6912a..6d1b9b0215 100644 --- a/_data/engine-cli-edge/docker_plugin_push.yaml +++ b/_data/engine-cli-edge/docker_plugin_push.yaml @@ -11,8 +11,11 @@ pname: docker plugin plink: docker_plugin.yaml options: - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image signing + deprecated: false + experimental: false examples: |- The following example shows how to push a sample `user/plugin`. @@ -24,4 +27,7 @@ examples: |- $ docker plugin push user/plugin ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_rm.yaml b/_data/engine-cli-edge/docker_plugin_rm.yaml index 4df92179d1..c914d6948d 100644 --- a/_data/engine-cli-edge/docker_plugin_rm.yaml +++ b/_data/engine-cli-edge/docker_plugin_rm.yaml @@ -12,8 +12,11 @@ plink: docker_plugin.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force the removal of an active plugin + deprecated: false + experimental: false examples: |- The following example disables and removes the `sample-volume-plugin:latest` plugin: @@ -27,4 +30,7 @@ examples: |- tiborvass/sample-volume-plugin ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_set.yaml b/_data/engine-cli-edge/docker_plugin_set.yaml index cc40f414f3..d7c2c8e42a 100644 --- a/_data/engine-cli-edge/docker_plugin_set.yaml +++ b/_data/engine-cli-edge/docker_plugin_set.yaml @@ -80,4 +80,7 @@ examples: |- ["foo", "bar", "baz"] ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_plugin_upgrade.yaml b/_data/engine-cli-edge/docker_plugin_upgrade.yaml index b254e9b9c4..b5430d30a3 100644 --- a/_data/engine-cli-edge/docker_plugin_upgrade.yaml +++ b/_data/engine-cli-edge/docker_plugin_upgrade.yaml @@ -10,15 +10,24 @@ pname: docker plugin plink: docker_plugin.yaml options: - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: grant-all-permissions + value_type: bool default_value: "false" description: Grant all permissions necessary to run the plugin + deprecated: false + experimental: false - option: skip-remote-check + value_type: bool default_value: "false" description: | Do not check if specified remote plugin matches existing plugin image + deprecated: false + experimental: false examples: |- The following example installs `vieus/sshfs` plugin, uses it to create and use a volume, then upgrades the plugin. @@ -70,4 +79,7 @@ examples: |- hello ``` +deprecated: false +min_api_version: "1.26" +experimental: false diff --git a/_data/engine-cli-edge/docker_port.yaml b/_data/engine-cli-edge/docker_port.yaml index 00550b9ddb..cdf9306cac 100644 --- a/_data/engine-cli-edge/docker_port.yaml +++ b/_data/engine-cli-edge/docker_port.yaml @@ -24,4 +24,6 @@ examples: |- $ docker port test 7890 0.0.0.0:4321 ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_ps.yaml b/_data/engine-cli-edge/docker_ps.yaml index 07fb2cddf2..217240a6f7 100644 --- a/_data/engine-cli-edge/docker_ps.yaml +++ b/_data/engine-cli-edge/docker_ps.yaml @@ -7,32 +7,56 @@ plink: docker.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all containers (default shows just running) + deprecated: false + experimental: false - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print containers using a Go template + deprecated: false + experimental: false - option: last shorthand: "n" + value_type: int default_value: "-1" description: Show n last created containers (includes all states) + deprecated: false + experimental: false - option: latest shorthand: l + value_type: bool default_value: "false" description: Show the latest created container (includes all states) + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display numeric IDs + deprecated: false + experimental: false - option: size shorthand: s + value_type: bool default_value: "false" description: Display total file sizes + deprecated: false + experimental: false examples: |- ### Prevent truncating output @@ -68,18 +92,19 @@ examples: |- | Filter | Description | |:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------| - | `id` | container's ID | - | `name` | container's name | - | `label` | An arbitrary string representing either a key or a key-value pair | + | `id` | Container's ID | + | `name` | Container's name | + | `label` | An arbitrary string representing either a key or a key-value pair. Expressed as `` or `=` | | `exited` | An integer representing the container's exit code. Only useful with `--all`. | - | `status` | One of `created|restarting|running|removing|paused|exited|dead` | + | `status` | One of `created`, `restarting`, `running`, `removing`, `paused`, `exited`, or `dead` | | `ancestor` | Filters containers which share a given image as an ancestor. Expressed as `[:]`, ``, or `` | | `before` or `since` | Filters containers created before or after a given container ID or name | | `volume` | Filters running containers which have mounted a given volume or bind mount. | | `network` | Filters running containers connected to a given network. | - | `publish` or `expose` | Filters containers which publish or expose a given port. | - | `health` | One of `starting|healthy|unhealthy|none`. Filters containers based on their healthcheck status. | - | `isolation` | Windows daemon only. One of `default|process|hyperv`. | + | `publish` or `expose` | Filters containers which publish or expose a given port. Expressed as `[/]` or `/[]` | + | `health` | Filters containers based on their healthcheck status. One of `starting`, `healthy`, `unhealthy` or `none`. | + | `isolation` | Windows daemon only. One of `default`, `process`, or `hyperv`. | + | `is-task` | Filters containers that are a "task" for a service. Boolean option (`true` or `false`) | #### label @@ -192,11 +217,11 @@ examples: |- The `ancestor` filter matches containers based on its image or a descendant of it. The filter supports the following image representation: - - image - - image:tag - - image:tag@digest - - short-id - - full-id + - `image` + - `image:tag` + - `image:tag@digest` + - `short-id` + - `full-id` If you don't specify a `tag`, the `latest` tag is used. For example, to filter for containers that use the latest `ubuntu` image: @@ -415,4 +440,6 @@ examples: |- c1d3b0166030 com.docker.swarm.node=debian,com.docker.swarm.cpu=6 41d50ecd2f57 com.docker.swarm.node=fedora,com.docker.swarm.cpu=3,com.docker.swarm.storage=ssd ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_pull.yaml b/_data/engine-cli-edge/docker_pull.yaml index 90ef2a1853..8dccd0467d 100644 --- a/_data/engine-cli-edge/docker_pull.yaml +++ b/_data/engine-cli-edge/docker_pull.yaml @@ -31,11 +31,17 @@ plink: docker.yaml options: - option: all-tags shorthand: a + value_type: bool default_value: "false" description: Download all tagged images in the repository + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false examples: |- ### Pull an image from Docker Hub @@ -234,4 +240,6 @@ examples: |- > connection between the Docker Engine daemon and the Docker Engine client > initiating the pull is lost. If the connection with the Engine daemon is > lost for other reasons than a manual interaction, the pull is also aborted. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_push.yaml b/_data/engine-cli-edge/docker_push.yaml index de132ef035..54b2098d16 100644 --- a/_data/engine-cli-edge/docker_push.yaml +++ b/_data/engine-cli-edge/docker_push.yaml @@ -17,8 +17,11 @@ pname: docker plink: docker.yaml options: - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image signing + deprecated: false + experimental: false examples: |- ### Push a new image to a registry @@ -49,4 +52,6 @@ examples: |- You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd` listed. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_rename.yaml b/_data/engine-cli-edge/docker_rename.yaml index d1af0fbd3c..b3df21d236 100644 --- a/_data/engine-cli-edge/docker_rename.yaml +++ b/_data/engine-cli-edge/docker_rename.yaml @@ -8,4 +8,6 @@ examples: |- ```bash $ docker rename my_container my_new_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_restart.yaml b/_data/engine-cli-edge/docker_restart.yaml index 2814a576eb..7b21af4c1d 100644 --- a/_data/engine-cli-edge/docker_restart.yaml +++ b/_data/engine-cli-edge/docker_restart.yaml @@ -7,10 +7,15 @@ plink: docker.yaml options: - option: time shorthand: t + value_type: int default_value: "10" description: Seconds to wait for stop before killing the container + deprecated: false + experimental: false examples: |- ```bash $ docker restart my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_rm.yaml b/_data/engine-cli-edge/docker_rm.yaml index aa30c51914..df4efed1de 100644 --- a/_data/engine-cli-edge/docker_rm.yaml +++ b/_data/engine-cli-edge/docker_rm.yaml @@ -7,16 +7,25 @@ plink: docker.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force the removal of a running container (uses SIGKILL) + deprecated: false + experimental: false - option: link shorthand: l + value_type: bool default_value: "false" description: Remove the specified link + deprecated: false + experimental: false - option: volumes shorthand: v + value_type: bool default_value: "false" description: Remove the volumes associated with the container + deprecated: false + experimental: false examples: |- ### Remove a container @@ -87,4 +96,6 @@ examples: |- In this example, the volume for `/foo` will remain intact, but the volume for `/bar` will be removed. The same behavior holds for volumes inherited with `--volumes-from`. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_rmi.yaml b/_data/engine-cli-edge/docker_rmi.yaml index 017cda4509..6477634b6c 100644 --- a/_data/engine-cli-edge/docker_rmi.yaml +++ b/_data/engine-cli-edge/docker_rmi.yaml @@ -7,11 +7,17 @@ plink: docker.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force removal of the image + deprecated: false + experimental: false - option: no-prune + value_type: bool default_value: "false" description: Do not delete untagged parents + deprecated: false + experimental: 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 tag referencing it, you must remove all of them before @@ -88,4 +94,6 @@ examples: |- Deleted: ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2 Deleted: df7546f9f060a2268024c8a230d8639878585defcc1bc6f79d2728a13957871b ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_run.yaml b/_data/engine-cli-edge/docker_run.yaml index 580ed3937e..cb8717b800 100644 --- a/_data/engine-cli-edge/docker_run.yaml +++ b/_data/engine-cli-edge/docker_run.yaml @@ -17,268 +17,568 @@ pname: docker plink: docker.yaml options: - option: add-host + value_type: list description: Add a custom host-to-IP mapping (host:ip) + deprecated: false + experimental: false - option: attach shorthand: a + value_type: list description: Attach to STDIN, STDOUT or STDERR + deprecated: false + experimental: false - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: blkio-weight-device + value_type: list default_value: '[]' description: Block IO weight (relative device weight) + deprecated: false + experimental: false - option: cap-add + value_type: list description: Add Linux capabilities + deprecated: false + experimental: false - option: cap-drop + value_type: list description: Drop Linux capabilities + deprecated: false + experimental: false - option: cgroup-parent + value_type: string description: Optional parent cgroup for the container + deprecated: false + experimental: false - option: cidfile + value_type: string description: Write the container ID to the file + deprecated: false + experimental: false - option: cpu-count + value_type: int64 default_value: "0" description: CPU count (Windows only) + deprecated: false + experimental: false - option: cpu-percent + value_type: int64 default_value: "0" description: CPU percent (Windows only) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: detach shorthand: d + value_type: bool default_value: "false" description: Run container in background and print container ID + deprecated: false + experimental: false - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: device + value_type: list description: Add a host device to the container + deprecated: false + experimental: false - option: device-cgroup-rule + value_type: list description: Add a rule to the cgroup allowed devices list + deprecated: false + experimental: false - option: device-read-bps + value_type: list default_value: '[]' description: Limit read rate (bytes per second) from a device + deprecated: false + experimental: false - option: device-read-iops + value_type: list default_value: '[]' description: Limit read rate (IO per second) from a device + deprecated: false + experimental: false - option: device-write-bps + value_type: list default_value: '[]' description: Limit write rate (bytes per second) to a device + deprecated: false + experimental: false - option: device-write-iops + value_type: list default_value: '[]' description: Limit write rate (IO per second) to a device + deprecated: false + experimental: false - option: disable-content-trust + value_type: bool default_value: "true" description: Skip image verification + deprecated: false + experimental: false - option: dns + value_type: list description: Set custom DNS servers + deprecated: false + experimental: false - option: dns-opt + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-option + value_type: list description: Set DNS options + deprecated: false + experimental: false - option: dns-search + value_type: list description: Set custom DNS search domains + deprecated: false + experimental: false - option: entrypoint + value_type: string description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + experimental: false - option: env-file + value_type: list description: Read in a file of environment variables + deprecated: false + experimental: false - option: expose + value_type: list description: Expose a port or a range of ports + deprecated: false + experimental: false - option: group-add + value_type: list description: Add additional groups to join + deprecated: false + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + experimental: false - option: health-start-period + value_type: duration default_value: 0s description: | Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) + deprecated: false + min_api_version: "1.29" + experimental: false - option: health-timeout + value_type: duration default_value: 0s description: | Maximum time to allow one check to run (ms|s|m|h) (default 0s) + deprecated: false + experimental: false - option: help + value_type: bool default_value: "false" description: Print usage + deprecated: false + experimental: false - option: hostname shorthand: h + value_type: string description: Container host name + deprecated: false + experimental: false - option: init + value_type: bool default_value: "false" description: | Run an init inside the container that forwards signals and reaps processes + deprecated: false + min_api_version: "1.25" + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Keep STDIN open even if not attached + deprecated: false + experimental: false - option: io-maxbandwidth + value_type: bytes default_value: "0" description: | Maximum IO bandwidth limit for the system drive (Windows only) + deprecated: false + experimental: false - option: io-maxiops + value_type: uint64 default_value: "0" description: Maximum IOps limit for the system drive (Windows only) + deprecated: false + experimental: false - option: ip + value_type: string description: IPv4 address (e.g., 172.30.100.104) + deprecated: false + experimental: false - option: ip6 + value_type: string description: IPv6 address (e.g., 2001:db8::33) + deprecated: false + experimental: false - option: ipc - description: IPC namespace to use + value_type: string + description: IPC mode to use + deprecated: false + experimental: false - option: isolation + value_type: string description: Container isolation technology + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: label shorthand: l + value_type: list description: Set meta data on a container + deprecated: false + experimental: false - option: label-file + value_type: list description: Read in a line delimited file of labels + deprecated: false + experimental: false - option: link + value_type: list description: Add link to another container + deprecated: false + experimental: false - option: link-local-ip + value_type: list description: Container IPv4/IPv6 link-local addresses + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for the container + deprecated: false + experimental: false - option: log-opt + value_type: list description: Log driver options + deprecated: false + experimental: false - option: mac-address + value_type: string description: Container MAC address (e.g., 92:d0:c6:0a:29:33) + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: memory-swappiness + value_type: int64 default_value: "-1" description: Tune container memory swappiness (0 to 100) + deprecated: false + experimental: false - option: mount + value_type: mount description: Attach a filesystem mount to the container + deprecated: false + experimental: false - option: name + value_type: string description: Assign a name to the container + deprecated: false + experimental: false - option: net + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: net-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: network + value_type: string default_value: default description: Connect a container to a network + deprecated: false + experimental: false - option: network-alias + value_type: list description: Add network-scoped alias for the container + deprecated: false + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + experimental: false - option: oom-kill-disable + value_type: bool default_value: "false" description: Disable OOM Killer + deprecated: false + experimental: false - option: oom-score-adj + value_type: int default_value: "0" description: Tune host's OOM preferences (-1000 to 1000) + deprecated: false + experimental: false - option: pid + value_type: string description: PID namespace to use + deprecated: false + experimental: false - option: pids-limit + value_type: int64 default_value: "0" description: Tune container pids limit (set -1 for unlimited) + deprecated: false + experimental: false - option: privileged + value_type: bool default_value: "false" description: Give extended privileges to this container + deprecated: false + experimental: false - option: publish shorthand: p + value_type: list description: Publish a container's port(s) to the host + deprecated: false + experimental: false - option: publish-all shorthand: P + value_type: bool default_value: "false" description: Publish all exposed ports to random ports + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + experimental: false - option: restart + value_type: string default_value: "no" description: Restart policy to apply when a container exits + deprecated: false + experimental: false - option: rm + value_type: bool default_value: "false" description: Automatically remove the container when it exits + deprecated: false + experimental: false - option: runtime + value_type: string description: Runtime to use for this container + deprecated: false + experimental: false - option: security-opt + value_type: list description: Security Options + deprecated: false + experimental: false - option: shm-size + value_type: bytes default_value: "0" description: Size of /dev/shm + deprecated: false + experimental: false - option: sig-proxy + value_type: bool default_value: "true" description: Proxy received signals to the process + deprecated: false + experimental: false - option: stop-signal + value_type: string default_value: SIGTERM description: Signal to stop a container + deprecated: false + experimental: false - option: stop-timeout + value_type: int default_value: "0" description: Timeout (in seconds) to stop a container + deprecated: false + min_api_version: "1.25" + experimental: false - option: storage-opt + value_type: list description: Storage driver options for the container + deprecated: false + experimental: false - option: sysctl + value_type: map default_value: map[] description: Sysctl options + deprecated: false + experimental: false - option: tmpfs + value_type: list description: Mount a tmpfs directory + deprecated: false + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + experimental: false - option: ulimit + value_type: ulimit default_value: '[]' description: Ulimit options + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: userns + value_type: string description: User namespace to use + deprecated: false + experimental: false - option: uts + value_type: string description: UTS namespace to use + deprecated: false + experimental: false - option: volume shorthand: v + value_type: list description: Bind mount a volume + deprecated: false + experimental: false - option: volume-driver + value_type: string description: Optional volume driver for the container + deprecated: false + experimental: false - option: volumes-from + value_type: list description: Mount volumes from the specified container(s) + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container + deprecated: false + experimental: false examples: |- ### Assign name and allocate pseudo-TTY (--name, -it) @@ -419,7 +719,7 @@ examples: |- ``` The following examples will fail when using Windows-based containers, as the - destination of a volume or bind-mount inside the container must be one of: + destination of a volume or bind mount inside the container must be one of: a non-existing or empty directory; or a drive other than C:. Further, the source of a bind mount must be a local directory, not a file. @@ -435,7 +735,7 @@ examples: |- For in-depth information about volumes, refer to [manage data in containers](https://docs.docker.com/engine/tutorials/dockervolumes/) - ### Add bind-mounts or volumes using the --mount flag + ### Add bind mounts or volumes using the --mount flag The `--mount` flag allows you to mount volumes, host-directories and `tmpfs` mounts in a container. @@ -870,8 +1170,9 @@ examples: |- On Windows, this will affect containers differently depending on what type of isolation is used. - With `process` isolation, Windows will report the full memory of the host system, not the limit to applications running inside the container + ```powershell - docker run -it -m 2GB --isolation=process microsoft/nanoserver powershell Get-ComputerInfo *memory* + PS C:\> docker run -it -m 2GB --isolation=process microsoft/nanoserver powershell Get-ComputerInfo *memory* CsTotalPhysicalMemory : 17064509440 CsPhyicallyInstalledMemory : 16777216 @@ -882,9 +1183,11 @@ examples: |- OsInUseVirtualMemory : 1957488 OsMaxProcessMemorySize : 137438953344 ``` + - With `hyperv` isolation, Windows will create a utility VM that is big enough to hold the memory limit, plus the minimal OS needed to host the container. That size is reported as "Total Physical Memory." + ```powershell - docker run -it -m 2GB --isolation=hyperv microsoft/nanoserver powershell Get-ComputerInfo *memory* + PS C:\> docker run -it -m 2GB --isolation=hyperv microsoft/nanoserver powershell Get-ComputerInfo *memory* CsTotalPhysicalMemory : 2683355136 CsPhyicallyInstalledMemory : @@ -927,4 +1230,6 @@ examples: |- Sysctls beginning with net.* If you use the `--network=host` option using these sysctls will not be allowed. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_save.yaml b/_data/engine-cli-edge/docker_save.yaml index 5f63798c2f..6b1222fa63 100644 --- a/_data/engine-cli-edge/docker_save.yaml +++ b/_data/engine-cli-edge/docker_save.yaml @@ -10,7 +10,10 @@ plink: docker.yaml options: - option: output shorthand: o + value_type: string description: Write to a file, instead of STDOUT + deprecated: false + experimental: false examples: |- ### Create a backup that can then be used with `docker load`. @@ -39,4 +42,6 @@ examples: |- ```bash $ docker save -o ubuntu.tar ubuntu:lucid ubuntu:saucy ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_search.yaml b/_data/engine-cli-edge/docker_search.yaml index 4993a4b1d3..0a1813aace 100644 --- a/_data/engine-cli-edge/docker_search.yaml +++ b/_data/engine-cli-edge/docker_search.yaml @@ -12,21 +12,41 @@ pname: docker plink: docker.yaml options: - option: automated + value_type: bool default_value: "false" description: Only show automated builds + deprecated: true + experimental: false - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false +- option: format + value_type: string + description: Pretty-print search using a Go template + deprecated: false + experimental: false - option: limit + value_type: int default_value: "25" description: Max number of search results + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Don't truncate output + deprecated: false + experimental: false - option: stars shorthand: s + value_type: uint default_value: "0" description: Only displays with at least x stars + deprecated: true + experimental: 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 @@ -86,5 +106,28 @@ examples: "### Search images by name\n\nThis example displays images with a name --filter \"stars=3\" busybox\n\nNAME DESCRIPTION STARS \ OFFICIAL AUTOMATED\nprogrium/busybox 50 \ [OK]\nradial/busyboxplus Full-chain, Internet enabled, busybox - made... 8 [OK]\n```" + made... 8 [OK]\n```\n\n### Format the output\n\nThe formatting + option (`--format`) pretty-prints search output\nusing a Go template.\n\nValid placeholders + for the Go template are:\n\n| Placeholder | Description |\n| + -------------- | --------------------------------- |\n| `.Name` | Image Name + \ |\n| `.Description` | Image description |\n| + `.StarCount` | Number of stars for the image |\n| `.IsOfficial` | \"OK\" + if image is official |\n| `.IsAutomated` | \"OK\" if image build was automated + |\n\nWhen you use the `--format` option, the `search` command will\noutput the data + exactly as the template declares. If you use the\n`table` directive, column headers + are included as well.\n\nThe following example uses a template without headers and + outputs the\n`Name` and `StarCount` entries separated by a colon for all images:\n\n```bash\n{% + raw %}\n$ docker search --format \"{{.Name}}: {{.StarCount}}\" nginx\n\nnginx: 5441\njwilder/nginx-proxy: + 953\nricharvey/nginx-php-fpm: 353\nmillion12/nginx-php: 75\nwebdevops/php-nginx: + 70\nh3nrik/nginx-ldap: 35\nbitnami/nginx: 23\nevild/alpine-nginx: 14\nmillion12/nginx: + 9\nmaxexcloo/nginx: 7\n{% endraw %}\n```\n\nThis example outputs a table format:\n\n```bash\n{% + raw %}\n$ docker search --format \"table {{.Name}}\\t{{.IsAutomated}}\\t{{.IsOfficial}}\" + nginx\n\nNAME AUTOMATED OFFICIAL\nnginx + \ [OK]\njwilder/nginx-proxy + \ [OK] \nricharvey/nginx-php-fpm [OK] + \ \njrcs/letsencrypt-nginx-proxy-companion [OK] \nmillion12/nginx-php + \ [OK] \nwebdevops/php-nginx [OK] + \ \n{% endraw %}\n```" +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_secret.yaml b/_data/engine-cli-edge/docker_secret.yaml index 8e10971288..d1b319727e 100644 --- a/_data/engine-cli-edge/docker_secret.yaml +++ b/_data/engine-cli-edge/docker_secret.yaml @@ -14,4 +14,7 @@ clink: - docker_secret_inspect.yaml - docker_secret_ls.yaml - docker_secret_rm.yaml +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_secret_create.yaml b/_data/engine-cli-edge/docker_secret_create.yaml index e522ad4b10..f913c7f9cb 100644 --- a/_data/engine-cli-edge/docker_secret_create.yaml +++ b/_data/engine-cli-edge/docker_secret_create.yaml @@ -9,7 +9,10 @@ plink: docker_secret.yaml options: - option: label shorthand: l + value_type: list description: Secret labels + deprecated: false + experimental: false examples: |- ### Create a secret @@ -68,4 +71,7 @@ examples: |- } ] ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_secret_inspect.yaml b/_data/engine-cli-edge/docker_secret_inspect.yaml index dfa65eeb10..14e3e94bd9 100644 --- a/_data/engine-cli-edge/docker_secret_inspect.yaml +++ b/_data/engine-cli-edge/docker_secret_inspect.yaml @@ -17,10 +17,16 @@ plink: docker_secret.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: pretty + value_type: bool default_value: "false" description: Print the information in a human friendly format + deprecated: false + experimental: false examples: |- ### Inspect a secret by name or ID @@ -68,4 +74,7 @@ examples: |- 2017-03-24 08:15:09.735271783 +0000 UTC ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_secret_ls.yaml b/_data/engine-cli-edge/docker_secret_ls.yaml index 5a9dd499ae..17ab912ec5 100644 --- a/_data/engine-cli-edge/docker_secret_ls.yaml +++ b/_data/engine-cli-edge/docker_secret_ls.yaml @@ -11,13 +11,22 @@ plink: docker_secret.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print secrets using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false examples: |- ```bash $ docker secret ls @@ -130,4 +139,7 @@ examples: |- b6fa739cedf5 secret-2 3 hours ago 78a85c484f71 secret-3 10 days ago ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_secret_rm.yaml b/_data/engine-cli-edge/docker_secret_rm.yaml index 0759d3c98c..6cdd3b3c3e 100644 --- a/_data/engine-cli-edge/docker_secret_rm.yaml +++ b/_data/engine-cli-edge/docker_secret_rm.yaml @@ -19,4 +19,7 @@ examples: |- > **Warning**: Unlike `docker rm`, this command does not ask for confirmation > before removing a secret. +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_service.yaml b/_data/engine-cli-edge/docker_service.yaml index d99d94118d..bb4ae9be14 100644 --- a/_data/engine-cli-edge/docker_service.yaml +++ b/_data/engine-cli-edge/docker_service.yaml @@ -11,6 +11,7 @@ cname: - docker service ls - docker service ps - docker service rm +- docker service rollback - docker service scale - docker service update clink: @@ -20,6 +21,10 @@ clink: - docker_service_ls.yaml - docker_service_ps.yaml - docker_service_rm.yaml +- docker_service_rollback.yaml - docker_service_scale.yaml - docker_service_update.yaml +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_create.yaml b/_data/engine-cli-edge/docker_service_create.yaml index a77eb3b246..0843fc710b 100644 --- a/_data/engine-cli-edge/docker_service_create.yaml +++ b/_data/engine-cli-edge/docker_service_create.yaml @@ -8,168 +8,381 @@ pname: docker service plink: docker_service.yaml options: - option: config + value_type: config description: Specify configurations to expose to the service + deprecated: false + min_api_version: "1.30" + experimental: false - option: constraint + value_type: list description: Placement constraints + deprecated: false + experimental: false - option: container-label + value_type: list description: Container labels + deprecated: false + experimental: 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 - option: detach shorthand: d + value_type: bool default_value: "true" description: | Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false - option: dns + value_type: list description: Set custom DNS servers + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-option + value_type: list description: Set DNS options + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-search + value_type: list description: Set custom DNS search domains + deprecated: false + min_api_version: "1.25" + experimental: false - option: endpoint-mode + value_type: string default_value: vip description: Endpoint mode (vip or dnsrr) + deprecated: false + experimental: false - option: entrypoint + value_type: command description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env shorthand: e + value_type: list description: Set environment variables + deprecated: false + experimental: false - option: env-file + value_type: list description: Read in a file of environment variables + deprecated: false + experimental: 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 - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + min_api_version: "1.25" + experimental: false - option: health-start-period + value_type: duration description: | Start period for the container to initialize before counting retries towards unstable (ms|s|m|h) + deprecated: false + min_api_version: "1.29" + experimental: 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 - 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 - option: hostname + value_type: string description: Container hostname + deprecated: false + min_api_version: "1.25" + experimental: false - option: label shorthand: l + value_type: list description: Service labels + deprecated: false + experimental: false - option: limit-cpu + value_type: decimal description: Limit CPUs + deprecated: false + experimental: false - option: limit-memory + value_type: bytes default_value: "0" description: Limit Memory + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for service + deprecated: false + experimental: false - option: log-opt + value_type: list description: Logging driver options + deprecated: false + experimental: false - option: mode + value_type: string default_value: replicated description: Service mode (replicated or global) + deprecated: false + experimental: false - option: mount + value_type: mount description: Attach a filesystem mount to the service + deprecated: false + experimental: false - option: name + value_type: string description: Service name + deprecated: false + experimental: false - option: network + value_type: network description: Network attachments + deprecated: false + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + min_api_version: "1.25" + experimental: false - option: no-resolve-image + value_type: bool default_value: "false" description: | Do not query the registry to resolve image digest and supported platforms + deprecated: false + min_api_version: "1.30" + experimental: false - option: placement-pref + value_type: pref description: Add a placement preference + deprecated: false + min_api_version: "1.28" + experimental: false - option: publish shorthand: p + value_type: port description: Publish a port as a node port + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress progress output + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + min_api_version: "1.28" + experimental: false - option: replicas + value_type: uint description: Number of tasks + deprecated: false + experimental: false - option: reserve-cpu + value_type: decimal description: Reserve CPUs + deprecated: false + experimental: false - option: reserve-memory + value_type: bytes default_value: "0" description: Reserve Memory + deprecated: false + experimental: false - option: restart-condition + value_type: string description: | Restart when condition is met ("none"|"on-failure"|"any") (default "any") + deprecated: false + experimental: false - option: restart-delay + value_type: duration description: Delay between restart attempts (ns|us|ms|s|m|h) (default 5s) + deprecated: false + experimental: false - option: restart-max-attempts + value_type: uint description: Maximum number of restarts before giving up + deprecated: false + experimental: 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 - option: rollback-delay + value_type: duration default_value: 0s description: Delay between task rollbacks (ns|us|ms|s|m|h) (default 0s) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-failure-action + value_type: string description: | Action on rollback failure ("pause"|"continue") (default "pause") + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during a rollback (default 0) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-monitor + value_type: duration default_value: 0s description: | Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h) (default 5s) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-order + value_type: string description: | Rollback order ("start-first"|"stop-first") (default "stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: rollback-parallelism + value_type: uint64 default_value: "1" description: | Maximum number of tasks rolled back simultaneously (0 to roll back all at once) + deprecated: false + min_api_version: "1.28" + experimental: false - option: secret + value_type: secret description: Specify secrets to expose to the service + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: stop-signal + value_type: string description: Signal to stop the container + deprecated: false + min_api_version: "1.28" + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: update-failure-action + value_type: string description: | Action on update failure ("pause"|"continue"|"rollback") (default "pause") + deprecated: false + experimental: false - option: update-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during an update (default 0) + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-monitor + value_type: duration default_value: 0s description: | Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 5s) + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-order + value_type: string description: | Update order ("start-first"|"stop-first") (default "stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: update-parallelism + value_type: uint64 default_value: "1" description: | Maximum number of tasks updated simultaneously (0 to update all at once) + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to swarm agents + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container + deprecated: false + experimental: false examples: |- ### Create a service @@ -322,21 +535,19 @@ examples: |- For more information about labels, refer to [apply custom metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/). - ### Add bind-mounts or volumes + ### Add bind mounts, volumes or memory filesystems - Docker supports two different kinds of mounts, which allow containers to read to - or write from files or directories on other containers or the host operating - system. These types are _data volumes_ (often referred to simply as volumes) and - _bind-mounts_. + Docker supports three different kinds of mounts, which allow containers to read + from or write to files or directories, either on the host operating system, or + on memory filesystems. These types are _data volumes_ (often referred to simply + as volumes), _bind mounts_, and _tmpfs_. - Additionally, Docker supports `tmpfs` mounts. - - A **bind-mount** makes a file or directory on the host available to the - container it is mounted within. A bind-mount may be either read-only or + A **bind mount** makes a file or directory on the host available to the + container it is mounted within. A bind mount may be either read-only or read-write. For example, a container might share its host's DNS information by - means of a bind-mount of the host's `/etc/resolv.conf` or a container might + means of a bind mount of the host's `/etc/resolv.conf` or a container might write logs to its host's `/var/log/myContainerLogs` directory. If you use - bind-mounts and your host and containers have different notions of permissions, + bind mounts and your host and containers have different notions of permissions, access controls, or other such details, you will run into portability issues. A **named volume** is a mechanism for decoupling persistent data needed by your @@ -360,7 +571,7 @@ examples: |- For more information about named volumes, see [Data Volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). - The following table describes options which apply to both bind-mounts and named + The following table describes options which apply to both bind mounts and named volumes in a service: @@ -409,7 +620,7 @@ examples: |- @@ -443,15 +654,15 @@ examples: |- #### Bind Propagation Bind propagation refers to whether or not mounts created within a given - bind-mount or named volume can be propagated to replicas of that mount. Consider + bind mount or named volume can be propagated to replicas of that mount. Consider a mount point `/mnt`, which is also mounted on `/tmp`. The propation settings control whether a mount on `/tmp/a` would also be available on `/mnt/a`. Each propagation setting has a recursive counterpoint. In the case of recursion, consider that `/tmp/a` is also mounted as `/foo`. The propagation settings control whether `/mnt/a` and/or `/tmp/a` would exist. - The `bind-propagation` option defaults to `rprivate` for both bind-mounts and - volume mounts, and is only configurable for bind-mounts. In other words, named + The `bind-propagation` option defaults to `rprivate` for both bind mounts and + volume mounts, and is only configurable for bind mounts. In other words, named volumes do not support bind propagation. - **`shared`**: Sub-mounts of the original mount are exposed to replica mounts, @@ -950,4 +1161,7 @@ examples: |- x3ti0erg11rjpg64m75kej2mz-hosttempl ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_inspect.yaml b/_data/engine-cli-edge/docker_service_inspect.yaml index a0f715d4e5..f23c0cb8b4 100644 --- a/_data/engine-cli-edge/docker_service_inspect.yaml +++ b/_data/engine-cli-edge/docker_service_inspect.yaml @@ -15,10 +15,16 @@ plink: docker_service.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: pretty + value_type: bool default_value: "false" description: Print the information in a human friendly format + deprecated: false + experimental: 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 @@ -50,4 +56,7 @@ examples: "### Inspect a service by name or ID\n\nYou can inspect a service, eit option can be used to obtain specific information about a\nservice. For example, the following command outputs the number of replicas\nof the \"redis\" service.\n\n```bash\n$ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis\n\n10\n```" +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_logs.yaml b/_data/engine-cli-edge/docker_service_logs.yaml index e9ad985e1b..282c55f1aa 100644 --- a/_data/engine-cli-edge/docker_service_logs.yaml +++ b/_data/engine-cli-edge/docker_service_logs.yaml @@ -46,32 +46,64 @@ pname: docker service plink: docker_service.yaml options: - option: details + value_type: bool default_value: "false" description: Show extra details provided to logs + deprecated: false + min_api_version: "1.30" + experimental: false - option: follow shorthand: f + value_type: bool default_value: "false" description: Follow log output + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names in output + deprecated: false + experimental: false - option: no-task-ids + value_type: bool default_value: "false" description: Do not include task IDs in output + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: raw + value_type: bool default_value: "false" description: Do not neatly format logs + deprecated: false + min_api_version: "1.30" + experimental: 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 - option: tail + value_type: string default_value: all description: Number of lines to show from the end of the logs + deprecated: false + experimental: false - option: timestamps shorthand: t + value_type: bool default_value: "false" description: Show timestamps + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.29" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_ls.yaml b/_data/engine-cli-edge/docker_service_ls.yaml index e24dc6cea5..9366499ebd 100644 --- a/_data/engine-cli-edge/docker_service_ls.yaml +++ b/_data/engine-cli-edge/docker_service_ls.yaml @@ -10,13 +10,22 @@ plink: docker_service.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print services using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false examples: |- On a manager node: @@ -133,4 +142,7 @@ examples: |- 0zmvwuiu3vue: replicated 10/10 fm6uf97exkul: global 5/5 ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_ps.yaml b/_data/engine-cli-edge/docker_service_ps.yaml index 69efa95577..5af577d78f 100644 --- a/_data/engine-cli-edge/docker_service_ps.yaml +++ b/_data/engine-cli-edge/docker_service_ps.yaml @@ -9,19 +9,34 @@ plink: docker_service.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print tasks using a Go template + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display task IDs + deprecated: false + experimental: false examples: |- ### List the tasks that are part of a service @@ -168,4 +183,7 @@ examples: |- top.2: busybox top.3: busybox ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_rm.yaml b/_data/engine-cli-edge/docker_service_rm.yaml index 03fa2adccb..228a1011a1 100644 --- a/_data/engine-cli-edge/docker_service_rm.yaml +++ b/_data/engine-cli-edge/docker_service_rm.yaml @@ -22,4 +22,7 @@ examples: |- > **Warning**: Unlike `docker rm`, this command does not ask for confirmation > before removing a running service. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_rollback.yaml b/_data/engine-cli-edge/docker_service_rollback.yaml new file mode 100644 index 0000000000..e953bf7605 --- /dev/null +++ b/_data/engine-cli-edge/docker_service_rollback.yaml @@ -0,0 +1,78 @@ +command: docker service rollback +short: Revert changes to a service's configuration +long: |- + Roll back a specified service to its previous version from the swarm. This command must be run + targeting a manager node. +usage: docker service rollback [OPTIONS] SERVICE +pname: docker service +plink: docker_service.yaml +options: +- option: detach + shorthand: d + value_type: bool + default_value: "true" + description: | + Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false +- option: quiet + shorthand: q + value_type: bool + default_value: "false" + description: Suppress progress output + deprecated: false + experimental: false +examples: |- + ### Roll back to the previous version of a service + + Use the `docker service rollback` command to roll back to the previous version + of a service. After executing this command, the service is reverted to the + configuration that was in place before the most recent `docker service update` + command. + + The following example creates a service with a single replica, updates the + service to use three replicas, and then rolls back the service to the + previous version, having one replica. + + Create a service with a single replica: + + ```bash + $ docker service create --name my-service -p 8080:80 nginx:alpine + ``` + + Confirm that the service is running with a single replica: + + ```bash + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 1/1 nginx:alpine *:8080->80/tcp + ``` + + Update the service to use three replicas: + + ```bash + $ docker service update --replicas=3 my-service + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 3/3 nginx:alpine *:8080->80/tcp + ``` + + Now roll back the service to its previous version, and confirm it is + running a single replica again: + + ```bash + $ docker service rollback my-service + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 1/1 nginx:alpine *:8080->80/tcp + ``` +deprecated: false +min_api_version: "1.31" +experimental: false + diff --git a/_data/engine-cli-edge/docker_service_scale.yaml b/_data/engine-cli-edge/docker_service_scale.yaml index 62338e1aef..03937d2892 100644 --- a/_data/engine-cli-edge/docker_service_scale.yaml +++ b/_data/engine-cli-edge/docker_service_scale.yaml @@ -12,9 +12,13 @@ plink: docker_service.yaml options: - option: detach shorthand: d + value_type: bool default_value: "true" description: | Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false examples: |- ### Scale a single service @@ -74,4 +78,7 @@ examples: |- 3pr5mlvu3fh9 frontend replicated 5/5 nginx:alpine 74nzcxxjv6fq backend replicated 3/3 redis:3.0.6 ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_service_update.yaml b/_data/engine-cli-edge/docker_service_update.yaml index 5db5bdbdee..1ea04755b1 100644 --- a/_data/engine-cli-edge/docker_service_update.yaml +++ b/_data/engine-cli-edge/docker_service_update.yaml @@ -15,243 +15,610 @@ pname: docker service plink: docker_service.yaml options: - option: args + value_type: command description: Service command args + deprecated: false + experimental: 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 - option: config-rm + value_type: list description: Remove a configuration file + deprecated: false + min_api_version: "1.30" + experimental: false - option: constraint-add + value_type: list description: Add or update a placement constraint + deprecated: false + experimental: false - option: constraint-rm + value_type: list description: Remove a constraint + deprecated: false + experimental: false - option: container-label-add + value_type: list description: Add or update a container label + deprecated: false + experimental: false - option: container-label-rm + value_type: list description: Remove a container label by its key + deprecated: false + experimental: 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 - option: detach shorthand: d + value_type: bool default_value: "true" description: | Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false - option: dns-add + value_type: list description: Add or update a custom DNS server + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-option-add + value_type: list description: Add or update a DNS option + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-option-rm + value_type: list description: Remove a DNS option + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-rm + value_type: list description: Remove a custom DNS server + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: dns-search-rm + value_type: list description: Remove a DNS search domain + deprecated: false + min_api_version: "1.25" + experimental: false - option: endpoint-mode + value_type: string description: Endpoint mode (vip or dnsrr) + deprecated: false + experimental: false - option: entrypoint + value_type: command description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env-add + value_type: list description: Add or update an environment variable + deprecated: false + experimental: false - option: env-rm + value_type: list description: Remove an environment variable + deprecated: false + experimental: false - option: force + value_type: bool default_value: "false" description: Force update even if no changes require it + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: group-rm + value_type: list description: | Remove a previously added supplementary user group from the container + deprecated: false + min_api_version: "1.25" + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + min_api_version: "1.25" + experimental: false - option: health-start-period + value_type: duration description: | Start period for the container to initialize before counting retries towards unstable (ms|s|m|h) + deprecated: false + min_api_version: "1.29" + experimental: 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 - option: host-add + value_type: list description: Add or update a custom host-to-IP mapping (host:ip) + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: hostname + value_type: string description: Container hostname + deprecated: false + min_api_version: "1.25" + experimental: false - option: image + value_type: string description: Service image tag + deprecated: false + experimental: false - option: label-add + value_type: list description: Add or update a service label + deprecated: false + experimental: false - option: label-rm + value_type: list description: Remove a label by its key + deprecated: false + experimental: false - option: limit-cpu + value_type: decimal description: Limit CPUs + deprecated: false + experimental: false - option: limit-memory + value_type: bytes default_value: "0" description: Limit Memory + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for service + deprecated: false + experimental: false - option: log-opt + value_type: list description: Logging driver options + deprecated: false + experimental: false - option: mount-add + value_type: mount description: Add or update a mount on a service + deprecated: false + experimental: false - option: mount-rm + value_type: list description: Remove a mount by its target path + deprecated: false + experimental: false - option: network-add + value_type: network description: Add a network + deprecated: false + min_api_version: "1.29" + experimental: false - option: network-rm + value_type: list description: Remove a network + deprecated: false + min_api_version: "1.29" + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + min_api_version: "1.25" + experimental: false - option: no-resolve-image + value_type: bool default_value: "false" description: | Do not query the registry to resolve image digest and supported platforms + deprecated: false + min_api_version: "1.30" + experimental: false - option: placement-pref-add + value_type: pref description: Add a placement preference + deprecated: false + min_api_version: "1.28" + experimental: false - option: placement-pref-rm + value_type: pref description: Remove a placement preference + deprecated: false + min_api_version: "1.28" + experimental: false - option: publish-add + value_type: port description: Add or update a published port + deprecated: false + experimental: false - option: publish-rm + value_type: port description: Remove a published port by its target port + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress progress output + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + min_api_version: "1.28" + experimental: false - option: replicas + value_type: uint description: Number of tasks + deprecated: false + experimental: false - option: reserve-cpu + value_type: decimal description: Reserve CPUs + deprecated: false + experimental: false - option: reserve-memory + value_type: bytes default_value: "0" description: Reserve Memory + deprecated: false + experimental: false - option: restart-condition + value_type: string description: Restart when condition is met ("none"|"on-failure"|"any") + deprecated: false + experimental: false - option: restart-delay + value_type: duration description: Delay between restart attempts (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: restart-max-attempts + value_type: uint description: Maximum number of restarts before giving up + deprecated: false + experimental: 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 - option: rollback + value_type: bool default_value: "false" description: Rollback to previous specification + deprecated: false + min_api_version: "1.25" + experimental: false - option: rollback-delay + value_type: duration default_value: 0s description: Delay between task rollbacks (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-failure-action + value_type: string description: Action on rollback failure ("pause"|"continue") + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during a rollback + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-monitor + value_type: duration default_value: 0s description: | Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-order + value_type: string description: Rollback order ("start-first"|"stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: rollback-parallelism + value_type: uint64 default_value: "0" description: | Maximum number of tasks rolled back simultaneously (0 to roll back all at once) + deprecated: false + min_api_version: "1.28" + experimental: 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 - option: secret-rm + value_type: list description: Remove a secret + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: stop-signal + value_type: string description: Signal to stop the container + deprecated: false + min_api_version: "1.28" + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-delay + value_type: duration default_value: 0s description: Delay between updates (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: update-failure-action + value_type: string description: Action on update failure ("pause"|"continue"|"rollback") + deprecated: false + experimental: false - option: update-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during an update + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-monitor + value_type: duration default_value: 0s description: | Duration after each task update to monitor for failure (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-order + value_type: string description: Update order ("start-first"|"stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: update-parallelism + value_type: uint64 default_value: "0" description: | Maximum number of tasks updated simultaneously (0 to update all at once) + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to swarm agents + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container -examples: "### Update a service\n\n```bash\n$ docker service update --limit-cpu 2 - redis\n```\n\n### Perform a rolling restart with no parameter changes\n\n```bash\n$ - docker service update --force --update-parallelism 1 --update-delay 30s redis\n```\n\nIn - this example, the `--force` flag causes the service's tasks to be shut down\nand - replaced with new ones even though none of the other parameters would\nnormally - cause that to happen. The `--update-parallelism 1` setting ensures\nthat only one - task is replaced at a time (this is the default behavior). The\n`--update-delay - 30s` setting introduces a 30 second delay between tasks, so\nthat the rolling restart - happens gradually.\n\n### Add or remove mounts\n\nUse the `--mount-add` or `--mount-rm` - options add or remove a service's bind-mounts\nor volumes.\n\nThe following example - creates a service which mounts the `test-data` volume to\n`/somewhere`. The next - step updates the service to also mount the `other-volume`\nvolume to `/somewhere-else`volume, - The last step unmounts the `/somewhere` mount\npoint, effectively removing the `test-data` - volume. Each command returns the\nservice name.\n\n- The `--mount-add` flag takes - the same parameters as the `--mount` flag on\n `service create`. Refer to the [volumes - and\n bind-mounts](service_create.md#volumes-and-bind-mounts-mount) section in - the\n `service create` reference for details.\n\n- The `--mount-rm` flag takes - the `target` path of the mount.\n\n```bash\n$ docker service create \\\n --name=myservice - \\\n --mount \\\n type=volume,source=test-data,target=/somewhere \\\n nginx:alpine - \\\n myservice\n\nmyservice\n\n$ docker service update \\\n --mount-add \\\n - \ type=volume,source=other-volume,target=/somewhere-else \\\n myservice\n\nmyservice\n\n$ - docker service update --mount-rm /somewhere myservice\n\nmyservice\n```\n\n### Rolling - back to the previous version of a service \n\nUse the `--rollback` option to roll - back to the previous version of the service. \n\nThis will revert the service to - the configuration that was in place before the most recent `docker service update` - command.\n\nThe following example updates the number of replicas for the service - from 4 to 5, and then rolls back to the previous configuration.\n\n```bash\n$ docker - service update --replicas=5 web\n\nweb\n\n$ docker service ls\n\nID NAME - \ MODE REPLICAS IMAGE\n80bvrzp6vxf3 web replicated 0/5 nginx:alpine\n\n```\nRoll - back the `web` service... \n\n```bash\n$ docker service update --rollback web\n\nweb\n\n$ - docker service ls\n\nID NAME MODE REPLICAS IMAGE\n80bvrzp6vxf3 - \ web replicated 0/4 nginx:alpine\n\n```\n\nOther options can be combined - with `--rollback` as well, for example, `--update-delay 0s` to execute the rollback - without a delay between tasks:\n\n```bash\n$ docker service update \\\n --rollback - \\\n --update-delay 0s\n web\n\nweb\n\n```\n\nServices can also be set up to roll - back to the previous version automatically\nwhen an update fails. To set up a service - for automatic rollback, use\n`--update-failure-action=rollback`. A rollback will - be triggered if the fraction\nof the tasks which failed to update successfully exceeds - the value given with\n`--update-max-failure-ratio`.\n\nThe rate, parallelism, and - other parameters of a rollback operation are\ndetermined by the values passed with - the following flags:\n\n- `--rollback-delay`\n- `--rollback-failure-action`\n- `--rollback-max-failure-ratio`\n- - `--rollback-monitor`\n- `--rollback-parallelism`\n\nFor example, a service set up - with `--update-parallelism 1 --rollback-parallelism 3`\nwill update one task at - a time during a normal update, but during a rollback, 3\ntasks at a time will get - rolled back. These rollback parameters are respected both\nduring automatic rollbacks - and for rollbacks initiated manually using `--rollback`.\n\n### Add or remove secrets\n\nUse - the `--secret-add` or `--secret-rm` options add or remove a service's\nsecrets.\n\nThe - following example adds a secret named `ssh-2` and removes `ssh-1`:\n\n```bash\n$ - docker service update \\\n --secret-add source=ssh-2,target=ssh-2 \\\n --secret-rm - ssh-1 \\\n myservice\n```\n\n### Update services using templates\n\nSome flags - of `service update` support the use of templating.\nSee [`service create`](./service_create.md#templating) - for the reference." + deprecated: false + experimental: false +examples: |- + ### Update a service + + ```bash + $ docker service update --limit-cpu 2 redis + ``` + + ### Perform a rolling restart with no parameter changes + + ```bash + $ docker service update --force --update-parallelism 1 --update-delay 30s redis + ``` + + In this example, the `--force` flag causes the service's tasks to be shut down + and replaced with new ones even though none of the other parameters would + normally cause that to happen. The `--update-parallelism 1` setting ensures + that only one task is replaced at a time (this is the default behavior). The + `--update-delay 30s` setting introduces a 30 second delay between tasks, so + that the rolling restart happens gradually. + + ### Add or remove mounts + + Use the `--mount-add` or `--mount-rm` options add or remove a service's bind mounts + or volumes. + + The following example creates a service which mounts the `test-data` volume to + `/somewhere`. The next step updates the service to also mount the `other-volume` + volume to `/somewhere-else`volume, The last step unmounts the `/somewhere` mount + point, effectively removing the `test-data` volume. Each command returns the + service name. + + - The `--mount-add` flag takes the same parameters as the `--mount` flag on + `service create`. Refer to the [volumes and + bind mounts](service_create.md#volumes-and-bind-mounts-mount) section in the + `service create` reference for details. + + - The `--mount-rm` flag takes the `target` path of the mount. + + ```bash + $ docker service create \ + --name=myservice \ + --mount \ + type=volume,source=test-data,target=/somewhere \ + nginx:alpine \ + myservice + + myservice + + $ docker service update \ + --mount-add \ + type=volume,source=other-volume,target=/somewhere-else \ + myservice + + myservice + + $ docker service update --mount-rm /somewhere myservice + + myservice + ``` + + ### Roll back to the previous version of a service + + Use the `--rollback` option to roll back to the previous version of the service. + + This will revert the service to the configuration that was in place before the most recent `docker service update` command. + + The following example updates the number of replicas for the service from 4 to 5, and then rolls back to the previous configuration. + + ```bash + $ docker service update --replicas=5 web + + web + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE + 80bvrzp6vxf3 web replicated 0/5 nginx:alpine + + ``` + Roll back the `web` service... + + ```bash + $ docker service update --rollback web + + web + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE + 80bvrzp6vxf3 web replicated 0/4 nginx:alpine + + ``` + + Other options can be combined with `--rollback` as well, for example, `--update-delay 0s` to execute the rollback without a delay between tasks: + + ```bash + $ docker service update \ + --rollback \ + --update-delay 0s + web + + web + + ``` + + Services can also be set up to roll back to the previous version automatically + when an update fails. To set up a service for automatic rollback, use + `--update-failure-action=rollback`. A rollback will be triggered if the fraction + of the tasks which failed to update successfully exceeds the value given with + `--update-max-failure-ratio`. + + The rate, parallelism, and other parameters of a rollback operation are + determined by the values passed with the following flags: + + - `--rollback-delay` + - `--rollback-failure-action` + - `--rollback-max-failure-ratio` + - `--rollback-monitor` + - `--rollback-parallelism` + + For example, a service set up with `--update-parallelism 1 --rollback-parallelism 3` + will update one task at a time during a normal update, but during a rollback, 3 + tasks at a time will get rolled back. These rollback parameters are respected both + during automatic rollbacks and for rollbacks initiated manually using `--rollback`. + + ### Add or remove secrets + + Use the `--secret-add` or `--secret-rm` options add or remove a service's + secrets. + + The following example adds a secret named `ssh-2` and removes `ssh-1`: + + ```bash + $ docker service update \ + --secret-add source=ssh-2,target=ssh-2 \ + --secret-rm ssh-1 \ + myservice + ``` + + ### Update services using templates + + Some flags of `service update` support the use of templating. + See [`service create`](./service_create.md#templating) for the reference. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack.yaml b/_data/engine-cli-edge/docker_stack.yaml index ad1d4ae6ef..f0e2903f71 100644 --- a/_data/engine-cli-edge/docker_stack.yaml +++ b/_data/engine-cli-edge/docker_stack.yaml @@ -16,4 +16,7 @@ clink: - docker_stack_ps.yaml - docker_stack_rm.yaml - docker_stack_services.yaml +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack_deploy.yaml b/_data/engine-cli-edge/docker_stack_deploy.yaml index 05cf6afb96..cb165c85de 100644 --- a/_data/engine-cli-edge/docker_stack_deploy.yaml +++ b/_data/engine-cli-edge/docker_stack_deploy.yaml @@ -9,20 +9,38 @@ pname: docker stack plink: docker_stack.yaml options: - option: bundle-file + value_type: string description: Path to a Distributed Application Bundle file + deprecated: false + experimental: true - option: compose-file shorthand: c + value_type: string description: Path to a Compose file + deprecated: false + min_api_version: "1.25" + experimental: false - option: prune + value_type: bool default_value: "false" description: Prune services that are no longer referenced + deprecated: false + min_api_version: "1.27" + experimental: false - option: resolve-image + value_type: string default_value: always description: | Query the registry to resolve image digest and supported platforms ("always"|"changed"|"never") + deprecated: false + min_api_version: "1.30" + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to Swarm agents + deprecated: false + experimental: false examples: |- ### Compose file @@ -43,6 +61,23 @@ examples: |- Creating service vossibility_lookupd ``` + The Compose file can also be provided as standard input with `--compose-file -`: + + ```bash + $ cat docker-compose.yml | docker stack deploy --compose-file - vossibility + + Ignoring unsupported options: links + + Creating network vossibility_vossibility + Creating network vossibility_default + Creating service vossibility_nsqd + Creating service vossibility_logstash + Creating service vossibility_elasticsearch + Creating service vossibility_kibana + Creating service vossibility_ghollector + 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 @@ -105,4 +140,7 @@ examples: |- 9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack_ls.yaml b/_data/engine-cli-edge/docker_stack_ls.yaml index c2c41839a2..7afdf7e84f 100644 --- a/_data/engine-cli-edge/docker_stack_ls.yaml +++ b/_data/engine-cli-edge/docker_stack_ls.yaml @@ -7,7 +7,10 @@ pname: docker stack plink: docker_stack.yaml options: - option: format + value_type: string description: Pretty-print stacks using a Go template + deprecated: false + experimental: false examples: |- The following command shows all stacks and some additional information: @@ -42,4 +45,7 @@ examples: |- web-server: 1 web-cache: 4 ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack_ps.yaml b/_data/engine-cli-edge/docker_stack_ps.yaml index 1cdc7b5c92..5d4c65d35f 100644 --- a/_data/engine-cli-edge/docker_stack_ps.yaml +++ b/_data/engine-cli-edge/docker_stack_ps.yaml @@ -9,19 +9,34 @@ plink: docker_stack.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print tasks using a Go template + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display task IDs + deprecated: false + experimental: false examples: |- ### List the tasks that are part of a stack @@ -208,4 +223,7 @@ examples: |- "Version": { (...) ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack_rm.yaml b/_data/engine-cli-edge/docker_stack_rm.yaml index dcdd30420e..e32c67671e 100644 --- a/_data/engine-cli-edge/docker_stack_rm.yaml +++ b/_data/engine-cli-edge/docker_stack_rm.yaml @@ -43,4 +43,7 @@ examples: |- Removing network vossibility_default Removing network vossibility_vossibility ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_stack_services.yaml b/_data/engine-cli-edge/docker_stack_services.yaml index bfb96e0533..526c6829ff 100644 --- a/_data/engine-cli-edge/docker_stack_services.yaml +++ b/_data/engine-cli-edge/docker_stack_services.yaml @@ -9,13 +9,22 @@ plink: docker_stack.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print services using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false examples: |- The following command shows all services in the `myapp` stack: @@ -77,4 +86,7 @@ examples: |- 0zmvwuiu3vue: replicated 10/10 fm6uf97exkul: global 5/5 ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_start.yaml b/_data/engine-cli-edge/docker_start.yaml index d75b08b6d6..b87b37dd83 100644 --- a/_data/engine-cli-edge/docker_start.yaml +++ b/_data/engine-cli-edge/docker_start.yaml @@ -7,20 +7,37 @@ plink: docker.yaml options: - option: attach shorthand: a + value_type: bool default_value: "false" description: Attach STDOUT/STDERR and forward signals + deprecated: false + experimental: false - option: checkpoint + value_type: string description: Restore from this checkpoint + deprecated: false + experimental: true - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: true - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Attach container's STDIN + deprecated: false + experimental: false examples: |- ```bash $ docker start my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_stats.yaml b/_data/engine-cli-edge/docker_stats.yaml index 23d95475df..be96d16bec 100644 --- a/_data/engine-cli-edge/docker_stats.yaml +++ b/_data/engine-cli-edge/docker_stats.yaml @@ -10,13 +10,22 @@ plink: docker.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all containers (default shows just running) + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: no-stream + value_type: bool default_value: "false" description: Disable streaming stats and only pull the first result + deprecated: false + experimental: false examples: |- Running `docker stats` on all running containers against a Linux daemon. @@ -121,4 +130,6 @@ examples: |- 9c76f7834ae2 0.07% 2.746 MiB / 64 MiB d1ea048f04e4 0.03% 4.583 MiB / 64 MiB ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_stop.yaml b/_data/engine-cli-edge/docker_stop.yaml index c650227858..8667f6ad7b 100644 --- a/_data/engine-cli-edge/docker_stop.yaml +++ b/_data/engine-cli-edge/docker_stop.yaml @@ -9,10 +9,15 @@ plink: docker.yaml options: - option: time shorthand: t + value_type: int default_value: "10" description: Seconds to wait for stop before killing it + deprecated: false + experimental: false examples: |- ```bash $ docker stop my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm.yaml b/_data/engine-cli-edge/docker_swarm.yaml index c9c48e986a..86d210cdfd 100644 --- a/_data/engine-cli-edge/docker_swarm.yaml +++ b/_data/engine-cli-edge/docker_swarm.yaml @@ -22,4 +22,7 @@ clink: - docker_swarm_unlock.yaml - docker_swarm_unlock-key.yaml - docker_swarm_update.yaml +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_ca.yaml b/_data/engine-cli-edge/docker_swarm_ca.yaml index 287d4c672a..153b0f9760 100644 --- a/_data/engine-cli-edge/docker_swarm_ca.yaml +++ b/_data/engine-cli-edge/docker_swarm_ca.yaml @@ -7,29 +7,50 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: ca-cert + value_type: pem-file description: | Path to the PEM-formatted root CA certificate to use for the new cluster + deprecated: false + experimental: 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 - 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 - option: detach shorthand: d + value_type: bool default_value: "false" description: | Exit immediately instead of waiting for the root rotation to converge + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress progress output + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: | Rotate the swarm CA - if no certificate or key are provided, new ones will be generated + deprecated: false + experimental: false examples: |- Run the `docker swarm ca` command without any options to view the current root CA certificate in PEM format. @@ -105,4 +126,7 @@ examples: |- Initiate the root CA rotation, but do not wait for the completion of or display the progress of the rotation. +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_init.yaml b/_data/engine-cli-edge/docker_swarm_init.yaml index 1821d6b9d9..788a34aa27 100644 --- a/_data/engine-cli-edge/docker_swarm_init.yaml +++ b/_data/engine-cli-edge/docker_swarm_init.yaml @@ -8,40 +8,78 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: advertise-addr + value_type: string description: 'Advertised address (format: [:port])' + deprecated: false + experimental: false - option: autolock + value_type: bool default_value: "false" description: | Enable manager autolocking (requiring an unlock key to start a stopped manager) + deprecated: false + experimental: false - option: availability + value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") + deprecated: false + experimental: 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 - option: data-path-addr + value_type: string description: | Address or interface to use for data path traffic (format: ) + deprecated: false + experimental: false - option: dispatcher-heartbeat + value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: force-new-cluster + value_type: bool default_value: "false" description: Force create a new cluster from current state + deprecated: false + experimental: false - option: listen-addr + value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' + deprecated: false + experimental: false - option: max-snapshots + value_type: uint64 default_value: "0" description: Number of additional Raft snapshots to retain + deprecated: false + min_api_version: "1.25" + experimental: false - option: snapshot-interval + value_type: uint64 default_value: "10000" description: Number of log entries between Raft snapshots + deprecated: false + min_api_version: "1.25" + experimental: false - option: task-history-limit + value_type: int64 default_value: "5" description: Task history retention limit + deprecated: false + experimental: false examples: |- ```bash $ docker swarm init --advertise-addr 192.168.99.121 @@ -155,4 +193,7 @@ examples: |- This flag is useful in certain situations. For example, a cluster may want to have dedicated manager nodes that are not served as worker nodes. This could be achieved by passing `--availability=drain` to `docker swarm init`. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_join-token.yaml b/_data/engine-cli-edge/docker_swarm_join-token.yaml index 326572db1c..25f87affb6 100644 --- a/_data/engine-cli-edge/docker_swarm_join-token.yaml +++ b/_data/engine-cli-edge/docker_swarm_join-token.yaml @@ -7,9 +7,18 @@ plink: docker_swarm.yaml options: - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display token + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: Rotate join token + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_join.yaml b/_data/engine-cli-edge/docker_swarm_join.yaml index 47fd58c016..eb753b238b 100644 --- a/_data/engine-cli-edge/docker_swarm_join.yaml +++ b/_data/engine-cli-edge/docker_swarm_join.yaml @@ -9,18 +9,33 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: advertise-addr + value_type: string description: 'Advertised address (format: [:port])' + deprecated: false + experimental: false - option: availability + value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") + deprecated: false + experimental: false - option: data-path-addr + value_type: string description: | Address or interface to use for data path traffic (format: ) + deprecated: false + experimental: false - option: listen-addr + value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' + deprecated: false + experimental: false - option: token + value_type: string description: Token for entry into the swarm + deprecated: false + experimental: false examples: |- ### Join a node to swarm as a manager @@ -102,4 +117,7 @@ examples: |- This flag is useful in certain situations. For example, a cluster may want to have dedicated manager nodes that are not served as worker nodes. This could be achieved by passing `--availability=drain` to `docker swarm join`. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_leave.yaml b/_data/engine-cli-edge/docker_swarm_leave.yaml index d489a086a9..826ece6c16 100644 --- a/_data/engine-cli-edge/docker_swarm_leave.yaml +++ b/_data/engine-cli-edge/docker_swarm_leave.yaml @@ -15,8 +15,11 @@ plink: docker_swarm.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force this node to leave the swarm, ignoring warnings + deprecated: false + experimental: false examples: |- Consider the following swarm, as seen from the manager: @@ -39,4 +42,7 @@ examples: |- affects swarm operation, but a long list of `down` nodes can clutter the node list. To remove an inactive node from the list, use the [`node rm`](node_rm.md) command. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_unlock-key.yaml b/_data/engine-cli-edge/docker_swarm_unlock-key.yaml index 38f93daf1b..faad356aba 100644 --- a/_data/engine-cli-edge/docker_swarm_unlock-key.yaml +++ b/_data/engine-cli-edge/docker_swarm_unlock-key.yaml @@ -7,9 +7,18 @@ plink: docker_swarm.yaml options: - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display token + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: Rotate unlock key + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_unlock.yaml b/_data/engine-cli-edge/docker_swarm_unlock.yaml index 5f5b313083..fd7e84e23d 100644 --- a/_data/engine-cli-edge/docker_swarm_unlock.yaml +++ b/_data/engine-cli-edge/docker_swarm_unlock.yaml @@ -13,4 +13,7 @@ examples: |- $ docker swarm unlock Please enter unlock key: ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_swarm_update.yaml b/_data/engine-cli-edge/docker_swarm_update.yaml index cea124c154..30e889b154 100644 --- a/_data/engine-cli-edge/docker_swarm_update.yaml +++ b/_data/engine-cli-edge/docker_swarm_update.yaml @@ -7,27 +7,53 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: autolock + value_type: bool default_value: "false" description: Change manager autolocking setting (true|false) + deprecated: false + experimental: 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 - option: dispatcher-heartbeat + value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: max-snapshots + value_type: uint64 default_value: "0" description: Number of additional Raft snapshots to retain + deprecated: false + min_api_version: "1.25" + experimental: false - option: snapshot-interval + value_type: uint64 default_value: "10000" description: Number of log entries between Raft snapshots + deprecated: false + min_api_version: "1.25" + experimental: false - option: task-history-limit + value_type: int64 default_value: "5" description: Task history retention limit + deprecated: false + experimental: false examples: |- ```bash $ docker swarm update --cert-expiry 720h ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli-edge/docker_system.yaml b/_data/engine-cli-edge/docker_system.yaml index 12a585ecf8..f6b66a9168 100644 --- a/_data/engine-cli-edge/docker_system.yaml +++ b/_data/engine-cli-edge/docker_system.yaml @@ -14,4 +14,6 @@ clink: - docker_system_events.yaml - docker_system_info.yaml - docker_system_prune.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_system_df.yaml b/_data/engine-cli-edge/docker_system_df.yaml index de6bf0ff40..03fe99e459 100644 --- a/_data/engine-cli-edge/docker_system_df.yaml +++ b/_data/engine-cli-edge/docker_system_df.yaml @@ -8,11 +8,17 @@ pname: docker system plink: docker_system.yaml options: - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: verbose shorthand: v + value_type: bool default_value: "false" description: Show detailed information on space usage + deprecated: false + experimental: false examples: |- By default the command will just show a summary of the data used: @@ -58,4 +64,7 @@ examples: |- > **Note**: Network information is not shown because it doesn't consume the disk > space. +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_system_events.yaml b/_data/engine-cli-edge/docker_system_events.yaml index 0f3e06818b..db71b662df 100644 --- a/_data/engine-cli-edge/docker_system_events.yaml +++ b/_data/engine-cli-edge/docker_system_events.yaml @@ -138,13 +138,25 @@ plink: docker_system.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: since + value_type: string description: Show all events created since timestamp + deprecated: false + experimental: false - option: until + value_type: string description: Stream events until this timestamp + deprecated: false + experimental: false examples: |- ### Basic example @@ -325,4 +337,6 @@ examples: |- {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_system_info.yaml b/_data/engine-cli-edge/docker_system_info.yaml index 1c01d7c47d..1fac9a8088 100644 --- a/_data/engine-cli-edge/docker_system_info.yaml +++ b/_data/engine-cli-edge/docker_system_info.yaml @@ -7,5 +7,10 @@ plink: docker_system.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_system_prune.yaml b/_data/engine-cli-edge/docker_system_prune.yaml index ce5fc4abc1..d89aa09ee8 100644 --- a/_data/engine-cli-edge/docker_system_prune.yaml +++ b/_data/engine-cli-edge/docker_system_prune.yaml @@ -8,17 +8,30 @@ plink: docker_system.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Remove all unused images not just dangling ones + deprecated: false + experimental: false - option: filter + value_type: filter description: Provide filter values (e.g. 'label==') + deprecated: false + min_api_version: "1.28" + experimental: false - option: force shorthand: f + value_type: bool default_value: "false" description: Do not prompt for confirmation + deprecated: false + experimental: false - option: volumes + value_type: bool default_value: "false" description: Prune volumes + deprecated: false + experimental: false examples: "```bash\n$ docker system prune -a\n\nWARNING! This will remove:\n\t- all stopped containers\n\t- all volumes not used by at least one container\n\t- all networks not used by at least one container\n\t- all images without at least one @@ -55,4 +68,7 @@ examples: "```bash\n$ docker system prune -a\n\nWARNING! This will remove:\n\t- with the specified labels. The other\nformat is the `label!=...` (`label!=` or `label!==`), which removes\ncontainers, images, networks, and volumes without the specified labels." +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli-edge/docker_tag.yaml b/_data/engine-cli-edge/docker_tag.yaml index e8554a7260..84dc216c05 100644 --- a/_data/engine-cli-edge/docker_tag.yaml +++ b/_data/engine-cli-edge/docker_tag.yaml @@ -58,4 +58,6 @@ examples: |- ```bash $ docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0 ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_top.yaml b/_data/engine-cli-edge/docker_top.yaml index c4cda8bb6e..40ec70aad5 100644 --- a/_data/engine-cli-edge/docker_top.yaml +++ b/_data/engine-cli-edge/docker_top.yaml @@ -4,4 +4,6 @@ long: Display the running processes of a container usage: docker top CONTAINER [ps OPTIONS] pname: docker plink: docker.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_unpause.yaml b/_data/engine-cli-edge/docker_unpause.yaml index 9ef98f1efb..6413eda0c1 100644 --- a/_data/engine-cli-edge/docker_unpause.yaml +++ b/_data/engine-cli-edge/docker_unpause.yaml @@ -14,4 +14,6 @@ examples: |- ```bash $ docker unpause my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_update.yaml b/_data/engine-cli-edge/docker_update.yaml index de5d4e2f0a..8cbc0e612d 100644 --- a/_data/engine-cli-edge/docker_update.yaml +++ b/_data/engine-cli-edge/docker_update.yaml @@ -11,52 +11,101 @@ long: |- options on a running or a stopped container. On kernel version older than 4.6, you can only update `--kernel-memory` on a stopped container or on a running container with kernel memory initialized. + + > **Warning**: The `docker update` and `docker container update` commands are + > not supported for Windows containers. + {: .warning } usage: docker update [OPTIONS] CONTAINER [CONTAINER...] pname: docker plink: docker.yaml options: - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit the CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit the CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.29" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: restart + value_type: string description: Restart policy to apply when a container exits + deprecated: false + experimental: false examples: |- The following sections illustrate ways to use this command. @@ -126,4 +175,6 @@ examples: |- Note that if the container is started with "--rm" flag, you cannot update the restart policy for it. The `AutoRemove` and `RestartPolicy` are mutually exclusive for the container. +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_version.yaml b/_data/engine-cli-edge/docker_version.yaml index 294738cc4f..c77c34532d 100644 --- a/_data/engine-cli-edge/docker_version.yaml +++ b/_data/engine-cli-edge/docker_version.yaml @@ -12,7 +12,10 @@ plink: docker.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ### Default output @@ -51,4 +54,6 @@ examples: |- {"Client":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"},"ServerOK":true,"Server":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","KernelVersion":"3.13.2-gentoo","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"}} ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli-edge/docker_volume.yaml b/_data/engine-cli-edge/docker_volume.yaml index ad5134eae0..e1cc74a696 100644 --- a/_data/engine-cli-edge/docker_volume.yaml +++ b/_data/engine-cli-edge/docker_volume.yaml @@ -18,4 +18,7 @@ clink: - docker_volume_ls.yaml - docker_volume_prune.yaml - docker_volume_rm.yaml +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli-edge/docker_volume_create.yaml b/_data/engine-cli-edge/docker_volume_create.yaml index 8b774d254b..7b5dc2266f 100644 --- a/_data/engine-cli-edge/docker_volume_create.yaml +++ b/_data/engine-cli-edge/docker_volume_create.yaml @@ -9,16 +9,28 @@ plink: docker_volume.yaml options: - option: driver shorthand: d + value_type: string default_value: local description: Specify volume driver name + deprecated: false + experimental: false - option: label + value_type: list description: Set metadata for a volume + deprecated: false + experimental: false - option: name + value_type: string description: Specify volume name + deprecated: false + experimental: false - option: opt shorthand: o + value_type: map default_value: map[] description: Set driver specific options + deprecated: false + experimental: false examples: |- Create a volume and then configure the container to use it: @@ -101,4 +113,7 @@ examples: |- --opt device=:/path/to/dir \ foo ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli-edge/docker_volume_inspect.yaml b/_data/engine-cli-edge/docker_volume_inspect.yaml index 460bdc3e71..4af3cf3b62 100644 --- a/_data/engine-cli-edge/docker_volume_inspect.yaml +++ b/_data/engine-cli-edge/docker_volume_inspect.yaml @@ -12,7 +12,10 @@ plink: docker_volume.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ```bash $ docker volume create @@ -30,4 +33,7 @@ examples: |- $ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d /var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli-edge/docker_volume_ls.yaml b/_data/engine-cli-edge/docker_volume_ls.yaml index 95499710c4..1f55ae1d94 100644 --- a/_data/engine-cli-edge/docker_volume_ls.yaml +++ b/_data/engine-cli-edge/docker_volume_ls.yaml @@ -11,13 +11,22 @@ plink: docker_volume.yaml options: - option: filter shorthand: f + value_type: filter description: Provide filter values (e.g. 'dangling=true') + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print volumes using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display volume names + deprecated: false + experimental: false examples: |- ### Create a volume ```bash @@ -145,11 +154,11 @@ examples: |- Placeholder | Description --------------|------------------------------------------------------------------------------------------ - `.Name` | Network name - `.Driver` | Network driver - `.Scope` | Network scope (local, global) - `.Mountpoint` | Whether the network is internal or not. - `.Labels` | All labels assigned to the volume. + `.Name` | Volume name + `.Driver` | Volume driver + `.Scope` | Volume scope (local, global) + `.Mountpoint` | The mount point of the volume on the host + `.Labels` | All labels assigned to the volume `.Label` | Value of a specific label for this volume. For example `{{.Label "project.version"}}` When using the `--format` option, the `volume ls` command will either @@ -166,4 +175,7 @@ examples: |- vol2: local vol3: local ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli-edge/docker_volume_prune.yaml b/_data/engine-cli-edge/docker_volume_prune.yaml index e18f78a667..920b3f54dd 100644 --- a/_data/engine-cli-edge/docker_volume_prune.yaml +++ b/_data/engine-cli-edge/docker_volume_prune.yaml @@ -7,11 +7,17 @@ pname: docker volume plink: docker_volume.yaml options: - option: filter + value_type: filter description: Provide filter values (e.g. 'label=

Mount path inside the container, for example /some/path/in/container/. If the path does not exist in the container's filesystem, the Engine creates - a directory at the specified location before mounting the volume or bind-mount.

+ a directory at the specified location before mounting the volume or bind mount.
@@ -409,7 +620,7 @@ examples: |- @@ -443,15 +654,15 @@ examples: |- #### Bind Propagation Bind propagation refers to whether or not mounts created within a given - bind-mount or named volume can be propagated to replicas of that mount. Consider + bind mount or named volume can be propagated to replicas of that mount. Consider a mount point `/mnt`, which is also mounted on `/tmp`. The propation settings control whether a mount on `/tmp/a` would also be available on `/mnt/a`. Each propagation setting has a recursive counterpoint. In the case of recursion, consider that `/tmp/a` is also mounted as `/foo`. The propagation settings control whether `/mnt/a` and/or `/tmp/a` would exist. - The `bind-propagation` option defaults to `rprivate` for both bind-mounts and - volume mounts, and is only configurable for bind-mounts. In other words, named + The `bind-propagation` option defaults to `rprivate` for both bind mounts and + volume mounts, and is only configurable for bind mounts. In other words, named volumes do not support bind propagation. - **`shared`**: Sub-mounts of the original mount are exposed to replica mounts, @@ -950,4 +1161,7 @@ examples: |- x3ti0erg11rjpg64m75kej2mz-hosttempl ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_inspect.yaml b/_data/engine-cli/docker_service_inspect.yaml index a0f715d4e5..f23c0cb8b4 100644 --- a/_data/engine-cli/docker_service_inspect.yaml +++ b/_data/engine-cli/docker_service_inspect.yaml @@ -15,10 +15,16 @@ plink: docker_service.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: pretty + value_type: bool default_value: "false" description: Print the information in a human friendly format + deprecated: false + experimental: 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 @@ -50,4 +56,7 @@ examples: "### Inspect a service by name or ID\n\nYou can inspect a service, eit option can be used to obtain specific information about a\nservice. For example, the following command outputs the number of replicas\nof the \"redis\" service.\n\n```bash\n$ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis\n\n10\n```" +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_logs.yaml b/_data/engine-cli/docker_service_logs.yaml index e9ad985e1b..282c55f1aa 100644 --- a/_data/engine-cli/docker_service_logs.yaml +++ b/_data/engine-cli/docker_service_logs.yaml @@ -46,32 +46,64 @@ pname: docker service plink: docker_service.yaml options: - option: details + value_type: bool default_value: "false" description: Show extra details provided to logs + deprecated: false + min_api_version: "1.30" + experimental: false - option: follow shorthand: f + value_type: bool default_value: "false" description: Follow log output + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names in output + deprecated: false + experimental: false - option: no-task-ids + value_type: bool default_value: "false" description: Do not include task IDs in output + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: raw + value_type: bool default_value: "false" description: Do not neatly format logs + deprecated: false + min_api_version: "1.30" + experimental: 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 - option: tail + value_type: string default_value: all description: Number of lines to show from the end of the logs + deprecated: false + experimental: false - option: timestamps shorthand: t + value_type: bool default_value: "false" description: Show timestamps + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.29" +experimental: false diff --git a/_data/engine-cli/docker_service_ls.yaml b/_data/engine-cli/docker_service_ls.yaml index e24dc6cea5..9366499ebd 100644 --- a/_data/engine-cli/docker_service_ls.yaml +++ b/_data/engine-cli/docker_service_ls.yaml @@ -10,13 +10,22 @@ plink: docker_service.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print services using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false examples: |- On a manager node: @@ -133,4 +142,7 @@ examples: |- 0zmvwuiu3vue: replicated 10/10 fm6uf97exkul: global 5/5 ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_ps.yaml b/_data/engine-cli/docker_service_ps.yaml index 69efa95577..5af577d78f 100644 --- a/_data/engine-cli/docker_service_ps.yaml +++ b/_data/engine-cli/docker_service_ps.yaml @@ -9,19 +9,34 @@ plink: docker_service.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print tasks using a Go template + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display task IDs + deprecated: false + experimental: false examples: |- ### List the tasks that are part of a service @@ -168,4 +183,7 @@ examples: |- top.2: busybox top.3: busybox ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_rm.yaml b/_data/engine-cli/docker_service_rm.yaml index 03fa2adccb..228a1011a1 100644 --- a/_data/engine-cli/docker_service_rm.yaml +++ b/_data/engine-cli/docker_service_rm.yaml @@ -22,4 +22,7 @@ examples: |- > **Warning**: Unlike `docker rm`, this command does not ask for confirmation > before removing a running service. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_rollback.yaml b/_data/engine-cli/docker_service_rollback.yaml new file mode 100644 index 0000000000..e953bf7605 --- /dev/null +++ b/_data/engine-cli/docker_service_rollback.yaml @@ -0,0 +1,78 @@ +command: docker service rollback +short: Revert changes to a service's configuration +long: |- + Roll back a specified service to its previous version from the swarm. This command must be run + targeting a manager node. +usage: docker service rollback [OPTIONS] SERVICE +pname: docker service +plink: docker_service.yaml +options: +- option: detach + shorthand: d + value_type: bool + default_value: "true" + description: | + Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false +- option: quiet + shorthand: q + value_type: bool + default_value: "false" + description: Suppress progress output + deprecated: false + experimental: false +examples: |- + ### Roll back to the previous version of a service + + Use the `docker service rollback` command to roll back to the previous version + of a service. After executing this command, the service is reverted to the + configuration that was in place before the most recent `docker service update` + command. + + The following example creates a service with a single replica, updates the + service to use three replicas, and then rolls back the service to the + previous version, having one replica. + + Create a service with a single replica: + + ```bash + $ docker service create --name my-service -p 8080:80 nginx:alpine + ``` + + Confirm that the service is running with a single replica: + + ```bash + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 1/1 nginx:alpine *:8080->80/tcp + ``` + + Update the service to use three replicas: + + ```bash + $ docker service update --replicas=3 my-service + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 3/3 nginx:alpine *:8080->80/tcp + ``` + + Now roll back the service to its previous version, and confirm it is + running a single replica again: + + ```bash + $ docker service rollback my-service + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE PORTS + xbw728mf6q0d my-service replicated 1/1 nginx:alpine *:8080->80/tcp + ``` +deprecated: false +min_api_version: "1.31" +experimental: false + diff --git a/_data/engine-cli/docker_service_scale.yaml b/_data/engine-cli/docker_service_scale.yaml index 3e4e387ce3..03937d2892 100644 --- a/_data/engine-cli/docker_service_scale.yaml +++ b/_data/engine-cli/docker_service_scale.yaml @@ -9,6 +9,16 @@ long: |- usage: docker service scale SERVICE=REPLICAS [SERVICE=REPLICAS...] pname: docker service plink: docker_service.yaml +options: +- option: detach + shorthand: d + value_type: bool + default_value: "true" + description: | + Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false examples: |- ### Scale a single service @@ -68,4 +78,7 @@ examples: |- 3pr5mlvu3fh9 frontend replicated 5/5 nginx:alpine 74nzcxxjv6fq backend replicated 3/3 redis:3.0.6 ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_service_update.yaml b/_data/engine-cli/docker_service_update.yaml index 5db5bdbdee..1ea04755b1 100644 --- a/_data/engine-cli/docker_service_update.yaml +++ b/_data/engine-cli/docker_service_update.yaml @@ -15,243 +15,610 @@ pname: docker service plink: docker_service.yaml options: - option: args + value_type: command description: Service command args + deprecated: false + experimental: 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 - option: config-rm + value_type: list description: Remove a configuration file + deprecated: false + min_api_version: "1.30" + experimental: false - option: constraint-add + value_type: list description: Add or update a placement constraint + deprecated: false + experimental: false - option: constraint-rm + value_type: list description: Remove a constraint + deprecated: false + experimental: false - option: container-label-add + value_type: list description: Add or update a container label + deprecated: false + experimental: false - option: container-label-rm + value_type: list description: Remove a container label by its key + deprecated: false + experimental: 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 - option: detach shorthand: d + value_type: bool default_value: "true" description: | Exit immediately instead of waiting for the service to converge + deprecated: false + min_api_version: "1.29" + experimental: false - option: dns-add + value_type: list description: Add or update a custom DNS server + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-option-add + value_type: list description: Add or update a DNS option + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-option-rm + value_type: list description: Remove a DNS option + deprecated: false + min_api_version: "1.25" + experimental: false - option: dns-rm + value_type: list description: Remove a custom DNS server + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: dns-search-rm + value_type: list description: Remove a DNS search domain + deprecated: false + min_api_version: "1.25" + experimental: false - option: endpoint-mode + value_type: string description: Endpoint mode (vip or dnsrr) + deprecated: false + experimental: false - option: entrypoint + value_type: command description: Overwrite the default ENTRYPOINT of the image + deprecated: false + experimental: false - option: env-add + value_type: list description: Add or update an environment variable + deprecated: false + experimental: false - option: env-rm + value_type: list description: Remove an environment variable + deprecated: false + experimental: false - option: force + value_type: bool default_value: "false" description: Force update even if no changes require it + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: group-rm + value_type: list description: | Remove a previously added supplementary user group from the container + deprecated: false + min_api_version: "1.25" + experimental: false - option: health-cmd + value_type: string description: Command to run to check health + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: health-retries + value_type: int default_value: "0" description: Consecutive failures needed to report unhealthy + deprecated: false + min_api_version: "1.25" + experimental: false - option: health-start-period + value_type: duration description: | Start period for the container to initialize before counting retries towards unstable (ms|s|m|h) + deprecated: false + min_api_version: "1.29" + experimental: 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 - option: host-add + value_type: list description: Add or update a custom host-to-IP mapping (host:ip) + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: hostname + value_type: string description: Container hostname + deprecated: false + min_api_version: "1.25" + experimental: false - option: image + value_type: string description: Service image tag + deprecated: false + experimental: false - option: label-add + value_type: list description: Add or update a service label + deprecated: false + experimental: false - option: label-rm + value_type: list description: Remove a label by its key + deprecated: false + experimental: false - option: limit-cpu + value_type: decimal description: Limit CPUs + deprecated: false + experimental: false - option: limit-memory + value_type: bytes default_value: "0" description: Limit Memory + deprecated: false + experimental: false - option: log-driver + value_type: string description: Logging driver for service + deprecated: false + experimental: false - option: log-opt + value_type: list description: Logging driver options + deprecated: false + experimental: false - option: mount-add + value_type: mount description: Add or update a mount on a service + deprecated: false + experimental: false - option: mount-rm + value_type: list description: Remove a mount by its target path + deprecated: false + experimental: false - option: network-add + value_type: network description: Add a network + deprecated: false + min_api_version: "1.29" + experimental: false - option: network-rm + value_type: list description: Remove a network + deprecated: false + min_api_version: "1.29" + experimental: false - option: no-healthcheck + value_type: bool default_value: "false" description: Disable any container-specified HEALTHCHECK + deprecated: false + min_api_version: "1.25" + experimental: false - option: no-resolve-image + value_type: bool default_value: "false" description: | Do not query the registry to resolve image digest and supported platforms + deprecated: false + min_api_version: "1.30" + experimental: false - option: placement-pref-add + value_type: pref description: Add a placement preference + deprecated: false + min_api_version: "1.28" + experimental: false - option: placement-pref-rm + value_type: pref description: Remove a placement preference + deprecated: false + min_api_version: "1.28" + experimental: false - option: publish-add + value_type: port description: Add or update a published port + deprecated: false + experimental: false - option: publish-rm + value_type: port description: Remove a published port by its target port + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress progress output + deprecated: false + experimental: false - option: read-only + value_type: bool default_value: "false" description: Mount the container's root filesystem as read only + deprecated: false + min_api_version: "1.28" + experimental: false - option: replicas + value_type: uint description: Number of tasks + deprecated: false + experimental: false - option: reserve-cpu + value_type: decimal description: Reserve CPUs + deprecated: false + experimental: false - option: reserve-memory + value_type: bytes default_value: "0" description: Reserve Memory + deprecated: false + experimental: false - option: restart-condition + value_type: string description: Restart when condition is met ("none"|"on-failure"|"any") + deprecated: false + experimental: false - option: restart-delay + value_type: duration description: Delay between restart attempts (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: restart-max-attempts + value_type: uint description: Maximum number of restarts before giving up + deprecated: false + experimental: 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 - option: rollback + value_type: bool default_value: "false" description: Rollback to previous specification + deprecated: false + min_api_version: "1.25" + experimental: false - option: rollback-delay + value_type: duration default_value: 0s description: Delay between task rollbacks (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-failure-action + value_type: string description: Action on rollback failure ("pause"|"continue") + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during a rollback + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-monitor + value_type: duration default_value: 0s description: | Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.28" + experimental: false - option: rollback-order + value_type: string description: Rollback order ("start-first"|"stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: rollback-parallelism + value_type: uint64 default_value: "0" description: | Maximum number of tasks rolled back simultaneously (0 to roll back all at once) + deprecated: false + min_api_version: "1.28" + experimental: 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 - option: secret-rm + value_type: list description: Remove a secret + deprecated: false + min_api_version: "1.25" + experimental: 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 - option: stop-signal + value_type: string description: Signal to stop the container + deprecated: false + min_api_version: "1.28" + experimental: false - option: tty shorthand: t + value_type: bool default_value: "false" description: Allocate a pseudo-TTY + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-delay + value_type: duration default_value: 0s description: Delay between updates (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: update-failure-action + value_type: string description: Action on update failure ("pause"|"continue"|"rollback") + deprecated: false + experimental: false - option: update-max-failure-ratio + value_type: float default_value: "0" description: Failure rate to tolerate during an update + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-monitor + value_type: duration default_value: 0s description: | Duration after each task update to monitor for failure (ns|us|ms|s|m|h) + deprecated: false + min_api_version: "1.25" + experimental: false - option: update-order + value_type: string description: Update order ("start-first"|"stop-first") + deprecated: false + min_api_version: "1.29" + experimental: false - option: update-parallelism + value_type: uint64 default_value: "0" description: | Maximum number of tasks updated simultaneously (0 to update all at once) + deprecated: false + experimental: false - option: user shorthand: u + value_type: string description: 'Username or UID (format: [:])' + deprecated: false + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to swarm agents + deprecated: false + experimental: false - option: workdir shorthand: w + value_type: string description: Working directory inside the container -examples: "### Update a service\n\n```bash\n$ docker service update --limit-cpu 2 - redis\n```\n\n### Perform a rolling restart with no parameter changes\n\n```bash\n$ - docker service update --force --update-parallelism 1 --update-delay 30s redis\n```\n\nIn - this example, the `--force` flag causes the service's tasks to be shut down\nand - replaced with new ones even though none of the other parameters would\nnormally - cause that to happen. The `--update-parallelism 1` setting ensures\nthat only one - task is replaced at a time (this is the default behavior). The\n`--update-delay - 30s` setting introduces a 30 second delay between tasks, so\nthat the rolling restart - happens gradually.\n\n### Add or remove mounts\n\nUse the `--mount-add` or `--mount-rm` - options add or remove a service's bind-mounts\nor volumes.\n\nThe following example - creates a service which mounts the `test-data` volume to\n`/somewhere`. The next - step updates the service to also mount the `other-volume`\nvolume to `/somewhere-else`volume, - The last step unmounts the `/somewhere` mount\npoint, effectively removing the `test-data` - volume. Each command returns the\nservice name.\n\n- The `--mount-add` flag takes - the same parameters as the `--mount` flag on\n `service create`. Refer to the [volumes - and\n bind-mounts](service_create.md#volumes-and-bind-mounts-mount) section in - the\n `service create` reference for details.\n\n- The `--mount-rm` flag takes - the `target` path of the mount.\n\n```bash\n$ docker service create \\\n --name=myservice - \\\n --mount \\\n type=volume,source=test-data,target=/somewhere \\\n nginx:alpine - \\\n myservice\n\nmyservice\n\n$ docker service update \\\n --mount-add \\\n - \ type=volume,source=other-volume,target=/somewhere-else \\\n myservice\n\nmyservice\n\n$ - docker service update --mount-rm /somewhere myservice\n\nmyservice\n```\n\n### Rolling - back to the previous version of a service \n\nUse the `--rollback` option to roll - back to the previous version of the service. \n\nThis will revert the service to - the configuration that was in place before the most recent `docker service update` - command.\n\nThe following example updates the number of replicas for the service - from 4 to 5, and then rolls back to the previous configuration.\n\n```bash\n$ docker - service update --replicas=5 web\n\nweb\n\n$ docker service ls\n\nID NAME - \ MODE REPLICAS IMAGE\n80bvrzp6vxf3 web replicated 0/5 nginx:alpine\n\n```\nRoll - back the `web` service... \n\n```bash\n$ docker service update --rollback web\n\nweb\n\n$ - docker service ls\n\nID NAME MODE REPLICAS IMAGE\n80bvrzp6vxf3 - \ web replicated 0/4 nginx:alpine\n\n```\n\nOther options can be combined - with `--rollback` as well, for example, `--update-delay 0s` to execute the rollback - without a delay between tasks:\n\n```bash\n$ docker service update \\\n --rollback - \\\n --update-delay 0s\n web\n\nweb\n\n```\n\nServices can also be set up to roll - back to the previous version automatically\nwhen an update fails. To set up a service - for automatic rollback, use\n`--update-failure-action=rollback`. A rollback will - be triggered if the fraction\nof the tasks which failed to update successfully exceeds - the value given with\n`--update-max-failure-ratio`.\n\nThe rate, parallelism, and - other parameters of a rollback operation are\ndetermined by the values passed with - the following flags:\n\n- `--rollback-delay`\n- `--rollback-failure-action`\n- `--rollback-max-failure-ratio`\n- - `--rollback-monitor`\n- `--rollback-parallelism`\n\nFor example, a service set up - with `--update-parallelism 1 --rollback-parallelism 3`\nwill update one task at - a time during a normal update, but during a rollback, 3\ntasks at a time will get - rolled back. These rollback parameters are respected both\nduring automatic rollbacks - and for rollbacks initiated manually using `--rollback`.\n\n### Add or remove secrets\n\nUse - the `--secret-add` or `--secret-rm` options add or remove a service's\nsecrets.\n\nThe - following example adds a secret named `ssh-2` and removes `ssh-1`:\n\n```bash\n$ - docker service update \\\n --secret-add source=ssh-2,target=ssh-2 \\\n --secret-rm - ssh-1 \\\n myservice\n```\n\n### Update services using templates\n\nSome flags - of `service update` support the use of templating.\nSee [`service create`](./service_create.md#templating) - for the reference." + deprecated: false + experimental: false +examples: |- + ### Update a service + + ```bash + $ docker service update --limit-cpu 2 redis + ``` + + ### Perform a rolling restart with no parameter changes + + ```bash + $ docker service update --force --update-parallelism 1 --update-delay 30s redis + ``` + + In this example, the `--force` flag causes the service's tasks to be shut down + and replaced with new ones even though none of the other parameters would + normally cause that to happen. The `--update-parallelism 1` setting ensures + that only one task is replaced at a time (this is the default behavior). The + `--update-delay 30s` setting introduces a 30 second delay between tasks, so + that the rolling restart happens gradually. + + ### Add or remove mounts + + Use the `--mount-add` or `--mount-rm` options add or remove a service's bind mounts + or volumes. + + The following example creates a service which mounts the `test-data` volume to + `/somewhere`. The next step updates the service to also mount the `other-volume` + volume to `/somewhere-else`volume, The last step unmounts the `/somewhere` mount + point, effectively removing the `test-data` volume. Each command returns the + service name. + + - The `--mount-add` flag takes the same parameters as the `--mount` flag on + `service create`. Refer to the [volumes and + bind mounts](service_create.md#volumes-and-bind-mounts-mount) section in the + `service create` reference for details. + + - The `--mount-rm` flag takes the `target` path of the mount. + + ```bash + $ docker service create \ + --name=myservice \ + --mount \ + type=volume,source=test-data,target=/somewhere \ + nginx:alpine \ + myservice + + myservice + + $ docker service update \ + --mount-add \ + type=volume,source=other-volume,target=/somewhere-else \ + myservice + + myservice + + $ docker service update --mount-rm /somewhere myservice + + myservice + ``` + + ### Roll back to the previous version of a service + + Use the `--rollback` option to roll back to the previous version of the service. + + This will revert the service to the configuration that was in place before the most recent `docker service update` command. + + The following example updates the number of replicas for the service from 4 to 5, and then rolls back to the previous configuration. + + ```bash + $ docker service update --replicas=5 web + + web + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE + 80bvrzp6vxf3 web replicated 0/5 nginx:alpine + + ``` + Roll back the `web` service... + + ```bash + $ docker service update --rollback web + + web + + $ docker service ls + + ID NAME MODE REPLICAS IMAGE + 80bvrzp6vxf3 web replicated 0/4 nginx:alpine + + ``` + + Other options can be combined with `--rollback` as well, for example, `--update-delay 0s` to execute the rollback without a delay between tasks: + + ```bash + $ docker service update \ + --rollback \ + --update-delay 0s + web + + web + + ``` + + Services can also be set up to roll back to the previous version automatically + when an update fails. To set up a service for automatic rollback, use + `--update-failure-action=rollback`. A rollback will be triggered if the fraction + of the tasks which failed to update successfully exceeds the value given with + `--update-max-failure-ratio`. + + The rate, parallelism, and other parameters of a rollback operation are + determined by the values passed with the following flags: + + - `--rollback-delay` + - `--rollback-failure-action` + - `--rollback-max-failure-ratio` + - `--rollback-monitor` + - `--rollback-parallelism` + + For example, a service set up with `--update-parallelism 1 --rollback-parallelism 3` + will update one task at a time during a normal update, but during a rollback, 3 + tasks at a time will get rolled back. These rollback parameters are respected both + during automatic rollbacks and for rollbacks initiated manually using `--rollback`. + + ### Add or remove secrets + + Use the `--secret-add` or `--secret-rm` options add or remove a service's + secrets. + + The following example adds a secret named `ssh-2` and removes `ssh-1`: + + ```bash + $ docker service update \ + --secret-add source=ssh-2,target=ssh-2 \ + --secret-rm ssh-1 \ + myservice + ``` + + ### Update services using templates + + Some flags of `service update` support the use of templating. + See [`service create`](./service_create.md#templating) for the reference. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_stack.yaml b/_data/engine-cli/docker_stack.yaml index ad1d4ae6ef..f0e2903f71 100644 --- a/_data/engine-cli/docker_stack.yaml +++ b/_data/engine-cli/docker_stack.yaml @@ -16,4 +16,7 @@ clink: - docker_stack_ps.yaml - docker_stack_rm.yaml - docker_stack_services.yaml +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_stack_deploy.yaml b/_data/engine-cli/docker_stack_deploy.yaml index 05cf6afb96..cb165c85de 100644 --- a/_data/engine-cli/docker_stack_deploy.yaml +++ b/_data/engine-cli/docker_stack_deploy.yaml @@ -9,20 +9,38 @@ pname: docker stack plink: docker_stack.yaml options: - option: bundle-file + value_type: string description: Path to a Distributed Application Bundle file + deprecated: false + experimental: true - option: compose-file shorthand: c + value_type: string description: Path to a Compose file + deprecated: false + min_api_version: "1.25" + experimental: false - option: prune + value_type: bool default_value: "false" description: Prune services that are no longer referenced + deprecated: false + min_api_version: "1.27" + experimental: false - option: resolve-image + value_type: string default_value: always description: | Query the registry to resolve image digest and supported platforms ("always"|"changed"|"never") + deprecated: false + min_api_version: "1.30" + experimental: false - option: with-registry-auth + value_type: bool default_value: "false" description: Send registry authentication details to Swarm agents + deprecated: false + experimental: false examples: |- ### Compose file @@ -43,6 +61,23 @@ examples: |- Creating service vossibility_lookupd ``` + The Compose file can also be provided as standard input with `--compose-file -`: + + ```bash + $ cat docker-compose.yml | docker stack deploy --compose-file - vossibility + + Ignoring unsupported options: links + + Creating network vossibility_vossibility + Creating network vossibility_default + Creating service vossibility_nsqd + Creating service vossibility_logstash + Creating service vossibility_elasticsearch + Creating service vossibility_kibana + Creating service vossibility_ghollector + 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 @@ -105,4 +140,7 @@ examples: |- 9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_stack_ls.yaml b/_data/engine-cli/docker_stack_ls.yaml index c2c41839a2..7afdf7e84f 100644 --- a/_data/engine-cli/docker_stack_ls.yaml +++ b/_data/engine-cli/docker_stack_ls.yaml @@ -7,7 +7,10 @@ pname: docker stack plink: docker_stack.yaml options: - option: format + value_type: string description: Pretty-print stacks using a Go template + deprecated: false + experimental: false examples: |- The following command shows all stacks and some additional information: @@ -42,4 +45,7 @@ examples: |- web-server: 1 web-cache: 4 ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_stack_ps.yaml b/_data/engine-cli/docker_stack_ps.yaml index 1cdc7b5c92..5d4c65d35f 100644 --- a/_data/engine-cli/docker_stack_ps.yaml +++ b/_data/engine-cli/docker_stack_ps.yaml @@ -9,19 +9,34 @@ plink: docker_stack.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print tasks using a Go template + deprecated: false + experimental: false - option: no-resolve + value_type: bool default_value: "false" description: Do not map IDs to Names + deprecated: false + experimental: false - option: no-trunc + value_type: bool default_value: "false" description: Do not truncate output + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display task IDs + deprecated: false + experimental: false examples: |- ### List the tasks that are part of a stack @@ -208,4 +223,7 @@ examples: |- "Version": { (...) ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_stack_rm.yaml b/_data/engine-cli/docker_stack_rm.yaml index dcdd30420e..e32c67671e 100644 --- a/_data/engine-cli/docker_stack_rm.yaml +++ b/_data/engine-cli/docker_stack_rm.yaml @@ -43,4 +43,7 @@ examples: |- Removing network vossibility_default Removing network vossibility_vossibility ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_stack_services.yaml b/_data/engine-cli/docker_stack_services.yaml index bfb96e0533..526c6829ff 100644 --- a/_data/engine-cli/docker_stack_services.yaml +++ b/_data/engine-cli/docker_stack_services.yaml @@ -9,13 +9,22 @@ plink: docker_stack.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print services using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display IDs + deprecated: false + experimental: false examples: |- The following command shows all services in the `myapp` stack: @@ -77,4 +86,7 @@ examples: |- 0zmvwuiu3vue: replicated 10/10 fm6uf97exkul: global 5/5 ``` +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_start.yaml b/_data/engine-cli/docker_start.yaml index d75b08b6d6..b87b37dd83 100644 --- a/_data/engine-cli/docker_start.yaml +++ b/_data/engine-cli/docker_start.yaml @@ -7,20 +7,37 @@ plink: docker.yaml options: - option: attach shorthand: a + value_type: bool default_value: "false" description: Attach STDOUT/STDERR and forward signals + deprecated: false + experimental: false - option: checkpoint + value_type: string description: Restore from this checkpoint + deprecated: false + experimental: true - option: checkpoint-dir + value_type: string description: Use a custom checkpoint storage directory + deprecated: false + experimental: true - option: detach-keys + value_type: string description: Override the key sequence for detaching a container + deprecated: false + experimental: false - option: interactive shorthand: i + value_type: bool default_value: "false" description: Attach container's STDIN + deprecated: false + experimental: false examples: |- ```bash $ docker start my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_stats.yaml b/_data/engine-cli/docker_stats.yaml index 23d95475df..be96d16bec 100644 --- a/_data/engine-cli/docker_stats.yaml +++ b/_data/engine-cli/docker_stats.yaml @@ -10,13 +10,22 @@ plink: docker.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Show all containers (default shows just running) + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: no-stream + value_type: bool default_value: "false" description: Disable streaming stats and only pull the first result + deprecated: false + experimental: false examples: |- Running `docker stats` on all running containers against a Linux daemon. @@ -121,4 +130,6 @@ examples: |- 9c76f7834ae2 0.07% 2.746 MiB / 64 MiB d1ea048f04e4 0.03% 4.583 MiB / 64 MiB ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_stop.yaml b/_data/engine-cli/docker_stop.yaml index c650227858..8667f6ad7b 100644 --- a/_data/engine-cli/docker_stop.yaml +++ b/_data/engine-cli/docker_stop.yaml @@ -9,10 +9,15 @@ plink: docker.yaml options: - option: time shorthand: t + value_type: int default_value: "10" description: Seconds to wait for stop before killing it + deprecated: false + experimental: false examples: |- ```bash $ docker stop my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_swarm.yaml b/_data/engine-cli/docker_swarm.yaml index c9c48e986a..86d210cdfd 100644 --- a/_data/engine-cli/docker_swarm.yaml +++ b/_data/engine-cli/docker_swarm.yaml @@ -22,4 +22,7 @@ clink: - docker_swarm_unlock.yaml - docker_swarm_unlock-key.yaml - docker_swarm_update.yaml +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_ca.yaml b/_data/engine-cli/docker_swarm_ca.yaml index e3db12c4de..153b0f9760 100644 --- a/_data/engine-cli/docker_swarm_ca.yaml +++ b/_data/engine-cli/docker_swarm_ca.yaml @@ -1,5 +1,5 @@ command: docker swarm ca -short: Manage root CA +short: Display and rotate the root CA long: View or rotate the current swarm CA certificate. This command must target a manager node. usage: docker swarm ca [OPTIONS] @@ -7,29 +7,50 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: ca-cert + value_type: pem-file description: | Path to the PEM-formatted root CA certificate to use for the new cluster + deprecated: false + experimental: 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 - 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 - option: detach shorthand: d + value_type: bool default_value: "false" description: | Exit immediately instead of waiting for the root rotation to converge + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Suppress progress output + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: | Rotate the swarm CA - if no certificate or key are provided, new ones will be generated + deprecated: false + experimental: false examples: |- Run the `docker swarm ca` command without any options to view the current root CA certificate in PEM format. @@ -105,4 +126,7 @@ examples: |- Initiate the root CA rotation, but do not wait for the completion of or display the progress of the rotation. +deprecated: false +min_api_version: "1.30" +experimental: false diff --git a/_data/engine-cli/docker_swarm_init.yaml b/_data/engine-cli/docker_swarm_init.yaml index 1821d6b9d9..788a34aa27 100644 --- a/_data/engine-cli/docker_swarm_init.yaml +++ b/_data/engine-cli/docker_swarm_init.yaml @@ -8,40 +8,78 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: advertise-addr + value_type: string description: 'Advertised address (format: [:port])' + deprecated: false + experimental: false - option: autolock + value_type: bool default_value: "false" description: | Enable manager autolocking (requiring an unlock key to start a stopped manager) + deprecated: false + experimental: false - option: availability + value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") + deprecated: false + experimental: 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 - option: data-path-addr + value_type: string description: | Address or interface to use for data path traffic (format: ) + deprecated: false + experimental: false - option: dispatcher-heartbeat + value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: force-new-cluster + value_type: bool default_value: "false" description: Force create a new cluster from current state + deprecated: false + experimental: false - option: listen-addr + value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' + deprecated: false + experimental: false - option: max-snapshots + value_type: uint64 default_value: "0" description: Number of additional Raft snapshots to retain + deprecated: false + min_api_version: "1.25" + experimental: false - option: snapshot-interval + value_type: uint64 default_value: "10000" description: Number of log entries between Raft snapshots + deprecated: false + min_api_version: "1.25" + experimental: false - option: task-history-limit + value_type: int64 default_value: "5" description: Task history retention limit + deprecated: false + experimental: false examples: |- ```bash $ docker swarm init --advertise-addr 192.168.99.121 @@ -155,4 +193,7 @@ examples: |- This flag is useful in certain situations. For example, a cluster may want to have dedicated manager nodes that are not served as worker nodes. This could be achieved by passing `--availability=drain` to `docker swarm init`. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_join-token.yaml b/_data/engine-cli/docker_swarm_join-token.yaml index 326572db1c..25f87affb6 100644 --- a/_data/engine-cli/docker_swarm_join-token.yaml +++ b/_data/engine-cli/docker_swarm_join-token.yaml @@ -7,9 +7,18 @@ plink: docker_swarm.yaml options: - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display token + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: Rotate join token + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_join.yaml b/_data/engine-cli/docker_swarm_join.yaml index 47fd58c016..eb753b238b 100644 --- a/_data/engine-cli/docker_swarm_join.yaml +++ b/_data/engine-cli/docker_swarm_join.yaml @@ -9,18 +9,33 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: advertise-addr + value_type: string description: 'Advertised address (format: [:port])' + deprecated: false + experimental: false - option: availability + value_type: string default_value: active description: Availability of the node ("active"|"pause"|"drain") + deprecated: false + experimental: false - option: data-path-addr + value_type: string description: | Address or interface to use for data path traffic (format: ) + deprecated: false + experimental: false - option: listen-addr + value_type: node-addr default_value: 0.0.0.0:2377 description: 'Listen address (format: [:port])' + deprecated: false + experimental: false - option: token + value_type: string description: Token for entry into the swarm + deprecated: false + experimental: false examples: |- ### Join a node to swarm as a manager @@ -102,4 +117,7 @@ examples: |- This flag is useful in certain situations. For example, a cluster may want to have dedicated manager nodes that are not served as worker nodes. This could be achieved by passing `--availability=drain` to `docker swarm join`. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_leave.yaml b/_data/engine-cli/docker_swarm_leave.yaml index d489a086a9..826ece6c16 100644 --- a/_data/engine-cli/docker_swarm_leave.yaml +++ b/_data/engine-cli/docker_swarm_leave.yaml @@ -15,8 +15,11 @@ plink: docker_swarm.yaml options: - option: force shorthand: f + value_type: bool default_value: "false" description: Force this node to leave the swarm, ignoring warnings + deprecated: false + experimental: false examples: |- Consider the following swarm, as seen from the manager: @@ -39,4 +42,7 @@ examples: |- affects swarm operation, but a long list of `down` nodes can clutter the node list. To remove an inactive node from the list, use the [`node rm`](node_rm.md) command. +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_unlock-key.yaml b/_data/engine-cli/docker_swarm_unlock-key.yaml index 38f93daf1b..faad356aba 100644 --- a/_data/engine-cli/docker_swarm_unlock-key.yaml +++ b/_data/engine-cli/docker_swarm_unlock-key.yaml @@ -7,9 +7,18 @@ plink: docker_swarm.yaml options: - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display token + deprecated: false + experimental: false - option: rotate + value_type: bool default_value: "false" description: Rotate unlock key + deprecated: false + experimental: false +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_unlock.yaml b/_data/engine-cli/docker_swarm_unlock.yaml index 5f5b313083..fd7e84e23d 100644 --- a/_data/engine-cli/docker_swarm_unlock.yaml +++ b/_data/engine-cli/docker_swarm_unlock.yaml @@ -13,4 +13,7 @@ examples: |- $ docker swarm unlock Please enter unlock key: ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_swarm_update.yaml b/_data/engine-cli/docker_swarm_update.yaml index cea124c154..30e889b154 100644 --- a/_data/engine-cli/docker_swarm_update.yaml +++ b/_data/engine-cli/docker_swarm_update.yaml @@ -7,27 +7,53 @@ pname: docker swarm plink: docker_swarm.yaml options: - option: autolock + value_type: bool default_value: "false" description: Change manager autolocking setting (true|false) + deprecated: false + experimental: 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 - option: dispatcher-heartbeat + value_type: duration default_value: 5s description: Dispatcher heartbeat period (ns|us|ms|s|m|h) + deprecated: false + experimental: false - option: external-ca + value_type: external-ca description: Specifications of one or more certificate signing endpoints + deprecated: false + experimental: false - option: max-snapshots + value_type: uint64 default_value: "0" description: Number of additional Raft snapshots to retain + deprecated: false + min_api_version: "1.25" + experimental: false - option: snapshot-interval + value_type: uint64 default_value: "10000" description: Number of log entries between Raft snapshots + deprecated: false + min_api_version: "1.25" + experimental: false - option: task-history-limit + value_type: int64 default_value: "5" description: Task history retention limit + deprecated: false + experimental: false examples: |- ```bash $ docker swarm update --cert-expiry 720h ``` +deprecated: false +min_api_version: "1.24" +experimental: false diff --git a/_data/engine-cli/docker_system.yaml b/_data/engine-cli/docker_system.yaml index 12a585ecf8..f6b66a9168 100644 --- a/_data/engine-cli/docker_system.yaml +++ b/_data/engine-cli/docker_system.yaml @@ -14,4 +14,6 @@ clink: - docker_system_events.yaml - docker_system_info.yaml - docker_system_prune.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_system_df.yaml b/_data/engine-cli/docker_system_df.yaml index de6bf0ff40..03fe99e459 100644 --- a/_data/engine-cli/docker_system_df.yaml +++ b/_data/engine-cli/docker_system_df.yaml @@ -8,11 +8,17 @@ pname: docker system plink: docker_system.yaml options: - option: format + value_type: string description: Pretty-print images using a Go template + deprecated: false + experimental: false - option: verbose shorthand: v + value_type: bool default_value: "false" description: Show detailed information on space usage + deprecated: false + experimental: false examples: |- By default the command will just show a summary of the data used: @@ -58,4 +64,7 @@ examples: |- > **Note**: Network information is not shown because it doesn't consume the disk > space. +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_system_events.yaml b/_data/engine-cli/docker_system_events.yaml index 0f3e06818b..db71b662df 100644 --- a/_data/engine-cli/docker_system_events.yaml +++ b/_data/engine-cli/docker_system_events.yaml @@ -138,13 +138,25 @@ plink: docker_system.yaml options: - option: filter shorthand: f + value_type: filter description: Filter output based on conditions provided + deprecated: false + experimental: false - option: format + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false - option: since + value_type: string description: Show all events created since timestamp + deprecated: false + experimental: false - option: until + value_type: string description: Stream events until this timestamp + deprecated: false + experimental: false examples: |- ### Basic example @@ -325,4 +337,6 @@ examples: |- {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_system_info.yaml b/_data/engine-cli/docker_system_info.yaml index 1c01d7c47d..1fac9a8088 100644 --- a/_data/engine-cli/docker_system_info.yaml +++ b/_data/engine-cli/docker_system_info.yaml @@ -7,5 +7,10 @@ plink: docker_system.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_system_prune.yaml b/_data/engine-cli/docker_system_prune.yaml index ce5fc4abc1..d89aa09ee8 100644 --- a/_data/engine-cli/docker_system_prune.yaml +++ b/_data/engine-cli/docker_system_prune.yaml @@ -8,17 +8,30 @@ plink: docker_system.yaml options: - option: all shorthand: a + value_type: bool default_value: "false" description: Remove all unused images not just dangling ones + deprecated: false + experimental: false - option: filter + value_type: filter description: Provide filter values (e.g. 'label==') + deprecated: false + min_api_version: "1.28" + experimental: false - option: force shorthand: f + value_type: bool default_value: "false" description: Do not prompt for confirmation + deprecated: false + experimental: false - option: volumes + value_type: bool default_value: "false" description: Prune volumes + deprecated: false + experimental: false examples: "```bash\n$ docker system prune -a\n\nWARNING! This will remove:\n\t- all stopped containers\n\t- all volumes not used by at least one container\n\t- all networks not used by at least one container\n\t- all images without at least one @@ -55,4 +68,7 @@ examples: "```bash\n$ docker system prune -a\n\nWARNING! This will remove:\n\t- with the specified labels. The other\nformat is the `label!=...` (`label!=` or `label!==`), which removes\ncontainers, images, networks, and volumes without the specified labels." +deprecated: false +min_api_version: "1.25" +experimental: false diff --git a/_data/engine-cli/docker_tag.yaml b/_data/engine-cli/docker_tag.yaml index e8554a7260..84dc216c05 100644 --- a/_data/engine-cli/docker_tag.yaml +++ b/_data/engine-cli/docker_tag.yaml @@ -58,4 +58,6 @@ examples: |- ```bash $ docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0 ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_top.yaml b/_data/engine-cli/docker_top.yaml index c4cda8bb6e..40ec70aad5 100644 --- a/_data/engine-cli/docker_top.yaml +++ b/_data/engine-cli/docker_top.yaml @@ -4,4 +4,6 @@ long: Display the running processes of a container usage: docker top CONTAINER [ps OPTIONS] pname: docker plink: docker.yaml +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_unpause.yaml b/_data/engine-cli/docker_unpause.yaml index 9ef98f1efb..6413eda0c1 100644 --- a/_data/engine-cli/docker_unpause.yaml +++ b/_data/engine-cli/docker_unpause.yaml @@ -14,4 +14,6 @@ examples: |- ```bash $ docker unpause my_container ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_update.yaml b/_data/engine-cli/docker_update.yaml index de5d4e2f0a..8cbc0e612d 100644 --- a/_data/engine-cli/docker_update.yaml +++ b/_data/engine-cli/docker_update.yaml @@ -11,52 +11,101 @@ long: |- options on a running or a stopped container. On kernel version older than 4.6, you can only update `--kernel-memory` on a stopped container or on a running container with kernel memory initialized. + + > **Warning**: The `docker update` and `docker container update` commands are + > not supported for Windows containers. + {: .warning } usage: docker update [OPTIONS] CONTAINER [CONTAINER...] pname: docker plink: docker.yaml options: - option: blkio-weight + value_type: uint16 default_value: "0" description: | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) + deprecated: false + experimental: false - option: cpu-period + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) period + deprecated: false + experimental: false - option: cpu-quota + value_type: int64 default_value: "0" description: Limit CPU CFS (Completely Fair Scheduler) quota + deprecated: false + experimental: false - option: cpu-rt-period + value_type: int64 default_value: "0" description: Limit the CPU real-time period in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-rt-runtime + value_type: int64 default_value: "0" description: Limit the CPU real-time runtime in microseconds + deprecated: false + min_api_version: "1.25" + experimental: false - option: cpu-shares shorthand: c + value_type: int64 default_value: "0" description: CPU shares (relative weight) + deprecated: false + experimental: false - option: cpus + value_type: decimal description: Number of CPUs + deprecated: false + min_api_version: "1.29" + experimental: false - option: cpuset-cpus + value_type: string description: CPUs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: cpuset-mems + value_type: string description: MEMs in which to allow execution (0-3, 0,1) + deprecated: false + experimental: false - option: kernel-memory + value_type: bytes default_value: "0" description: Kernel memory limit + deprecated: false + experimental: false - option: memory shorthand: m + value_type: bytes default_value: "0" description: Memory limit + deprecated: false + experimental: false - option: memory-reservation + value_type: bytes default_value: "0" description: Memory soft limit + deprecated: false + experimental: false - option: memory-swap + value_type: bytes default_value: "0" description: | Swap limit equal to memory plus swap: '-1' to enable unlimited swap + deprecated: false + experimental: false - option: restart + value_type: string description: Restart policy to apply when a container exits + deprecated: false + experimental: false examples: |- The following sections illustrate ways to use this command. @@ -126,4 +175,6 @@ examples: |- Note that if the container is started with "--rm" flag, you cannot update the restart policy for it. The `AutoRemove` and `RestartPolicy` are mutually exclusive for the container. +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_version.yaml b/_data/engine-cli/docker_version.yaml index 294738cc4f..c77c34532d 100644 --- a/_data/engine-cli/docker_version.yaml +++ b/_data/engine-cli/docker_version.yaml @@ -12,7 +12,10 @@ plink: docker.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ### Default output @@ -51,4 +54,6 @@ examples: |- {"Client":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"},"ServerOK":true,"Server":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","KernelVersion":"3.13.2-gentoo","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"}} ``` +deprecated: false +experimental: false diff --git a/_data/engine-cli/docker_volume.yaml b/_data/engine-cli/docker_volume.yaml index ad5134eae0..e1cc74a696 100644 --- a/_data/engine-cli/docker_volume.yaml +++ b/_data/engine-cli/docker_volume.yaml @@ -18,4 +18,7 @@ clink: - docker_volume_ls.yaml - docker_volume_prune.yaml - docker_volume_rm.yaml +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli/docker_volume_create.yaml b/_data/engine-cli/docker_volume_create.yaml index 8b774d254b..7b5dc2266f 100644 --- a/_data/engine-cli/docker_volume_create.yaml +++ b/_data/engine-cli/docker_volume_create.yaml @@ -9,16 +9,28 @@ plink: docker_volume.yaml options: - option: driver shorthand: d + value_type: string default_value: local description: Specify volume driver name + deprecated: false + experimental: false - option: label + value_type: list description: Set metadata for a volume + deprecated: false + experimental: false - option: name + value_type: string description: Specify volume name + deprecated: false + experimental: false - option: opt shorthand: o + value_type: map default_value: map[] description: Set driver specific options + deprecated: false + experimental: false examples: |- Create a volume and then configure the container to use it: @@ -101,4 +113,7 @@ examples: |- --opt device=:/path/to/dir \ foo ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli/docker_volume_inspect.yaml b/_data/engine-cli/docker_volume_inspect.yaml index 460bdc3e71..4af3cf3b62 100644 --- a/_data/engine-cli/docker_volume_inspect.yaml +++ b/_data/engine-cli/docker_volume_inspect.yaml @@ -12,7 +12,10 @@ plink: docker_volume.yaml options: - option: format shorthand: f + value_type: string description: Format the output using the given Go template + deprecated: false + experimental: false examples: |- ```bash $ docker volume create @@ -30,4 +33,7 @@ examples: |- $ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d /var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli/docker_volume_ls.yaml b/_data/engine-cli/docker_volume_ls.yaml index e9c16aaf62..1f55ae1d94 100644 --- a/_data/engine-cli/docker_volume_ls.yaml +++ b/_data/engine-cli/docker_volume_ls.yaml @@ -11,13 +11,22 @@ plink: docker_volume.yaml options: - option: filter shorthand: f + value_type: filter description: Provide filter values (e.g. 'dangling=true') + deprecated: false + experimental: false - option: format + value_type: string description: Pretty-print volumes using a Go template + deprecated: false + experimental: false - option: quiet shorthand: q + value_type: bool default_value: "false" description: Only display volume names + deprecated: false + experimental: false examples: |- ### Create a volume ```bash @@ -166,4 +175,7 @@ examples: |- vol2: local vol3: local ``` +deprecated: false +min_api_version: "1.21" +experimental: false diff --git a/_data/engine-cli/docker_volume_prune.yaml b/_data/engine-cli/docker_volume_prune.yaml index e18f78a667..920b3f54dd 100644 --- a/_data/engine-cli/docker_volume_prune.yaml +++ b/_data/engine-cli/docker_volume_prune.yaml @@ -7,11 +7,17 @@ pname: docker volume plink: docker_volume.yaml options: - option: filter + value_type: filter description: Provide filter values (e.g. 'label=

Mount path inside the container, for example /some/path/in/container/. If the path does not exist in the container's filesystem, the Engine creates - a directory at the specified location before mounting the volume or bind-mount.

+ a directory at the specified location before mounting the volume or bind mount.