diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000000..e69de29bb2 diff --git a/404.html b/404.html new file mode 100644 index 0000000000..410cdd8549 --- /dev/null +++ b/404.html @@ -0,0 +1,15 @@ + + + + + + Docker Documentation + + +

We have moved away from the docker.github.io domain. If you're not automatically redirected, please visit us at docs.docker.com.

+ + + + \ No newline at end of file diff --git a/Jenkinsfile b/Jenkinsfile index 310ed40948..34916fbce7 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -1,25 +1,92 @@ -wrappedNode(label: 'ubuntu-1604 && x86_64') { - timeout(time: 60, unit: 'MINUTES') { - deleteDir() - stage "checkout" - checkout scm - sh "git submodule update --init --recursive" - stage "test" +def dtrVpnAddress = "vpn.corp-us-east-1.aws.dckr.io" +def ucpBundle = [file(credentialsId: "ucp-bundle", variable: 'UCP')] +def slackString = [string(credentialsId: 'slack-docs-webhook', variable: 'slack')] +def reg = [credentialsId: 'csebuildbot', url: 'https://index.docker.io/v1/'] - /* Jekyll creates html files to implement client side redirects. - There are absolute links to docs.docker.com in these htmls - we don't want them to be parsed by the tests for now. - Removing jekyll-redirect-from option will make sure these pages - are not generated when building with Jekyll. */ - sh "awk '/jekyll-redirect-from/{n=1}; n {n--; next}; 1' < _config.yml > _config.yml.tmp" - sh "mv _config.yml.tmp _config.yml" - - sh "docker build -t docs:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`" - sh "docker build -t tests:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`/tests" - sh "docker run -v /usr/src/app/allvbuild --name docs-${JOB_BASE_NAME}-${BUILD_NUMBER} docs:${JOB_BASE_NAME}-${BUILD_NUMBER} /bin/true" - sh "docker run --rm --volumes-from docs-${JOB_BASE_NAME}-${BUILD_NUMBER} -v `pwd`:/docs tests:${JOB_BASE_NAME}-${BUILD_NUMBER}" - sh "docker rm -fv docs-${JOB_BASE_NAME}-${BUILD_NUMBER}" - sh "docker rmi docs:${JOB_BASE_NAME}-${BUILD_NUMBER} tests:${JOB_BASE_NAME}-${BUILD_NUMBER}" - deleteDir() +pipeline { + agent none + options { + timeout(time: 1, unit: 'HOURS') + } + stages { + stage( 'docker.github.io' ) { + agent { + label 'ubuntu-1604-aufs-stable' + } + stages { + stage( 'build and push stage image' ) { + when { + branch 'master' + } + steps { + withDockerRegistry(reg) { + sh """ + docker image build --tag docs/docker.github.io:stage-${env.BUILD_NUMBER} . && \ + docker image push docs/docker.github.io:stage-${env.BUILD_NUMBER} + """ + } + } + } + stage( 'build and push prod image' ) { + when { + branch 'published' + } + steps { + withDockerRegistry(reg) { + sh """ + docker image build --tag docs/docker.github.io:prod-${env.BUILD_NUMBER} . && \ + docker image push docs/docker.github.io:prod-${env.BUILD_NUMBER} + """ + } + } + } + stage( 'update docs-stage' ) { + when { + branch 'master' + } + steps { + withVpn(dtrVpnAddress) { + withCredentials(ucpBundle) { + sh 'unzip -o $UCP' + } + withDockerRegistry(reg) { + sh """ + export DOCKER_TLS_VERIFY=1 + export COMPOSE_TLS_VERSION=TLSv1_2 + export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot + export DOCKER_HOST=tcp://ucp.corp-us-east-1.aws.dckr.io:443 + docker service update --detach=false --force --image docs/docker.github.io:stage-${env.BUILD_NUMBER} docs-stage-docker-com_docs --with-registry-auth + """ + } + } + } + } + stage( 'update docs-prod' ) { + when { + branch 'published' + } + steps { + withVpn(dtrVpnAddress) { + withCredentials(ucpBundle) { + sh 'unzip -o $UCP' + } + withCredentials(slackString) { + withDockerRegistry(reg) { + sh """ + cd ucp-bundle-success_bot + export DOCKER_TLS_VERIFY=1 + export COMPOSE_TLS_VERSION=TLSv1_2 + export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot + export DOCKER_HOST=tcp://ucp.corp-us-east-1.aws.dckr.io:443 + docker service update --detach=false --force --image docs/docker.github.io:prod-${env.BUILD_NUMBER} docs-docker-com_docs --with-registry-auth + curl -X POST -H 'Content-type: application/json' --data '{"text":"Successfully published docs. https://docs.docker.com/"}' $slack + """ + } + } + } + } + } + } + } } } diff --git a/_config.yml b/_config.yml index 309402b22f..e7faeadac9 100644 --- a/_config.yml +++ b/_config.yml @@ -14,14 +14,13 @@ lsi: false url: https://docs.docker.com # This needs to have all the directories you expect to be in the archives (delivered by docs-base in the Dockerfile) keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13", "v17.03", "v17.06", "v17.09", "v17.12", "v18.03"] -exclude: ["_scripts", "apidocs/layouts", "Gemfile", "hooks"] +exclude: ["_scripts", "apidocs/layouts", "Gemfile", "hooks", "index.html", "404.html"] -# Component versions -- address like site.docker_ce_stable_version +# Component versions -- address like site.docker_ce_version # You can't have - characters in these for non-YAML reasons -latest_stable_docker_engine_api_version: "1.39" -docker_ce_stable_version: "18.09" -docker_ce_edge_version: "18.09" +latest_engine_api_version: "1.39" +docker_ce_version: "18.09" docker_ee_version: "18.09" compose_version: "1.23.2" machine_version: "0.16.0" diff --git a/_config_authoring.yml b/_config_authoring.yml index 921585729a..f95761ac42 100644 --- a/_config_authoring.yml +++ b/_config_authoring.yml @@ -2,36 +2,38 @@ name: Docker Documentation markdown: kramdown kramdown: input: GFM + gfm_quirks: [paragraph_end, no_auto_typographic] html_to_native: true hard_wrap: false syntax_highlighter: rouge toc_levels: 2..3 +incremental: false permalink: pretty safe: false lsi: false url: https://docs.docker.com -incremental: false -# Component versions -- address like site.docker_ce_stable_version +# Component versions -- address like site.docker_ce_version # You can't have - characters in these for non-YAML reasons # TO USE ME: # jekyll serve --incremental --config _config_authoring.yml -docker_ce_stable_version: "17.09" -latest_stable_docker_engine_api_version: "1.32" -docker_ce_edge_version: "17.09" -docker_ee_version: "17.06" -compose_version: "1.16.1" -machine_version: "0.12.2" +latest_engine_api_version: "1.39" +docker_ce_version: "18.09" +docker_ee_version: "18.09" +compose_version: "1.23.2" +machine_version: "0.16.0" distribution_version: "2.6" -dtr_version: "2.5" -ucp_version: "3.0" +dtr_version: "2.6" +ucp_version: "3.1" ucp_versions: - - version: "3.0" + - version: "3.1" path: /ee/ucp/ latest: true + - version: "3.0" + path: /datacenter/ucp/3.0/guides/ - version: "2.2" path: /datacenter/ucp/2.2/guides/ - version: "2.1" @@ -42,9 +44,11 @@ ucp_versions: path: /datacenter/ucp/1.1/overview/ dtr_versions: - - version: "2.5" + - version: "2.6" path: /ee/dtr/ latest: true + - version: "2.5" + path: /datacenter/dtr/2.5/guides/ - version: "2.4" path: /datacenter/dtr/2.4/guides/ - version: "2.3" @@ -57,7 +61,7 @@ dtr_versions: path: /datacenter/dtr/2.0/ tablabels: - dee-2.0: Docker Enterprise Edition 2.0 Beta2 + dee-2.0: Docker Enterprise Edition 2.0 ucp-3.0: Universal Control Plane 3.0 ucp-2.2: Universal Control Plane 2.2 dtr-2.5: Docker Trusted Registry 2.5 @@ -69,52 +73,65 @@ tablabels: kubectl: Kubernetes CLI cli: CLI +collections: + samples: + output: true + +plugins: + - jekyll-redirect-from + - jekyll-relative-links + - jekyll-sitemap + defaults: - - - scope: + - scope: path: "" type: "pages" values: layout: docs - defaultassignee: johndmulhausen toc_min: 2 toc_max: 3 tree: true - scope: - path: "engine" + path: "install" values: - win_latest_build: "docker-17.06.2-ee-6" + win_latest_build: "docker-18.09.1" - scope: path: "datacenter" values: - ucp_latest_image: "docker/ucp:3.0.0-beta2" - dtr_latest_image: "docker/dtr:2.5.0-beta3" enterprise: true - scope: path: "ee/dtr" values: dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.5.0-beta3" + dtr_version: "2.6.1" + - scope: + path: "datacenter/dtr/2.5" + values: + hide_from_sitemap: true + dtr_org: "docker" + dtr_repo: "dtr" + dtr_version: "2.5.7" - scope: path: "datacenter/dtr/2.4" values: hide_from_sitemap: true dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.4.1" + dtr_version: "2.4.8" - scope: path: "datacenter/dtr/2.3" values: + hide_from_sitemap: true dtr_org: "docker" dtr_repo: "dtr" - dtr_version: "2.3.4" + dtr_version: "2.3.10" - scope: path: "datacenter/dtr/2.2" values: ucp_version: "2.1" dtr_version: "2.2" - docker_image: "docker/dtr:2.2.9" + docker_image: "docker/dtr:2.2.11" - scope: path: "datacenter/dtr/2.1" values: @@ -130,29 +147,47 @@ defaults: values: ucp_org: "docker" ucp_repo: "ucp" - ucp_version: "3.0.0-beta2" + ucp_version: "3.1.2" + - scope: # This is a bit of a hack for the get-support.md topic. + path: "ee" + values: + ucp_org: "docker" + ucp_repo: "ucp" + dtr_repo: "dtr" + ucp_version: "3.1.2" + dtr_version: "2.6.1" + - scope: + path: "datacenter/ucp/3.0" + values: + hide_from_sitemap: true + ucp_org: "docker" + ucp_repo: "ucp" + ucp_version: "3.0.8" - scope: path: "datacenter/ucp/2.2" values: hide_from_sitemap: true ucp_org: "docker" ucp_repo: "ucp" - ucp_version: "2.2.3" + ucp_version: "2.2.15" - scope: path: "datacenter/ucp/2.1" values: + hide_from_sitemap: true ucp_version: "2.1" dtr_version: "2.2" - docker_image: "docker/ucp:2.1.5" + docker_image: "docker/ucp:2.1.8" - scope: path: "datacenter/ucp/2.0" values: + hide_from_sitemap: true ucp_version: "2.0" dtr_version: "2.1" - docker_image: "docker/ucp:2.0.3" + docker_image: "docker/ucp:2.0.4" - scope: path: "datacenter/ucp/1.1" values: + hide_from_sitemap: true ucp_version: "1.1" dtr_version: "2.0" diff --git a/_data/engine-cli-edge/docker.yaml b/_data/engine-cli-edge/docker.yaml deleted file mode 100644 index cfed41624a..0000000000 --- a/_data/engine-cli-edge/docker.yaml +++ /dev/null @@ -1,121 +0,0 @@ -command: docker -cname: -- docker attach -- docker build -- docker checkpoint -- docker commit -- docker config -- docker container -- docker cp -- docker create -- docker deploy -- docker diff -- docker events -- docker exec -- docker export -- docker history -- docker image -- docker images -- docker import -- docker info -- docker inspect -- docker kill -- docker load -- docker login -- docker logout -- docker logs -- docker manifest -- docker network -- docker node -- docker pause -- docker plugin -- docker port -- docker ps -- docker pull -- docker push -- docker rename -- docker restart -- docker rm -- docker rmi -- docker run -- docker save -- docker search -- docker secret -- docker service -- docker stack -- docker start -- docker stats -- docker stop -- docker swarm -- docker system -- docker tag -- docker top -- docker trust -- docker unpause -- docker update -- docker version -- docker volume -- docker wait -clink: -- docker_attach.yaml -- docker_build.yaml -- docker_checkpoint.yaml -- docker_commit.yaml -- docker_config.yaml -- docker_container.yaml -- docker_cp.yaml -- docker_create.yaml -- docker_deploy.yaml -- docker_diff.yaml -- docker_events.yaml -- docker_exec.yaml -- docker_export.yaml -- docker_history.yaml -- docker_image.yaml -- docker_images.yaml -- docker_import.yaml -- docker_info.yaml -- docker_inspect.yaml -- docker_kill.yaml -- docker_load.yaml -- docker_login.yaml -- docker_logout.yaml -- docker_logs.yaml -- docker_manifest.yaml -- docker_network.yaml -- docker_node.yaml -- docker_pause.yaml -- docker_plugin.yaml -- docker_port.yaml -- docker_ps.yaml -- docker_pull.yaml -- docker_push.yaml -- docker_rename.yaml -- docker_restart.yaml -- docker_rm.yaml -- docker_rmi.yaml -- docker_run.yaml -- docker_save.yaml -- docker_search.yaml -- docker_secret.yaml -- docker_service.yaml -- docker_stack.yaml -- docker_start.yaml -- docker_stats.yaml -- docker_stop.yaml -- docker_swarm.yaml -- docker_system.yaml -- docker_tag.yaml -- docker_top.yaml -- docker_trust.yaml -- docker_unpause.yaml -- docker_update.yaml -- docker_version.yaml -- docker_volume.yaml -- docker_wait.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_attach.yaml b/_data/engine-cli-edge/docker_attach.yaml deleted file mode 100644 index 9497cb5cb4..0000000000 --- a/_data/engine-cli-edge/docker_attach.yaml +++ /dev/null @@ -1,166 +0,0 @@ -command: docker attach -short: Attach local standard input, output, and error streams to a running container -long: |- - Use `docker attach` to attach your terminal's standard input, output, and error - (or any combination of the three) to a running container using the container's - ID or name. This allows you to view its ongoing output or to control it - interactively, as though the commands were running directly in your terminal. - - > **Note:** - > The `attach` command will display the output of the `ENTRYPOINT/CMD` process. This - > can appear as if the attach command is hung when in fact the process may simply - > not be interacting with the terminal at that time. - - You can attach to the same contained process multiple times simultaneously, - from different sessions on the Docker host. - - To stop a container, use `CTRL-c`. This key sequence sends `SIGKILL` to the - container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to - the container. You can detach from a container and leave it running using the - `CTRL-p CTRL-q` key sequence. - - > **Note:** - > A process running as PID 1 inside a container is treated specially by - > Linux: it ignores any signal with the default action. So, the process - > will not terminate on `SIGINT` or `SIGTERM` unless it is coded to do - > so. - - It is forbidden to redirect the standard input of a `docker attach` command - while attaching to a tty-enabled container (i.e.: launched with `-t`). - - While a client is connected to container's stdio using `docker attach`, Docker - uses a ~1MB memory buffer to maximize the throughput of the application. If - this buffer is filled, the speed of the API connection will start to have an - effect on the process output writing speed. This is similar to other - applications like SSH. Because of this, it is not recommended to run - performance critical applications that generate a lot of output in the - foreground over a slow client connection. Instead, users should use the - `docker logs` command to get access to the logs. - - ### Override the detach sequence - - If you want, you can configure an override the Docker key sequence for detach. - This is useful if the Docker default sequence conflicts with key sequence you - use for other applications. There are two ways to define your own detach key - sequence, as a per-container override or as a configuration property on your - entire configuration. - - To override the sequence for an individual container, use the - `--detach-keys=""` flag with the `docker attach` command. The format of - the `` is either a letter [a-Z], or the `ctrl-` combined with any of - the following: - - * `a-z` (a single lowercase alpha character ) - * `@` (at sign) - * `[` (left bracket) - * `\\` (two backward slashes) - * `_` (underscore) - * `^` (caret) - - These `a`, `ctrl-a`, `X`, or `ctrl-\\` values are all examples of valid key - sequences. To configure a different configuration default key sequence for all - containers, see [**Configuration file** section](cli.md#configuration-files). -usage: docker attach [OPTIONS] CONTAINER -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: no-stdin - value_type: bool - default_value: "false" - description: Do not attach STDIN - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sig-proxy - value_type: bool - default_value: "true" - description: Proxy all received signals to the process - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Attach to and detach from a running container - - ```bash - $ docker run -d --name topdemo ubuntu /usr/bin/top -b - - $ docker attach topdemo - - top - 02:05:52 up 3:05, 0 users, load average: 0.01, 0.02, 0.05 - Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie - Cpu(s): 0.1%us, 0.2%sy, 0.0%ni, 99.7%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st - Mem: 373572k total, 355560k used, 18012k free, 27872k buffers - Swap: 786428k total, 0k used, 786428k free, 221740k cached - - PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND - 1 root 20 0 17200 1116 912 R 0 0.3 0:00.03 top - - top - 02:05:55 up 3:05, 0 users, load average: 0.01, 0.02, 0.05 - Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie - Cpu(s): 0.0%us, 0.2%sy, 0.0%ni, 99.8%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st - Mem: 373572k total, 355244k used, 18328k free, 27872k buffers - Swap: 786428k total, 0k used, 786428k free, 221776k cached - - PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND - 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top - - - top - 02:05:58 up 3:06, 0 users, load average: 0.01, 0.02, 0.05 - Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie - Cpu(s): 0.2%us, 0.3%sy, 0.0%ni, 99.5%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st - Mem: 373572k total, 355780k used, 17792k free, 27880k buffers - Swap: 786428k total, 0k used, 786428k free, 221776k cached - - PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND - 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top - ^C$ - - $ echo $? - 0 - $ docker ps -a | grep topdemo - - 7998ac8581f9 ubuntu:14.04 "/usr/bin/top -b" 38 seconds ago Exited (0) 21 seconds ago topdemo - ``` - - ### Get the exit code of the container's command - - And in this second example, you can see the exit code returned by the `bash` - process is returned by the `docker attach` command to its caller too: - - ```bash - $ docker run --name test -d -it debian - - 275c44472aebd77c926d4527885bb09f2f6db21d878c75f0a1c212c03d3bcfab - - $ docker attach test - - root@f38c87f2a42d:/# exit 13 - - exit - - $ echo $? - - 13 - - $ docker ps -a | grep test - - 275c44472aeb debian:7 "/bin/bash" 26 seconds ago Exited (13) 17 seconds ago test - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_build.yaml b/_data/engine-cli-edge/docker_build.yaml deleted file mode 100644 index 9955ac989b..0000000000 --- a/_data/engine-cli-edge/docker_build.yaml +++ /dev/null @@ -1,580 +0,0 @@ -command: docker build -short: Build an image from a Dockerfile -long: |- - The `docker build` command builds Docker images from a Dockerfile and a - "context". A build's context is the set of files located in the specified - `PATH` or `URL`. The build process can refer to any of the files in the - context. For example, your build can use a [*COPY*](../builder.md#copy) - instruction to reference a file in the context. - - The `URL` parameter can refer to three kinds of resources: Git repositories, - pre-packaged tarball contexts and plain text files. - - ### Git repositories - - When the `URL` parameter points to the location of a Git repository, the - 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 - 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. - - > **Note:** - > If the `URL` parameter contains a fragment the system will recursively clone - > the repository and its submodules using a `git clone --recursive` command. - - Git URLs accept context configuration in their fragment section, separated by a - colon `:`. The first part represents the reference that Git will check out, - and can be either a branch, a tag, or a remote reference. The second part - represents a subdirectory inside the repository that will be used as a build - context. - - For example, run this command to use a directory called `docker` in the branch - `container`: - - ```bash - $ docker build https://github.com/docker/rootfs.git#container:docker - ``` - - The following table represents all the valid suffixes with their build - contexts: - - Build Syntax Suffix | Commit Used | Build Context Used - --------------------------------|-----------------------|------------------- - `myrepo.git` | `refs/heads/master` | `/` - `myrepo.git#mytag` | `refs/tags/mytag` | `/` - `myrepo.git#mybranch` | `refs/heads/mybranch` | `/` - `myrepo.git#pull/42/head` | `refs/pull/42/head` | `/` - `myrepo.git#:myfolder` | `refs/heads/master` | `/myfolder` - `myrepo.git#master:myfolder` | `refs/heads/master` | `/myfolder` - `myrepo.git#mytag:myfolder` | `refs/tags/mytag` | `/myfolder` - `myrepo.git#mybranch:myfolder` | `refs/heads/mybranch` | `/myfolder` - - - ### Tarball contexts - - If you pass an URL to a remote tarball, the URL itself is sent to the daemon: - - ```bash - $ docker build http://server/context.tar.gz - ``` - - The download operation will be performed on the host the Docker daemon is - running on, which is not necessarily the same host from which the build command - is being issued. The Docker daemon will fetch `context.tar.gz` and use it as the - build context. Tarball contexts must be tar archives conforming to the standard - `tar` UNIX format and can be compressed with any one of the 'xz', 'bzip2', - 'gzip' or 'identity' (no compression) formats. - - ### Text files - - Instead of specifying a context, you can pass a single `Dockerfile` in the - `URL` or pipe the file in via `STDIN`. To pipe a `Dockerfile` from `STDIN`: - - ```bash - $ docker build - < Dockerfile - ``` - - With Powershell on Windows, you can run: - - ```powershell - Get-Content Dockerfile | docker build - - ``` - - If you use `STDIN` or specify a `URL` pointing to a plain text file, the system - places the contents into a file called `Dockerfile`, and any `-f`, `--file` - option is ignored. In this scenario, there is no context. - - By default the `docker build` command will look for a `Dockerfile` at the root - of the build context. The `-f`, `--file`, option lets you specify the path to - an alternative file to use instead. This is useful in cases where the same set - of files are used for multiple builds. The path must be to a file within the - build context. If a relative path is specified then it is interpreted as - relative to the root of the context. - - In most cases, it's best to put each Dockerfile in an empty directory. Then, - add to that directory only the files needed for building the Dockerfile. To - increase the build's performance, you can exclude files and directories by - adding a `.dockerignore` file to that directory as well. For information on - creating one, see the [.dockerignore file](../builder.md#dockerignore-file). - - If the Docker client loses connection to the daemon, the build is canceled. - This happens if you interrupt the Docker client with `CTRL-c` or if the Docker - client is killed for any reason. If the build initiated a pull which is still - running at the time the build is cancelled, the pull is cancelled as well. -usage: docker build [OPTIONS] PATH | URL | - -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: build-arg - value_type: list - description: Set build-time variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cache-from - value_type: stringSlice - default_value: '[]' - description: Images to consider as cache sources - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: compress - value_type: bool - default_value: "false" - description: Compress the build context using gzip - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit the CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit the CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: file - shorthand: f - value_type: string - description: Name of the Dockerfile (Default is 'PATH/Dockerfile') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force-rm - value_type: bool - default_value: "false" - description: Always remove intermediate containers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: iidfile - value_type: string - description: Write the image ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - value_type: list - description: Set metadata for an image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: no-cache - value_type: bool - default_value: "false" - description: Do not use cache when building the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: pull - value_type: bool - default_value: "false" - description: Always attempt to pull a newer version of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress the build output and print image ID on success - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "true" - description: Remove intermediate containers after a successful build - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: stringSlice - default_value: '[]' - description: Security options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: squash - value_type: bool - default_value: "false" - description: Squash newly built layers into a single new layer - deprecated: false - min_api_version: "1.25" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: tag - shorthand: t - value_type: list - description: Name and optionally a tag in the 'name:tag' format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: target - value_type: string - description: Set the target build stage to build. - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240 - bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284 - MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh - /\n ---> Running in 9c9e81692ae9\ntotal 24\ndrwxr-xr-x 2 root root 4.0K - Mar 12 2013 bin\ndrwxr-xr-x 5 root root 4.0K Oct 19 00:19 dev\ndrwxr-xr-x - \ 2 root root 4.0K Oct 19 00:19 etc\ndrwxr-xr-x 2 root root - \ 4.0K Nov 15 23:34 lib\nlrwxrwxrwx 1 root root 3 Mar 12 - \ 2013 lib64 -> lib\ndr-xr-xr-x 116 root root 0 Nov 15 23:34 proc\nlrwxrwxrwx - \ 1 root root 3 Mar 12 2013 sbin -> bin\ndr-xr-xr-x 13 root root - \ 0 Nov 15 23:34 sys\ndrwxr-xr-x 2 root root 4.0K Mar 12 - \ 2013 tmp\ndrwxr-xr-x 2 root root 4.0K Nov 15 23:34 usr\n ---> b35f4035db3f\nStep - 3/3 : CMD echo Hello world\n ---> Running in 02071fceb21b\n ---> f52f38b7823e\nSuccessfully - built f52f38b7823e\nRemoving intermediate container 9c9e81692ae9\nRemoving intermediate - container 02071fceb21b\n```\n\nThis example specifies that the `PATH` is `.`, and - so all the files in the\nlocal directory get `tar`d and sent to the Docker daemon. - The `PATH` specifies\nwhere to find the files for the \"context\" of the build on - the Docker daemon.\nRemember that the daemon could be running on a remote machine - and that no\nparsing of the Dockerfile happens at the client side (where you're - running\n`docker build`). That means that *all* the files at `PATH` get sent, not - just\nthe ones listed to [*ADD*](../builder.md#add) in the Dockerfile.\n\nThe transfer - of context from the local machine to the Docker daemon is what the\n`docker` client - means when you see the \"Sending build context\" message.\n\nIf you wish to keep - the intermediate containers after the build is complete,\nyou must use `--rm=false`. - This does not affect the build cache.\n\n### Build with URL\n\n```bash\n$ docker - build github.com/creack/docker-firefox\n```\n\nThis will clone the GitHub repository - and use the cloned repository as context.\nThe Dockerfile at the root of the repository - is used as Dockerfile. You can\nspecify an arbitrary Git repository by using the - `git://` or `git@` scheme.\n\n```bash\n$ docker build -f ctx/Dockerfile http://server/ctx.tar.gz\n\nDownloading - context: http://server/ctx.tar.gz [===================>] 240 B/240 B\nStep 1/3 - : FROM busybox\n ---> 8c2e06607696\nStep 2/3 : ADD ctx/container.cfg /\n ---> e7829950cee3\nRemoving - intermediate container b35224abf821\nStep 3/3 : CMD /bin/ls\n ---> Running in fbc63d321d73\n - ---> 3286931702ad\nRemoving intermediate container fbc63d321d73\nSuccessfully built - 377c409b35e4\n```\n\nThis sends the URL `http://server/ctx.tar.gz` to the Docker - daemon, which\ndownloads and extracts the referenced tarball. The `-f ctx/Dockerfile`\nparameter - specifies a path inside `ctx.tar.gz` to the `Dockerfile` that is used\nto build - the image. Any `ADD` commands in that `Dockerfile` that refers to local\npaths must - be relative to the root of the contents inside `ctx.tar.gz`. In the\nexample above, - the tarball contains a directory `ctx/`, so the `ADD\nctx/container.cfg /` operation - works as expected.\n\n### Build with -\n\n```bash\n$ docker build - < Dockerfile\n```\n\nThis - will read a Dockerfile from `STDIN` without context. Due to the lack of a\ncontext, - no contents of any local directory will be sent to the Docker daemon.\nSince there - is no context, a Dockerfile `ADD` only works if it refers to a\nremote URL.\n\n```bash\n$ - docker build - < context.tar.gz\n```\n\nThis will build an image for a compressed - context read from `STDIN`. Supported\nformats are: bzip2, gzip and xz.\n\n### Use - a .dockerignore file\n\n```bash\n$ docker build .\n\nUploading context 18.829 MB\nUploading - context\nStep 1/2 : FROM busybox\n ---> 769b9341d937\nStep 2/2 : CMD echo Hello - world\n ---> Using cache\n ---> 99cc1ad10469\nSuccessfully built 99cc1ad10469\n$ - echo \".git\" > .dockerignore\n$ docker build .\nUploading context 6.76 MB\nUploading - context\nStep 1/2 : FROM busybox\n ---> 769b9341d937\nStep 2/2 : CMD echo Hello - world\n ---> Using cache\n ---> 99cc1ad10469\nSuccessfully built 99cc1ad10469\n```\n\nThis - example shows the use of the `.dockerignore` file to exclude the `.git`\ndirectory - from the context. Its effect can be seen in the changed size of the\nuploaded context. - The builder reference contains detailed information on\n[creating a .dockerignore - file](../builder.md#dockerignore-file)\n\n### Tag an image (-t)\n\n```bash\n$ docker - build -t vieux/apache:2.0 .\n```\n\nThis will build like the previous example, but - it will then tag the resulting\nimage. The repository name will be `vieux/apache` - and the tag will be `2.0`.\n[Read more about valid tags](tag.md).\n\nYou can apply - multiple tags to an image. For example, you can apply the `latest`\ntag to a newly - built image and add another tag that references a specific\nversion.\nFor example, - to tag an image both as `whenry/fedora-jboss:latest` and\n`whenry/fedora-jboss:v2.1`, - use the following:\n\n```bash\n$ docker build -t whenry/fedora-jboss:latest -t whenry/fedora-jboss:v2.1 - .\n```\n\n### Specify a Dockerfile (-f)\n\n```bash\n$ docker build -f Dockerfile.debug - .\n```\n\nThis will use a file called `Dockerfile.debug` for the build instructions\ninstead - of `Dockerfile`.\n\n```bash\n$ curl example.com/remote/Dockerfile | docker build - -f - .\n```\n\nThe above command will use the current directory as the build context - and read\na Dockerfile from stdin.\n\n```bash\n$ docker build -f dockerfiles/Dockerfile.debug - -t myapp_debug .\n$ docker build -f dockerfiles/Dockerfile.prod -t myapp_prod .\n```\n\nThe - above commands will build the current build context (as specified by the\n`.`) twice, - once using a debug version of a `Dockerfile` and once using a\nproduction version.\n\n```bash\n$ - cd /home/me/myapp/some/dir/really/deep\n$ docker build -f /home/me/myapp/dockerfiles/debug - /home/me/myapp\n$ docker build -f ../../../../dockerfiles/debug /home/me/myapp\n```\n\nThese - two `docker build` commands do the exact same thing. They both use the\ncontents - of the `debug` file instead of looking for a `Dockerfile` and will use\n`/home/me/myapp` - as the root of the build context. Note that `debug` is in the\ndirectory structure - of the build context, regardless of how you refer to it on\nthe command line.\n\n> - **Note:**\n> `docker build` will return a `no such file or directory` error if the\n> - file or directory does not exist in the uploaded context. This may\n> happen if - there is no context, or if you specify a file that is\n> elsewhere on the Host system. - The context is limited to the current\n> directory (and its children) for security - reasons, and to ensure\n> repeatable builds on remote Docker hosts. This is also - the reason why\n> `ADD ../file` will not work.\n\n### Use a custom parent cgroup - (--cgroup-parent)\n\nWhen `docker build` is run with the `--cgroup-parent` option - the containers\nused in the build will be run with the [corresponding `docker run`\nflag](../run.md#specifying-custom-cgroups).\n\n### - Set ulimits in container (--ulimit)\n\nUsing the `--ulimit` option with `docker - build` will cause each build step's\ncontainer to be started using those [`--ulimit`\nflag - values](./run.md#set-ulimits-in-container-ulimit).\n\n### Set build-time variables - (--build-arg)\n\nYou can use `ENV` instructions in a Dockerfile to define variable\nvalues. - These values persist in the built image. However, often\npersistence is not what - you want. Users want to specify variables differently\ndepending on which host they - build an image on.\n\nA good example is `http_proxy` or source versions for pulling - intermediate\nfiles. The `ARG` instruction lets Dockerfile authors define values - that users\ncan set at build-time using the `--build-arg` flag:\n\n```bash\n$ docker - build --build-arg HTTP_PROXY=http://10.20.30.2:1234 --build-arg FTP_PROXY=http://40.50.60.5:4567 - .\n```\n\nThis flag allows you to pass the build-time variables that are\naccessed - like regular environment variables in the `RUN` instruction of the\nDockerfile. - Also, these values don't persist in the intermediate or final images\nlike `ENV` - values do. You must add `--build-arg` for each build argument. \n\nUsing this - flag will not alter the output you see when the `ARG` lines from the\nDockerfile - are echoed during the build process.\n\nFor detailed information on using `ARG` - and `ENV` instructions, see the\n[Dockerfile reference](../builder.md).\n\nYou may - also use the `--build-arg` flag without a value, in which case the value\nfrom the - local environment will be propagated into the Docker container being\nbuilt:\n\n```bash\n$ - export HTTP_PROXY=http://10.20.30.2:1234\n$ docker build --build-arg HTTP_PROXY - .\n```\n\nThis is similar to how `docker run -e` works. Refer to the [`docker run` - documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)\nfor - more information.\n\n### Optional security options (--security-opt)\n\nThis flag - is only supported on a daemon running on Windows, and only supports\nthe `credentialspec` - option. The `credentialspec` must be in the format\n`file://spec.txt` or `registry://keyname`.\n\n### - Specify isolation technology for container (--isolation)\n\nThis option is useful - in situations where you are running Docker containers on\nWindows. The `--isolation=` - option sets a container's isolation\ntechnology. On Linux, the only supported is - the `default` option which uses\nLinux namespaces. On Microsoft Windows, you can - specify these values:\n\n\n| Value | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| - `default` | Use the value specified by the Docker daemon's `--exec-opt` . If the - `daemon` does not specify an isolation technology, Microsoft Windows uses `process` - as its default value. |\n| `process` | Namespace isolation only. |\n| - `hyperv` | Hyper-V hypervisor partition-based isolation. |\n\nSpecifying - the `--isolation` flag without a value is the same as setting `--isolation=\"default\"`.\n\n### - Add entries to container hosts file (--add-host)\n\nYou can add other hosts into - a container's `/etc/hosts` file by using one or\nmore `--add-host` flags. This example - adds a static address for a host named\n`docker`:\n\n $ docker build --add-host=docker:10.180.0.1 - .\n\n### Specifying target build stage (--target)\n\nWhen building a Dockerfile - with multiple build stages, `--target` can be used to\nspecify an intermediate build - stage by name as a final stage for the resulting\nimage. Commands after the target - stage will be skipped.\n\n```Dockerfile\nFROM debian AS build-env\n...\n\nFROM alpine - AS production-env\n...\n```\n\n```bash\n$ docker build -t mybuildimage --target - build-env .\n```\n\n### Squash an image's layers (--squash) (experimental)\n\n#### - Overview\n\nOnce the image is built, squash the new layers into a new image with - a single\nnew layer. Squashing does not destroy any existing image, rather it creates - a new\nimage with the content of the squashed layers. This effectively makes it - look\nlike all `Dockerfile` commands were created with a single layer. The build\ncache - is preserved with this method.\n\nThe `--squash` option is an experimental feature, - and should not be considered\nstable.\n\n\nSquashing layers can be beneficial if - your Dockerfile produces multiple layers\nmodifying the same files, for example, - file that are created in one step, and\nremoved in another step. For other use-cases, - squashing images may actually have\na negative impact on performance; when pulling - an image consisting of multiple\nlayers, layers can be pulled in parallel, and allows - sharing layers between\nimages (saving space).\n\nFor most use cases, multi-stage - are a better alternative, as they give more\nfine-grained control over your build, - and can take advantage of future\noptimizations in the builder. Refer to the [use - multi-stage builds](https://docs.docker.com/engine/userguide/eng-image/multistage-build/)\nsection - in the userguide for more information.\n\n\n#### Known limitations\n\nThe `--squash` - option has a number of known limitations:\n\n- When squashing layers, the resulting - image cannot take advantage of layer\n sharing with other images, and may use significantly - more space. Sharing the\n base image is still supported.\n- When using this option - you may see significantly more space used due to\n storing two copies of the image, - one for the build cache with all the cache\n layers in tact, and one for the squashed - version.\n- While squashing layers may produce smaller images, it may have a negative\n - \ impact on performance, as a single layer takes longer to extract, and\n downloading - a single layer cannot be parallelized.\n- When attempting to squash an image that - does not make changes to the\n filesystem (for example, the Dockerfile only contains - `ENV` instructions),\n the squash step will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n#### - Prerequisites\n\nThe example on this page is using experimental mode in Docker 1.13.\n\nExperimental - mode can be enabled by using the `--experimental` flag when starting the Docker - daemon or setting `experimental: true` in the `daemon.json` configuration file.\n\nBy - default, experimental mode is disabled. To see the current configuration, use the - `docker version` command.\n\n```none\nServer:\n Version: 1.13.1\n API version: - \ 1.26 (minimum version 1.12)\n Go version: go1.7.5\n Git commit: 092cba3\n - Built: Wed Feb 8 06:35:24 2017\n OS/Arch: linux/amd64\n Experimental: - false\n\n [...]\n```\n\nTo enable experimental mode, users need to restart the docker - daemon with the experimental flag enabled.\n\n#### Enable Docker experimental\n\nExperimental - features are now included in the standard Docker binaries as of version 1.13.0. - For enabling experimental features, you need to start the Docker daemon with `--experimental` - flag. You can also enable the daemon flag via /etc/docker/daemon.json. e.g.\n\n```json\n{\n - \ \"experimental\": true\n}\n```\n\nThen make sure the experimental flag is enabled:\n\n```bash\n$ - docker version -f '{{.Server.Experimental}}'\ntrue\n```\n\n#### Build an image with - `--squash` argument\n\nThe following is an example of docker build with `--squash` - argument\n\n```Dockerfile\nFROM busybox\nRUN echo hello > /hello\nRUN echo world - >> /hello\nRUN touch remove_me /remove_me\nENV HELLO world\nRUN rm /remove_me\n```\n\nAn - image named `test` is built with `--squash` argument.\n\n```bash\n$ docker build - --squash -t test .\n\n[...]\n```\n\nIf everything is right, the history will look - like this:\n\n```bash\n$ docker history test\n\nIMAGE CREATED CREATED - BY SIZE COMMENT\n4e10cb5b4cac - \ 3 seconds ago 12 B - \ merge sha256:88a7b0112a41826885df0e7072698006ee8f621c6ab99fca7fe9151d7b599702 - to sha256:47bcc53f74dc94b1920f0b34f6036096526296767650f223433fe65c35f149eb\n - \ 5 minutes ago /bin/sh -c rm /remove_me 0 - B\n 5 minutes ago /bin/sh -c #(nop) ENV HELLO=world 0 - B\n 5 minutes ago /bin/sh -c touch remove_me /remove_me - \ 0 B\n 5 minutes ago /bin/sh -c echo world >> - /hello 0 B\n 6 minutes ago /bin/sh -c echo - hello > /hello 0 B\n 7 weeks ago /bin/sh - -c #(nop) CMD [\"sh\"] 0 B\n 7 weeks ago /bin/sh - -c #(nop) ADD file:47ca6e777c36a4cfff 1.113 MB\n```\n\nWe could find that all - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_checkpoint.yaml b/_data/engine-cli-edge/docker_checkpoint.yaml deleted file mode 100644 index 970f801688..0000000000 --- a/_data/engine-cli-edge/docker_checkpoint.yaml +++ /dev/null @@ -1,21 +0,0 @@ -command: docker checkpoint -short: Manage checkpoints -long: Manage checkpoints -usage: docker checkpoint -pname: docker -plink: docker.yaml -cname: -- docker checkpoint create -- docker checkpoint ls -- docker checkpoint rm -clink: -- docker_checkpoint_create.yaml -- docker_checkpoint_ls.yaml -- docker_checkpoint_rm.yaml -deprecated: false -min_api_version: "1.25" -experimental: true -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_checkpoint_create.yaml b/_data/engine-cli-edge/docker_checkpoint_create.yaml deleted file mode 100644 index c21eac46c2..0000000000 --- a/_data/engine-cli-edge/docker_checkpoint_create.yaml +++ /dev/null @@ -1,31 +0,0 @@ -command: docker checkpoint create -short: Create a checkpoint from a running container -long: Create a checkpoint from a running container -usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT -pname: docker checkpoint -plink: docker_checkpoint.yaml -options: -- option: checkpoint-dir - value_type: string - description: Use a custom checkpoint storage directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: leave-running - value_type: bool - default_value: "false" - description: Leave the container running after checkpoint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.25" -experimental: true -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_checkpoint_ls.yaml b/_data/engine-cli-edge/docker_checkpoint_ls.yaml deleted file mode 100644 index 4f37970d31..0000000000 --- a/_data/engine-cli-edge/docker_checkpoint_ls.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker checkpoint ls -aliases: list -short: List checkpoints for a container -long: List checkpoints for a container -usage: docker checkpoint ls [OPTIONS] CONTAINER -pname: docker checkpoint -plink: docker_checkpoint.yaml -options: -- option: checkpoint-dir - value_type: string - description: Use a custom checkpoint storage directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.25" -experimental: true -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_checkpoint_rm.yaml b/_data/engine-cli-edge/docker_checkpoint_rm.yaml deleted file mode 100644 index 95bcadddd4..0000000000 --- a/_data/engine-cli-edge/docker_checkpoint_rm.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker checkpoint rm -aliases: remove -short: Remove a checkpoint -long: Remove a checkpoint -usage: docker checkpoint rm [OPTIONS] CONTAINER CHECKPOINT -pname: docker checkpoint -plink: docker_checkpoint.yaml -options: -- option: checkpoint-dir - value_type: string - description: Use a custom checkpoint storage directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.25" -experimental: true -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_commit.yaml b/_data/engine-cli-edge/docker_commit.yaml deleted file mode 100644 index f3f4ffc39a..0000000000 --- a/_data/engine-cli-edge/docker_commit.yaml +++ /dev/null @@ -1,133 +0,0 @@ -command: docker commit -short: Create a new image from a container's changes -long: |- - It can be useful to commit a container's file changes or settings into a new - image. This allows you to debug a container by running an interactive shell, or to - export a working dataset to another server. Generally, it is better to use - Dockerfiles to manage your images in a documented and maintainable way. - [Read more about valid image names and tags](tag.md). - - The commit operation will not include any data contained in - volumes mounted inside the container. - - By default, the container being committed and its processes will be paused - while the image is committed. This reduces the likelihood of encountering data - corruption during the process of creating the commit. If this behavior is - undesired, set the `--pause` option to false. - - The `--change` option will apply `Dockerfile` instructions to the image that is - created. Supported `Dockerfile` instructions: - `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`LABEL`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` -usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]] -pname: docker -plink: docker.yaml -options: -- option: author - shorthand: a - value_type: string - description: Author (e.g., "John Hannibal Smith ") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: change - shorthand: c - value_type: list - description: Apply Dockerfile instruction to the created image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: message - shorthand: m - value_type: string - description: Commit message - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pause - shorthand: p - value_type: bool - default_value: "true" - description: Pause container during commit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Commit a container - - ```bash - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky - 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton - - $ docker commit c3f279d17e0a svendowideit/testimage:version3 - - f5283438590d - - $ docker images - - REPOSITORY TAG ID CREATED SIZE - svendowideit/testimage version3 f5283438590d 16 seconds ago 335.7 MB - ``` - - ### Commit a container with new configurations - - ```bash - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky - 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton - - $ docker inspect -f "{{ .Config.Env }}" c3f279d17e0a - - [HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin] - - $ docker commit --change "ENV DEBUG true" c3f279d17e0a svendowideit/testimage:version3 - - f5283438590d - - $ docker inspect -f "{{ .Config.Env }}" f5283438590d - - [HOME=/ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin DEBUG=true] - ``` - - ### Commit a container with new `CMD` and `EXPOSE` instructions - - ```bash - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky - 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton - - $ docker commit --change='CMD ["apachectl", "-DFOREGROUND"]' -c "EXPOSE 80" c3f279d17e0a svendowideit/testimage:version4 - - f5283438590d - - $ docker run -d svendowideit/testimage:version4 - - 89373736e2e7f00bc149bd783073ac43d0507da250e999f3f1036e0db60817c0 - - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 89373736e2e7 testimage:version4 "apachectl -DFOREGROU" 3 seconds ago Up 2 seconds 80/tcp distracted_fermat - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_config.yaml b/_data/engine-cli-edge/docker_config.yaml deleted file mode 100644 index 3689f3b235..0000000000 --- a/_data/engine-cli-edge/docker_config.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker config -short: Manage Docker configs -long: Manage Docker configs -usage: docker config -pname: docker -plink: docker.yaml -cname: -- docker config create -- docker config inspect -- docker config ls -- docker config rm -clink: -- docker_config_create.yaml -- docker_config_inspect.yaml -- docker_config_ls.yaml -- docker_config_rm.yaml -deprecated: false -min_api_version: "1.30" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_config_create.yaml b/_data/engine-cli-edge/docker_config_create.yaml deleted file mode 100644 index afb9df737f..0000000000 --- a/_data/engine-cli-edge/docker_config_create.yaml +++ /dev/null @@ -1,31 +0,0 @@ -command: docker config create -short: Create a config from a file or STDIN -long: Create a config from a file or STDIN -usage: docker config create [OPTIONS] CONFIG file|- -pname: docker config -plink: docker_config.yaml -options: -- option: label - shorthand: l - value_type: list - description: Config labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: template-driver - value_type: string - description: Template driver - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.30" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_config_inspect.yaml b/_data/engine-cli-edge/docker_config_inspect.yaml deleted file mode 100644 index 015af0db13..0000000000 --- a/_data/engine-cli-edge/docker_config_inspect.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker config inspect -short: Display detailed information on one or more configs -long: Display detailed information on one or more configs -usage: docker config inspect [OPTIONS] CONFIG [CONFIG...] -pname: docker config -plink: docker_config.yaml -options: -- option: format - shorthand: f - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pretty - value_type: bool - default_value: "false" - description: Print the information in a human friendly format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.30" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_config_ls.yaml b/_data/engine-cli-edge/docker_config_ls.yaml deleted file mode 100644 index 100f632f72..0000000000 --- a/_data/engine-cli-edge/docker_config_ls.yaml +++ /dev/null @@ -1,42 +0,0 @@ -command: docker config ls -aliases: list -short: List configs -long: List configs -usage: docker config ls [OPTIONS] -pname: docker config -plink: docker_config.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print configs using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.30" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_config_rm.yaml b/_data/engine-cli-edge/docker_config_rm.yaml deleted file mode 100644 index 991ecfc9ec..0000000000 --- a/_data/engine-cli-edge/docker_config_rm.yaml +++ /dev/null @@ -1,14 +0,0 @@ -command: docker config rm -aliases: remove -short: Remove one or more configs -long: Remove one or more configs -usage: docker config rm CONFIG [CONFIG...] -pname: docker config -plink: docker_config.yaml -deprecated: false -min_api_version: "1.30" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_container.yaml b/_data/engine-cli-edge/docker_container.yaml deleted file mode 100644 index 3c501b4487..0000000000 --- a/_data/engine-cli-edge/docker_container.yaml +++ /dev/null @@ -1,64 +0,0 @@ -command: docker container -short: Manage containers -long: Manage containers. -usage: docker container -pname: docker -plink: docker.yaml -cname: -- docker container attach -- docker container commit -- docker container cp -- docker container create -- docker container diff -- docker container exec -- docker container export -- docker container inspect -- docker container kill -- docker container logs -- docker container ls -- docker container pause -- docker container port -- docker container prune -- docker container rename -- docker container restart -- docker container rm -- docker container run -- docker container start -- docker container stats -- docker container stop -- docker container top -- docker container unpause -- docker container update -- docker container wait -clink: -- docker_container_attach.yaml -- docker_container_commit.yaml -- docker_container_cp.yaml -- docker_container_create.yaml -- docker_container_diff.yaml -- docker_container_exec.yaml -- docker_container_export.yaml -- docker_container_inspect.yaml -- docker_container_kill.yaml -- docker_container_logs.yaml -- docker_container_ls.yaml -- docker_container_pause.yaml -- docker_container_port.yaml -- docker_container_prune.yaml -- docker_container_rename.yaml -- docker_container_restart.yaml -- docker_container_rm.yaml -- docker_container_run.yaml -- docker_container_start.yaml -- docker_container_stats.yaml -- docker_container_stop.yaml -- docker_container_top.yaml -- docker_container_unpause.yaml -- docker_container_update.yaml -- docker_container_wait.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_attach.yaml b/_data/engine-cli-edge/docker_container_attach.yaml deleted file mode 100644 index 95b4d3ede8..0000000000 --- a/_data/engine-cli-edge/docker_container_attach.yaml +++ /dev/null @@ -1,39 +0,0 @@ -command: docker container attach -short: Attach local standard input, output, and error streams to a running container -long: Attach local standard input, output, and error streams to a running container -usage: docker container attach [OPTIONS] CONTAINER -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: no-stdin - value_type: bool - default_value: "false" - description: Do not attach STDIN - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sig-proxy - value_type: bool - default_value: "true" - description: Proxy all received signals to the process - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_commit.yaml b/_data/engine-cli-edge/docker_container_commit.yaml deleted file mode 100644 index 8524a53a5b..0000000000 --- a/_data/engine-cli-edge/docker_container_commit.yaml +++ /dev/null @@ -1,50 +0,0 @@ -command: docker container commit -short: Create a new image from a container's changes -long: Create a new image from a container's changes -usage: docker container commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]] -pname: docker container -plink: docker_container.yaml -options: -- option: author - shorthand: a - value_type: string - description: Author (e.g., "John Hannibal Smith ") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: change - shorthand: c - value_type: list - description: Apply Dockerfile instruction to the created image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: message - shorthand: m - value_type: string - description: Commit message - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pause - shorthand: p - value_type: bool - default_value: "true" - description: Pause container during commit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_cp.yaml b/_data/engine-cli-edge/docker_container_cp.yaml deleted file mode 100644 index e308f4068a..0000000000 --- a/_data/engine-cli-edge/docker_container_cp.yaml +++ /dev/null @@ -1,40 +0,0 @@ -command: docker container cp -short: Copy files/folders between a container and the local filesystem -long: |- - Copy files/folders between a container and the local filesystem - - Use '-' as the source to read a tar archive from stdin - and extract it to a directory destination in a container. - Use '-' as the destination to stream a tar archive of a - container source to stdout. -usage: "docker container cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-\n\tdocker cp - [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH" -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: follow-link - shorthand: L - value_type: bool - default_value: "false" - description: Always follow symbol link in SRC_PATH - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_create.yaml b/_data/engine-cli-edge/docker_container_create.yaml deleted file mode 100644 index e3f2a6790a..0000000000 --- a/_data/engine-cli-edge/docker_container_create.yaml +++ /dev/null @@ -1,852 +0,0 @@ -command: docker container create -short: Create a new container -long: Create a new container -usage: docker container create [OPTIONS] IMAGE [COMMAND] [ARG...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: attach - shorthand: a - value_type: list - description: Attach to STDIN, STDOUT or STDERR - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight - value_type: uint16 - default_value: "0" - description: | - Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight-device - value_type: list - default_value: '[]' - description: Block IO weight (relative device weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-add - value_type: list - description: Add Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-drop - value_type: list - description: Drop Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cidfile - value_type: string - description: Write the container ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-count - value_type: int64 - default_value: "0" - description: CPU count (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-percent - value_type: int64 - default_value: "0" - description: CPU percent (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device - value_type: list - description: Add a host device to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-cgroup-rule - value_type: list - description: Add a rule to the cgroup allowed devices list - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-bps - value_type: list - default_value: '[]' - description: Limit read rate (bytes per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-iops - value_type: list - default_value: '[]' - description: Limit read rate (IO per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-bps - value_type: list - default_value: '[]' - description: Limit write rate (bytes per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-iops - value_type: list - default_value: '[]' - description: Limit write rate (IO per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns - value_type: list - description: Set custom DNS servers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-opt - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search - value_type: list - description: Set custom DNS search domains - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: string - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-file - value_type: list - description: Read in a file of environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: expose - value_type: list - description: Expose a port or a range of ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-add - value_type: list - description: Add additional groups to join - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - default_value: 0s - description: Time between running the check (ms|s|m|h) (default 0s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-start-period - value_type: duration - default_value: 0s - 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: help - value_type: bool - default_value: "false" - description: Print usage - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - shorthand: h - value_type: string - description: Container host name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: init - value_type: bool - default_value: "false" - description: | - Run an init inside the container that forwards signals and reaps processes - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxbandwidth - value_type: bytes - default_value: "0" - description: | - Maximum IO bandwidth limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxiops - value_type: uint64 - default_value: "0" - description: Maximum IOps limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip - value_type: string - description: IPv4 address (e.g., 172.30.100.104) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip6 - value_type: string - description: IPv6 address (e.g., 2001:db8::33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipc - value_type: string - description: IPC mode to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Set meta data on a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-file - value_type: list - description: Read in a line delimited file of labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link - value_type: list - description: Add link to another container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link-local-ip - value_type: list - description: Container IPv4/IPv6 link-local addresses - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Log driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mac-address - value_type: string - description: Container MAC address (e.g., 92:d0:c6:0a:29:33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swappiness - value_type: int64 - default_value: "-1" - description: Tune container memory swappiness (0 to 100) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount - value_type: mount - description: Attach a filesystem mount to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Assign a name to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-kill-disable - value_type: bool - default_value: "false" - description: Disable OOM Killer - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-score-adj - value_type: int - default_value: "0" - description: Tune host's OOM preferences (-1000 to 1000) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pid - value_type: string - description: PID namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pids-limit - value_type: int64 - default_value: "0" - description: Tune container pids limit (set -1 for unlimited) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish - shorthand: p - value_type: list - description: Publish a container's port(s) to the host - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-all - shorthand: P - value_type: bool - default_value: "false" - description: Publish all exposed ports to random ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - default_value: "no" - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "false" - description: Automatically remove the container when it exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: runtime - value_type: string - description: Runtime to use for this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: list - description: Security Options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - default_value: SIGTERM - description: Signal to stop a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-timeout - value_type: int - default_value: "0" - description: Timeout (in seconds) to stop a container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: storage-opt - value_type: list - description: Storage driver options for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sysctl - value_type: map - default_value: map[] - description: Sysctl options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tmpfs - value_type: list - description: Mount a tmpfs directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: userns - value_type: string - description: User namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: uts - value_type: string - description: UTS namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume - shorthand: v - value_type: list - description: Bind mount a volume - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume-driver - value_type: string - description: Optional volume driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes-from - value_type: list - description: Mount volumes from the specified container(s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_diff.yaml b/_data/engine-cli-edge/docker_container_diff.yaml deleted file mode 100644 index 48c1ccf5d3..0000000000 --- a/_data/engine-cli-edge/docker_container_diff.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container diff -short: Inspect changes to files or directories on a container's filesystem -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_exec.yaml b/_data/engine-cli-edge/docker_container_exec.yaml deleted file mode 100644 index 7f6a1a5ea0..0000000000 --- a/_data/engine-cli-edge/docker_container_exec.yaml +++ /dev/null @@ -1,89 +0,0 @@ -command: docker container exec -short: Run a command in a running container -long: Run a command in a running container -usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to the command - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_export.yaml b/_data/engine-cli-edge/docker_container_export.yaml deleted file mode 100644 index e45c77d971..0000000000 --- a/_data/engine-cli-edge/docker_container_export.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker container export -short: Export a container's filesystem as a tar archive -long: Export a container's filesystem as a tar archive -usage: docker container export [OPTIONS] CONTAINER -pname: docker container -plink: docker_container.yaml -options: -- option: output - shorthand: o - value_type: string - description: Write to a file, instead of STDOUT - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_inspect.yaml b/_data/engine-cli-edge/docker_container_inspect.yaml deleted file mode 100644 index c27e4a4506..0000000000 --- a/_data/engine-cli-edge/docker_container_inspect.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker container inspect -short: Display detailed information on one or more containers -long: Display detailed information on one or more containers -usage: docker container inspect [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: size - shorthand: s - value_type: bool - default_value: "false" - description: Display total file sizes - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_kill.yaml b/_data/engine-cli-edge/docker_container_kill.yaml deleted file mode 100644 index 44c184add6..0000000000 --- a/_data/engine-cli-edge/docker_container_kill.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker container kill -short: Kill one or more running containers -long: Kill one or more running containers -usage: docker container kill [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_logs.yaml b/_data/engine-cli-edge/docker_container_logs.yaml deleted file mode 100644 index 4bfb043e3a..0000000000 --- a/_data/engine-cli-edge/docker_container_logs.yaml +++ /dev/null @@ -1,70 +0,0 @@ -command: docker container logs -short: Fetch the logs of a container -long: Fetch the logs of a container -usage: docker container logs [OPTIONS] CONTAINER -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: follow - shorthand: f - value_type: bool - default_value: "false" - description: Follow log output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: since - value_type: string - description: | - Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tail - value_type: string - default_value: all - description: Number of lines to show from the end of the logs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: timestamps - shorthand: t - value_type: bool - default_value: "false" - description: Show timestamps - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: until - value_type: string - description: | - Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_ls.yaml b/_data/engine-cli-edge/docker_container_ls.yaml deleted file mode 100644 index 59f445b59a..0000000000 --- a/_data/engine-cli-edge/docker_container_ls.yaml +++ /dev/null @@ -1,90 +0,0 @@ -command: docker container ls -aliases: ps, list -short: List containers -long: List containers -usage: docker container ls [OPTIONS] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print containers using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: last - shorthand: "n" - value_type: int - default_value: "-1" - description: Show n last created containers (includes all states) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: latest - shorthand: l - value_type: bool - default_value: "false" - description: Show the latest created container (includes all states) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: size - shorthand: s - value_type: bool - default_value: "false" - description: Display total file sizes - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_pause.yaml b/_data/engine-cli-edge/docker_container_pause.yaml deleted file mode 100644 index dd28f672aa..0000000000 --- a/_data/engine-cli-edge/docker_container_pause.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container pause -short: Pause all processes within one or more containers -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_port.yaml b/_data/engine-cli-edge/docker_container_port.yaml deleted file mode 100644 index e211a449a3..0000000000 --- a/_data/engine-cli-edge/docker_container_port.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container port -short: List port mappings or a specific mapping for the container -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_prune.yaml b/_data/engine-cli-edge/docker_container_prune.yaml deleted file mode 100644 index b26f0e296e..0000000000 --- a/_data/engine-cli-edge/docker_container_prune.yaml +++ /dev/null @@ -1,116 +0,0 @@ -command: docker container prune -short: Remove all stopped containers -long: Removes all stopped containers. -usage: docker container prune [OPTIONS] -pname: docker container -plink: docker_container.yaml -options: -- option: filter - value_type: filter - description: Provide filter values (e.g. 'until=') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: Do not prompt for confirmation - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Prune containers - - ```bash - $ docker container prune - WARNING! This will remove all stopped containers. - Are you sure you want to continue? [y/N] y - Deleted Containers: - 4a7f7eebae0f63178aff7eb0aa39cd3f0627a203ab2df258c1a00b456cf20063 - f98f9c2aa1eaf727e4ec9c0283bc7d4aa4762fbdba7f26191f26c97f64090360 - - Total reclaimed space: 212 B - ``` - - ### Filtering - - The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * until (``) - only remove containers created before given timestamp - * label (`label=`, `label==`, `label!=`, or `label!==`) - only remove containers with (or without, in case `label!=...` is used) the specified labels. - - The `until` filter can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the daemon machine’s time. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the daemon will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - The `label` filter accepts two formats. One is the `label=...` (`label=` or `label==`), - which removes containers with the specified labels. The other - format is the `label!=...` (`label!=` or `label!==`), which removes - containers without the specified labels. - - The following removes containers created more than 5 minutes ago: - - ```bash - $ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}' - - CONTAINER ID IMAGE COMMAND CREATED AT STATUS - 61b9efa71024 busybox "sh" 2017-01-04 13:23:33 -0800 PST Exited (0) 41 seconds ago - 53a9bc23a516 busybox "sh" 2017-01-04 13:11:59 -0800 PST Exited (0) 12 minutes ago - - $ docker container prune --force --filter "until=5m" - - Deleted Containers: - 53a9bc23a5168b6caa2bfbefddf1b30f93c7ad57f3dec271fd32707497cb9369 - - Total reclaimed space: 25 B - - $ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}' - - CONTAINER ID IMAGE COMMAND CREATED AT STATUS - 61b9efa71024 busybox "sh" 2017-01-04 13:23:33 -0800 PST Exited (0) 44 seconds ago - ``` - - The following removes containers created before `2017-01-04T13:10:00`: - - ```bash - $ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}' - - CONTAINER ID IMAGE COMMAND CREATED AT STATUS - 53a9bc23a516 busybox "sh" 2017-01-04 13:11:59 -0800 PST Exited (0) 7 minutes ago - 4a75091a6d61 busybox "sh" 2017-01-04 13:09:53 -0800 PST Exited (0) 9 minutes ago - - $ docker container prune --force --filter "until=2017-01-04T13:10:00" - - Deleted Containers: - 4a75091a6d618526fcd8b33ccd6e5928ca2a64415466f768a6180004b0c72c6c - - Total reclaimed space: 27 B - - $ docker ps -a --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.CreatedAt}}\t{{.Status}}' - - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_rename.yaml b/_data/engine-cli-edge/docker_container_rename.yaml deleted file mode 100644 index 088cfe0119..0000000000 --- a/_data/engine-cli-edge/docker_container_rename.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container rename -short: Rename a container -long: Rename a container -usage: docker container rename CONTAINER NEW_NAME -pname: docker container -plink: docker_container.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_restart.yaml b/_data/engine-cli-edge/docker_container_restart.yaml deleted file mode 100644 index 74d8bbac86..0000000000 --- a/_data/engine-cli-edge/docker_container_restart.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker container restart -short: Restart one or more containers -long: Restart one or more containers -usage: docker container restart [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_rm.yaml b/_data/engine-cli-edge/docker_container_rm.yaml deleted file mode 100644 index 0dbfa786f0..0000000000 --- a/_data/engine-cli-edge/docker_container_rm.yaml +++ /dev/null @@ -1,43 +0,0 @@ -command: docker container rm -short: Remove one or more containers -long: Remove one or more containers -usage: docker container rm [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: link - shorthand: l - value_type: bool - default_value: "false" - description: Remove the specified link - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes - shorthand: v - value_type: bool - default_value: "false" - description: Remove the volumes associated with the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_run.yaml b/_data/engine-cli-edge/docker_container_run.yaml deleted file mode 100644 index 37c5e48681..0000000000 --- a/_data/engine-cli-edge/docker_container_run.yaml +++ /dev/null @@ -1,879 +0,0 @@ -command: docker container run -short: Run a command in a new container -long: Run a command in a new container -usage: docker container run [OPTIONS] IMAGE [COMMAND] [ARG...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: attach - shorthand: a - value_type: list - description: Attach to STDIN, STDOUT or STDERR - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight - value_type: uint16 - default_value: "0" - description: | - Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight-device - value_type: list - default_value: '[]' - description: Block IO weight (relative device weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-add - value_type: list - description: Add Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-drop - value_type: list - description: Drop Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cidfile - value_type: string - description: Write the container ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-count - value_type: int64 - default_value: "0" - description: CPU count (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-percent - value_type: int64 - default_value: "0" - description: CPU percent (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach - shorthand: d - value_type: bool - default_value: "false" - description: Run container in background and print container ID - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device - value_type: list - description: Add a host device to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-cgroup-rule - value_type: list - description: Add a rule to the cgroup allowed devices list - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-bps - value_type: list - default_value: '[]' - description: Limit read rate (bytes per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-iops - value_type: list - default_value: '[]' - description: Limit read rate (IO per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-bps - value_type: list - default_value: '[]' - description: Limit write rate (bytes per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-iops - value_type: list - default_value: '[]' - description: Limit write rate (IO per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns - value_type: list - description: Set custom DNS servers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-opt - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search - value_type: list - description: Set custom DNS search domains - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: string - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-file - value_type: list - description: Read in a file of environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: expose - value_type: list - description: Expose a port or a range of ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-add - value_type: list - description: Add additional groups to join - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - default_value: 0s - description: Time between running the check (ms|s|m|h) (default 0s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-start-period - value_type: duration - default_value: 0s - 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: help - value_type: bool - default_value: "false" - description: Print usage - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - shorthand: h - value_type: string - description: Container host name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: init - value_type: bool - default_value: "false" - description: | - Run an init inside the container that forwards signals and reaps processes - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxbandwidth - value_type: bytes - default_value: "0" - description: | - Maximum IO bandwidth limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxiops - value_type: uint64 - default_value: "0" - description: Maximum IOps limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip - value_type: string - description: IPv4 address (e.g., 172.30.100.104) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip6 - value_type: string - description: IPv6 address (e.g., 2001:db8::33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipc - value_type: string - description: IPC mode to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Set meta data on a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-file - value_type: list - description: Read in a line delimited file of labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link - value_type: list - description: Add link to another container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link-local-ip - value_type: list - description: Container IPv4/IPv6 link-local addresses - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Log driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mac-address - value_type: string - description: Container MAC address (e.g., 92:d0:c6:0a:29:33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swappiness - value_type: int64 - default_value: "-1" - description: Tune container memory swappiness (0 to 100) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount - value_type: mount - description: Attach a filesystem mount to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Assign a name to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-kill-disable - value_type: bool - default_value: "false" - description: Disable OOM Killer - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-score-adj - value_type: int - default_value: "0" - description: Tune host's OOM preferences (-1000 to 1000) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pid - value_type: string - description: PID namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pids-limit - value_type: int64 - default_value: "0" - description: Tune container pids limit (set -1 for unlimited) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish - shorthand: p - value_type: list - description: Publish a container's port(s) to the host - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-all - shorthand: P - value_type: bool - default_value: "false" - description: Publish all exposed ports to random ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - default_value: "no" - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "false" - description: Automatically remove the container when it exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: runtime - value_type: string - description: Runtime to use for this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: list - description: Security Options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sig-proxy - value_type: bool - default_value: "true" - description: Proxy received signals to the process - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - default_value: SIGTERM - description: Signal to stop a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-timeout - value_type: int - default_value: "0" - description: Timeout (in seconds) to stop a container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: storage-opt - value_type: list - description: Storage driver options for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sysctl - value_type: map - default_value: map[] - description: Sysctl options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tmpfs - value_type: list - description: Mount a tmpfs directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: userns - value_type: string - description: User namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: uts - value_type: string - description: UTS namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume - shorthand: v - value_type: list - description: Bind mount a volume - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume-driver - value_type: string - description: Optional volume driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes-from - value_type: list - description: Mount volumes from the specified container(s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_start.yaml b/_data/engine-cli-edge/docker_container_start.yaml deleted file mode 100644 index a14deea297..0000000000 --- a/_data/engine-cli-edge/docker_container_start.yaml +++ /dev/null @@ -1,57 +0,0 @@ -command: docker container start -short: Start one or more stopped containers -long: Start one or more stopped containers -usage: docker container start [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: checkpoint - value_type: string - description: Restore from this checkpoint - deprecated: false - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: checkpoint-dir - value_type: string - description: Use a custom checkpoint storage directory - deprecated: false - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Attach container's STDIN - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_stats.yaml b/_data/engine-cli-edge/docker_container_stats.yaml deleted file mode 100644 index d8f081e8b5..0000000000 --- a/_data/engine-cli-edge/docker_container_stats.yaml +++ /dev/null @@ -1,49 +0,0 @@ -command: docker container stats -short: Display a live stream of container(s) resource usage statistics -long: Display a live stream of container(s) resource usage statistics -usage: docker container stats [OPTIONS] [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print images using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-stream - value_type: bool - default_value: "false" - description: Disable streaming stats and only pull the first result - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_stop.yaml b/_data/engine-cli-edge/docker_container_stop.yaml deleted file mode 100644 index 80fa23dc99..0000000000 --- a/_data/engine-cli-edge/docker_container_stop.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker container stop -short: Stop one or more running containers -long: Stop one or more running containers -usage: docker container stop [OPTIONS] CONTAINER [CONTAINER...] -pname: docker container -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_top.yaml b/_data/engine-cli-edge/docker_container_top.yaml deleted file mode 100644 index c35656326d..0000000000 --- a/_data/engine-cli-edge/docker_container_top.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container top -short: Display the running processes of a container -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_unpause.yaml b/_data/engine-cli-edge/docker_container_unpause.yaml deleted file mode 100644 index fcd8612ee6..0000000000 --- a/_data/engine-cli-edge/docker_container_unpause.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container unpause -short: Unpause all processes within one or more containers -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_update.yaml b/_data/engine-cli-edge/docker_container_update.yaml deleted file mode 100644 index cb09c7a05f..0000000000 --- a/_data/engine-cli-edge/docker_container_update.yaml +++ /dev/null @@ -1,142 +0,0 @@ -command: docker container update -short: Update configuration of one or more containers -long: Update configuration of one or more containers -usage: docker container update [OPTIONS] CONTAINER [CONTAINER...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit the CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit the CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_container_wait.yaml b/_data/engine-cli-edge/docker_container_wait.yaml deleted file mode 100644 index 9edf8772ba..0000000000 --- a/_data/engine-cli-edge/docker_container_wait.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker container wait -short: Block until one or more containers stop, then print their exit codes -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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_cp.yaml b/_data/engine-cli-edge/docker_cp.yaml deleted file mode 100644 index 01bdd2205f..0000000000 --- a/_data/engine-cli-edge/docker_cp.yaml +++ /dev/null @@ -1,116 +0,0 @@ -command: docker cp -short: Copy files/folders between a container and the local filesystem -long: |- - The `docker cp` utility copies the contents of `SRC_PATH` to the `DEST_PATH`. - You can copy from the container's file system to the local machine or the - reverse, from the local filesystem to the container. If `-` is specified for - either the `SRC_PATH` or `DEST_PATH`, you can also stream a tar archive from - `STDIN` or to `STDOUT`. The `CONTAINER` can be a running or stopped container. - The `SRC_PATH` or `DEST_PATH` can be a file or directory. - - The `docker cp` command assumes container paths are relative to the container's - `/` (root) directory. This means supplying the initial forward slash is optional; - The command sees `compassionate_darwin:/tmp/foo/myfile.txt` and - `compassionate_darwin:tmp/foo/myfile.txt` as identical. Local machine paths can - be an absolute or relative value. The command interprets a local machine's - relative paths as relative to the current working directory where `docker cp` is - run. - - The `cp` command behaves like the Unix `cp -a` command in that directories are - copied recursively with permissions preserved if possible. Ownership is set to - 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. 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. - - Assuming a path separator of `/`, a first argument of `SRC_PATH` and second - argument of `DEST_PATH`, the behavior is as follows: - - - `SRC_PATH` specifies a file - - `DEST_PATH` does not exist - - the file is saved to a file created at `DEST_PATH` - - `DEST_PATH` does not exist and ends with `/` - - Error condition: the destination directory must exist. - - `DEST_PATH` exists and is a file - - the destination is overwritten with the source file's contents - - `DEST_PATH` exists and is a directory - - the file is copied into this directory using the basename from - `SRC_PATH` - - `SRC_PATH` specifies a directory - - `DEST_PATH` does not exist - - `DEST_PATH` is created as a directory and the *contents* of the source - directory are copied into this directory - - `DEST_PATH` exists and is a file - - Error condition: cannot copy a directory to a file - - `DEST_PATH` exists and is a directory - - `SRC_PATH` does not end with `/.` (that is: _slash_ followed by _dot_) - - the source directory is copied into this directory - - `SRC_PATH` does end with `/.` (that is: _slash_ followed by _dot_) - - the *content* of the source directory is copied into this - directory - - The command requires `SRC_PATH` and `DEST_PATH` to exist according to the above - rules. If `SRC_PATH` is local and is a symbolic link, the symbolic link, not - the target, is copied by default. To copy the link target and not the link, specify - the `-L` option. - - A colon (`:`) is used as a delimiter between `CONTAINER` and its path. You can - also use `:` when specifying paths to a `SRC_PATH` or `DEST_PATH` on a local - machine, for example `file:name.txt`. If you use a `:` in a local machine path, - you must be explicit with a relative or absolute path, for example: - - `/path/to/file:name.txt` or `./file:name.txt` - - It is not possible to copy certain system files such as resources under - `/proc`, `/sys`, `/dev`, [tmpfs](run.md#mount-tmpfs-tmpfs), and mounts created by - the user in the container. However, you can still copy such files by manually - running `tar` in `docker exec`. Both of the following examples do the same thing - in different ways (consider `SRC_PATH` and `DEST_PATH` are directories): - - ```bash - $ 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 CONTAINER tar Cxf DEST_PATH - - ``` - - Using `-` as the `SRC_PATH` streams the contents of `STDIN` as a tar archive. - The command extracts the content of the tar to the `DEST_PATH` in container's - filesystem. In this case, `DEST_PATH` must specify a directory. Using `-` as - the `DEST_PATH` streams the contents of the resource as a tar archive to `STDOUT`. -usage: "docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-\n\tdocker cp [OPTIONS] - SRC_PATH|- CONTAINER:DEST_PATH" -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: follow-link - shorthand: L - value_type: bool - default_value: "false" - description: Always follow symbol link in SRC_PATH - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_create.yaml b/_data/engine-cli-edge/docker_create.yaml deleted file mode 100644 index dac8c8f7f5..0000000000 --- a/_data/engine-cli-edge/docker_create.yaml +++ /dev/null @@ -1,971 +0,0 @@ -command: docker create -short: Create a new container -long: |- - The `docker create` command creates a writeable container layer over the - specified image and prepares it for running the specified command. The - container ID is then printed to `STDOUT`. This is similar to `docker run -d` - except the container is never started. You can then use the - `docker start ` command to start the container at any point. - - This is useful when you want to set up a container configuration ahead of time - so that it is ready to start when you need it. The initial status of the - new container is `created`. - - Please see the [run command](run.md) section and the [Docker run reference](../run.md) for more details. -usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: attach - shorthand: a - value_type: list - description: Attach to STDIN, STDOUT or STDERR - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight - value_type: uint16 - default_value: "0" - description: | - Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight-device - value_type: list - default_value: '[]' - description: Block IO weight (relative device weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-add - value_type: list - description: Add Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-drop - value_type: list - description: Drop Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cidfile - value_type: string - description: Write the container ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-count - value_type: int64 - default_value: "0" - description: CPU count (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-percent - value_type: int64 - default_value: "0" - description: CPU percent (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device - value_type: list - description: Add a host device to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-cgroup-rule - value_type: list - description: Add a rule to the cgroup allowed devices list - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-bps - value_type: list - default_value: '[]' - description: Limit read rate (bytes per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-iops - value_type: list - default_value: '[]' - description: Limit read rate (IO per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-bps - value_type: list - default_value: '[]' - description: Limit write rate (bytes per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-iops - value_type: list - default_value: '[]' - description: Limit write rate (IO per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns - value_type: list - description: Set custom DNS servers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-opt - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search - value_type: list - description: Set custom DNS search domains - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: string - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-file - value_type: list - description: Read in a file of environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: expose - value_type: list - description: Expose a port or a range of ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-add - value_type: list - description: Add additional groups to join - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - default_value: 0s - description: Time between running the check (ms|s|m|h) (default 0s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-start-period - value_type: duration - default_value: 0s - 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: help - value_type: bool - default_value: "false" - description: Print usage - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - shorthand: h - value_type: string - description: Container host name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: init - value_type: bool - default_value: "false" - description: | - Run an init inside the container that forwards signals and reaps processes - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxbandwidth - value_type: bytes - default_value: "0" - description: | - Maximum IO bandwidth limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxiops - value_type: uint64 - default_value: "0" - description: Maximum IOps limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip - value_type: string - description: IPv4 address (e.g., 172.30.100.104) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip6 - value_type: string - description: IPv6 address (e.g., 2001:db8::33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipc - value_type: string - description: IPC mode to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Set meta data on a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-file - value_type: list - description: Read in a line delimited file of labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link - value_type: list - description: Add link to another container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link-local-ip - value_type: list - description: Container IPv4/IPv6 link-local addresses - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Log driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mac-address - value_type: string - description: Container MAC address (e.g., 92:d0:c6:0a:29:33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swappiness - value_type: int64 - default_value: "-1" - description: Tune container memory swappiness (0 to 100) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount - value_type: mount - description: Attach a filesystem mount to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Assign a name to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-kill-disable - value_type: bool - default_value: "false" - description: Disable OOM Killer - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-score-adj - value_type: int - default_value: "0" - description: Tune host's OOM preferences (-1000 to 1000) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pid - value_type: string - description: PID namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pids-limit - value_type: int64 - default_value: "0" - description: Tune container pids limit (set -1 for unlimited) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish - shorthand: p - value_type: list - description: Publish a container's port(s) to the host - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-all - shorthand: P - value_type: bool - default_value: "false" - description: Publish all exposed ports to random ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - default_value: "no" - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "false" - description: Automatically remove the container when it exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: runtime - value_type: string - description: Runtime to use for this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: list - description: Security Options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - default_value: SIGTERM - description: Signal to stop a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-timeout - value_type: int - default_value: "0" - description: Timeout (in seconds) to stop a container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: storage-opt - value_type: list - description: Storage driver options for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sysctl - value_type: map - default_value: map[] - description: Sysctl options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tmpfs - value_type: list - description: Mount a tmpfs directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: userns - value_type: string - description: User namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: uts - value_type: string - description: UTS namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume - shorthand: v - value_type: list - description: Bind mount a volume - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume-driver - value_type: string - description: Optional volume driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes-from - value_type: list - description: Mount volumes from the specified container(s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Create and start a container - - ```bash - $ docker create -t -i fedora bash - - 6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752 - - $ docker start -a -i 6d8af538ec5 - - bash-4.2# - ``` - - ### Initialize volumes - - As of v1.4.0 container volumes are initialized during the `docker create` phase - (i.e., `docker run` too). For example, this allows you to `create` the `data` - volume container, and then use it from another container: - - ```bash - $ docker create -v /data --name data ubuntu - - 240633dfbb98128fa77473d3d9018f6123b99c454b3251427ae190a7d951ad57 - - $ docker run --rm --volumes-from data ubuntu ls -la /data - - total 8 - drwxr-xr-x 2 root root 4096 Dec 5 04:10 . - drwxr-xr-x 48 root root 4096 Dec 5 04:11 .. - ``` - - Similarly, `create` a host directory bind mounted volume container, which can - then be used from the subsequent container: - - ```bash - $ docker create -v /home/docker:/docker --name docker ubuntu - - 9aa88c08f319cd1e4515c3c46b0de7cc9aa75e878357b1e96f91e2c773029f03 - - $ docker run --rm --volumes-from docker ubuntu ls -la /docker - - total 20 - drwxr-sr-x 5 1000 staff 180 Dec 5 04:00 . - drwxr-xr-x 48 root root 4096 Dec 5 04:13 .. - -rw-rw-r-- 1 1000 staff 3833 Dec 5 04:01 .ash_history - -rw-r--r-- 1 1000 staff 446 Nov 28 11:51 .ashrc - -rw-r--r-- 1 1000 staff 25 Dec 5 04:00 .gitconfig - drwxr-sr-x 3 1000 staff 60 Dec 1 03:28 .local - -rw-r--r-- 1 1000 staff 920 Nov 28 11:51 .profile - drwx--S--- 2 1000 staff 460 Dec 5 00:51 .ssh - drwxr-xr-x 32 1000 staff 1140 Dec 5 04:01 docker - ``` - - - Set storage driver options per container. - - ```bash - $ docker create -it --storage-opt size=120G fedora /bin/bash - ``` - - This (size) will allow to set the container rootfs size to 120G at creation time. - This option is only available for the `devicemapper`, `btrfs`, `overlay2`, - `windowsfilter` and `zfs` graph drivers. - For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers, - user cannot pass a size less than the Default BaseFS Size. - For the `overlay2` storage driver, the size option is only available if the - backing fs is `xfs` and mounted with the `pquota` mount option. - Under these conditions, user can pass any size less than the backing fs size. - - ### Specify isolation technology for container (--isolation) - - This option is useful in situations where you are running Docker containers on - Windows. The `--isolation=` option sets a container's isolation - technology. On Linux, the only supported is the `default` option which uses - Linux namespaces. On Microsoft Windows, you can specify these values: - - - | Value | Description | - |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `default` | Use the value specified by the Docker daemon's `--exec-opt` . If the `daemon` does not specify an isolation technology, Microsoft Windows uses `process` as its default value if the - daemon is running on Windows server, or `hyperv` if running on Windows client. | - | `process` | Namespace isolation only. | - | `hyperv` | Hyper-V hypervisor partition-based isolation. | - - Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`. - - ### Dealing with dynamically created devices (--device-cgroup-rule) - - Devices available to a container are assigned at creation time. The - assigned devices will both be added to the cgroup.allow file and - created into the container once it is run. This poses a problem when - a new device needs to be added to running container. - - One of the solution is to add a more permissive rule to a container - allowing it access to a wider range of devices. For example, supposing - our container needs access to a character device with major `42` and - any number of minor number (added as new devices appear), the - following rule would be added: - - ``` - docker create --device-cgroup-rule='c 42:* rmw' -name my-container my-image - ``` - - Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 ` - the required device when it is added. - - NOTE: initially present devices still need to be explicitely added to - the create/run command -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_deploy.yaml b/_data/engine-cli-edge/docker_deploy.yaml deleted file mode 100644 index 0ec01f06df..0000000000 --- a/_data/engine-cli-edge/docker_deploy.yaml +++ /dev/null @@ -1,126 +0,0 @@ -command: docker deploy -short: Deploy a new stack or update an existing stack -long: |- - Create and update a stack from a `compose` or a `dab` file on the swarm. This command - has to be run targeting a manager node. -usage: docker deploy [OPTIONS] STACK -pname: docker -plink: docker.yaml -options: -- option: bundle-file - value_type: string - description: Path to a Distributed Application Bundle file - deprecated: false - experimental: true - experimentalcli: false - kubernetes: false - swarm: true -- option: compose-file - shorthand: c - value_type: stringSlice - default_value: '[]' - description: Path to a Compose file - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: prune - value_type: bool - default_value: "false" - description: Prune services that are no longer referenced - deprecated: false - min_api_version: "1.27" - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -- 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 - experimentalcli: false - kubernetes: false - swarm: true -- option: with-registry-auth - value_type: bool - default_value: "false" - description: Send registry authentication details to Swarm agents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -examples: |- - ### Compose file - - The `deploy` command supports compose file version `3.0` and above. - - ```bash - $ docker stack deploy --compose-file docker-compose.yml 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 - ``` - - You can verify that the services were correctly created - - ```bash - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - 29bv0vnlm903 vossibility_lookupd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4awt47624qwh vossibility_nsqd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4tjx9biia6fs vossibility_elasticsearch replicated 1/1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa - 7563uuzr9eys vossibility_kibana replicated 1/1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03 - 9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe - axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba - ``` - - ### DAB file - - ```bash - $ docker stack deploy --bundle-file vossibility-stack.dab vossibility - - Loading bundle from vossibility-stack.dab - Creating service vossibility_elasticsearch - Creating service vossibility_kibana - Creating service vossibility_logstash - Creating service vossibility_lookupd - Creating service vossibility_nsqd - Creating service vossibility_vossibility-collector - ``` - - You can verify that the services were correctly created: - - ```bash - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - 29bv0vnlm903 vossibility_lookupd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4awt47624qwh vossibility_nsqd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4tjx9biia6fs vossibility_elasticsearch replicated 1/1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa - 7563uuzr9eys vossibility_kibana replicated 1/1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03 - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_diff.yaml b/_data/engine-cli-edge/docker_diff.yaml deleted file mode 100644 index 4fd4fd4fa0..0000000000 --- a/_data/engine-cli-edge/docker_diff.yaml +++ /dev/null @@ -1,49 +0,0 @@ -command: docker diff -short: Inspect changes to files or directories on a container's filesystem -long: |- - List the changed files and directories in a container᾿s filesystem since the - container was created. Three different types of change are tracked: - - | Symbol | Description | - |--------|---------------------------------| - | `A` | A file or directory was added | - | `D` | A file or directory was deleted | - | `C` | A file or directory was changed | - - You can use the full or shortened container ID or the container name set using - `docker run --name` option. -usage: docker diff CONTAINER -pname: docker -plink: docker.yaml -examples: |- - Inspect the changes to an `nginx` container: - - ```bash - $ docker diff 1fdfd1f54c1b - - C /dev - C /dev/console - C /dev/core - C /dev/stdout - C /dev/fd - C /dev/ptmx - C /dev/stderr - C /dev/stdin - C /run - A /run/nginx.pid - C /var/lib/nginx/tmp - A /var/lib/nginx/tmp/client_body - A /var/lib/nginx/tmp/fastcgi - A /var/lib/nginx/tmp/proxy - A /var/lib/nginx/tmp/scgi - A /var/lib/nginx/tmp/uwsgi - C /var/log/nginx - A /var/log/nginx/access.log - A /var/log/nginx/error.log - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_events.yaml b/_data/engine-cli-edge/docker_events.yaml deleted file mode 100644 index fd42f278c5..0000000000 --- a/_data/engine-cli-edge/docker_events.yaml +++ /dev/null @@ -1,424 +0,0 @@ -command: docker events -short: Get real time events from the server -long: |- - Use `docker events` to get real-time events from the server. These events differ - per Docker object type. - - ### Object types - - #### Containers - - Docker containers report the following events: - - - `attach` - - `commit` - - `copy` - - `create` - - `destroy` - - `detach` - - `die` - - `exec_create` - - `exec_detach` - - `exec_start` - - `export` - - `health_status` - - `kill` - - `oom` - - `pause` - - `rename` - - `resize` - - `restart` - - `start` - - `stop` - - `top` - - `unpause` - - `update` - - #### Images - - Docker images report the following events: - - - `delete` - - `import` - - `load` - - `pull` - - `push` - - `save` - - `tag` - - `untag` - - #### Plugins - - Docker plugins report the following events: - - - `enable` - - `disable` - - `install` - - `remove` - - #### Volumes - - Docker volumes report the following events: - - - `create` - - `destroy` - - `mount` - - `unmount` - - #### Networks - - Docker networks report the following events: - - - `create` - - `connect` - - `destroy` - - `disconnect` - - `remove` - - #### Daemons - - Docker daemons report the following events: - - - `reload` - - #### Services - - Docker services report the following events: - - - `create` - - `remove` - - `update` - - #### Nodes - - Docker nodes report the following events: - - - `create` - - `remove` - - `update` - - #### Secrets - - Docker secrets report the following events: - - - `create` - - `remove` - - `update` - - #### Configs - - Docker configs report the following events: - - - `create` - - `remove` - - `update` - - ### Limiting, filtering, and formatting the output - - #### Limit events by time - - The `--since` and `--until` parameters can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the client machine’s time. If you do not provide the `--since` option, - the command returns only new and/or live events. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the client will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - #### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If you would - like to use multiple filters, pass multiple flags (e.g., - `--filter "foo=bar" --filter "bif=baz"`) - - Using the same filter multiple times will be handled as a *OR*; for example - `--filter container=588a23dac085 --filter container=a8f7720b8c22` will display - events for container 588a23dac085 *OR* container a8f7720b8c22 - - Using multiple filters will be handled as a *AND*; for example - `--filter container=588a23dac085 --filter event=start` will display events for - container container 588a23dac085 *AND* the event type is *start* - - The currently supported filters are: - - * config (`config=`) - * container (`container=`) - * daemon (`daemon=`) - * event (`event=`) - * image (`image=`) - * label (`label=` or `label==`) - * network (`network=`) - * node (`node=`) - * plugin (`plugin=`) - * scope (`scope=`) - * secret (`secret=`) - * service (`service=`) - * type (`type=`) - * volume (`volume=`) - - #### Format - - If a format (`--format`) is specified, the given template will be executed - instead of the default - format. Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. - - If a format is set to `{{json .}}`, the events are streamed as valid JSON - Lines. For information about JSON Lines, please refer to http://jsonlines.org/ . -usage: docker events [OPTIONS] -pname: docker -plink: docker.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: since - value_type: string - description: Show all events created since timestamp - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: until - value_type: string - description: Stream events until this timestamp - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Basic example - - You'll need two shells for this example. - - **Shell 1: Listening for events:** - - ```bash - $ docker events - ``` - - **Shell 2: Start and Stop containers:** - - ```bash - $ docker create --name test alpine:latest top - $ docker start test - $ docker stop test - ``` - - **Shell 1: (Again .. now showing events):** - - ```none - 2017-01-05T00:35:58.859401177+08:00 container create 0fdb48addc82871eb34eb23a847cfd033dedd1a0a37bef2e6d9eb3870fc7ff37 (image=alpine:latest, name=test) - 2017-01-05T00:36:04.703631903+08:00 network connect e2e1f5ceda09d4300f3a846f0acfaa9a8bb0d89e775eb744c5acecd60e0529e2 (container=0fdb...ff37, name=bridge, type=bridge) - 2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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) - ``` - - To exit the `docker events` command, use `CTRL+C`. - - ### Filter events by time - - You can filter the output by an absolute timestamp or relative time on the host - machine, using the following different time syntaxes: - - ```bash - $ docker events --since 1483283804 - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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-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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 '2013-09-03T15:49:29' - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 '10m' - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 - - The following commands show several different ways to filter the `docker event` - output. - - ```bash - $ docker events --filter 'event=stop' - - 2017-01-05T00:40:22.880175420+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:41:17.888104182+08:00 container stop 2a8f...4e78 (image=alpine, name=kickass_brattain) - - $ docker events --filter 'image=alpine' - - 2017-01-05T00:41:55.784240236+08:00 container create d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:41:55.913156783+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:42:01.106875249+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=15) - 2017-01-05T00:42:11.111934041+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=9) - 2017-01-05T00:42:11.119578204+08:00 container die d9cd...4d70 (exitCode=137, image=alpine, name=happy_meitner) - 2017-01-05T00:42:11.173276611+08:00 container stop d9cd...4d70 (image=alpine, name=happy_meitner) - - $ docker events --filter 'container=test' - - 2017-01-05T00:43:00.139719934+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:43:09.259951086+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 2017-01-05T00:43:09.270102715+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) - 2017-01-05T00:43:09.312556440+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) - - $ docker events --filter 'container=test' --filter 'container=d9cdb1525ea8' - - 2017-01-05T00:44:11.517071981+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:44:17.685870901+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:44:29.757658470+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=9) - 2017-01-05T00:44:29.767718510+08:00 container die 0fdb...ff37 (exitCode=137, image=alpine:latest, name=test) - 2017-01-05T00:44:29.815798344+08:00 container destroy 0fdb...ff37 (image=alpine:latest, name=test) - - $ docker events --filter 'container=test' --filter 'event=stop' - - 2017-01-05T00:46:13.664099505+08:00 container stop a9d1...e130 (image=alpine, name=test) - - $ docker events --filter 'type=volume' - - 2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) - 2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562f...5025, destination=/foo, driver=local, propagation=rprivate) - 2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562f...5025, driver=local) - 2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - - $ docker events --filter 'type=network' - - 2015-12-23T21:38:24.705709133Z network create 8b11...2c5b (name=test-event-network-local, type=bridge) - 2015-12-23T21:38:25.119625123Z network connect 8b11...2c5b (name=test-event-network-local, container=b4be...c54e, type=bridge) - - $ docker events --filter 'container=container_1' --filter 'container=container_2' - - 2014-09-03T15:49:29.999999999Z07:00 container die 4386fb97867d (image=ubuntu-1:14.04) - 2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu-1:14.04) - 2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (imager=redis:2.8) - 2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8) - - $ docker events --filter 'type=volume' - - 2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) - 2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, destination=/foo, driver=local, propagation=rprivate) - 2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, driver=local) - 2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - - $ docker events --filter 'type=network' - - 2015-12-23T21:38:24.705709133Z network create 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, type=bridge) - 2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge) - - $ docker events --filter 'type=plugin' - - 2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) - 2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) - - $ docker events -f type=service - - 2017-07-12T06:34:07.999446625Z service create wj64st89fzgchxnhiqpn8p4oj (name=reverent_albattani) - 2017-07-12T06:34:21.405496207Z service remove wj64st89fzgchxnhiqpn8p4oj (name=reverent_albattani) - - $ docker events -f type=node - - 2017-07-12T06:21:51.951586759Z node update 3xyz5ttp1a253q74z1thwywk9 (name=ip-172-31-23-42, state.new=ready, state.old=unknown) - - $ docker events -f type=secret - - 2017-07-12T06:32:13.915704367Z secret create s8o6tmlnndrgzbmdilyy5ymju (name=new_secret) - 2017-07-12T06:32:37.052647783Z secret remove s8o6tmlnndrgzbmdilyy5ymju (name=new_secret) - - $ docker events -f type=config - 2017-07-12T06:44:13.349037127Z config create u96zlvzdfsyb9sg4mhyxfh3rl (name=abc) - 2017-07-12T06:44:36.327694184Z config remove u96zlvzdfsyb9sg4mhyxfh3rl (name=abc) - - $ docker events --filter 'scope=swarm' - - 2017-07-10T07:46:50.250024503Z service create m8qcxu8081woyof7w3jaax6gk (name=affectionate_wilson) - 2017-07-10T07:47:31.093797134Z secret create 6g5pufzsv438p9tbvl9j94od4 (name=new_secret) - ``` - - ### Format the output - - ```bash - $ docker events --filter 'type=container' --format 'Type={{.Type}} Status={{.Status}} ID={{.ID}}' - - Type=container Status=create ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=attach ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=start ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=resize ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=die ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - ``` - - #### Format as JSON - - ```none - $ docker events --format '{{json .}}' - - {"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - {"status":"attach","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - {"Type":"network","Action":"connect","Actor":{"ID":"1b50a5bf755f6021dfa78e.. - {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. - {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_exec.yaml b/_data/engine-cli-edge/docker_exec.yaml deleted file mode 100644 index 93602aeb0e..0000000000 --- a/_data/engine-cli-edge/docker_exec.yaml +++ /dev/null @@ -1,124 +0,0 @@ -command: docker exec -short: Run a command in a running container -long: |- - The `docker exec` command runs a new command in a running container. - - The command started using `docker exec` only runs while the container's primary - process (`PID 1`) is running, and it is not restarted if the container is - restarted. - - COMMAND will run in the default directory of the container. If the - underlying image has a custom directory specified with the WORKDIR directive - in its Dockerfile, this will be used instead. - - COMMAND should be an executable, a chained or a quoted command - will not work. Example: `docker exec -ti my_container "echo a && echo b"` will - not work, but `docker exec -ti my_container sh -c "echo a && echo b"` will. -usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to the command - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$ - docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a - container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command - on the container.\n\n```bash\n$ docker exec -d ubuntu_bash touch /tmp/execWorks\n```\n\nThis - will create a new file `/tmp/execWorks` inside the running container\n`ubuntu_bash`, - in the background.\n\nNext, execute an interactive `bash` shell on the container.\n\n```bash\n$ - docker exec -it ubuntu_bash bash\n```\n\nThis will create a new Bash session in - the container `ubuntu_bash`.\n\nNext, set an environment variable in the current - bash session.\n\n```bash\n$ docker exec -it -e VAR=1 ubuntu_bash bash\n```\n\nThis - will create a new Bash session in the container `ubuntu_bash` with environment \nvariable - `$VAR` set to \"1\". Note that this environment variable will only be valid \non - the current Bash session.\n\nBy default `docker exec` command runs in the same working - directory set when container was created.\n\n```bash\n$ docker exec -it ubuntu_bash - pwd\n/\n```\n\nYou can select working directory for the command to execute into\n\n```bash\n$ - docker exec -it -w /root ubuntu_bash pwd\n/root\n```\n\n\n### Try to run `docker - exec` on a paused container\n\nIf the container is paused, then the `docker exec` - command will fail with an error:\n\n```bash\n$ docker pause test\n\ntest\n\n$ docker - ps\n\nCONTAINER ID IMAGE COMMAND CREATED STATUS - \ PORTS NAMES\n1ae3b36715d2 ubuntu:latest - \ \"bash\" 17 seconds ago Up 16 seconds (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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_export.yaml b/_data/engine-cli-edge/docker_export.yaml deleted file mode 100644 index 1959106442..0000000000 --- a/_data/engine-cli-edge/docker_export.yaml +++ /dev/null @@ -1,39 +0,0 @@ -command: docker export -short: Export a container's filesystem as a tar archive -long: |- - The `docker export` command does not export the contents of volumes associated - with the container. If a volume is mounted on top of an existing directory in - the container, `docker export` will export the contents of the *underlying* - directory, not the contents of the volume. - - Refer to [Backup, restore, or migrate data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/#backup-restore-or-migrate-data-volumes) - in the user guide for examples on exporting data in a volume. -usage: docker export [OPTIONS] CONTAINER -pname: docker -plink: docker.yaml -options: -- option: output - shorthand: o - value_type: string - description: Write to a file, instead of STDOUT - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Each of these commands has the same result. - - ```bash - $ docker export red_panda > latest.tar - ``` - - ```bash - $ docker export --output="latest.tar" red_panda - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_history.yaml b/_data/engine-cli-edge/docker_history.yaml deleted file mode 100644 index b4e86cf854..0000000000 --- a/_data/engine-cli-edge/docker_history.yaml +++ /dev/null @@ -1,105 +0,0 @@ -command: docker history -short: Show the history of an image -long: Show the history of an image -usage: docker history [OPTIONS] IMAGE -pname: docker -plink: docker.yaml -options: -- option: format - value_type: string - description: Pretty-print images using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: human - shorthand: H - value_type: bool - default_value: "true" - description: Print sizes and dates in human readable format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only show numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - To see how the `docker:latest` image was built: - - ```bash - $ docker history docker - - IMAGE CREATED CREATED BY SIZE COMMENT - 3e23a5875458 8 days ago /bin/sh -c #(nop) ENV LC_ALL=C.UTF-8 0 B - 8578938dd170 8 days ago /bin/sh -c dpkg-reconfigure locales && loc 1.245 MB - be51b77efb42 8 days ago /bin/sh -c apt-get update && apt-get install 338.3 MB - 4b137612be55 6 weeks ago /bin/sh -c #(nop) ADD jessie.tar.xz in / 121 MB - 750d58736b4b 6 weeks ago /bin/sh -c #(nop) MAINTAINER Tianon Gravi : 4 weeks ago - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image.yaml b/_data/engine-cli-edge/docker_image.yaml deleted file mode 100644 index c094b25a6f..0000000000 --- a/_data/engine-cli-edge/docker_image.yaml +++ /dev/null @@ -1,38 +0,0 @@ -command: docker image -short: Manage images -long: Manage images. -usage: docker image -pname: docker -plink: docker.yaml -cname: -- docker image build -- docker image history -- docker image import -- docker image inspect -- docker image load -- docker image ls -- docker image prune -- docker image pull -- docker image push -- docker image rm -- docker image save -- docker image tag -clink: -- docker_image_build.yaml -- docker_image_history.yaml -- docker_image_import.yaml -- docker_image_inspect.yaml -- docker_image_load.yaml -- docker_image_ls.yaml -- docker_image_prune.yaml -- docker_image_pull.yaml -- docker_image_push.yaml -- docker_image_rm.yaml -- docker_image_save.yaml -- docker_image_tag.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_build.yaml b/_data/engine-cli-edge/docker_image_build.yaml deleted file mode 100644 index 8621343da4..0000000000 --- a/_data/engine-cli-edge/docker_image_build.yaml +++ /dev/null @@ -1,291 +0,0 @@ -command: docker image build -short: Build an image from a Dockerfile -long: Build an image from a Dockerfile -usage: docker image build [OPTIONS] PATH | URL | - -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: build-arg - value_type: list - description: Set build-time variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cache-from - value_type: stringSlice - default_value: '[]' - description: Images to consider as cache sources - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: compress - value_type: bool - default_value: "false" - description: Compress the build context using gzip - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit the CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit the CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: file - shorthand: f - value_type: string - description: Name of the Dockerfile (Default is 'PATH/Dockerfile') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force-rm - value_type: bool - default_value: "false" - description: Always remove intermediate containers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: iidfile - value_type: string - description: Write the image ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - value_type: list - description: Set metadata for an image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: no-cache - value_type: bool - default_value: "false" - description: Do not use cache when building the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: pull - value_type: bool - default_value: "false" - description: Always attempt to pull a newer version of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress the build output and print image ID on success - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "true" - description: Remove intermediate containers after a successful build - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: stringSlice - default_value: '[]' - description: Security options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: squash - value_type: bool - default_value: "false" - description: Squash newly built layers into a single new layer - deprecated: false - min_api_version: "1.25" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: tag - shorthand: t - value_type: list - description: Name and optionally a tag in the 'name:tag' format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: target - value_type: string - description: Set the target build stage to build. - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_history.yaml b/_data/engine-cli-edge/docker_image_history.yaml deleted file mode 100644 index 265accf096..0000000000 --- a/_data/engine-cli-edge/docker_image_history.yaml +++ /dev/null @@ -1,50 +0,0 @@ -command: docker image history -short: Show the history of an image -long: Show the history of an image -usage: docker image history [OPTIONS] IMAGE -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: human - shorthand: H - value_type: bool - default_value: "true" - description: Print sizes and dates in human readable format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only show numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_import.yaml b/_data/engine-cli-edge/docker_image_import.yaml deleted file mode 100644 index fd63cfcf51..0000000000 --- a/_data/engine-cli-edge/docker_image_import.yaml +++ /dev/null @@ -1,31 +0,0 @@ -command: docker image import -short: Import the contents from a tarball to create a filesystem image -long: Import the contents from a tarball to create a filesystem image -usage: docker image import [OPTIONS] file|URL|- [REPOSITORY[:TAG]] -pname: docker image -plink: docker_image.yaml -options: -- option: change - shorthand: c - value_type: list - description: Apply Dockerfile instruction to the created image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: message - shorthand: m - value_type: string - description: Set commit message for imported image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_inspect.yaml b/_data/engine-cli-edge/docker_image_inspect.yaml deleted file mode 100644 index e79573128a..0000000000 --- a/_data/engine-cli-edge/docker_image_inspect.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker image inspect -short: Display detailed information on one or more images -long: Display detailed information on one or more images -usage: docker image inspect [OPTIONS] IMAGE [IMAGE...] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_load.yaml b/_data/engine-cli-edge/docker_image_load.yaml deleted file mode 100644 index 61d47dab9b..0000000000 --- a/_data/engine-cli-edge/docker_image_load.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker image load -short: Load an image from a tar archive or STDIN -long: Load an image from a tar archive or STDIN -usage: docker image load [OPTIONS] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress the load output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_ls.yaml b/_data/engine-cli-edge/docker_image_ls.yaml deleted file mode 100644 index 0e341e81fa..0000000000 --- a/_data/engine-cli-edge/docker_image_ls.yaml +++ /dev/null @@ -1,69 +0,0 @@ -command: docker image ls -aliases: images, list -short: List images -long: List images -usage: docker image ls [OPTIONS] [REPOSITORY[:TAG]] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: digests - value_type: bool - default_value: "false" - description: Show digests - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print images using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only show numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_prune.yaml b/_data/engine-cli-edge/docker_image_prune.yaml deleted file mode 100644 index 7271fc8cb8..0000000000 --- a/_data/engine-cli-edge/docker_image_prune.yaml +++ /dev/null @@ -1,214 +0,0 @@ -command: docker image prune -short: Remove unused images -long: Remove all dangling images. If `-a` is specified, will also remove all images - not referenced by any container. -usage: docker image prune [OPTIONS] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - value_type: filter - description: Provide filter values (e.g. 'until=') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: Do not prompt for confirmation - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Example output: - - ```bash - $ docker image prune -a - - WARNING! This will remove all images without at least one container associated to them. - Are you sure you want to continue? [y/N] y - Deleted Images: - untagged: alpine:latest - untagged: alpine@sha256:3dcdb92d7432d56604d4545cbd324b14e647b313626d99b889d0626de158f73a - deleted: sha256:4e38e38c8ce0b8d9041a9c4fefe786631d1416225e13b0bfe8cfa2321aec4bba - deleted: sha256:4fe15f8d0ae69e169824f25f1d4da3015a48feeeeebb265cd2e328e15c6a869f - untagged: alpine:3.3 - untagged: alpine@sha256:4fa633f4feff6a8f02acfc7424efd5cb3e76686ed3218abf4ca0fa4a2a358423 - untagged: my-jq:latest - deleted: sha256:ae67841be6d008a374eff7c2a974cde3934ffe9536a7dc7ce589585eddd83aff - deleted: sha256:34f6f1261650bc341eb122313372adc4512b4fceddc2a7ecbb84f0958ce5ad65 - deleted: sha256:cf4194e8d8db1cb2d117df33f2c75c0369c3a26d96725efb978cc69e046b87e7 - untagged: my-curl:latest - deleted: sha256:b2789dd875bf427de7f9f6ae001940073b3201409b14aba7e5db71f408b8569e - deleted: sha256:96daac0cb203226438989926fc34dd024f365a9a8616b93e168d303cfe4cb5e9 - deleted: sha256:5cbd97a14241c9cd83250d6b6fc0649833c4a3e84099b968dd4ba403e609945e - deleted: sha256:a0971c4015c1e898c60bf95781c6730a05b5d8a2ae6827f53837e6c9d38efdec - deleted: sha256:d8359ca3b681cc5396a4e790088441673ed3ce90ebc04de388bfcd31a0716b06 - deleted: sha256:83fc9ba8fb70e1da31dfcc3c88d093831dbd4be38b34af998df37e8ac538260c - deleted: sha256:ae7041a4cc625a9c8e6955452f7afe602b401f662671cea3613f08f3d9343b35 - deleted: sha256:35e0f43a37755b832f0bbea91a2360b025ee351d7309dae0d9737bc96b6d0809 - deleted: sha256:0af941dd29f00e4510195dd00b19671bc591e29d1495630e7e0f7c44c1e6a8c0 - deleted: sha256:9fc896fc2013da84f84e45b3096053eb084417b42e6b35ea0cce5a3529705eac - deleted: sha256:47cf20d8c26c46fff71be614d9f54997edacfe8d46d51769706e5aba94b16f2b - deleted: sha256:2c675ee9ed53425e31a13e3390bf3f539bf8637000e4bcfbb85ee03ef4d910a1 - - Total reclaimed space: 16.43 MB - ``` - - ### Filtering - - The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * until (``) - only remove images created before given timestamp - * label (`label=`, `label==`, `label!=`, or `label!==`) - only remove images with (or without, in case `label!=...` is used) the specified labels. - - The `until` filter can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the daemon machine’s time. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the daemon will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - The `label` filter accepts two formats. One is the `label=...` (`label=` or `label==`), - which removes images with the specified labels. The other - format is the `label!=...` (`label!=` or `label!==`), which removes - images without the specified labels. - - > **Predicting what will be removed** - > - > If you are using positive filtering (testing for the existence of a label or - > that a label has a specific value), you can use `docker image ls` with the - > same filtering syntax to see which images match your filter. - > - > However, if you are using negative filtering (testing for the absence of a - > label or that a label does *not* have a specific value), this type of filter - > does not work with `docker image ls` so you cannot easily predict which images - > will be removed. In addition, the confirmation prompt for `docker image prune` - > always warns that *all* dangling images will be removed, even if you are using - > `--filter`. - - The following removes images created before `2017-01-04T00:00:00`: - - ```bash - $ docker images --format 'table {{.Repository}}\t{{.Tag}}\t{{.ID}}\t{{.CreatedAt}}\t{{.Size}}' - REPOSITORY TAG IMAGE ID CREATED AT SIZE - foo latest 2f287ac753da 2017-01-04 13:42:23 -0800 PST 3.98 MB - alpine latest 88e169ea8f46 2016-12-27 10:17:25 -0800 PST 3.98 MB - busybox latest e02e811dd08f 2016-10-07 14:03:58 -0700 PDT 1.09 MB - - $ docker image prune -a --force --filter "until=2017-01-04T00:00:00" - - Deleted Images: - untagged: alpine:latest - untagged: alpine@sha256:dfbd4a3a8ebca874ebd2474f044a0b33600d4523d03b0df76e5c5986cb02d7e8 - untagged: busybox:latest - untagged: busybox@sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912 - deleted: sha256:e02e811dd08fd49e7f6032625495118e63f597eb150403d02e3238af1df240ba - deleted: sha256:e88b3f82283bc59d5e0df427c824e9f95557e661fcb0ea15fb0fb6f97760f9d9 - - Total reclaimed space: 1.093 MB - - $ docker images --format 'table {{.Repository}}\t{{.Tag}}\t{{.ID}}\t{{.CreatedAt}}\t{{.Size}}' - - REPOSITORY TAG IMAGE ID CREATED AT SIZE - foo latest 2f287ac753da 2017-01-04 13:42:23 -0800 PST 3.98 MB - ``` - - The following removes images created more than 10 days (`240h`) ago: - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - foo latest 2f287ac753da 14 seconds ago 3.98 MB - alpine latest 88e169ea8f46 8 days ago 3.98 MB - debian jessie 7b0a06c805e8 2 months ago 123 MB - busybox latest e02e811dd08f 2 months ago 1.09 MB - golang 1.7.0 138c2e655421 4 months ago 670 MB - - $ docker image prune -a --force --filter "until=240h" - - Deleted Images: - untagged: golang:1.7.0 - untagged: golang@sha256:6765038c2b8f407fd6e3ecea043b44580c229ccfa2a13f6d85866cf2b4a9628e - deleted: sha256:138c2e6554219de65614d88c15521bfb2da674cbb0bf840de161f89ff4264b96 - deleted: sha256:ec353c2e1a673f456c4b78906d0d77f9d9456cfb5229b78c6a960bfb7496b76a - deleted: sha256:fe22765feaf3907526b4921c73ea6643ff9e334497c9b7e177972cf22f68ee93 - deleted: sha256:ff845959c80148421a5c3ae11cc0e6c115f950c89bc949646be55ed18d6a2912 - deleted: sha256:a4320831346648c03db64149eafc83092e2b34ab50ca6e8c13112388f25899a7 - deleted: sha256:4c76020202ee1d9709e703b7c6de367b325139e74eebd6b55b30a63c196abaf3 - deleted: sha256:d7afd92fb07236c8a2045715a86b7d5f0066cef025018cd3ca9a45498c51d1d6 - deleted: sha256:9e63c5bce4585dd7038d830a1f1f4e44cb1a1515b00e620ac718e934b484c938 - untagged: debian:jessie - untagged: debian@sha256:c1af755d300d0c65bb1194d24bce561d70c98a54fb5ce5b1693beb4f7988272f - deleted: sha256:7b0a06c805e8f23807fb8856621c60851727e85c7bcb751012c813f122734c8d - deleted: sha256:f96222d75c5563900bc4dd852179b720a0885de8f7a0619ba0ac76e92542bbc8 - - Total reclaimed space: 792.6 MB - - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - foo latest 2f287ac753da About a minute ago 3.98 MB - alpine latest 88e169ea8f46 8 days ago 3.98 MB - busybox latest e02e811dd08f 2 months ago 1.09 MB - ``` - - The following example removes images with the label `deprecated`: - - ```bash - $ docker image prune --filter="label=deprecated" - ``` - - The following example removes images with the label `maintainer` set to `john`: - - ```bash - $ docker image prune --filter="label=maintainer=john" - ``` - - This example removes images which have no `maintainer` label: - - ```bash - $ docker image prune --filter="label!=maintainer" - ``` - - This example removes images which have a maintainer label not set to `john`: - - ```bash - $ docker image prune --filter="label!=maintainer=john" - ``` - - > **Note**: You are prompted for confirmation before the `prune` removes - > anything, but you are not shown a list of what will potentially be removed. - > In addition, `docker image ls` does not support negative filtering, so it - > difficult to predict what images will actually be removed. -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_pull.yaml b/_data/engine-cli-edge/docker_image_pull.yaml deleted file mode 100644 index 0b70ac118e..0000000000 --- a/_data/engine-cli-edge/docker_image_pull.yaml +++ /dev/null @@ -1,41 +0,0 @@ -command: docker image pull -short: Pull an image or a repository from a registry -long: Pull an image or a repository from a registry -usage: docker image pull [OPTIONS] NAME[:TAG|@DIGEST] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_push.yaml b/_data/engine-cli-edge/docker_image_push.yaml deleted file mode 100644 index b4f5f22b86..0000000000 --- a/_data/engine-cli-edge/docker_image_push.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker image push -short: Push an image or a repository to a registry -long: Push an image or a repository to a registry -usage: docker image push [OPTIONS] NAME[:TAG] -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_rm.yaml b/_data/engine-cli-edge/docker_image_rm.yaml deleted file mode 100644 index c60a498429..0000000000 --- a/_data/engine-cli-edge/docker_image_rm.yaml +++ /dev/null @@ -1,33 +0,0 @@ -command: docker image rm -aliases: rmi, remove -short: Remove one or more images -long: Remove one or more images -usage: docker image rm [OPTIONS] IMAGE [IMAGE...] -pname: docker image -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: no-prune - value_type: bool - default_value: "false" - description: Do not delete untagged parents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_save.yaml b/_data/engine-cli-edge/docker_image_save.yaml deleted file mode 100644 index 1fbdbb1a05..0000000000 --- a/_data/engine-cli-edge/docker_image_save.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker image save -short: Save one or more images to a tar archive (streamed to STDOUT by default) -long: Save one or more images to a tar archive (streamed to STDOUT by default) -usage: docker image save [OPTIONS] IMAGE [IMAGE...] -pname: docker image -plink: docker_image.yaml -options: -- option: output - shorthand: o - value_type: string - description: Write to a file, instead of STDOUT - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_image_tag.yaml b/_data/engine-cli-edge/docker_image_tag.yaml deleted file mode 100644 index 3830ef1b8d..0000000000 --- a/_data/engine-cli-edge/docker_image_tag.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker image tag -short: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE -long: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE -usage: docker image tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] -pname: docker image -plink: docker_image.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_images.yaml b/_data/engine-cli-edge/docker_images.yaml deleted file mode 100644 index 1777872ac9..0000000000 --- a/_data/engine-cli-edge/docker_images.yaml +++ /dev/null @@ -1,370 +0,0 @@ -command: docker images -short: List images -long: |- - The default `docker images` will show all top level - images, their repository and tags, and their size. - - Docker images have intermediate layers that increase reusability, - decrease disk usage, and speed up `docker build` by - allowing each step to be cached. These intermediate layers are not shown - by default. - - The `SIZE` is the cumulative space taken up by the image and all - its parent images. This is also the disk space used by the contents of the - Tar file created when you `docker save` an image. - - An image will be listed more than once if it has multiple repository names - or tags. This single image (identifiable by its matching `IMAGE ID`) - uses up the `SIZE` listed only once. -usage: docker images [OPTIONS] [REPOSITORY[:TAG]] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: digests - value_type: bool - default_value: "false" - description: Show digests - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print images using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only show numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### List the most recently created images - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - 77af4d6b9913 19 hours ago 1.089 GB - committ latest b6fa739cedf5 19 hours ago 1.089 GB - 78a85c484f71 19 hours ago 1.089 GB - docker latest 30557a29d5ab 20 hours ago 1.089 GB - 5ed6274db6ce 24 hours ago 1.089 GB - postgres 9 746b819f315e 4 days ago 213.4 MB - postgres 9.3 746b819f315e 4 days ago 213.4 MB - postgres 9.3.5 746b819f315e 4 days ago 213.4 MB - postgres latest 746b819f315e 4 days ago 213.4 MB - ``` - - ### List images by name and tag - - The `docker images` command takes an optional `[REPOSITORY[:TAG]]` argument - that restricts the list to images that match the argument. If you specify - `REPOSITORY`but no `TAG`, the `docker images` command lists all images in the - given repository. - - For example, to list all images in the "java" repository, run this command : - - ```bash - $ docker images java - - REPOSITORY TAG IMAGE ID CREATED SIZE - java 8 308e519aac60 6 days ago 824.5 MB - java 7 493d82594c15 3 months ago 656.3 MB - java latest 2711b1d6f3aa 5 months ago 603.9 MB - ``` - - The `[REPOSITORY[:TAG]]` value must be an "exact match". This means that, for example, - `docker images jav` does not match the image `java`. - - If both `REPOSITORY` and `TAG` are provided, only images matching that - repository and tag are listed. To find all local images in the "java" - repository with tag "8" you can use: - - ```bash - $ docker images java:8 - - REPOSITORY TAG IMAGE ID CREATED SIZE - java 8 308e519aac60 6 days ago 824.5 MB - ``` - - If nothing matches `REPOSITORY[:TAG]`, the list is empty. - - ```bash - $ docker images java:0 - - REPOSITORY TAG IMAGE ID CREATED SIZE - ``` - - ### List the full length image IDs - - ```bash - $ docker images --no-trunc - - REPOSITORY TAG IMAGE ID CREATED SIZE - sha256:77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182 19 hours ago 1.089 GB - committest latest sha256:b6fa739cedf5ea12a620a439402b6004d057da800f91c7524b5086a5e4749c9f 19 hours ago 1.089 GB - sha256:78a85c484f71509adeaace20e72e941f6bdd2b25b4c75da8693efd9f61a37921 19 hours ago 1.089 GB - docker latest sha256:30557a29d5abc51e5f1d5b472e79b7e296f595abcf19fe6b9199dbbc809c6ff4 20 hours ago 1.089 GB - sha256:0124422dd9f9cf7ef15c0617cda3931ee68346455441d66ab8bdc5b05e9fdce5 20 hours ago 1.089 GB - sha256:18ad6fad340262ac2a636efd98a6d1f0ea775ae3d45240d3418466495a19a81b 22 hours ago 1.082 GB - sha256:f9f1e26352f0a3ba6a0ff68167559f64f3e21ff7ada60366e2d44a04befd1d3a 23 hours ago 1.089 GB - tryout latest sha256:2629d1fa0b81b222fca63371ca16cbf6a0772d07759ff80e8d1369b926940074 23 hours ago 131.5 MB - sha256:5ed6274db6ceb2397844896966ea239290555e74ef307030ebb01ff91b1914df 24 hours ago 1.089 GB - ``` - - ### List image digests - - Images that use the v2 or later format have a content-addressable identifier - called a `digest`. As long as the input used to generate the image is - unchanged, the digest value is predictable. To list image digest values, use - the `--digests` flag: - - ```bash - $ docker images --digests - REPOSITORY TAG DIGEST IMAGE ID CREATED SIZE - localhost:5000/test/busybox sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf 4986bf8c1536 9 weeks ago 2.43 MB - ``` - - When pushing or pulling to a 2.0 registry, the `push` or `pull` command - output includes the image digest. You can `pull` using a digest value. You can - also reference by digest in `create`, `run`, and `rmi` commands, as well as the - `FROM` image reference in a Dockerfile. - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * dangling (boolean - true or false) - * label (`label=` or `label==`) - * before (`[:]`, `` or ``) - filter images created before given id or references - * since (`[:]`, `` or ``) - filter images created since given id or references - * reference (pattern of an image reference) - filter images whose reference matches the specified pattern - - #### Show untagged images (dangling) - - ```bash - $ docker images --filter "dangling=true" - - REPOSITORY TAG IMAGE ID CREATED SIZE - 8abc22fbb042 4 weeks ago 0 B - 48e5f45168b9 4 weeks ago 2.489 MB - bf747efa0e2f 4 weeks ago 0 B - 980fe10e5736 12 weeks ago 101.4 MB - dea752e4e117 12 weeks ago 101.4 MB - 511136ea3c5a 8 months ago 0 B - ``` - - This will display untagged images that are the leaves of the images tree (not - intermediary layers). These images occur when a new build of an image takes the - `repo:tag` away from the image ID, leaving it as `:` or untagged. - A warning will be issued if trying to remove an image when a container is presently - using it. By having this flag it allows for batch cleanup. - - You can use this in conjunction with `docker rmi ...`: - - ```bash - $ docker rmi $(docker images -f "dangling=true" -q) - - 8abc22fbb042 - 48e5f45168b9 - bf747efa0e2f - 980fe10e5736 - dea752e4e117 - 511136ea3c5a - ``` - - > **Note**: Docker warns you if any containers exist that are using these - > untagged images. - - - #### Show images with a given label - - The `label` filter matches images based on the presence of a `label` alone or a `label` and a - value. - - The following filter matches images with the `com.example.version` label regardless of its value. - - ```bash - $ docker images --filter "label=com.example.version" - - REPOSITORY TAG IMAGE ID CREATED SIZE - match-me-1 latest eeae25ada2aa About a minute ago 188.3 MB - match-me-2 latest dea752e4e117 About a minute ago 188.3 MB - ``` - - The following filter matches images with the `com.example.version` label with the `1.0` value. - - ```bash - $ docker images --filter "label=com.example.version=1.0" - - REPOSITORY TAG IMAGE ID CREATED SIZE - match-me latest 511136ea3c5a About a minute ago 188.3 MB - ``` - - In this example, with the `0.1` value, it returns an empty set because no matches were found. - - ```bash - $ docker images --filter "label=com.example.version=0.1" - REPOSITORY TAG IMAGE ID CREATED SIZE - ``` - - #### Filter images by time - - The `before` filter shows only images created before the image with - given id or reference. For example, having these images: - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - image1 latest eeae25ada2aa 4 minutes ago 188.3 MB - image2 latest dea752e4e117 9 minutes ago 188.3 MB - image3 latest 511136ea3c5a 25 minutes ago 188.3 MB - ``` - - Filtering with `before` would give: - - ```bash - $ docker images --filter "before=image1" - - REPOSITORY TAG IMAGE ID CREATED SIZE - image2 latest dea752e4e117 9 minutes ago 188.3 MB - image3 latest 511136ea3c5a 25 minutes ago 188.3 MB - ``` - - Filtering with `since` would give: - - ```bash - $ docker images --filter "since=image3" - REPOSITORY TAG IMAGE ID CREATED SIZE - image1 latest eeae25ada2aa 4 minutes ago 188.3 MB - image2 latest dea752e4e117 9 minutes ago 188.3 MB - ``` - - #### Filter images by reference - - The `reference` filter shows only images whose reference matches - the specified pattern. - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - busybox latest e02e811dd08f 5 weeks ago 1.09 MB - busybox uclibc e02e811dd08f 5 weeks ago 1.09 MB - busybox musl 733eb3059dce 5 weeks ago 1.21 MB - busybox glibc 21c16b6787c6 5 weeks ago 4.19 MB - ``` - - Filtering with `reference` would give: - - ```bash - $ docker images --filter=reference='busy*:*libc' - - REPOSITORY TAG IMAGE ID CREATED SIZE - busybox uclibc e02e811dd08f 5 weeks ago 1.09 MB - busybox glibc 21c16b6787c6 5 weeks ago 4.19 MB - ``` - - ### Format the output - - The formatting option (`--format`) will pretty print container output - using a Go template. - - Valid placeholders for the Go template are listed below: - - | Placeholder | Description| - | ---- | ---- | - | `.ID` | Image ID | - | `.Repository` | Image repository | - | `.Tag` | Image tag | - | `.Digest` | Image digest | - | `.CreatedSince` | Elapsed time since the image was created | - | `.CreatedAt` | Time when the image was created | - | `.Size` | Image disk size | - - When using the `--format` option, the `image` command will either - output the data exactly as the template declares or, when using the - `table` directive, will include column headers as well. - - The following example uses a template without headers and outputs the - `ID` and `Repository` entries separated by a colon for all images: - - ```bash - $ docker images --format "{{.ID}}: {{.Repository}}" - - 77af4d6b9913: - b6fa739cedf5: committ - 78a85c484f71: - 30557a29d5ab: docker - 5ed6274db6ce: - 746b819f315e: postgres - 746b819f315e: postgres - 746b819f315e: postgres - 746b819f315e: postgres - ``` - - To list all images with their repository and tag in a table format you - can use: - - ```bash - $ docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}" - - IMAGE ID REPOSITORY TAG - 77af4d6b9913 - b6fa739cedf5 committ latest - 78a85c484f71 - 30557a29d5ab docker latest - 5ed6274db6ce - 746b819f315e postgres 9 - 746b819f315e postgres 9.3 - 746b819f315e postgres 9.3.5 - 746b819f315e postgres latest - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_import.yaml b/_data/engine-cli-edge/docker_import.yaml deleted file mode 100644 index b80b96792a..0000000000 --- a/_data/engine-cli-edge/docker_import.yaml +++ /dev/null @@ -1,88 +0,0 @@ -command: docker import -short: Import the contents from a tarball to create a filesystem image -long: |- - You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The - `URL` can point to an archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, or .txz) - containing a filesystem or to an individual file on the Docker host. If you - specify an archive, Docker untars it in the container relative to the `/` - (root). If you specify an individual file, you must specify the full path within - the host. To import from a remote location, specify a `URI` that begins with the - `http://` or `https://` protocol. - - The `--change` option will apply `Dockerfile` instructions to the image - that is created. - Supported `Dockerfile` instructions: - `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` -usage: docker import [OPTIONS] file|URL|- [REPOSITORY[:TAG]] -pname: docker -plink: docker.yaml -options: -- option: change - shorthand: c - value_type: list - description: Apply Dockerfile instruction to the created image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: message - shorthand: m - value_type: string - description: Set commit message for imported image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Import from a remote location - - This will create a new untagged image. - - ```bash - $ docker import http://example.com/exampleimage.tgz - ``` - - ### Import from a local file - - - Import to docker via pipe and `STDIN`. - - ```bash - $ cat exampleimage.tgz | docker import - exampleimagelocal:new - ``` - - - Import with a commit message. - - ```bash - $ cat exampleimage.tgz | docker import --message "New image imported from tarball" - exampleimagelocal:new - ``` - - - Import to docker from a local archive. - - ```bash - $ docker import /path/to/exampleimage.tgz - ``` - - ### Import from a local directory - - ```bash - $ sudo tar -c . | docker import - exampleimagedir - ``` - - ### Import from a local directory with new configurations - - ```bash - $ sudo tar -c . | docker import --change "ENV DEBUG true" - exampleimagedir - ``` - - Note the `sudo` in this example – you must preserve - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_info.yaml b/_data/engine-cli-edge/docker_info.yaml deleted file mode 100644 index 39af472a3e..0000000000 --- a/_data/engine-cli-edge/docker_info.yaml +++ /dev/null @@ -1,236 +0,0 @@ -command: docker info -short: Display system-wide information -long: |- - This command displays system wide information regarding the Docker installation. - Information displayed includes the kernel version, number of containers and images. - The number of images shown is the number of unique images. The same image tagged - under different names is counted only once. - - If a format is specified, the given template will be executed instead of the - default format. Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. - - Depending on the storage driver in use, additional information can be shown, such - as pool name, data file, metadata file, data space used, total data space, metadata - space used, and total metadata space. - - The data file is where the images are stored and the metadata file is where the - meta data regarding those images are stored. When run for the first time Docker - allocates a certain amount of data space and meta data space from the space - available on the volume where `/var/lib/docker` is mounted. -usage: docker info [OPTIONS] -pname: docker -plink: docker.yaml -options: -- option: format - shorthand: f - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Show output - - The example below shows the output for a daemon running on Red Hat Enterprise Linux, - using the `devicemapper` storage driver. As can be seen in the output, additional - information about the `devicemapper` storage driver is shown: - - ```bash - $ docker info - - Containers: 14 - Running: 3 - Paused: 1 - Stopped: 10 - Images: 52 - Server Version: 1.10.3 - Storage Driver: devicemapper - Pool Name: docker-202:2-25583803-pool - Pool Blocksize: 65.54 kB - Base Device Size: 10.74 GB - Backing Filesystem: xfs - Data file: /dev/loop0 - Metadata file: /dev/loop1 - Data Space Used: 1.68 GB - Data Space Total: 107.4 GB - Data Space Available: 7.548 GB - Metadata Space Used: 2.322 MB - Metadata Space Total: 2.147 GB - Metadata Space Available: 2.145 GB - Udev Sync Supported: true - Deferred Removal Enabled: false - Deferred Deletion Enabled: false - Deferred Deleted Device Count: 0 - Data loop file: /var/lib/docker/devicemapper/devicemapper/data - Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata - Library Version: 1.02.107-RHEL7 (2015-12-01) - Execution Driver: native-0.2 - Logging Driver: json-file - Plugins: - Volume: local - Network: null host bridge - Kernel Version: 3.10.0-327.el7.x86_64 - Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo) - OSType: linux - Architecture: x86_64 - CPUs: 1 - Total Memory: 991.7 MiB - Name: ip-172-30-0-91.ec2.internal - ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S - Docker Root Dir: /var/lib/docker - Debug mode (client): false - Debug mode (server): false - Username: gordontheturtle - Registry: https://index.docker.io/v1/ - Insecure registries: - myinsecurehost:5000 - 127.0.0.0/8 - ``` - - ### Show debugging output - - Here is a sample output for a daemon running on Ubuntu, using the overlay2 - storage driver and a node that is part of a 2-node swarm: - - ```bash - $ docker -D info - - Containers: 14 - Running: 3 - Paused: 1 - Stopped: 10 - Images: 52 - Server Version: 1.13.0 - Storage Driver: overlay2 - Backing Filesystem: extfs - Supports d_type: true - Native Overlay Diff: false - Logging Driver: json-file - Cgroup Driver: cgroupfs - Plugins: - Volume: local - Network: bridge host macvlan null overlay - Swarm: active - NodeID: rdjq45w1op418waxlairloqbm - Is Manager: true - ClusterID: te8kdyw33n36fqiz74bfjeixd - Managers: 1 - Nodes: 2 - Orchestration: - Task History Retention Limit: 5 - Raft: - Snapshot Interval: 10000 - Number of Old Snapshots to Retain: 0 - Heartbeat Tick: 1 - Election Tick: 3 - Dispatcher: - Heartbeat Period: 5 seconds - CA Configuration: - Expiry Duration: 3 months - Root Rotation In Progress: false - Node Address: 172.16.66.128 172.16.66.129 - Manager Addresses: - 172.16.66.128:2477 - Runtimes: runc - Default Runtime: runc - Init Binary: docker-init - containerd version: 8517738ba4b82aff5662c97ca4627e7e4d03b531 - runc version: ac031b5bf1cc92239461125f4c1ffb760522bbf2 - init version: N/A (expected: v0.13.0) - Security Options: - apparmor - seccomp - Profile: default - Kernel Version: 4.4.0-31-generic - Operating System: Ubuntu 16.04.1 LTS - OSType: linux - Architecture: x86_64 - CPUs: 2 - Total Memory: 1.937 GiB - Name: ubuntu - ID: H52R:7ZR6:EIIA:76JG:ORIY:BVKF:GSFU:HNPG:B5MK:APSC:SZ3Q:N326 - Docker Root Dir: /var/lib/docker - Debug Mode (client): true - Debug Mode (server): true - File Descriptors: 30 - Goroutines: 123 - System Time: 2016-11-12T17:24:37.955404361-08:00 - EventsListeners: 0 - Http Proxy: http://test:test@proxy.example.com:8080 - Https Proxy: https://test:test@proxy.example.com:8080 - No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com - Registry: https://index.docker.io/v1/ - WARNING: No swap limit support - Labels: - storage=ssd - staging=true - Experimental: false - Insecure Registries: - 127.0.0.0/8 - Registry Mirrors: - http://192.168.1.2/ - http://registry-mirror.example.com:5000/ - Live Restore Enabled: false - ``` - - The global `-D` option causes all `docker` commands to output debug information. - - ### Format the output - - You can also specify the output format: - - ```bash - $ docker info --format '{{json .}}' - - {"ID":"I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S","Containers":14, ...} - ``` - - ### Run `docker info` on Windows - - Here is a sample output for a daemon running on Windows Server 2016: - - ```none - E:\docker>docker info - - Containers: 1 - Running: 0 - Paused: 0 - Stopped: 1 - Images: 17 - Server Version: 1.13.0 - Storage Driver: windowsfilter - Windows: - Logging Driver: json-file - Plugins: - Volume: local - Network: nat null overlay - Swarm: inactive - Default Isolation: process - Kernel Version: 10.0 14393 (14393.206.amd64fre.rs1_release.160912-1937) - Operating System: Windows Server 2016 Datacenter - OSType: windows - Architecture: x86_64 - CPUs: 8 - Total Memory: 3.999 GiB - Name: WIN-V0V70C0LU5P - ID: NYMS:B5VK:UMSL:FVDZ:EWB5:FKVK:LPFL:FJMQ:H6FT:BZJ6:L2TD:XH62 - Docker Root Dir: C:\control - Debug Mode (client): false - Debug Mode (server): false - Registry: https://index.docker.io/v1/ - Insecure Registries: - 127.0.0.0/8 - Registry Mirrors: - http://192.168.1.2/ - http://registry-mirror.example.com:5000/ - Live Restore Enabled: false - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_inspect.yaml b/_data/engine-cli-edge/docker_inspect.yaml deleted file mode 100644 index 675803b038..0000000000 --- a/_data/engine-cli-edge/docker_inspect.yaml +++ /dev/null @@ -1,104 +0,0 @@ -command: docker inspect -short: Return low-level information on Docker objects -long: |- - Docker inspect provides detailed information on constructs controlled by Docker. - - By default, `docker inspect` will render results in a JSON array. -usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] -pname: docker -plink: docker.yaml -options: -- option: format - shorthand: f - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: size - shorthand: s - value_type: bool - default_value: "false" - description: Display total file sizes if the type is container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: type - value_type: string - description: Return JSON for specified type - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Get an instance's IP address - - For the most part, you can pick out any field from the JSON in a fairly - straightforward manner. - - ```bash - $ docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $INSTANCE_ID - ``` - - ### Get an instance's MAC address - - ```bash - $ docker inspect --format='{{range .NetworkSettings.Networks}}{{.MacAddress}}{{end}}' $INSTANCE_ID - ``` - - ### Get an instance's log path - - ```bash - $ docker inspect --format='{{.LogPath}}' $INSTANCE_ID - ``` - - ### Get an instance's image name - - ```bash - $ docker inspect --format='{{.Config.Image}}' $INSTANCE_ID - ``` - - ### List all port bindings - - You can loop over arrays and maps in the results to produce simple text - output: - - ```bash - $ docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID - ``` - - ### Find a specific port mapping - - The `.Field` syntax doesn't work when the field name begins with a - number, but the template language's `index` function does. The - `.NetworkSettings.Ports` section contains a map of the internal port - mappings to a list of external address/port objects. To grab just the - numeric public port, you use `index` to find the specific port map, and - then `index` 0 contains the first object inside of that. Then we ask for - the `HostPort` field to get the public address. - - ```bash - $ docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID - ``` - - ### Get a subsection in JSON format - - If you request a field which is itself a structure containing other - fields, by default you get a Go-style dump of the inner values. - Docker adds a template function, `json`, which can be applied to get - results in JSON format. - - ```bash - $ docker inspect --format='{{json .Config}}' $INSTANCE_ID - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_kill.yaml b/_data/engine-cli-edge/docker_kill.yaml deleted file mode 100644 index cb12ba7d1d..0000000000 --- a/_data/engine-cli-edge/docker_kill.yaml +++ /dev/null @@ -1,62 +0,0 @@ -command: docker kill -short: Kill one or more running containers -long: |- - The `docker kill` subcommand kills one or more containers. The main process - inside the container is sent `SIGKILL` signal (default), or the signal that is - specified with the `--signal` option. You can kill a container using the - container's ID, ID-prefix, or name. - - > **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of - > `/bin/sh -c`, which does not pass signals. This means that the executable is - > not the container’s PID 1 and does not receive Unix signals. -usage: docker kill [OPTIONS] CONTAINER [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Send a KILL signal to a container - - The following example sends the default `KILL` signal to the container named - `my_container`: - - ```bash - $ docker kill my_container - ``` - - ### Send a custom signal to a container - - The following example sends a `SIGHUP` signal to the container named - `my_container`: - - ```bash - $ docker kill --signal=SIGHUP my_container - ``` - - - You can specify a custom signal either by _name_, or _number_. The `SIG` prefix - is optional, so the following examples are equivalent: - - ```bash - $ docker kill --signal=SIGHUP my_container - $ docker kill --signal=HUP my_container - $ docker kill --signal=1 my_container - ``` - - Refer to the [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html) - man-page for a list of standard Linux signals. -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_load.yaml b/_data/engine-cli-edge/docker_load.yaml deleted file mode 100644 index 6c78f498e0..0000000000 --- a/_data/engine-cli-edge/docker_load.yaml +++ /dev/null @@ -1,62 +0,0 @@ -command: docker load -short: Load an image from a tar archive or STDIN -long: |- - Load an image or repository from a tar archive (even if compressed with gzip, - bzip2, or xz) from a file or STDIN. It restores both images and tags. -usage: docker load [OPTIONS] -pname: docker -plink: docker.yaml -options: -- option: input - shorthand: i - value_type: string - description: Read from tar archive file, instead of STDIN - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress the load output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker image ls - - REPOSITORY TAG IMAGE ID CREATED SIZE - - $ docker load < busybox.tar.gz - - Loaded image: busybox:latest - $ docker images - REPOSITORY TAG IMAGE ID CREATED SIZE - busybox latest 769b9341d937 7 weeks ago 2.489 MB - - $ docker load --input fedora.tar - - Loaded image: fedora:rawhide - - Loaded image: fedora:20 - - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - busybox latest 769b9341d937 7 weeks ago 2.489 MB - fedora rawhide 0d20aec6529d 7 weeks ago 387 MB - fedora 20 58394af37342 7 weeks ago 385.5 MB - fedora heisenbug 58394af37342 7 weeks ago 385.5 MB - fedora latest 58394af37342 7 weeks ago 385.5 MB - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_login.yaml b/_data/engine-cli-edge/docker_login.yaml deleted file mode 100644 index c86ba0b06c..0000000000 --- a/_data/engine-cli-edge/docker_login.yaml +++ /dev/null @@ -1,107 +0,0 @@ -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### 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/engine/security/security/#docker-daemon-attack-surface) - for details.\n\nYou can log into any public or private repository for which you - have\ncredentials. When you log in, the command stores credentials in\n`$HOME/.docker/config.json` - on Linux or `%USERPROFILE%/.docker/config.json` on\nWindows, via the procedure described - below.\n\n### Credentials store\n\nThe Docker Engine can keep user credentials in - an external credentials store,\nsuch as the native keychain of the operating system. - Using an external store\nis more secure than storing credentials in the Docker configuration - file.\n\nTo use a credentials store, you need an external helper program to interact\nwith - a specific keychain or external store. Docker requires the helper\nprogram to be - in the client's host `$PATH`.\n\nThis is the list of currently available credentials - helpers and where\nyou can download them from:\n\n- D-Bus Secret Service: https://github.com/docker/docker-credential-helpers/releases\n- - Apple macOS keychain: https://github.com/docker/docker-credential-helpers/releases\n- - Microsoft Windows Credential Manager: https://github.com/docker/docker-credential-helpers/releases\n- - [pass](https://www.passwordstore.org/): https://github.com/docker/docker-credential-helpers/releases\n\nYou - need to specify the credentials store in `$HOME/.docker/config.json`\nto tell the - docker engine to use it. The value of the config property should be\nthe suffix - of the program to use (i.e. everything after `docker-credential-`).\nFor example, - to use `docker-credential-osxkeychain`:\n\n```json\n{\n\t\"credsStore\": \"osxkeychain\"\n}\n```\n\nIf - you are currently logged in, run `docker logout` to remove\nthe credentials from - the file and run `docker login` again.\n\n### Default behavior\n\nBy default, Docker - looks for the native binary on each of the platforms, i.e.\n\"osxkeychain\" on macOS, - \"wincred\" on windows, and \"pass\" on Linux. A special\ncase is that on Linux, - Docker will fall back to the \"secretservice\" binary if\nit cannot find the \"pass\" - binary. If none of these binaries are present, it\nstores the credentials (i.e. - password) in base64 encoding in the config files\ndescribed above.\n\n### Credential - helper protocol\n\nCredential helpers can be any program or script that follows - a very simple protocol.\nThis protocol is heavily inspired by Git, but it differs - in the information shared.\n\nThe helpers always use the first argument in the command - to identify the action.\nThere are only three possible values for that argument: - `store`, `get`, and `erase`.\n\nThe `store` command takes a JSON payload from the - standard input. That payload carries\nthe server address, to identify the credential, - the user name, and either a password\nor an identity token.\n\n```json\n{\n\t\"ServerURL\": - \"https://index.docker.io/v1\",\n\t\"Username\": \"david\",\n\t\"Secret\": \"passw0rd1\"\n}\n```\n\nIf - the secret being stored is an identity token, the Username should be set to\n``.\n\nThe - `store` command can write error messages to `STDOUT` that the docker engine\nwill - show if there was an issue.\n\nThe `get` command takes a string payload from the - standard input. That payload carries\nthe server address that the docker engine - needs credentials for. This is\nan example of that payload: `https://index.docker.io/v1`.\n\nThe - `get` command writes a JSON payload to `STDOUT`. Docker reads the user name\nand - password from this payload:\n\n```json\n{\n\t\"Username\": \"david\",\n\t\"Secret\": - \"passw0rd1\"\n}\n```\n\nThe `erase` command takes a string payload from `STDIN`. - That payload carries\nthe server address that the docker engine wants to remove - credentials for. This is\nan example of that payload: `https://index.docker.io/v1`.\n\nThe - `erase` command can write error messages to `STDOUT` that the docker engine\nwill - show if there was an issue.\n\n### Credential helpers\n\nCredential helpers are - similar to the credential store above, but act as the\ndesignated programs to handle - credentials for *specific registries*. The default\ncredential store (`credsStore` - or the config file itself) will not be used for\noperations concerning credentials - of the specified registries.\n\n### Logging out\n\nIf you are currently logged in, - run `docker logout` to remove\nthe credentials from the default store.\n\nCredential - helpers are specified in a similar way to `credsStore`, but\nallow for multiple - helpers to be configured at a time. Keys specify the\nregistry domain, and values - specify the suffix of the program to use\n(i.e. everything after `docker-credential-`).\nFor - example:\n\n```json\n{\n \"credHelpers\": {\n \"registry.example.com\": \"registryhelper\",\n - \ \"awesomereg.example.org\": \"hip-star\",\n \"unicorn.example.io\": \"vcbait\"\n - \ }\n}\n```" -usage: docker login [OPTIONS] [SERVER] -pname: docker -plink: docker.yaml -options: -- option: password - shorthand: p - value_type: string - description: Password - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: password-stdin - value_type: bool - default_value: "false" - description: Take the password from stdin - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: username - shorthand: u - value_type: string - description: Username - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_logout.yaml b/_data/engine-cli-edge/docker_logout.yaml deleted file mode 100644 index 2c4f41b645..0000000000 --- a/_data/engine-cli-edge/docker_logout.yaml +++ /dev/null @@ -1,16 +0,0 @@ -command: docker logout -short: Log out from a Docker registry -long: Log out from a Docker registry -usage: docker logout [SERVER] -pname: docker -plink: docker.yaml -examples: |- - ```bash - $ docker logout localhost:8080 - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_logs.yaml b/_data/engine-cli-edge/docker_logs.yaml deleted file mode 100644 index 8750eee686..0000000000 --- a/_data/engine-cli-edge/docker_logs.yaml +++ /dev/null @@ -1,119 +0,0 @@ -command: docker logs -short: Fetch the logs of a container -long: |- - The `docker logs` command batch-retrieves logs present at the time of execution. - - > **Note**: this command is only functional for containers that are started with - > the `json-file` or `journald` logging driver. - - For more information about selecting and configuring logging drivers, refer to - [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/). - - The `docker logs --follow` command will continue streaming the new output from - the container's `STDOUT` and `STDERR`. - - Passing a negative number or a non-integer to `--tail` is invalid and the - value is set to `all` in that case. - - The `docker logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) - , for example `2014-09-16T06:17:46.000000000Z`, to each - log entry. To ensure that the timestamps are aligned the - nano-second part of the timestamp will be padded with zero when necessary. - - The `docker logs --details` command will add on extra attributes, such as - environment variables and labels, provided to `--log-opt` when creating the - container. - - The `--since` option shows only the container logs generated after - a given date. You can specify the date as an RFC 3339 date, a UNIX - timestamp, or a Go duration string (e.g. `1m30s`, `3h`). Besides RFC3339 date - format you may also use RFC3339Nano, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the client will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. You can combine the - `--since` option with either or both of the `--follow` or `--tail` options. -usage: docker logs [OPTIONS] CONTAINER -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: follow - shorthand: f - value_type: bool - default_value: "false" - description: Follow log output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: since - value_type: string - description: | - Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tail - value_type: string - default_value: all - description: Number of lines to show from the end of the logs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: timestamps - shorthand: t - value_type: bool - default_value: "false" - description: Show timestamps - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: until - value_type: string - description: | - Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Retrieve logs until a specific point in time - - In order to retrieve logs before a specific point in time, run: - - ```bash - $ docker run --name test -d busybox sh -c "while true; do $(echo date); sleep 1; done" - $ date - Tue 14 Nov 2017 16:40:00 CET - $ docker logs -f --until=2s - Tue 14 Nov 2017 16:40:00 CET - Tue 14 Nov 2017 16:40:01 CET - Tue 14 Nov 2017 16:40:02 CET - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_manifest.yaml b/_data/engine-cli-edge/docker_manifest.yaml deleted file mode 100644 index 82249e3c7b..0000000000 --- a/_data/engine-cli-edge/docker_manifest.yaml +++ /dev/null @@ -1,133 +0,0 @@ -command: docker manifest -short: Manage Docker image manifests and manifest lists -long: "The `docker manifest` command by itself performs no action. In order to operate\non - a manifest or manifest list, one of the subcommands must be used.\n\nA single manifest - is information about an image, such as layers, size, and digest.\nThe docker manifest - command also gives users additional information such as the os\nand architecture - an image was built for.\n\nA manifest list is a list of image layers that is created - by specifying one or\nmore (ideally more than one) image names. It can then be used - in the same way as\nan image name in `docker pull` and `docker run` commands, for - example.\n\nIdeally a manifest list is created from images that are identical in - function for\ndifferent os/arch combinations. For this reason, manifest lists are - often referred to as\n\"multi-arch images\". However, a user could create a manifest - list that points\nto two images -- one for windows on amd64, and one for darwin - on amd64.\n\n### manifest inspect\n\n```\nmanifest inspect --help\n\nUsage: docker - manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST\n\nDisplay an image manifest, - or manifest list\n\nOptions:\n --help Print usage\n --insecure Allow - communication with an insecure registry\n -v, --verbose Output additional info - including layers and platform\n```\n\n### manifest create \n\n```bash\nUsage: docker - manifest create MANIFEST_LIST MANIFEST [MANIFEST...]\n\nCreate a local manifest - list for annotating and pushing to a registry\n\nOptions:\n -a, --amend Amend - an existing manifest list\n --insecure Allow communication with an insecure - registry\n --help Print usage\n```\n\n### manifest annotate\n```bash\nUsage: - \ docker manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST\n\nAdd additional information - to a local image manifest\n\nOptions:\n --arch string Set architecture\n - \ --help Print usage\n --os string Set - operating system\n --os-features stringSlice Set operating system feature\n - \ --variant string Set architecture variant\n\n```\n\n### manifest - push\n```bash\nUsage: docker manifest push [OPTIONS] MANIFEST_LIST\n\nPush a manifest - list to a repository\n\nOptions:\n --help Print usage\n --insecure - \ Allow push to an insecure registry\n -p, --purge Remove the local manifest - list after push\n```\n\n### Working with insecure registries\n\nThe manifest command - interacts solely with a Docker registry. Because of this, it has no way to query - the engine for the list of allowed insecure registries. To allow the CLI to interact - with an insecure registry, some `docker manifest` commands have an `--insecure` - flag. For each transaction, such as a `create`, which queries a registry, the `--insecure` - flag must be specified. This flag tells the CLI that this registry call may ignore - security concerns like missing or self-signed certificates. Likewise, on a `manifest - push` to an insecure registry, the `--insecure` flag must be specified. If this - is not used with an insecure registry, the manifest command fails to find a registry - that meets the default requirements." -usage: docker manifest COMMAND -pname: docker -plink: docker.yaml -cname: -- docker manifest annotate -- docker manifest create -- docker manifest inspect -- docker manifest push -clink: -- docker_manifest_annotate.yaml -- docker_manifest_create.yaml -- docker_manifest_inspect.yaml -- docker_manifest_push.yaml -examples: "### Inspect an image's manifest object\n \n```bash\n$ docker manifest inspect - hello-world\n{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n - \ \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n - \ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n - \ },\n \"layers\": [\n {\n \"mediaType\": - \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": - 972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n - \ }\n ]\n}\n```\n\n### Inspect an image's manifest and get - the os/arch info\n\nThe `docker manifest inspect` command takes an optional `--verbose` - flag\nthat gives you the image's name (Ref), and architecture and os (Platform).\n\nJust - as with other docker commands that take image names, you can refer to an image with - or\nwithout a tag, or by digest (e.g. hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f).\n\nHere - is an example of inspecting an image's manifest with the `--verbose` flag:\n\n```bash\n$ - docker manifest inspect --verbose hello-world\n{\n \"Ref\": \"docker.io/library/hello-world:latest\",\n - \ \"Digest\": \"sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f\",\n - \ \"SchemaV2Manifest\": {\n \"schemaVersion\": 2,\n \"mediaType\": - \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": - {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n - \ \"size\": 1520,\n \"digest\": \"sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57\"\n - \ },\n \"layers\": [\n {\n \"mediaType\": - \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": - 972,\n \"digest\": \"sha256:b04784fba78d739b526e27edc02a5a8cd07b1052e9283f5fc155828f4b614c28\"\n - \ }\n ]\n },\n \"Platform\": - {\n \"architecture\": \"amd64\",\n \"os\": \"linux\"\n - \ }\n}\n```\n\n### Create and push a manifest list\n\nTo create a manifest - list, you first `create` the manifest list locally by specifying the constituent - images you would\nlike to have included in your manifest list. Keep in mind that - this is pushed to a registry, so if you want to push\nto a registry other than the - docker registry, you need to create your manifest list with the registry name or - IP and port.\nThis is similar to tagging an image and pushing it to a foreign registry.\n\nAfter - you have created your local copy of the manifest list, you may optionally\n`annotate` - it. Annotations allowed are the architecture and operating system (overriding the - image's current values),\nos features, and an archictecure variant. \n\nFinally, - you need to `push` your manifest list to the desired registry. Below are descriptions - of these three commands,\nand an example putting them all together.\n\n```bash\n$ - docker manifest create 45.55.81.106:5000/coolapp:v1 \\\n 45.55.81.106:5000/coolapp-ppc64le-linux:v1 - \\\n 45.55.81.106:5000/coolapp-arm-linux:v1 \\\n 45.55.81.106:5000/coolapp-amd64-linux:v1 - \\\n 45.55.81.106:5000/coolapp-amd64-windows:v1\nCreated manifest list 45.55.81.106:5000/coolapp:v1\n```\n\n```bash\n$ - docker manifest annotate 45.55.81.106:5000/coolapp:v1 45.55.81.106:5000/coolapp-arm-linux - --arch arm\n```\n\n```bash\n$ docker manifest push 45.55.81.106:5000/coolapp:v1\nPushed - manifest 45.55.81.106:5000/coolapp@sha256:9701edc932223a66e49dd6c894a11db8c2cf4eccd1414f1ec105a623bf16b426 - with digest: sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\nPushed - manifest 45.55.81.106:5000/coolapp@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f - with digest: sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\nPushed - manifest 45.55.81.106:5000/coolapp@sha256:39dc41c658cf25f33681a41310372f02728925a54aac3598310bfb1770615fc9 - with digest: sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\nPushed - manifest 45.55.81.106:5000/coolapp@sha256:f91b1145cd4ac800b28122313ae9e88ac340bb3f1e3a4cd3e59a3648650f3275 - with digest: sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\nsha256:050b213d49d7673ba35014f21454c573dcbec75254a08f4a7c34f66a47c06aba\n\n```\n\n### - Inspect a manifest list\n\n```bash\n$ docker manifest inspect coolapp:v1\n{\n \"schemaVersion\": - 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.list.v2+json\",\n - \ \"manifests\": [\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n - \ \"size\": 424,\n \"digest\": \"sha256:f67dcc5fc786f04f0743abfe0ee5dae9bd8caf8efa6c8144f7f2a43889dc513b\",\n - \ \"platform\": {\n \"architecture\": \"arm\",\n \"os\": - \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n - \ \"size\": 424,\n \"digest\": \"sha256:b64ca0b60356a30971f098c92200b1271257f100a55b351e6bbe985638352f3a\",\n - \ \"platform\": {\n \"architecture\": \"amd64\",\n \"os\": - \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n - \ \"size\": 425,\n \"digest\": \"sha256:df436846483aff62bad830b730a0d3b77731bcf98ba5e470a8bbb8e9e346e4e8\",\n - \ \"platform\": {\n \"architecture\": \"ppc64le\",\n \"os\": - \"linux\"\n }\n },\n {\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n - \ \"size\": 425,\n \"digest\": \"sha256:5bb8e50aa2edd408bdf3ddf61efb7338ff34a07b762992c9432f1c02fc0e5e62\",\n - \ \"platform\": {\n \"architecture\": \"s390x\",\n \"os\": - \"linux\"\n }\n }\n ]\n}\n```\n\n### Push to an insecure registry\n\nHere - is an example of creating and pushing a manifest list using a known insecure registry.\n\n```\n$ - docker manifest create --insecure myprivateregistry.mycompany.com/repo/image:1.0 - \\\n myprivateregistry.mycompany.com/repo/image-linux-ppc64le:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-s390x:1.0 - \\\n myprivateregistry.mycompany.com/repo/image-linux-arm:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-armhf:1.0 - \\\n myprivateregistry.mycompany.com/repo/image-windows-amd64:1.0 \\\n myprivateregistry.mycompany.com/repo/image-linux-amd64:1.0\n```\n```\n$ - docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag\n```\n\nNote - that the `--insecure` flag is not required to annotate a manifest list, since annotations - are to a locally-stored copy of a manifest list. You may also skip the `--insecure` - flag if you are performaing a `docker manifest inspect` on a locally-stored manifest - list. Be sure to keep in mind that locally-stored manifest lists are never used - by the engine on a `docker pull`." -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_manifest_annotate.yaml b/_data/engine-cli-edge/docker_manifest_annotate.yaml deleted file mode 100644 index c1491c2e6b..0000000000 --- a/_data/engine-cli-edge/docker_manifest_annotate.yaml +++ /dev/null @@ -1,46 +0,0 @@ -command: docker manifest annotate -short: Add additional information to a local image manifest -long: Add additional information to a local image manifest -usage: docker manifest annotate [OPTIONS] MANIFEST_LIST MANIFEST -pname: docker manifest -plink: docker_manifest.yaml -options: -- option: arch - value_type: string - description: Set architecture - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: os - value_type: string - description: Set operating system - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: os-features - value_type: stringSlice - default_value: '[]' - description: Set operating system feature - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: variant - value_type: string - description: Set architecture variant - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_manifest_create.yaml b/_data/engine-cli-edge/docker_manifest_create.yaml deleted file mode 100644 index 9bee33d6bd..0000000000 --- a/_data/engine-cli-edge/docker_manifest_create.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker manifest create -short: Create a local manifest list for annotating and pushing to a registry -long: Create a local manifest list for annotating and pushing to a registry -usage: docker manifest create MANIFEST_LIST MANIFEST [MANIFEST...] -pname: docker manifest -plink: docker_manifest.yaml -options: -- option: amend - shorthand: a - value_type: bool - default_value: "false" - description: Amend an existing manifest list - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: insecure - value_type: bool - default_value: "false" - description: Allow communication with an insecure registry - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_manifest_inspect.yaml b/_data/engine-cli-edge/docker_manifest_inspect.yaml deleted file mode 100644 index 8da0a57b6f..0000000000 --- a/_data/engine-cli-edge/docker_manifest_inspect.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker manifest inspect -short: Display an image manifest, or manifest list -long: Display an image manifest, or manifest list -usage: docker manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST -pname: docker manifest -plink: docker_manifest.yaml -options: -- option: insecure - value_type: bool - default_value: "false" - description: Allow communication with an insecure registry - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: verbose - shorthand: v - value_type: bool - default_value: "false" - description: Output additional info including layers and platform - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_manifest_push.yaml b/_data/engine-cli-edge/docker_manifest_push.yaml deleted file mode 100644 index e286da6aee..0000000000 --- a/_data/engine-cli-edge/docker_manifest_push.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker manifest push -short: Push a manifest list to a repository -long: Push a manifest list to a repository -usage: docker manifest push [OPTIONS] MANIFEST_LIST -pname: docker manifest -plink: docker_manifest.yaml -options: -- option: insecure - value_type: bool - default_value: "false" - description: Allow push to an insecure registry - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: purge - shorthand: p - value_type: bool - default_value: "false" - description: Remove the local manifest list after push - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network.yaml b/_data/engine-cli-edge/docker_network.yaml deleted file mode 100644 index 01efb3d902..0000000000 --- a/_data/engine-cli-edge/docker_network.yaml +++ /dev/null @@ -1,30 +0,0 @@ -command: docker network -short: Manage networks -long: |- - Manage networks. You can use subcommands to create, inspect, list, remove, - prune, connect, and disconnect networks. -usage: docker network -pname: docker -plink: docker.yaml -cname: -- docker network connect -- docker network create -- docker network disconnect -- docker network inspect -- docker network ls -- docker network prune -- docker network rm -clink: -- docker_network_connect.yaml -- docker_network_create.yaml -- docker_network_disconnect.yaml -- docker_network_inspect.yaml -- docker_network_ls.yaml -- docker_network_prune.yaml -- docker_network_rm.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_connect.yaml b/_data/engine-cli-edge/docker_network_connect.yaml deleted file mode 100644 index 9c2fd43962..0000000000 --- a/_data/engine-cli-edge/docker_network_connect.yaml +++ /dev/null @@ -1,126 +0,0 @@ -command: docker network connect -short: Connect a container to a network -long: |- - Connects a container to a network. You can connect a container by name - or by ID. Once connected, the container can communicate with other containers in - the same network. -usage: docker network connect [OPTIONS] NETWORK CONTAINER -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: ip - value_type: string - description: IPv4 address (e.g., 172.30.100.104) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip6 - value_type: string - description: IPv6 address (e.g., 2001:db8::33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link - value_type: list - description: Add link to another container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link-local-ip - value_type: stringSlice - default_value: '[]' - description: Add a link-local address for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Connect a running container to a network - - ```bash - $ docker network connect multi-host-network container1 - ``` - - ### Connect a container to a network when it starts - - You can also use the `docker run --network=` option to start a container and immediately connect it to a network. - - ```bash - $ docker run -itd --network=multi-host-network busybox - ``` - - ### Specify the IP address a container will use on a given network - - You can specify the IP address you want to be assigned to the container's interface. - - ```bash - $ docker network connect --ip 10.10.36.122 multi-host-network container2 - ``` - - ### Use the legacy `--link` option - - You can use `--link` option to link another container with a preferred alias - - ```bash - $ docker network connect --link container1:c1 multi-host-network container2 - ``` - - ### Create a network alias for a container - - `--alias` option can be used to resolve the container by another name in the network - being connected to. - - ```bash - $ docker network connect --alias db --alias mysql multi-host-network container2 - ``` - - ### Network implications of stopping, pausing, or restarting containers - - You can pause, restart, and stop containers that are connected to a network. - A container connects to its configured networks when it runs. - - If specified, the container's IP address(es) is reapplied when a stopped - container is restarted. If the IP address is no longer available, the container - fails to start. One way to guarantee that the IP address is available is - to specify an `--ip-range` when creating the network, and choose the static IP - address(es) from outside that range. This ensures that the IP address is not - given to another container while this container is not on the network. - - ```bash - $ docker network create --subnet 172.20.0.0/16 --ip-range 172.20.240.0/20 multi-host-network - ``` - - ```bash - $ docker network connect --ip 172.20.128.2 multi-host-network container2 - ``` - - To verify the container is connected, use the `docker network inspect` command. Use `docker network disconnect` to remove a container from the network. - - Once connected in network, containers can communicate using only another - container's IP address or name. For `overlay` networks or custom plugins that - support multi-host connectivity, containers connected to the same multi-host - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_create.yaml b/_data/engine-cli-edge/docker_network_create.yaml deleted file mode 100644 index 799e4b3228..0000000000 --- a/_data/engine-cli-edge/docker_network_create.yaml +++ /dev/null @@ -1,343 +0,0 @@ -command: docker network create -short: Create a network -long: |- - Creates a new network. The `DRIVER` accepts `bridge` or `overlay` which are the - built-in network drivers. If you have installed a third party or your own custom - network driver you can specify that `DRIVER` here also. If you don't specify the - `--driver` option, the command automatically creates a `bridge` network for you. - When you install Docker Engine it creates a `bridge` network automatically. This - network corresponds to the `docker0` bridge that Engine has traditionally relied - on. When you launch a new container with `docker run` it automatically connects to - this bridge network. You cannot remove this default bridge network, but you can - create new ones using the `network create` command. - - ```bash - $ docker network create -d bridge my-bridge-network - ``` - - Bridge networks are isolated networks on a single Engine installation. If you - want to create a network that spans multiple Docker hosts each running an - Engine, you must create an `overlay` network. Unlike `bridge` networks, overlay - networks require some pre-existing conditions before you can create one. These - conditions are: - - * Access to a key-value store. Engine supports Consul, Etcd, and ZooKeeper (Distributed store) key-value stores. - * A cluster of hosts with connectivity to the key-value store. - * A properly configured Engine `daemon` on each host in the cluster. - - The `dockerd` options that support the `overlay` network are: - - * `--cluster-store` - * `--cluster-store-opt` - * `--cluster-advertise` - - To read more about these options and how to configure them, see ["*Get started - with multi-host network*"](https://docs.docker.com/engine/userguide/networking/get-started-overlay). - - While not required, it is a good idea to install Docker Swarm to - manage the cluster that makes up your network. Swarm provides sophisticated - discovery and server management tools that can assist your implementation. - - Once you have prepared the `overlay` network prerequisites you simply choose a - Docker host in the cluster and issue the following to create the network: - - ```bash - $ docker network create -d overlay my-multihost-network - ``` - - Network names must be unique. The Docker daemon attempts to identify naming - conflicts but this is not guaranteed. It is the user's responsibility to avoid - name conflicts. - - ### Overlay network limitations - - You should create overlay networks with `/24` blocks (the default), which limits - you to 256 IP addresses, when you create networks using the default VIP-based - endpoint-mode. This recommendation addresses - [limitations with swarm mode](https://github.com/moby/moby/issues/30820). If you - need more than 256 IP addresses, do not increase the IP block size. You can - either use `dnsrr` endpoint mode with an external load balancer, or use multiple - smaller overlay networks. See - [Configure service discovery](https://docs.docker.com/engine/swarm/networking/#configure-service-discovery) - for more information about different endpoint modes. -usage: docker network create [OPTIONS] NETWORK -pname: docker network -plink: docker_network.yaml -options: -- option: attachable - value_type: bool - default_value: "false" - description: Enable manual container attachment - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: aux-address - value_type: map - default_value: map[] - description: Auxiliary IPv4 or IPv6 addresses used by Network driver - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: config-from - value_type: string - description: The network from which copying the configuration - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: config-only - value_type: bool - default_value: "false" - description: Create a configuration only network - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: driver - shorthand: d - value_type: string - default_value: bridge - description: Driver to manage the Network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: gateway - value_type: stringSlice - default_value: '[]' - description: IPv4 or IPv6 Gateway for the master subnet - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ingress - value_type: bool - default_value: "false" - description: Create swarm routing-mesh network - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: internal - value_type: bool - default_value: "false" - description: Restrict external access to the network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip-range - value_type: stringSlice - default_value: '[]' - description: Allocate container ip from a sub-range - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipam-driver - value_type: string - default_value: default - description: IP Address Management Driver - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipam-opt - value_type: map - default_value: map[] - description: Set IPAM driver specific options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipv6 - value_type: bool - default_value: "false" - description: Enable IPv6 networking - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - value_type: list - description: Set metadata on a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: opt - shorthand: o - value_type: map - default_value: map[] - description: Set driver specific options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: scope - value_type: string - description: Control the network's scope - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: subnet - value_type: stringSlice - default_value: '[]' - description: Subnet in CIDR format that represents a network segment - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Connect containers - - When you start a container, use the `--network` flag to connect it to a network. - This example adds the `busybox` container to the `mynet` network: - - ```bash - $ docker run -itd --network=mynet busybox - ``` - - If you want to add a container to a network after the container is already - running, use the `docker network connect` subcommand. - - You can connect multiple containers to the same network. Once connected, the - containers can communicate using only another container's IP address or name. - For `overlay` networks or custom plugins that support multi-host connectivity, - containers connected to the same multi-host network but launched from different - Engines can also communicate in this way. - - You can disconnect a container from a network using the `docker network - disconnect` command. - - ### Specify advanced options - - When you create a network, Engine creates a non-overlapping subnetwork for the - network by default. This subnetwork is not a subdivision of an existing - network. It is purely for ip-addressing purposes. You can override this default - and specify subnetwork values directly using the `--subnet` option. On a - `bridge` network you can only create a single subnet: - - ```bash - $ docker network create --driver=bridge --subnet=192.168.0.0/16 br0 - ``` - - Additionally, you also specify the `--gateway` `--ip-range` and `--aux-address` - options. - - ```bash - $ docker network create \ - --driver=bridge \ - --subnet=172.28.0.0/16 \ - --ip-range=172.28.5.0/24 \ - --gateway=172.28.5.254 \ - br0 - ``` - - If you omit the `--gateway` flag the Engine selects one for you from inside a - preferred pool. For `overlay` networks and for network driver plugins that - support it you can create multiple subnetworks. This example uses two `/25` - subnet mask to adhere to the current guidance of not having more than 256 IPs in - a single overlay network. Each of the subnetworks has 126 usable addresses. - - ```bash - $ docker network create -d overlay \ - --subnet=192.168.1.0/25 \ - --subnet=192.170.2.0/25 \ - --gateway=192.168.1.100 \ - --gateway=192.170.2.100 \ - --aux-address="my-router=192.168.1.5" --aux-address="my-switch=192.168.1.6" \ - --aux-address="my-printer=192.170.1.5" --aux-address="my-nas=192.170.1.6" \ - my-multihost-network - ``` - - Be sure that your subnetworks do not overlap. If they do, the network create - fails and Engine returns an error. - - ### Bridge driver options - - When creating a custom network, the default network driver (i.e. `bridge`) has - additional options that can be passed. The following are those options and the - equivalent docker daemon flags used for docker0 bridge: - - | Option | Equivalent | Description | - |--------------------------------------------------|-------------|-------------------------------------------------------| - | `com.docker.network.bridge.name` | - | bridge name to be used when creating the Linux bridge | - | `com.docker.network.bridge.enable_ip_masquerade` | `--ip-masq` | Enable IP masquerading | - | `com.docker.network.bridge.enable_icc` | `--icc` | Enable or Disable Inter Container Connectivity | - | `com.docker.network.bridge.host_binding_ipv4` | `--ip` | Default IP when binding container ports | - | `com.docker.network.driver.mtu` | `--mtu` | Set the containers network MTU | - - The following arguments can be passed to `docker network create` for any - network driver, again with their approximate equivalents to `docker daemon`. - - | Argument | Equivalent | Description | - |--------------|----------------|--------------------------------------------| - | `--gateway` | - | IPv4 or IPv6 Gateway for the master subnet | - | `--ip-range` | `--fixed-cidr` | Allocate IPs from a range | - | `--internal` | - | Restrict external access to the network | - | `--ipv6` | `--ipv6` | Enable IPv6 networking | - | `--subnet` | `--bip` | Subnet for network | - - For example, let's use `-o` or `--opt` options to specify an IP address binding - when publishing ports: - - ```bash - $ docker network create \ - -o "com.docker.network.bridge.host_binding_ipv4"="172.19.0.1" \ - simple-network - ``` - - ### Network internal mode - - By default, when you connect a container to an `overlay` network, Docker also - connects a bridge network to it to provide external connectivity. If you want - to create an externally isolated `overlay` network, you can specify the - `--internal` option. - - ### Network ingress mode - - You can create the network which will be used to provide the routing-mesh in the - swarm cluster. You do so by specifying `--ingress` when creating the network. Only - one ingress network can be created at the time. The network can be removed only - if no services depend on it. Any option available when creating an overlay network - is also available when creating the ingress network, besides the `--attachable` option. - - ```bash - $ docker network create -d overlay \ - --subnet=10.11.0.0/16 \ - --ingress \ - --opt com.docker.network.driver.mtu=9216 \ - --opt encrypted=true \ - my-ingress-network - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_disconnect.yaml b/_data/engine-cli-edge/docker_network_disconnect.yaml deleted file mode 100644 index 507b305660..0000000000 --- a/_data/engine-cli-edge/docker_network_disconnect.yaml +++ /dev/null @@ -1,29 +0,0 @@ -command: docker network disconnect -short: Disconnect a container from a network -long: |- - Disconnects a container from a network. The container must be running to - disconnect it from the network. -usage: docker network disconnect [OPTIONS] NETWORK CONTAINER -pname: docker network -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker network disconnect multi-host-network container1 - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_inspect.yaml b/_data/engine-cli-edge/docker_network_inspect.yaml deleted file mode 100644 index b29c872a26..0000000000 --- a/_data/engine-cli-edge/docker_network_inspect.yaml +++ /dev/null @@ -1,34 +0,0 @@ -command: docker network inspect -short: Display detailed information on one or more networks -long: |- - Returns information about one or more networks. By default, this command renders - all results in a JSON object. -usage: docker network inspect [OPTIONS] NETWORK [NETWORK...] -pname: docker network -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: verbose - shorthand: v - value_type: bool - default_value: "false" - description: Verbose output for diagnostics - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_ls.yaml b/_data/engine-cli-edge/docker_network_ls.yaml deleted file mode 100644 index 6688affca9..0000000000 --- a/_data/engine-cli-edge/docker_network_ls.yaml +++ /dev/null @@ -1,132 +0,0 @@ -command: docker network ls -aliases: list -short: List networks -long: |- - Lists all the networks the Engine `daemon` knows about. This includes the - networks that span across multiple hosts in a cluster. -usage: docker network ls [OPTIONS] -pname: docker network -plink: docker_network.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Provide filter values (e.g. 'driver=bridge') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print networks using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate the output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display network IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK ID - \ NAME DRIVER SCOPE\n7fca4eb8c647 bridge - \ bridge local\n9f904ee27bf5 none null - \ local\ncf03ee007fb4 host host local\n78b03ee04fc4 - \ multi-host overlay swarm\n```\n\nUse the `--no-trunc` option - to display the full network id:\n\n```bash\n$ docker network ls --no-trunc\nNETWORK - ID NAME DRIVER - \ SCOPE\n18a2866682b85619a026c81b98a5e375bd33e1b0936a26cc497c283d27bae9b3 - \ none null local\nc288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 - \ host host local\n7b369448dccbf865d397c8d2be0cda7cf7edc6b0945f77d2529912ae917a0185 - \ bridge bridge local\n95e74588f40db048e86320c6526440c504650a1ff3e9f7d60a497c4d2163e5bd - \ foo bridge local\n63d1ff1f77b07ca51070a8c227e962238358bd310bde1529cf62e6c307ade161 - \ dev bridge local\n```\n\n### Filtering\n\nThe filtering - flag (`-f` or `--filter`) format is a `key=value` pair. If there\nis more than one - filter, then pass multiple flags (e.g. `--filter \"foo=bar\" --filter \"bif=baz\"`).\nMultiple - filter flags are combined as an `OR` filter. For example,\n`-f type=custom -f type=builtin` - returns both `custom` and `builtin` networks.\n\nThe currently supported filters - are:\n\n* driver\n* id (network's id)\n* label (`label=` or `label==`)\n* - name (network's name)\n* scope (`swarm|global|local`)\n* type (`custom|builtin`)\n\n#### - Driver\n\nThe `driver` filter matches networks based on their driver.\n\nThe following - example matches networks with the `bridge` driver:\n\n```bash\n$ docker network - ls --filter driver=bridge\nNETWORK ID NAME DRIVER SCOPE\ndb9db329f835 - \ test1 bridge local\nf6e212da9dfd test2 bridge - \ local\n```\n\n#### ID\n\nThe `id` filter matches on all or part of a - network's ID.\n\nThe following filter matches all networks with an ID containing - the\n`63d1ff1f77b0...` string.\n\n```bash\n$ docker network ls --filter id=63d1ff1f77b07ca51070a8c227e962238358bd310bde1529cf62e6c307ade161\nNETWORK - ID NAME DRIVER SCOPE\n63d1ff1f77b0 dev - \ bridge local\n```\n\nYou can also filter for a substring - in an ID as this shows:\n\n```bash\n$ docker network ls --filter id=95e74588f40d\nNETWORK - ID NAME DRIVER SCOPE\n95e74588f40d foo bridge - \ local\n\n$ docker network ls --filter id=95e\nNETWORK ID NAME - \ DRIVER SCOPE\n95e74588f40d foo bridge - \ local\n```\n\n#### Label\n\nThe `label` filter matches networks based - on the presence of a `label` alone or a `label` and a\nvalue.\n\nThe following filter - matches networks with the `usage` label regardless of its value.\n\n```bash\n$ docker - network ls -f \"label=usage\"\nNETWORK ID NAME DRIVER SCOPE\ndb9db329f835 - \ test1 bridge local\nf6e212da9dfd test2 bridge - \ local\n```\n\nThe following filter matches networks with the `usage` label - with the `prod` value.\n\n```bash\n$ docker network ls -f \"label=usage=prod\"\nNETWORK - ID NAME DRIVER SCOPE\nf6e212da9dfd test2 bridge - \ local\n```\n\n#### Name\n\nThe `name` filter matches on all or part of a - network's name.\n\nThe following filter matches all networks with a name containing - the `foobar` string.\n\n```bash\n$ docker network ls --filter name=foobar\nNETWORK - ID NAME DRIVER SCOPE\n06e7eef0a170 foobar bridge - \ local\n```\n\nYou can also filter for a substring in a name as this shows:\n\n```bash\n$ - docker network ls --filter name=foo\nNETWORK ID NAME DRIVER - \ SCOPE\n95e74588f40d foo bridge local\n06e7eef0a170 - \ foobar bridge local\n```\n\n#### Scope\n\nThe `scope` - filter matches networks based on their scope.\n\nThe following example matches networks - with the `swarm` scope:\n\n```bash\n$ docker network ls --filter scope=swarm\nNETWORK - ID NAME DRIVER SCOPE\nxbtm0v4f1lfh ingress - \ overlay swarm\nic6r88twuu92 swarmnet overlay - \ swarm\n```\n\nThe following example matches networks with the `local` - scope:\n\n```bash\n$ docker network ls --filter scope=local\nNETWORK ID NAME - \ DRIVER SCOPE\ne85227439ac7 bridge bridge - \ local\n0ca0e19443ed host host local\nca13cc149a36 - \ localnet bridge local\nf9e115d2de35 none - \ null local\n```\n\n#### Type\n\nThe `type` filter - supports two values; `builtin` displays predefined networks\n(`bridge`, `none`, - `host`), whereas `custom` displays user defined networks.\n\nThe following filter - matches all user defined networks:\n\n```bash\n$ docker network ls --filter type=custom\nNETWORK - ID NAME DRIVER SCOPE\n95e74588f40d foo bridge - \ local \n63d1ff1f77b0 dev bridge local\n```\n\nBy - having this flag it allows for batch cleanup. For example, use this filter\nto delete - all user defined networks:\n\n```bash\n$ docker network rm `docker network ls --filter - type=custom -q`\n```\n\nA warning will be issued when trying to remove a network - that has containers\nattached.\n\n### Formatting\n\nThe formatting options (`--format`) - pretty-prints networks output\nusing a Go template.\n\nValid placeholders for the - Go template are listed below:\n\nPlaceholder | Description\n-------------|------------------------------------------------------------------------------------------\n`.ID` - \ | Network ID\n`.Name` | Network name\n`.Driver` | Network driver\n`.Scope` - \ | Network scope (local, global)\n`.IPv6` | Whether IPv6 is enabled on - the network or not.\n`.Internal` | Whether the network is internal or not.\n`.Labels` - \ | All labels assigned to the network.\n`.Label` | Value of a specific label - for this network. For example `{{.Label \"project.version\"}}`\n`.CreatedAt` | Time - when the network was created\n\nWhen using the `--format` option, the `network ls` - command will either\noutput the data exactly as the template declares or, when using - the\n`table` directive, includes column headers as well.\n\nThe following example - uses a template without headers and outputs the\n`ID` 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_prune.yaml b/_data/engine-cli-edge/docker_network_prune.yaml deleted file mode 100644 index 251d0f3444..0000000000 --- a/_data/engine-cli-edge/docker_network_prune.yaml +++ /dev/null @@ -1,98 +0,0 @@ -command: docker network prune -short: Remove all unused networks -long: |- - Remove all unused networks. Unused networks are those which are not referenced - by any containers. -usage: docker network prune [OPTIONS] -pname: docker network -plink: docker_network.yaml -options: -- option: filter - value_type: filter - description: Provide filter values (e.g. 'until=') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: Do not prompt for confirmation - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker network prune - - WARNING! This will remove all networks not used by at least one container. - Are you sure you want to continue? [y/N] y - Deleted Networks: - n1 - n2 - ``` - - ### Filtering - - The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * until (``) - only remove networks created before given timestamp - * label (`label=`, `label==`, `label!=`, or `label!==`) - only remove networks with (or without, in case `label!=...` is used) the specified labels. - - The `until` filter can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the daemon machine’s time. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the daemon will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - The `label` filter accepts two formats. One is the `label=...` (`label=` or `label==`), - which removes networks with the specified labels. The other - format is the `label!=...` (`label!=` or `label!==`), which removes - networks without the specified labels. - - The following removes networks created more than 5 minutes ago. Note that - system networks such as `bridge`, `host`, and `none` will never be pruned: - - ```none - $ docker network ls - - NETWORK ID NAME DRIVER SCOPE - 7430df902d7a bridge bridge local - ea92373fd499 foo-1-day-ago bridge local - ab53663ed3c7 foo-1-min-ago bridge local - 97b91972bc3b host host local - f949d337b1f5 none null local - - $ docker network prune --force --filter until=5m - - Deleted Networks: - foo-1-day-ago - - $ docker network ls - - NETWORK ID NAME DRIVER SCOPE - 7430df902d7a bridge bridge local - ab53663ed3c7 foo-1-min-ago bridge local - 97b91972bc3b host host local - f949d337b1f5 none null local - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_network_rm.yaml b/_data/engine-cli-edge/docker_network_rm.yaml deleted file mode 100644 index 9feeccce5e..0000000000 --- a/_data/engine-cli-edge/docker_network_rm.yaml +++ /dev/null @@ -1,38 +0,0 @@ -command: docker network rm -aliases: remove -short: Remove one or more networks -long: |- - Removes one or more networks by name or identifier. To remove a network, - you must first disconnect any containers connected to it. -usage: docker network rm NETWORK [NETWORK...] -pname: docker network -plink: docker_network.yaml -examples: |- - ### Remove a network - - To remove the network named 'my-network': - - ```bash - $ docker network rm my-network - ``` - - ### Remove multiple networks - - To delete multiple networks in a single `docker network rm` command, provide - multiple network names or ids. The following example deletes a network with id - `3695c422697f` and a network named `my-network`: - - ```bash - $ docker network rm 3695c422697f my-network - ``` - - When you specify multiple networks, the command attempts to delete each in turn. - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_node.yaml b/_data/engine-cli-edge/docker_node.yaml deleted file mode 100644 index ca3e52bf5f..0000000000 --- a/_data/engine-cli-edge/docker_node.yaml +++ /dev/null @@ -1,29 +0,0 @@ -command: docker node -short: Manage Swarm nodes -long: Manage nodes. -usage: docker node -pname: docker -plink: docker.yaml -cname: -- docker node demote -- docker node inspect -- docker node ls -- docker node promote -- docker node ps -- docker node rm -- docker node update -clink: -- docker_node_demote.yaml -- docker_node_inspect.yaml -- docker_node_ls.yaml -- docker_node_promote.yaml -- docker_node_ps.yaml -- docker_node_rm.yaml -- docker_node_update.yaml -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_demote.yaml b/_data/engine-cli-edge/docker_node_demote.yaml deleted file mode 100644 index 9d671e42a4..0000000000 --- a/_data/engine-cli-edge/docker_node_demote.yaml +++ /dev/null @@ -1,19 +0,0 @@ -command: docker node demote -short: Demote one or more nodes from manager in the swarm -long: |- - Demotes an existing manager so that it is no longer a manager. This command - targets a docker engine that is a manager in the swarm. -usage: docker node demote NODE [NODE...] -pname: docker node -plink: docker_node.yaml -examples: |- - ```bash - $ docker node demote - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_inspect.yaml b/_data/engine-cli-edge/docker_node_inspect.yaml deleted file mode 100644 index d0790e0617..0000000000 --- a/_data/engine-cli-edge/docker_node_inspect.yaml +++ /dev/null @@ -1,73 +0,0 @@ -command: docker node inspect -short: Display detailed information on one or more nodes -long: |- - Returns information about a node. By default, this command renders all results - in a JSON array. You can specify an alternate format to execute a - given template for each result. Go's - [text/template](http://golang.org/pkg/text/template/) package describes all the - details of the format. -usage: docker node inspect [OPTIONS] self|NODE [NODE...] -pname: docker node -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: pretty - value_type: bool - default_value: "false" - description: Print the information in a human friendly format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n - \ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\": - 10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\": - \"2017-05-16T22:52:45.230878043Z\",\n \"Spec\": {\n \"Role\": \"manager\",\n - \ \"Availability\": \"active\"\n },\n \"Description\": {\n \"Hostname\": - \"swarm-manager\",\n \"Platform\": {\n \"Architecture\": \"x86_64\",\n - \ \"OS\": \"linux\"\n },\n \"Resources\": {\n \"NanoCPUs\": - 1000000000,\n \"MemoryBytes\": 1039843328\n },\n \"Engine\": - {\n \"EngineVersion\": \"17.06.0-ce\",\n \"Plugins\": [\n - \ {\n \"Type\": \"Volume\",\n \"Name\": - \"local\"\n },\n {\n \"Type\": - \"Network\",\n \"Name\": \"overlay\"\n },\n {\n - \ \"Type\": \"Network\",\n \"Name\": \"null\"\n - \ },\n {\n \"Type\": \"Network\",\n - \ \"Name\": \"host\"\n },\n {\n - \ \"Type\": \"Network\",\n \"Name\": \"bridge\"\n - \ },\n {\n \"Type\": \"Network\",\n - \ \"Name\": \"overlay\"\n }\n ]\n },\n - \ \"TLSInfo\": {\n \"TrustRoot\": \"-----BEGIN CERTIFICATE-----\\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\\n-----END - CERTIFICATE-----\\n\",\n \"CertIssuerSubject\": \"MBMxETAPBgNVBAMTCHN3YXJtLWNh\",\n - \ \"CertIssuerPublicKey\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==\"\n - \ }\n },\n \"Status\": {\n \"State\": \"ready\",\n \"Addr\": - \"168.0.32.137\"\n },\n \"ManagerStatus\": {\n \"Leader\": true,\n - \ \"Reachability\": \"reachable\",\n \"Addr\": \"168.0.32.137:2377\"\n - \ }\n}\n]\n```\n\n### Specify an output format\n\n```none\n$ docker node inspect - --format '{{ .ManagerStatus.Leader }}' self\n\nfalse\n\n$ docker node inspect --pretty - self\nID: e216jshn25ckzbvmwlnh5jr3g\nHostname: swarm-manager\nJoined - at: 2017-05-16 22:52:44.9910662 +0000 utc\nStatus:\n State: Ready\n - Availability: Active\n Address: 172.17.0.2\nManager Status:\n - Address: 172.17.0.2:2377\n Raft Status: Reachable\n Leader: - \ Yes\nPlatform:\n Operating System: linux\n Architecture: x86_64\nResources:\n - CPUs: 4\n Memory: 7.704 GiB\nPlugins:\n Network: - \ overlay, bridge, null, host, overlay\n Volume: local\nEngine - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_ls.yaml b/_data/engine-cli-edge/docker_node_ls.yaml deleted file mode 100644 index 6e36337428..0000000000 --- a/_data/engine-cli-edge/docker_node_ls.yaml +++ /dev/null @@ -1,93 +0,0 @@ -command: docker node ls -aliases: list -short: List nodes in the swarm -long: |- - Lists all the nodes that the Docker Swarm manager knows about. You can filter - using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section - for more information about available filter options. -usage: docker node ls [OPTIONS] -pname: docker node -plink: docker_node.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print nodes using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "```bash\n$ docker node ls\n\nID HOSTNAME STATUS - \ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready - \ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\ne216jshn25ckzbvmwlnh5jr3g - * swarm-manager1 Ready Active Leader\n```\n> **Note**:\n> In the above - example output, there is a hidden column of `.Self` that indicates if the\n> node - is the same node as the current docker daemon. A `*` (e.g., `e216jshn25ckzbvmwlnh5jr3g - *`)\n> means this node is the current docker daemon.\n\n\n### Filtering\n\nThe filtering - flag (`-f` or `--filter`) format is of \"key=value\". If there is more\nthan one - filter, then pass multiple flags (e.g., `--filter \"foo=bar\" --filter \"bif=baz\"`)\n\nThe - currently supported filters are:\n\n* [id](node_ls.md#id)\n* [label](node_ls.md#label)\n* - [membership](node_ls.md#membership)\n* [name](node_ls.md#name)\n* [role](node_ls.md#role)\n\n#### - id\n\nThe `id` filter matches all or part of a node's id.\n\n```bash\n$ docker node - ls -f id=1\n\nID HOSTNAME STATUS AVAILABILITY MANAGER - STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active\n```\n\n#### label\n\nThe - `label` filter matches nodes based on engine labels and on the presence of a `label` - alone or a `label` and a value. Node labels are currently not used for filtering.\n\nThe - following filter matches nodes with the `foo` label regardless of its value.\n\n```bash\n$ - docker node ls -f \"label=foo\"\n\nID HOSTNAME STATUS - \ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready - \ Active\n```\n\n#### membership\n\nThe `membership` filter matches nodes based - on the presence of a `membership` and a value\n`accepted` or `pending`.\n\nThe following - filter matches nodes with the `membership` of `accepted`.\n\n```bash\n$ docker node - ls -f \"membership=accepted\"\n\nID HOSTNAME STATUS - \ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready - \ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\n```\n\n#### - name\n\nThe `name` filter matches on all or part of a node hostname.\n\nThe following - filter matches the nodes with a name equal to `swarm-master` string.\n\n```bash\n$ - docker node ls -f name=swarm-manager1\n\nID HOSTNAME STATUS - \ AVAILABILITY MANAGER STATUS\ne216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready - \ Active Leader\n```\n\n#### role\n\nThe `role` filter matches nodes based - on the presence of a `role` and a value `worker` or `manager`.\n\nThe following - filter matches nodes with the `manager` role.\n\n```bash\n$ docker node ls -f \"role=manager\"\n\nID - \ HOSTNAME STATUS AVAILABILITY MANAGER STATUS\ne216jshn25ckzbvmwlnh5jr3g - * swarm-manager1 Ready Active Leader\n```\n\n### Formatting\n\nThe formatting - options (`--format`) pretty-prints nodes output\nusing a Go template.\n\nValid placeholders - for the Go template are listed below:\n\nPlaceholder | Description\n-----------------|------------------------------------------------------------------------------------------\n`.ID` - \ | Node ID\n`.Self` | Node of the daemon (`true/false`, `true`indicates - that the node is the same as current docker daemon)\n`.Hostname` | Node hostname\n`.Status` - \ | Node status\n`.Availability` | Node availability (\"active\", \"pause\", - or \"drain\")\n`.ManagerStatus` | Manager status of the node\n`.TLSStatus` | - TLS status of the node (\"Ready\", or \"Needs Rotation\" has TLS certificate signed - by an old CA)\n`.EngineVersion` | Engine version\n\nWhen using the `--format` option, - the `node ls` command will either\noutput the data exactly as the template declares - or, when using the\n`table` directive, includes column headers as well.\n\nThe following - example uses a template without headers and outputs the\n`ID`, `Hostname`, and `TLS - Status` entries separated by a colon for all nodes:\n\n```bash\n$ docker node ls - --format \"{{.ID}}: {{.Hostname}} {{.TLSStatus}}\"\ne216jshn25ckzbvmwlnh5jr3g: swarm-manager1 - Ready\n35o6tiywb700jesrt3dmllaza: swarm-worker1 Needs Rotation \n```" -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_promote.yaml b/_data/engine-cli-edge/docker_node_promote.yaml deleted file mode 100644 index ddb6a70264..0000000000 --- a/_data/engine-cli-edge/docker_node_promote.yaml +++ /dev/null @@ -1,19 +0,0 @@ -command: docker node promote -short: Promote one or more nodes to manager in the swarm -long: |- - Promotes a node to manager. This command targets a docker engine that is a - manager in the swarm. -usage: docker node promote NODE [NODE...] -pname: docker node -plink: docker_node.yaml -examples: |- - ```bash - $ docker node promote - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_ps.yaml b/_data/engine-cli-edge/docker_node_ps.yaml deleted file mode 100644 index 1d1dd220ca..0000000000 --- a/_data/engine-cli-edge/docker_node_ps.yaml +++ /dev/null @@ -1,163 +0,0 @@ -command: docker node ps -short: List tasks running on one or more nodes, defaults to current node -long: Lists all the tasks on a Node that Docker knows about. You can filter using - the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more - information about available filter options. -usage: docker node ps [OPTIONS] [NODE...] -pname: docker node -plink: docker_node.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print tasks using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve - value_type: bool - default_value: "false" - description: Do not map IDs to Names - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display task IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker node ps swarm-manager1 - NAME IMAGE NODE DESIRED STATE CURRENT STATE - redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:3.0.6 swarm-manager1 Running Running 5 hours - redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 29 seconds - redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds - redis.9.dkkual96p4bb3s6b10r7coxxt redis:3.0.6 swarm-manager1 Running Running 5 seconds - redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:3.0.6 swarm-manager1 Running Running 5 seconds - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * [name](#name) - * [id](#id) - * [label](#label) - * [desired-state](#desired-state) - - #### name - - The `name` filter matches on all or part of a task's name. - - The following filter matches all tasks with a name containing the `redis` string. - - ```bash - $ docker node ps -f name=redis swarm-manager1 - - NAME IMAGE NODE DESIRED STATE CURRENT STATE - redis.1.7q92v0nr1hcgts2amcjyqg3pq redis:3.0.6 swarm-manager1 Running Running 5 hours - redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 29 seconds - redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds - redis.9.dkkual96p4bb3s6b10r7coxxt redis:3.0.6 swarm-manager1 Running Running 5 seconds - redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:3.0.6 swarm-manager1 Running Running 5 seconds - ``` - - #### id - - The `id` filter matches a task's id. - - ```bash - $ docker node ps -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1 - - NAME IMAGE NODE DESIRED STATE CURRENT STATE - redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 5 seconds - ``` - - #### label - - The `label` filter matches tasks based on the presence of a `label` alone or a `label` and a - value. - - The following filter matches tasks with the `usage` label regardless of its value. - - ```bash - $ docker node ps -f "label=usage" - - NAME IMAGE NODE DESIRED STATE CURRENT STATE - redis.6.b465edgho06e318egmgjbqo4o redis:3.0.6 swarm-manager1 Running Running 10 minutes - redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running Running 9 minutes - ``` - - - #### desired-state - - The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`. - - - ### Formatting - - The formatting options (`--format`) pretty-prints tasks output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ----------------|------------------------------------------------------------------------------------------ - `.Name` | Task name - `.Image` | Task image - `.Node` | Node ID - `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`) - `.CurrentState` | Current state of the task - `.Error` | Error - `.Ports` | Task published ports - - When using the `--format` option, the `node ps` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Name` and `Image` entries separated by a colon for all tasks: - - ```bash - $ docker node ps --format "{{.Name}}: {{.Image}}" - top.1: busybox - top.2: busybox - top.3: busybox - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_rm.yaml b/_data/engine-cli-edge/docker_node_rm.yaml deleted file mode 100644 index 7133baa84e..0000000000 --- a/_data/engine-cli-edge/docker_node_rm.yaml +++ /dev/null @@ -1,60 +0,0 @@ -command: docker node rm -aliases: remove -short: Remove one or more nodes from the swarm -long: When run from a manager node, removes the specified nodes from a swarm. -usage: docker node rm [OPTIONS] NODE [NODE...] -pname: docker node -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Remove a stopped node from the swarm - - ```bash - $ docker node rm swarm-node-02 - - Node swarm-node-02 removed from swarm - ``` - ### Attempt to remove a running node from a swarm - - Removes the specified nodes from the swarm, but only if the nodes are in the - down state. If you attempt to remove an active node you will receive an error: - - ```non - $ docker node rm swarm-node-03 - - Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not - down and can't be removed - ``` - - ### Forcibly remove an inaccessible node from a swarm - - If you lose access to a worker node or need to shut it down because it has been - compromised or is not behaving as expected, you can use the `--force` option. - This may cause transient errors or interruptions, depending on the type of task - being run on the node. - - ```bash - $ docker node rm --force swarm-node-03 - - Node swarm-node-03 removed from swarm - ``` - - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_node_update.yaml b/_data/engine-cli-edge/docker_node_update.yaml deleted file mode 100644 index a5ba4451fd..0000000000 --- a/_data/engine-cli-edge/docker_node_update.yaml +++ /dev/null @@ -1,79 +0,0 @@ -command: docker node update -short: Update a node -long: Update metadata about a node, such as its availability, labels, or roles. -usage: docker node update [OPTIONS] NODE -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: label-add - value_type: list - description: Add or update a node label (key=value) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-rm - value_type: list - description: Remove a node label if exists - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: role - value_type: string - description: Role of the node ("worker"|"manager") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Add label metadata to a node - - Add metadata to a swarm node using node labels. You can specify a node label as - a key with an empty value: - - ``` bash - $ docker node update --label-add foo worker1 - ``` - - To add multiple labels to a node, pass the `--label-add` flag for each label: - - ```bash - $ docker node update --label-add foo --label-add bar worker1 - ``` - - When you [create a service](service_create.md), - you can use node labels as a constraint. A constraint limits the nodes where the - scheduler deploys tasks for a service. - - For example, to add a `type` label to identify nodes where the scheduler should - deploy message queue service tasks: - - ``` bash - $ docker node update --label-add type=queue worker1 - ``` - - The labels you set for nodes using `docker node update` apply only to the node - entity within the swarm. Do not confuse them with the docker daemon labels for - [dockerd](https://docs.docker.com/engine/userguide/labels-custom-metadata/#daemon-labels). - - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_pause.yaml b/_data/engine-cli-edge/docker_pause.yaml deleted file mode 100644 index 49714e66c0..0000000000 --- a/_data/engine-cli-edge/docker_pause.yaml +++ /dev/null @@ -1,26 +0,0 @@ -command: docker pause -short: Pause all processes within one or more containers -long: |- - The `docker pause` command suspends all processes in the specified containers. - On Linux, this uses the cgroups freezer. Traditionally, when suspending a process - the `SIGSTOP` signal is used, which is observable by the process being suspended. - With the cgroups freezer the process is unaware, and unable to capture, - that it is being suspended, and subsequently resumed. On Windows, only Hyper-V - containers can be paused. - - See the - [cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt) - for further details. -usage: docker pause CONTAINER [CONTAINER...] -pname: docker -plink: docker.yaml -examples: |- - ```bash - $ docker pause my_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin.yaml b/_data/engine-cli-edge/docker_plugin.yaml deleted file mode 100644 index 23b9087eef..0000000000 --- a/_data/engine-cli-edge/docker_plugin.yaml +++ /dev/null @@ -1,35 +0,0 @@ -command: docker plugin -short: Manage plugins -long: Manage plugins. -usage: docker plugin -pname: docker -plink: docker.yaml -cname: -- docker plugin create -- docker plugin disable -- docker plugin enable -- docker plugin inspect -- docker plugin install -- docker plugin ls -- docker plugin push -- docker plugin rm -- docker plugin set -- docker plugin upgrade -clink: -- docker_plugin_create.yaml -- docker_plugin_disable.yaml -- docker_plugin_enable.yaml -- docker_plugin_inspect.yaml -- docker_plugin_install.yaml -- docker_plugin_ls.yaml -- docker_plugin_push.yaml -- docker_plugin_rm.yaml -- docker_plugin_set.yaml -- docker_plugin_upgrade.yaml -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_create.yaml b/_data/engine-cli-edge/docker_plugin_create.yaml deleted file mode 100644 index 4d666debcb..0000000000 --- a/_data/engine-cli-edge/docker_plugin_create.yaml +++ /dev/null @@ -1,47 +0,0 @@ -command: docker plugin create -short: Create a plugin from a rootfs and configuration. Plugin data directory must - contain config.json and rootfs directory. -long: |- - Creates a plugin. Before creating the plugin, prepare the plugin's root filesystem as well as - [the config.json](../../extend/config.md) -usage: docker plugin create [OPTIONS] PLUGIN PLUGIN-DATA-DIR -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example shows how to create a sample `plugin`. - - ```bash - $ ls -ls /home/pluginDir - - total 4 - 4 -rw-r--r-- 1 root root 431 Nov 7 01:40 config.json - 0 drwxr-xr-x 19 root root 420 Nov 7 01:40 rootfs - - $ docker plugin create plugin /home/pluginDir - - plugin - - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 672d8144ec02 plugin latest A sample plugin for Docker false - ``` - - The plugin can subsequently be enabled for local use or pushed to the public registry. -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_disable.yaml b/_data/engine-cli-edge/docker_plugin_disable.yaml deleted file mode 100644 index d77ce27dc2..0000000000 --- a/_data/engine-cli-edge/docker_plugin_disable.yaml +++ /dev/null @@ -1,50 +0,0 @@ -command: docker plugin disable -short: Disable a plugin -long: |- - Disables a plugin. The plugin must be installed before it can be disabled, - see [`docker plugin install`](plugin_install.md). Without the `-f` option, - a plugin that has references (e.g., volumes, networks) cannot be disabled. -usage: docker plugin disable [OPTIONS] PLUGIN -pname: docker plugin -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example shows that the `sample-volume-plugin` plugin is installed - and enabled: - - ```bash - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true - ``` - - To disable the plugin, use the following command: - - ```bash - $ docker plugin disable tiborvass/sample-volume-plugin - - tiborvass/sample-volume-plugin - - $ docker plugin ls - - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_enable.yaml b/_data/engine-cli-edge/docker_plugin_enable.yaml deleted file mode 100644 index 30fa394e18..0000000000 --- a/_data/engine-cli-edge/docker_plugin_enable.yaml +++ /dev/null @@ -1,48 +0,0 @@ -command: docker plugin enable -short: Enable a plugin -long: |- - Enables a plugin. The plugin must be installed before it can be enabled, - see [`docker plugin install`](plugin_install.md). -usage: docker plugin enable [OPTIONS] PLUGIN -pname: docker plugin -plink: docker_plugin.yaml -options: -- option: timeout - value_type: int - default_value: "30" - description: HTTP client timeout (in seconds) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example shows that the `sample-volume-plugin` plugin is installed, - but disabled: - - ```bash - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false - ``` - - To enable the plugin, use the following command: - - ```bash - $ docker plugin enable tiborvass/sample-volume-plugin - - tiborvass/sample-volume-plugin - - $ docker plugin ls - - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_inspect.yaml b/_data/engine-cli-edge/docker_plugin_inspect.yaml deleted file mode 100644 index acc6c74794..0000000000 --- a/_data/engine-cli-edge/docker_plugin_inspect.yaml +++ /dev/null @@ -1,145 +0,0 @@ -command: docker plugin inspect -short: Display detailed information on one or more plugins -long: |- - Returns information about a plugin. By default, this command renders all results - in a JSON array. -usage: docker plugin inspect [OPTIONS] PLUGIN [PLUGIN...] -pname: docker plugin -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```none - $ docker plugin inspect tiborvass/sample-volume-plugin:latest - - { - "Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21", - "Name": "tiborvass/sample-volume-plugin:latest", - "PluginReference": "tiborvas/sample-volume-plugin:latest", - "Enabled": true, - "Config": { - "Mounts": [ - { - "Name": "", - "Description": "", - "Settable": null, - "Source": "/data", - "Destination": "/data", - "Type": "bind", - "Options": [ - "shared", - "rbind" - ] - }, - { - "Name": "", - "Description": "", - "Settable": null, - "Source": null, - "Destination": "/foobar", - "Type": "tmpfs", - "Options": null - } - ], - "Env": [ - "DEBUG=1" - ], - "Args": null, - "Devices": null - }, - "Manifest": { - "ManifestVersion": "v0", - "Description": "A test plugin for Docker", - "Documentation": "https://docs.docker.com/engine/extend/plugins/", - "Interface": { - "Types": [ - "docker.volumedriver/1.0" - ], - "Socket": "plugins.sock" - }, - "Entrypoint": [ - "plugin-sample-volume-plugin", - "/data" - ], - "Workdir": "", - "User": { - }, - "Network": { - "Type": "host" - }, - "Capabilities": null, - "Mounts": [ - { - "Name": "", - "Description": "", - "Settable": null, - "Source": "/data", - "Destination": "/data", - "Type": "bind", - "Options": [ - "shared", - "rbind" - ] - }, - { - "Name": "", - "Description": "", - "Settable": null, - "Source": null, - "Destination": "/foobar", - "Type": "tmpfs", - "Options": null - } - ], - "Devices": [ - { - "Name": "device", - "Description": "a host device to mount", - "Settable": null, - "Path": "/dev/cpu_dma_latency" - } - ], - "Env": [ - { - "Name": "DEBUG", - "Description": "If set, prints debug messages", - "Settable": null, - "Value": "1" - } - ], - "Args": { - "Name": "args", - "Description": "command line arguments", - "Settable": null, - "Value": [ - - ] - } - } - } - ``` - - (output formatted for readability) - - ### Formatting the output - - ```bash - $ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest - - 8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21 - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_install.yaml b/_data/engine-cli-edge/docker_plugin_install.yaml deleted file mode 100644 index 255f44cedb..0000000000 --- a/_data/engine-cli-edge/docker_plugin_install.yaml +++ /dev/null @@ -1,78 +0,0 @@ -command: docker plugin install -short: Install a plugin -long: |- - Installs and enables a plugin. Docker looks first for the plugin on your Docker - host. If the plugin does not exist locally, then the plugin is pulled from - the registry. Note that the minimum required registry version to distribute - plugins is 2.3.0 -usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...] -pname: docker plugin -plink: docker_plugin.yaml -options: -- option: alias - value_type: string - description: Local name for plugin - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable - value_type: bool - default_value: "false" - description: Do not enable the plugin on install - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: grant-all-permissions - value_type: bool - default_value: "false" - description: Grant all permissions necessary to run the plugin - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its - `DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker - Hub and prompt the user to accept the list of privileges that the plugin needs, - set the plugin's parameters and enable the plugin. - - ```bash - $ docker plugin install vieux/sshfs DEBUG=1 - - Plugin "vieux/sshfs" is requesting the following privileges: - - network: [host] - - device: [/dev/fuse] - - capabilities: [CAP_SYS_ADMIN] - Do you grant the above permissions? [y/N] y - vieux/sshfs - ``` - - After the plugin is installed, it appears in the list of plugins: - - ```bash - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_ls.yaml b/_data/engine-cli-edge/docker_plugin_ls.yaml deleted file mode 100644 index dc5e399f56..0000000000 --- a/_data/engine-cli-edge/docker_plugin_ls.yaml +++ /dev/null @@ -1,120 +0,0 @@ -command: docker plugin ls -aliases: list -short: List plugins -long: |- - Lists all the plugins that are currently installed. You can install plugins - using the [`docker plugin install`](plugin_install.md) command. - You can also filter using the `-f` or `--filter` flag. - Refer to the [filtering](#filtering) section for more information about available filter options. -usage: docker plugin ls [OPTIONS] -pname: docker plugin -plink: docker_plugin.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Provide filter values (e.g. 'enabled=true') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print plugins using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display plugin IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * enabled (boolean - true or false, 0 or 1) - * capability (string - currently `volumedriver`, `networkdriver`, `ipamdriver`, `logdriver`, `metricscollector`, or `authz`) - - #### enabled - - The `enabled` filter matches on plugins enabled or disabled. - - #### capability - - The `capability` filter matches on plugin capabilities. One plugin - might have multiple capabilities. Currently `volumedriver`, `networkdriver`, - `ipamdriver`, `logdriver`, `metricscollector`, and `authz` are supported capabilities. - - ```bash - $ docker plugin install --disable vieux/sshfs - - Installed plugin vieux/sshfs - - $ docker plugin ls --filter enabled=true - - NAME TAG DESCRIPTION ENABLED - ``` - - ### Formatting - - The formatting options (`--format`) pretty-prints plugins output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ---------------|------------------------------------------------------------------------------------------ - `.ID` | Plugin ID - `.Name` | Plugin name - `.Description` | Plugin description - `.Enabled` | Whether plugin is enabled or not - `.PluginReference` | The reference used to push/pull from a registry - - When using the `--format` option, the `plugin ls` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `ID` and `Name` entries separated by a colon for all plugins: - - ```bash - $ docker plugin ls --format "{{.ID}}: {{.Name}}" - - 4be01827a72e: vieux/sshfs:latest - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_push.yaml b/_data/engine-cli-edge/docker_plugin_push.yaml deleted file mode 100644 index 5cbf90b008..0000000000 --- a/_data/engine-cli-edge/docker_plugin_push.yaml +++ /dev/null @@ -1,39 +0,0 @@ -command: docker plugin push -short: Push a plugin to a registry -long: |- - After you have created a plugin using `docker plugin create` and the plugin is - ready for distribution, use `docker plugin push` to share your images to Docker - Hub or a self-hosted registry. - - Registry credentials are managed by [docker login](login.md). -usage: docker plugin push [OPTIONS] PLUGIN[:TAG] -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example shows how to push a sample `user/plugin`. - - ```bash - $ docker plugin ls - - ID NAME TAG DESCRIPTION ENABLED - 69553ca1d456 user/plugin latest A sample plugin for Docker false - - $ docker plugin push user/plugin - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_rm.yaml b/_data/engine-cli-edge/docker_plugin_rm.yaml deleted file mode 100644 index e6222f4a78..0000000000 --- a/_data/engine-cli-edge/docker_plugin_rm.yaml +++ /dev/null @@ -1,42 +0,0 @@ -command: docker plugin rm -aliases: remove -short: Remove one or more plugins -long: |- - Removes a plugin. You cannot remove a plugin if it is enabled, you must disable - a plugin using the [`docker plugin disable`](plugin_disable.md) before removing - it (or use --force, use of force is not recommended, since it can affect - functioning of running containers using the plugin). -usage: docker plugin rm [OPTIONS] PLUGIN [PLUGIN...] -pname: docker plugin -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example disables and removes the `sample-volume-plugin:latest` - plugin: - - ```bash - $ docker plugin disable tiborvass/sample-volume-plugin - - tiborvass/sample-volume-plugin - - $ docker plugin rm tiborvass/sample-volume-plugin:latest - - tiborvass/sample-volume-plugin - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_set.yaml b/_data/engine-cli-edge/docker_plugin_set.yaml deleted file mode 100644 index b8da2b11cb..0000000000 --- a/_data/engine-cli-edge/docker_plugin_set.yaml +++ /dev/null @@ -1,89 +0,0 @@ -command: docker plugin set -short: Change settings for a plugin -long: |- - Change settings for a plugin. The plugin must be disabled. - - The settings currently supported are: - * env variables - * source of mounts - * path of devices - * args -usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...] -pname: docker plugin -plink: docker_plugin.yaml -examples: |- - ### Change an environment variable - - The following example change the env variable `DEBUG` on the - `sample-volume-plugin` plugin. - - ```bash - $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin - [DEBUG=0] - - $ docker plugin set tiborvass/sample-volume-plugin DEBUG=1 - - $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin - [DEBUG=1] - ``` - - ### Change the source of a mount - - The following example change the source of the `mymount` mount on - the `myplugin` plugin. - - ```bash - $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin - /foo - - $ docker plugins set myplugin mymount.source=/bar - - $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin - /bar - ``` - - > **Note**: Since only `source` is settable in `mymount`, - > `docker plugins set mymount=/bar myplugin` would work too. - - ### Change a device path - - The following example change the path of the `mydevice` device on - the `myplugin` plugin. - - ```bash - $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin - - /dev/foo - - $ docker plugins set myplugin mydevice.path=/dev/bar - - $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin - - /dev/bar - ``` - - > **Note**: Since only `path` is settable in `mydevice`, - > `docker plugins set mydevice=/dev/bar myplugin` would work too. - - ### Change the source of the arguments - - The following example change the value of the args on the `myplugin` plugin. - - ```bash - $ docker plugin inspect -f '{{.Settings.Args}}' myplugin - - ["foo", "bar"] - - $ docker plugins set myplugin myargs="foo bar baz" - - $ docker plugin inspect -f '{{.Settings.Args}}' myplugin - - ["foo", "bar", "baz"] - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_plugin_upgrade.yaml b/_data/engine-cli-edge/docker_plugin_upgrade.yaml deleted file mode 100644 index 7a5baff06d..0000000000 --- a/_data/engine-cli-edge/docker_plugin_upgrade.yaml +++ /dev/null @@ -1,97 +0,0 @@ -command: docker plugin upgrade -short: Upgrade an existing plugin -long: |- - Upgrades an existing plugin to the specified remote plugin image. If no remote - is specified, Docker will re-pull the current image and use the updated version. - All existing references to the plugin will continue to work. - The plugin must be disabled before running the upgrade. -usage: docker plugin upgrade [OPTIONS] PLUGIN [REMOTE] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: grant-all-permissions - value_type: bool - default_value: "false" - description: Grant all permissions necessary to run the plugin - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: skip-remote-check - value_type: bool - default_value: "false" - description: | - Do not check if specified remote plugin matches existing plugin image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following example installs `vieus/sshfs` plugin, uses it to create and use - a volume, then upgrades the plugin. - - ```bash - $ docker plugin install vieux/sshfs DEBUG=1 - - Plugin "vieux/sshfs:next" is requesting the following privileges: - - network: [host] - - device: [/dev/fuse] - - capabilities: [CAP_SYS_ADMIN] - Do you grant the above permissions? [y/N] y - vieux/sshfs:next - - $ docker volume create -d vieux/sshfs:next -o sshcmd=root@1.2.3.4:/tmp/shared -o password=XXX sshvolume - - sshvolume - - $ docker run -it -v sshvolume:/data alpine sh -c "touch /data/hello" - - $ docker plugin disable -f vieux/sshfs:next - - viex/sshfs:next - - # Here docker volume ls doesn't show 'sshfsvolume', since the plugin is disabled - $ docker volume ls - - DRIVER VOLUME NAME - - $ docker plugin upgrade vieux/sshfs:next vieux/sshfs:next - - Plugin "vieux/sshfs:next" is requesting the following privileges: - - network: [host] - - device: [/dev/fuse] - - capabilities: [CAP_SYS_ADMIN] - Do you grant the above permissions? [y/N] y - Upgrade plugin vieux/sshfs:next to vieux/sshfs:next - - $ docker plugin enable vieux/sshfs:next - - viex/sshfs:next - - $ docker volume ls - - DRIVER VOLUME NAME - viuex/sshfs:next sshvolume - - $ docker run -it -v sshvolume:/data alpine sh -c "ls /data" - - hello - ``` -deprecated: false -min_api_version: "1.26" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_port.yaml b/_data/engine-cli-edge/docker_port.yaml deleted file mode 100644 index 7ee8782a83..0000000000 --- a/_data/engine-cli-edge/docker_port.yaml +++ /dev/null @@ -1,32 +0,0 @@ -command: docker port -short: List port mappings or a specific mapping for the container -long: List port mappings or a specific mapping for the container -usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]] -pname: docker -plink: docker.yaml -examples: |- - ### Show all mapped ports - - You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or - just a specific mapping: - - ```bash - $ docker ps - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - b650456536c7 busybox:latest top 54 minutes ago Up 54 minutes 0.0.0.0:1234->9876/tcp, 0.0.0.0:4321->7890/tcp test - $ docker port test - 7890/tcp -> 0.0.0.0:4321 - 9876/tcp -> 0.0.0.0:1234 - $ docker port test 7890/tcp - 0.0.0.0:4321 - $ docker port test 7890/udp - 2014/06/24 11:53:36 Error: No public port '7890/udp' published for test - $ docker port test 7890 - 0.0.0.0:4321 - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_ps.yaml b/_data/engine-cli-edge/docker_ps.yaml deleted file mode 100644 index 248e20a8aa..0000000000 --- a/_data/engine-cli-edge/docker_ps.yaml +++ /dev/null @@ -1,472 +0,0 @@ -command: docker ps -short: List containers -long: List containers -usage: docker ps [OPTIONS] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print containers using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: last - shorthand: "n" - value_type: int - default_value: "-1" - description: Show n last created containers (includes all states) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: latest - shorthand: l - value_type: bool - default_value: "false" - description: Show the latest created container (includes all states) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display numeric IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: size - shorthand: s - value_type: bool - default_value: "false" - description: Display total file sizes - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Prevent truncating output - - Running `docker ps --no-trunc` showing 2 linked containers. - - ```bash - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 4c01db0b339c ubuntu:12.04 bash 17 seconds ago Up 16 seconds 3300-3310/tcp webapp - d7886598dbe2 crosbymichael/redis:latest /redis-server --dir 33 minutes ago Up 33 minutes 6379/tcp redis,webapp/db - ``` - - ### Show both running and stopped containers - - The `docker ps` command only shows running containers by default. To see all - containers, use the `-a` (or `--all`) flag: - - ```bash - $ docker ps -a - ``` - - `docker ps` groups exposed ports into a single range if possible. E.g., a - container that exposes TCP ports `100, 101, 102` displays `100-102/tcp` in - the `PORTS` column. - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more - than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - | Filter | Description | - |:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------| - | `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`, 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. 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 - - The `label` filter matches containers based on the presence of a `label` alone or a `label` and a - value. - - The following filter matches containers with the `color` label regardless of its value. - - ```bash - $ docker ps --filter "label=color" - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 673394ef1d4c busybox "top" 47 seconds ago Up 45 seconds nostalgic_shockley - d85756f57265 busybox "top" 52 seconds ago Up 51 seconds high_albattani - ``` - - The following filter matches containers with the `color` label with the `blue` value. - - ```bash - $ docker ps --filter "label=color=blue" - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - d85756f57265 busybox "top" About a minute ago Up About a minute high_albattani - ``` - - #### name - - The `name` filter matches on all or part of a container's name. - - The following filter matches all containers with a name containing the `nostalgic_stallman` string. - - ```bash - $ docker ps --filter "name=nostalgic_stallman" - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9b6247364a03 busybox "top" 2 minutes ago Up 2 minutes nostalgic_stallman - ``` - - You can also filter for a substring in a name as this shows: - - ```bash - $ docker ps --filter "name=nostalgic" - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 715ebfcee040 busybox "top" 3 seconds ago Up 1 second i_am_nostalgic - 9b6247364a03 busybox "top" 7 minutes ago Up 7 minutes nostalgic_stallman - 673394ef1d4c busybox "top" 38 minutes ago Up 38 minutes nostalgic_shockley - ``` - - #### exited - - The `exited` filter matches containers by exist status code. For example, to - filter for containers that have exited successfully: - - ```bash - $ docker ps -a --filter 'exited=0' - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - ea09c3c82f6e registry:latest /srv/run.sh 2 weeks ago Exited (0) 2 weeks ago 127.0.0.1:5000->5000/tcp desperate_leakey - 106ea823fe4e fedora:latest /bin/sh -c 'bash -l' 2 weeks ago Exited (0) 2 weeks ago determined_albattani - 48ee228c9464 fedora:20 bash 2 weeks ago Exited (0) 2 weeks ago tender_torvalds - ``` - - #### Filter by exit signal - - You can use a filter to locate containers that exited with status of `137` - meaning a `SIGKILL(9)` killed them. - - ```none - $ docker ps -a --filter 'exited=137' - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - b3e1c0ed5bfe ubuntu:latest "sleep 1000" 12 seconds ago Exited (137) 5 seconds ago grave_kowalevski - a2eb5558d669 redis:latest "/entrypoint.sh redi 2 hours ago Exited (137) 2 hours ago sharp_lalande - ``` - - Any of these events result in a `137` status: - - * the `init` process of the container is killed manually - * `docker kill` kills the container - * Docker daemon restarts which kills all running containers - - #### status - - The `status` filter matches containers by status. You can filter using - `created`, `restarting`, `running`, `removing`, `paused`, `exited` and `dead`. For example, - to filter for `running` containers: - - ```bash - $ docker ps --filter status=running - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 715ebfcee040 busybox "top" 16 minutes ago Up 16 minutes i_am_nostalgic - d5c976d3c462 busybox "top" 23 minutes ago Up 23 minutes top - 9b6247364a03 busybox "top" 24 minutes ago Up 24 minutes nostalgic_stallman - ``` - - To filter for `paused` containers: - - ```bash - $ docker ps --filter status=paused - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 673394ef1d4c busybox "top" About an hour ago Up About an hour (Paused) nostalgic_shockley - ``` - - #### ancestor - - 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` - - If you don't specify a `tag`, the `latest` tag is used. For example, to filter - for containers that use the latest `ubuntu` image: - - ```bash - $ docker ps --filter ancestor=ubuntu - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 919e1179bdb8 ubuntu-c1 "top" About a minute ago Up About a minute admiring_lovelace - 5d1e4a540723 ubuntu-c2 "top" About a minute ago Up About a minute admiring_sammet - 82a598284012 ubuntu "top" 3 minutes ago Up 3 minutes sleepy_bose - bab2a34ba363 ubuntu "top" 3 minutes ago Up 3 minutes focused_yonath - ``` - - Match containers based on the `ubuntu-c1` image which, in this case, is a child - of `ubuntu`: - - ```bash - $ docker ps --filter ancestor=ubuntu-c1 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 919e1179bdb8 ubuntu-c1 "top" About a minute ago Up About a minute admiring_lovelace - ``` - - Match containers based on the `ubuntu` version `12.04.5` image: - - ```bash - $ docker ps --filter ancestor=ubuntu:12.04.5 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 82a598284012 ubuntu:12.04.5 "top" 3 minutes ago Up 3 minutes sleepy_bose - ``` - - The following matches containers based on the layer `d0e008c6cf02` or an image - that have this layer in its layer stack. - - ```bash - $ docker ps --filter ancestor=d0e008c6cf02 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 82a598284012 ubuntu:12.04.5 "top" 3 minutes ago Up 3 minutes sleepy_bose - ``` - - #### Create time - - ##### before - - The `before` filter shows only containers created before the container with - given id or name. For example, having these containers created: - - ```bash - $ docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9c3527ed70ce busybox "top" 14 seconds ago Up 15 seconds desperate_dubinsky - 4aace5031105 busybox "top" 48 seconds ago Up 49 seconds focused_hamilton - 6e63f6ff38b0 busybox "top" About a minute ago Up About a minute distracted_fermat - ``` - - Filtering with `before` would give: - - ```bash - $ docker ps -f before=9c3527ed70ce - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 4aace5031105 busybox "top" About a minute ago Up About a minute focused_hamilton - 6e63f6ff38b0 busybox "top" About a minute ago Up About a minute distracted_fermat - ``` - - ##### since - - The `since` filter shows only containers created since the container with given - id or name. For example, with the same containers as in `before` filter: - - ```bash - $ docker ps -f since=6e63f6ff38b0 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9c3527ed70ce busybox "top" 10 minutes ago Up 10 minutes desperate_dubinsky - 4aace5031105 busybox "top" 10 minutes ago Up 10 minutes focused_hamilton - ``` - - #### volume - - The `volume` filter shows only containers that mount a specific volume or have - a volume mounted in a specific path: - - ```bash - $ docker ps --filter volume=remote-volume --format "table {{.ID}}\t{{.Mounts}}" - CONTAINER ID MOUNTS - 9c3527ed70ce remote-volume - - $ docker ps --filter volume=/data --format "table {{.ID}}\t{{.Mounts}}" - CONTAINER ID MOUNTS - 9c3527ed70ce remote-volume - ``` - - #### network - - The `network` filter shows only containers that are connected to a network with - a given name or id. - - The following filter matches all containers that are connected to a network - with a name containing `net1`. - - ```bash - $ docker run -d --net=net1 --name=test1 ubuntu top - $ docker run -d --net=net2 --name=test2 ubuntu top - - $ docker ps --filter network=net1 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9d4893ed80fe ubuntu "top" 10 minutes ago Up 10 minutes test1 - ``` - - The network filter matches on both the network's name and id. The following - example shows all containers that are attached to the `net1` network, using - the network id as a filter; - - ```bash - $ docker network inspect --format "{{.ID}}" net1 - - 8c0b4110ae930dbe26b258de9bc34a03f98056ed6f27f991d32919bfe401d7c5 - - $ docker ps --filter network=8c0b4110ae930dbe26b258de9bc34a03f98056ed6f27f991d32919bfe401d7c5 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9d4893ed80fe ubuntu "top" 10 minutes ago Up 10 minutes test1 - ``` - - #### publish and expose - - The `publish` and `expose` filters show only containers that have published or exposed port with a given port - number, port range, and/or protocol. The default protocol is `tcp` when not specified. - - The following filter matches all containers that have published port of 80: - - ```bash - $ docker run -d --publish=80 busybox top - $ docker run -d --expose=8080 busybox top - - $ docker ps -a - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9833437217a5 busybox "top" 5 seconds ago Up 4 seconds 8080/tcp dreamy_mccarthy - fc7e477723b7 busybox "top" 50 seconds ago Up 50 seconds 0.0.0.0:32768->80/tcp admiring_roentgen - - $ docker ps --filter publish=80 - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - fc7e477723b7 busybox "top" About a minute ago Up About a minute 0.0.0.0:32768->80/tcp admiring_roentgen - ``` - - The following filter matches all containers that have exposed TCP port in the range of `8000-8080`: - ```bash - $ docker ps --filter expose=8000-8080/tcp - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 9833437217a5 busybox "top" 21 seconds ago Up 19 seconds 8080/tcp dreamy_mccarthy - ``` - - The following filter matches all containers that have exposed UDP port `80`: - ```bash - $ docker ps --filter publish=80/udp - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - ``` - - ### Formatting - - The formatting option (`--format`) pretty-prints container output using a Go - template. - - Valid placeholders for the Go template are listed below: - - | Placeholder | Description | - |:--------------|:------------------------------------------------------------------------------------------------| - | `.ID` | Container ID | - | `.Image` | Image ID | - | `.Command` | Quoted command | - | `.CreatedAt` | Time when the container was created. | - | `.RunningFor` | Elapsed time since the container was started. | - | `.Ports` | Exposed ports. | - | `.Status` | Container status. | - | `.Size` | Container disk size. | - | `.Names` | Container names. | - | `.Labels` | All labels assigned to the container. | - | `.Label` | Value of a specific label for this container. For example `'{{.Label "com.docker.swarm.cpu"}}'` | - | `.Mounts` | Names of the volumes mounted in this container. | - | `.Networks` | Names of the networks attached to this container. | - - When using the `--format` option, the `ps` command will either output the data - exactly as the template declares or, when using the `table` directive, includes - column headers as well. - - The following example uses a template without headers and outputs the `ID` and - `Command` entries separated by a colon for all running containers: - - ```bash - $ docker ps --format "{{.ID}}: {{.Command}}" - - a87ecb4f327c: /bin/sh -c #(nop) MA - 01946d9d34d8: /bin/sh -c #(nop) MA - c1d3b0166030: /bin/sh -c yum -y up - 41d50ecd2f57: /bin/sh -c #(nop) MA - ``` - - To list all running containers with their labels in a table format you can use: - - ```bash - $ docker ps --format "table {{.ID}}\t{{.Labels}}" - - CONTAINER ID LABELS - a87ecb4f327c com.docker.swarm.node=ubuntu,com.docker.swarm.storage=ssd - 01946d9d34d8 - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_pull.yaml b/_data/engine-cli-edge/docker_pull.yaml deleted file mode 100644 index 7b9768e9cf..0000000000 --- a/_data/engine-cli-edge/docker_pull.yaml +++ /dev/null @@ -1,263 +0,0 @@ -command: docker pull -short: Pull an image or a repository from a registry -long: |- - Most of your images will be created on top of a base image from the - [Docker Hub](https://hub.docker.com) registry. - - [Docker Hub](https://hub.docker.com) contains many pre-built images that you - can `pull` and try without needing to define and configure your own. - - To download a particular image, or set of images (i.e., a repository), - use `docker pull`. - - ### Proxy configuration - - If you are behind an HTTP proxy server, for example in corporate settings, - before open a connect to registry, you may need to configure the Docker - daemon's proxy settings, using the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` - environment variables. To set these environment variables on a host using - `systemd`, refer to the [control and configure Docker with systemd](https://docs.docker.com/engine/admin/systemd/#http-proxy) - for variables configuration. - - ### Concurrent downloads - - By default the Docker daemon will pull three layers of an image at a time. - If you are on a low bandwidth connection this may cause timeout issues and you may want to lower - this via the `--max-concurrent-downloads` daemon option. See the - [daemon documentation](dockerd.md) for more details. -usage: docker pull [OPTIONS] NAME[:TAG|@DIGEST] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Pull an image from Docker Hub - - To download a particular image, or set of images (i.e., a repository), use - `docker pull`. If no tag is provided, Docker Engine uses the `:latest` tag as a - default. This command pulls the `debian:latest` image: - - ```bash - $ docker pull debian - - Using default tag: latest - latest: Pulling from library/debian - fdd5d7827f33: Pull complete - a3ed95caeb02: Pull complete - Digest: sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa - Status: Downloaded newer image for debian:latest - ``` - - Docker images can consist of multiple layers. In the example above, the image - consists of two layers; `fdd5d7827f33` and `a3ed95caeb02`. - - Layers can be reused by images. For example, the `debian:jessie` image shares - both layers with `debian:latest`. Pulling the `debian:jessie` image therefore - only pulls its metadata, but not its layers, because all layers are already - present locally: - - ```bash - $ docker pull debian:jessie - - jessie: Pulling from library/debian - fdd5d7827f33: Already exists - a3ed95caeb02: Already exists - Digest: sha256:a9c958be96d7d40df920e7041608f2f017af81800ca5ad23e327bc402626b58e - Status: Downloaded newer image for debian:jessie - ``` - - To see which images are present locally, use the [`docker images`](images.md) - command: - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - debian jessie f50f9524513f 5 days ago 125.1 MB - debian latest f50f9524513f 5 days ago 125.1 MB - ``` - - Docker uses a content-addressable image store, and the image ID is a SHA256 - digest covering the image's configuration and layers. In the example above, - `debian:jessie` and `debian:latest` have the same image ID because they are - actually the *same* image tagged with different names. Because they are the - same image, their layers are stored only once and do not consume extra disk - space. - - For more information about images, layers, and the content-addressable store, - refer to [understand images, containers, and storage drivers](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers/). - - - ### Pull an image by digest (immutable identifier) - - So far, you've pulled images by their name (and "tag"). Using names and tags is - a convenient way to work with images. When using tags, you can `docker pull` an - image again to make sure you have the most up-to-date version of that image. - For example, `docker pull ubuntu:14.04` pulls the latest version of the Ubuntu - 14.04 image. - - In some cases you don't want images to be updated to newer versions, but prefer - to use a fixed version of an image. Docker enables you to pull an image by its - *digest*. When pulling an image by digest, you specify *exactly* which version - of an image to pull. Doing so, allows you to "pin" an image to that version, - and guarantee that the image you're using is always the same. - - To know the digest of an image, pull the image first. Let's pull the latest - `ubuntu:14.04` image from Docker Hub: - - ```bash - $ docker pull ubuntu:14.04 - - 14.04: Pulling from library/ubuntu - 5a132a7e7af1: Pull complete - fd2731e4c50c: Pull complete - 28a2f68d1120: Pull complete - a3ed95caeb02: Pull complete - Digest: sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - Status: Downloaded newer image for ubuntu:14.04 - ``` - - Docker prints the digest of the image after the pull has finished. In the example - above, the digest of the image is: - - sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - - Docker also prints the digest of an image when *pushing* to a registry. This - may be useful if you want to pin to a version of the image you just pushed. - - A digest takes the place of the tag when pulling an image, for example, to - pull the above image by digest, run the following command: - - ```bash - $ docker pull ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - - sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2: Pulling from library/ubuntu - 5a132a7e7af1: Already exists - fd2731e4c50c: Already exists - 28a2f68d1120: Already exists - a3ed95caeb02: Already exists - Digest: sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - Status: Downloaded newer image for ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - ``` - - Digest can also be used in the `FROM` of a Dockerfile, for example: - - ```Dockerfile - FROM ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2 - MAINTAINER some maintainer - ``` - - > **Note**: Using this feature "pins" an image to a specific version in time. - > Docker will therefore not pull updated versions of an image, which may include - > security updates. If you want to pull an updated image, you need to change the - > digest accordingly. - - - ### Pull from a different registry - - By default, `docker pull` pulls images from [Docker Hub](https://hub.docker.com). It is also possible to - manually specify the path of a registry to pull from. For example, if you have - set up a local registry, you can specify its path to pull from it. A registry - path is similar to a URL, but does not contain a protocol specifier (`https://`). - - The following command pulls the `testing/test-image` image from a local registry - listening on port 5000 (`myregistry.local:5000`): - - ```bash - $ docker pull myregistry.local:5000/testing/test-image - ``` - - Registry credentials are managed by [docker login](login.md). - - Docker uses the `https://` protocol to communicate with a registry, unless the - registry is allowed to be accessed over an insecure connection. Refer to the - [insecure registries](dockerd.md#insecure-registries) section for more information. - - - ### Pull a repository with multiple images - - By default, `docker pull` pulls a *single* image from the registry. A repository - can contain multiple images. To pull all images from a repository, provide the - `-a` (or `--all-tags`) option when using `docker pull`. - - This command pulls all images from the `fedora` repository: - - ```bash - $ docker pull --all-tags fedora - - Pulling repository fedora - ad57ef8d78d7: Download complete - 105182bb5e8b: Download complete - 511136ea3c5a: Download complete - 73bd853d2ea5: Download complete - .... - - Status: Downloaded newer image for fedora - ``` - - After the pull has completed use the `docker images` command to see the - images that were pulled. The example below shows all the `fedora` images - that are present locally: - - ```bash - $ docker images fedora - - REPOSITORY TAG IMAGE ID CREATED SIZE - fedora rawhide ad57ef8d78d7 5 days ago 359.3 MB - fedora 20 105182bb5e8b 5 days ago 372.7 MB - fedora heisenbug 105182bb5e8b 5 days ago 372.7 MB - fedora latest 105182bb5e8b 5 days ago 372.7 MB - ``` - - ### Cancel a pull - - Killing the `docker pull` process, for example by pressing `CTRL-c` while it is - running in a terminal, will terminate the pull operation. - - ```bash - $ docker pull fedora - - Using default tag: latest - latest: Pulling from library/fedora - a3ed95caeb02: Pulling fs layer - 236608c7b546: Pulling fs layer - ^C - ``` - - > **Note**: Technically, the Engine terminates a pull operation when the - > 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_push.yaml b/_data/engine-cli-edge/docker_push.yaml deleted file mode 100644 index 519980cc25..0000000000 --- a/_data/engine-cli-edge/docker_push.yaml +++ /dev/null @@ -1,63 +0,0 @@ -command: docker push -short: Push an image or a repository to a registry -long: "Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)\nregistry - or to a self-hosted one.\n\nRefer to the [`docker tag`](tag.md) reference for more - information about valid\nimage and tag names.\n\nKilling the `docker push` process, - for example by pressing `CTRL-c` while it is\nrunning in a terminal, terminates - the push operation.\n\nProgress bars are shown during docker push, which show the - uncompressed size. The \nactual amount of data that's pushed will be compressed - before sending, so the uploaded\n size will not be reflected by the progress bar. - \n\nRegistry credentials are managed by [docker login](login.md).\n\n### Concurrent - uploads\n\nBy default the Docker daemon will push five layers of an image at a time.\nIf - you are on a low bandwidth connection this may cause timeout issues and you may - want to lower\nthis via the `--max-concurrent-uploads` daemon option. See the\n[daemon - documentation](dockerd.md) for more details." -usage: docker push [OPTIONS] NAME[:TAG] -pname: docker -plink: docker.yaml -options: -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image signing - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Push a new image to a registry - - First save the new image by finding the container ID (using [`docker ps`](ps.md)) - and then committing it to a new image name. Note that only `a-z0-9-_.` are - allowed when naming images: - - ```bash - $ docker commit c16378f943fe rhel-httpd - ``` - - Now, push the image to the registry using the image ID. In this example the - registry is on host named `registry-host` and listening on port `5000`. To do - this, tag the image with the host name or IP address, and the port of the - registry: - - ```bash - $ docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd - - $ docker push registry-host:5000/myadmin/rhel-httpd - ``` - - Check that this worked by running: - - ```bash - $ docker images - ``` - - You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd` - listed. -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_rename.yaml b/_data/engine-cli-edge/docker_rename.yaml deleted file mode 100644 index c57ea4b5b8..0000000000 --- a/_data/engine-cli-edge/docker_rename.yaml +++ /dev/null @@ -1,16 +0,0 @@ -command: docker rename -short: Rename a container -long: The `docker rename` command renames a container. -usage: docker rename CONTAINER NEW_NAME -pname: docker -plink: docker.yaml -examples: |- - ```bash - $ docker rename my_container my_new_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_restart.yaml b/_data/engine-cli-edge/docker_restart.yaml deleted file mode 100644 index 90ff107560..0000000000 --- a/_data/engine-cli-edge/docker_restart.yaml +++ /dev/null @@ -1,27 +0,0 @@ -command: docker restart -short: Restart one or more containers -long: Restart one or more containers -usage: docker restart [OPTIONS] CONTAINER [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker restart my_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_rm.yaml b/_data/engine-cli-edge/docker_rm.yaml deleted file mode 100644 index 889a62aca8..0000000000 --- a/_data/engine-cli-edge/docker_rm.yaml +++ /dev/null @@ -1,113 +0,0 @@ -command: docker rm -short: Remove one or more containers -long: Remove one or more containers -usage: docker rm [OPTIONS] CONTAINER [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: link - shorthand: l - value_type: bool - default_value: "false" - description: Remove the specified link - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes - shorthand: v - value_type: bool - default_value: "false" - description: Remove the volumes associated with the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Remove a container - - This will remove the container referenced under the link - `/redis`. - - ```bash - $ docker rm /redis - - /redis - ``` - - ### Remove a link specified with `--link` on the default bridge network - - This will remove the underlying link between `/webapp` and the `/redis` - containers on the default bridge network, removing all network communication - between the two containers. This does not apply when `--link` is used with - user-specified networks. - - ```bash - $ docker rm --link /webapp/redis - - /webapp/redis - ``` - - ### Force-remove a running container - - This command will force-remove a running container. - - ```bash - $ docker rm --force redis - - redis - ``` - - The main process inside the container referenced under the link `redis` will receive - `SIGKILL`, then the container will be removed. - - ### Remove all stopped containers - - ```bash - $ docker rm $(docker ps -a -q) - ``` - - This command will delete all stopped containers. The command - `docker ps -a -q` will return all existing container IDs and pass them to - the `rm` command which will delete them. Any running containers will not be - deleted. - - ### Remove a container and its volumes - - ```bash - $ docker rm -v redis - redis - ``` - - This command will remove the container and any volumes associated with it. - Note that if a volume was specified with a name, it will not be removed. - - ### Remove a container and selectively remove volumes - - ```bash - $ docker create -v awesome:/foo -v /bar --name hello redis - hello - $ docker rm -v hello - ``` - - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_rmi.yaml b/_data/engine-cli-edge/docker_rmi.yaml deleted file mode 100644 index e21b2d3d46..0000000000 --- a/_data/engine-cli-edge/docker_rmi.yaml +++ /dev/null @@ -1,108 +0,0 @@ -command: docker rmi -short: Remove one or more images -long: Remove one or more images -usage: docker rmi [OPTIONS] IMAGE [IMAGE...] -pname: docker -plink: docker.yaml -options: -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: Force removal of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-prune - value_type: bool - default_value: "false" - description: Do not delete untagged parents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - You can remove an image using its short or long ID, its tag, or its digest. If - an image has one or more tags referencing it, you must remove all of them before - the image is removed. Digest references are removed automatically when an image - is removed by tag. - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - test2 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - - $ docker rmi fd484f19954f - - Error: Conflict, cannot delete image fd484f19954f because it is tagged in multiple repositories, use -f to force - 2013/12/11 05:47:16 Error: failed to remove one or more images - - $ docker rmi test1 - - Untagged: test1:latest - - $ docker rmi test2 - - Untagged: test2:latest - - - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - - $ docker rmi test - - Untagged: test:latest - Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 - ``` - - If you use the `-f` flag and specify the image's short or long ID, then this - command untags and removes all images that match the specified ID. - - ```bash - $ docker images - - REPOSITORY TAG IMAGE ID CREATED SIZE - test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - test2 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) - - $ docker rmi -f fd484f19954f - - Untagged: test1:latest - Untagged: test:latest - Untagged: test2:latest - Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 - ``` - - An image pulled by digest has no tag associated with it: - - ```bash - $ docker images --digests - - REPOSITORY TAG DIGEST IMAGE ID CREATED SIZE - localhost:5000/test/busybox sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf 4986bf8c1536 9 weeks ago 2.43 MB - ``` - - To remove an image using its digest: - - ```bash - $ docker rmi localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf - Untagged: localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf - Deleted: 4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125 - Deleted: ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2 - Deleted: df7546f9f060a2268024c8a230d8639878585defcc1bc6f79d2728a13957871b - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_run.yaml b/_data/engine-cli-edge/docker_run.yaml deleted file mode 100644 index 15d4a20ada..0000000000 --- a/_data/engine-cli-edge/docker_run.yaml +++ /dev/null @@ -1,1542 +0,0 @@ -command: docker run -short: Run a command in a new container -long: |- - The `docker run` command first `creates` a writeable container layer over the - specified image, and then `starts` it using the specified command. That is, - `docker run` is equivalent to the API `/containers/create` then - `/containers/(id)/start`. A stopped container can be restarted with all its - previous changes intact using `docker start`. See `docker ps -a` to view a list - of all containers. - - The `docker run` command can be used in combination with `docker commit` to - [*change the command that a container runs*](commit.md). There is additional detailed information about `docker run` in the [Docker run reference](../run.md). - - For information on connecting a container to a network, see the ["*Docker network overview*"](https://docs.docker.com/engine/userguide/networking/). -usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: attach - shorthand: a - value_type: list - description: Attach to STDIN, STDOUT or STDERR - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight - value_type: uint16 - default_value: "0" - description: | - Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: blkio-weight-device - value_type: list - default_value: '[]' - description: Block IO weight (relative device weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-add - value_type: list - description: Add Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cap-drop - value_type: list - description: Drop Linux capabilities - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cgroup-parent - value_type: string - description: Optional parent cgroup for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cidfile - value_type: string - description: Write the container ID to the file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-count - value_type: int64 - default_value: "0" - description: CPU count (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-percent - value_type: int64 - default_value: "0" - description: CPU percent (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach - shorthand: d - value_type: bool - default_value: "false" - description: Run container in background and print container ID - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device - value_type: list - description: Add a host device to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-cgroup-rule - value_type: list - description: Add a rule to the cgroup allowed devices list - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-bps - value_type: list - default_value: '[]' - description: Limit read rate (bytes per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-read-iops - value_type: list - default_value: '[]' - description: Limit read rate (IO per second) from a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-bps - value_type: list - default_value: '[]' - description: Limit write rate (bytes per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: device-write-iops - value_type: list - default_value: '[]' - description: Limit write rate (IO per second) to a device - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: disable-content-trust - value_type: bool - default_value: "true" - description: Skip image verification - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns - value_type: list - description: Set custom DNS servers - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-opt - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option - value_type: list - description: Set DNS options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search - value_type: list - description: Set custom DNS search domains - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: string - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-file - value_type: list - description: Read in a file of environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: expose - value_type: list - description: Expose a port or a range of ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-add - value_type: list - description: Add additional groups to join - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - default_value: 0s - description: Time between running the check (ms|s|m|h) (default 0s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-start-period - value_type: duration - default_value: 0s - 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: help - value_type: bool - default_value: "false" - description: Print usage - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - shorthand: h - value_type: string - description: Container host name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: init - value_type: bool - default_value: "false" - description: | - Run an init inside the container that forwards signals and reaps processes - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Keep STDIN open even if not attached - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxbandwidth - value_type: bytes - default_value: "0" - description: | - Maximum IO bandwidth limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: io-maxiops - value_type: uint64 - default_value: "0" - description: Maximum IOps limit for the system drive (Windows only) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip - value_type: string - description: IPv4 address (e.g., 172.30.100.104) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ip6 - value_type: string - description: IPv6 address (e.g., 2001:db8::33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ipc - value_type: string - description: IPC mode to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Container isolation technology - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Set meta data on a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-file - value_type: list - description: Read in a line delimited file of labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link - value_type: list - description: Add link to another container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: link-local-ip - value_type: list - description: Container IPv4/IPv6 link-local addresses - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Log driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mac-address - value_type: string - description: Container MAC address (e.g., 92:d0:c6:0a:29:33) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swappiness - value_type: int64 - default_value: "-1" - description: Tune container memory swappiness (0 to 100) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount - value_type: mount - description: Attach a filesystem mount to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Assign a name to the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: net-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network - value_type: string - default_value: default - description: Connect a container to a network - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-alias - value_type: list - description: Add network-scoped alias for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-kill-disable - value_type: bool - default_value: "false" - description: Disable OOM Killer - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: oom-score-adj - value_type: int - default_value: "0" - description: Tune host's OOM preferences (-1000 to 1000) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pid - value_type: string - description: PID namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pids-limit - value_type: int64 - default_value: "0" - description: Tune container pids limit (set -1 for unlimited) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: platform - value_type: string - description: Set platform if server is multi-platform capable - deprecated: false - min_api_version: "1.32" - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: privileged - value_type: bool - default_value: "false" - description: Give extended privileges to this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish - shorthand: p - value_type: list - description: Publish a container's port(s) to the host - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-all - shorthand: P - value_type: bool - default_value: "false" - description: Publish all exposed ports to random ports - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - default_value: "no" - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rm - value_type: bool - default_value: "false" - description: Automatically remove the container when it exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: runtime - value_type: string - description: Runtime to use for this container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: security-opt - value_type: list - description: Security Options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: shm-size - value_type: bytes - default_value: "0" - description: Size of /dev/shm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sig-proxy - value_type: bool - default_value: "true" - description: Proxy received signals to the process - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - default_value: SIGTERM - description: Signal to stop a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-timeout - value_type: int - default_value: "0" - description: Timeout (in seconds) to stop a container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: storage-opt - value_type: list - description: Storage driver options for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: sysctl - value_type: map - default_value: map[] - description: Sysctl options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tmpfs - value_type: list - description: Mount a tmpfs directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: ulimit - value_type: ulimit - default_value: '[]' - description: Ulimit options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: userns - value_type: string - description: User namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: uts - value_type: string - description: UTS namespace to use - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume - shorthand: v - value_type: list - description: Bind mount a volume - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volume-driver - value_type: string - description: Optional volume driver for the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes-from - value_type: list - description: Mount volumes from the specified container(s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Assign name and allocate pseudo-TTY (--name, -it) - - ```bash - $ docker run --name test -it debian - - root@d6c0fe130dba:/# exit 13 - $ echo $? - 13 - $ docker ps -a | grep test - d6c0fe130dba debian:7 "/bin/bash" 26 seconds ago Exited (13) 17 seconds ago test - ``` - - This example runs a container named `test` using the `debian:latest` - image. The `-it` instructs Docker to allocate a pseudo-TTY connected to - the container's stdin; creating an interactive `bash` shell in the container. - In the example, the `bash` shell is quit by entering - `exit 13`. This exit code is passed on to the caller of - `docker run`, and is recorded in the `test` container's metadata. - - ### Capture container ID (--cidfile) - - ```bash - $ docker run --cidfile /tmp/docker_test.cid ubuntu echo "test" - ``` - - This will create a container and print `test` to the console. The `cidfile` - flag makes Docker attempt to create a new file and write the container ID to it. - If the file exists already, Docker will return an error. Docker will close this - file when `docker run` exits. - - ### Full container capabilities (--privileged) - - ```bash - $ docker run -t -i --rm ubuntu bash - root@bc338942ef20:/# mount -t tmpfs none /mnt - mount: permission denied - ``` - - This will *not* work, because by default, most potentially dangerous kernel - capabilities are dropped; including `cap_sys_admin` (which is required to mount - filesystems). However, the `--privileged` flag will allow it to run: - - ```bash - $ docker run -t -i --privileged ubuntu bash - root@50e3f57e16e6:/# mount -t tmpfs none /mnt - root@50e3f57e16e6:/# df -h - Filesystem Size Used Avail Use% Mounted on - none 1.9G 0 1.9G 0% /mnt - ``` - - The `--privileged` flag gives *all* capabilities to the container, and it also - lifts all the limitations enforced by the `device` cgroup controller. In other - words, the container can then do almost everything that the host can do. This - flag exists to allow special use-cases, like running Docker within Docker. - - ### Set working directory (-w) - - ```bash - $ docker run -w /path/to/dir/ -i -t ubuntu pwd - ``` - - The `-w` lets the command being executed inside directory given, here - `/path/to/dir/`. If the path does not exist it is created inside the container. - - ### Set storage driver options per container - - ```bash - $ docker run -it --storage-opt size=120G fedora /bin/bash - ``` - - This (size) will allow to set the container rootfs size to 120G at creation time. - This option is only available for the `devicemapper`, `btrfs`, `overlay2`, - `windowsfilter` and `zfs` graph drivers. - For the `devicemapper`, `btrfs`, `windowsfilter` and `zfs` graph drivers, - user cannot pass a size less than the Default BaseFS Size. - For the `overlay2` storage driver, the size option is only available if the - backing fs is `xfs` and mounted with the `pquota` mount option. - Under these conditions, user can pass any size less than the backing fs size. - - ### Mount tmpfs (--tmpfs) - - ```bash - $ docker run -d --tmpfs /run:rw,noexec,nosuid,size=65536k my_image - ``` - - The `--tmpfs` flag mounts an empty tmpfs into the container with the `rw`, - `noexec`, `nosuid`, `size=65536k` options. - - ### Mount volume (-v, --read-only) - - ```bash - $ docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu pwd - ``` - - The `-v` flag mounts the current working directory into the container. The `-w` - lets the command being executed inside the current working directory, by - changing into the directory to the value returned by `pwd`. So this - combination executes the command using the container, but inside the - current working directory. - - ```bash - $ docker run -v /doesnt/exist:/foo -w /foo -i -t ubuntu bash - ``` - - When the host directory of a bind-mounted volume doesn't exist, Docker - will automatically create this directory on the host for you. In the - example above, Docker will create the `/doesnt/exist` - folder before starting your container. - - ```bash - $ docker run --read-only -v /icanwrite busybox touch /icanwrite/here - ``` - - Volumes can be used in combination with `--read-only` to control where - a container writes files. The `--read-only` flag mounts the container's root - filesystem as read only prohibiting writes to locations other than the - specified volumes for the container. - - ```bash - $ docker run -t -i -v /var/run/docker.sock:/var/run/docker.sock -v /path/to/static-docker-binary:/usr/bin/docker busybox sh - ``` - - By bind-mounting the docker unix socket and statically linked docker - binary (refer to [get the linux binary]( - https://docs.docker.com/engine/installation/binaries/#/get-the-linux-binary)), - you give the container the full access to create and manipulate the host's - Docker daemon. - - On Windows, the paths must be specified using Windows-style semantics. - - ```powershell - PS C:\> docker run -v c:\foo:c:\dest microsoft/nanoserver cmd /s /c type c:\dest\somefile.txt - Contents of file - - PS C:\> docker run -v c:\foo:d: microsoft/nanoserver cmd /s /c type d:\somefile.txt - Contents of file - ``` - - 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: - 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. - - ```powershell - net use z: \\remotemachine\share - docker run -v z:\foo:c:\dest ... - docker run -v \\uncpath\to\directory:c:\dest ... - docker run -v c:\foo\somefile.txt:c:\dest ... - docker run -v c:\foo:c: ... - docker run -v c:\foo:c:\existing-directory-with-contents ... - ``` - - 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 - - The `--mount` flag allows you to mount volumes, host-directories and `tmpfs` - mounts in a container. - - The `--mount` flag supports most options that are supported by the `-v` or the - `--volume` flag, but uses a different syntax. For in-depth information on the - `--mount` flag, and a comparison between `--volume` and `--mount`, refer to - the [service create command reference](service_create.md#add-bind-mounts-or-volumes). - - Even though there is no plan to deprecate `--volume`, usage of `--mount` is recommended. - - Examples: - - ```bash - $ docker run --read-only --mount type=volume,target=/icanwrite busybox touch /icanwrite/here - ``` - - ```bash - $ docker run -t -i --mount type=bind,src=/data,dst=/data busybox sh - ``` - - ### Publish or expose port (-p, --expose) - - ```bash - $ docker run -p 127.0.0.1:80:8080/tcp ubuntu bash - ``` - - This binds port `8080` of the container to TCP port `80` on `127.0.0.1` of the host - machine. You can also specify `udp` and `sctp` ports. - The [Docker User Guide](https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/) - explains in detail how to manipulate ports in Docker. - - ```bash - $ docker run --expose 80 ubuntu bash - ``` - - This exposes port `80` of the container without publishing the port to the host - system's interfaces. - - ### Set environment variables (-e, --env, --env-file) - - ```bash - $ docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash - ``` - - Use the `-e`, `--env`, and `--env-file` flags to set simple (non-array) - environment variables in the container you're running, or overwrite variables - that are defined in the Dockerfile of the image you're running. - - You can define the variable and its value when running the container: - - ```bash - $ docker run --env VAR1=value1 --env VAR2=value2 ubuntu env | grep VAR - VAR1=value1 - VAR2=value2 - ``` - - You can also use variables that you've exported to your local environment: - - ```bash - export VAR1=value1 - export VAR2=value2 - - $ docker run --env VAR1 --env VAR2 ubuntu env | grep VAR - VAR1=value1 - VAR2=value2 - ``` - - When running the command, the Docker CLI client checks the value the variable - has in your local environment and passes it to the container. - If no `=` is provided and that variable is not exported in your local - environment, the variable won't be set in the container. - - You can also load the environment variables from a file. This file should use - the syntax `=value` (which sets the variable to the given value) or - `` (which takes the value from the local environment), and `#` for comments. - - ```bash - $ cat env.list - # This is a comment - VAR1=value1 - VAR2=value2 - USER - - $ docker run --env-file env.list ubuntu env | grep VAR - VAR1=value1 - VAR2=value2 - USER=denis - ``` - - ### Set metadata on container (-l, --label, --label-file) - - A label is a `key=value` pair that applies metadata to a container. To label a container with two labels: - - ```bash - $ docker run -l my-label --label com.example.foo=bar ubuntu bash - ``` - - The `my-label` key doesn't specify a value so the label defaults to an empty - string(`""`). To add multiple labels, repeat the label flag (`-l` or `--label`). - - The `key=value` must be unique to avoid overwriting the label value. If you - specify labels with identical keys but different values, each subsequent value - overwrites the previous. Docker uses the last `key=value` you supply. - - Use the `--label-file` flag to load multiple labels from a file. Delimit each - label in the file with an EOL mark. The example below loads labels from a - labels file in the current directory: - - ```bash - $ docker run --label-file ./labels ubuntu bash - ``` - - The label-file format is similar to the format for loading environment - variables. (Unlike environment variables, labels are not visible to processes - running inside a container.) The following example illustrates a label-file - format: - - ```none - com.example.label1="a label" - - # this is a comment - com.example.label2=another\ label - com.example.label3 - ``` - - You can load multiple label-files by supplying multiple `--label-file` flags. - - For additional information on working with labels, see [*Labels - custom - metadata in Docker*](https://docs.docker.com/engine/userguide/labels-custom-metadata/) in the Docker User - Guide. - - ### Connect a container to a network (--network) - - When you start a container use the `--network` flag to connect it to a network. - This adds the `busybox` container to the `my-net` network. - - ```bash - $ docker run -itd --network=my-net busybox - ``` - - You can also choose the IP addresses for the container with `--ip` and `--ip6` - flags when you start the container on a user-defined network. - - ```bash - $ docker run -itd --network=my-net --ip=10.10.9.75 busybox - ``` - - If you want to add a running container to a network use the `docker network connect` subcommand. - - You can connect multiple containers to the same network. Once connected, the - containers can communicate easily need only another container's IP address - or name. For `overlay` networks or custom plugins that support multi-host - connectivity, containers connected to the same multi-host network but launched - from different Engines can also communicate in this way. - - > **Note**: Service discovery is unavailable on the default bridge network. - > Containers can communicate via their IP addresses by default. To communicate - > by name, they must be linked. - - You can disconnect a container from a network using the `docker network - disconnect` command. - - ### Mount volumes from container (--volumes-from) - - ```bash - $ docker run --volumes-from 777f7dc92da7 --volumes-from ba8c0c54f0f2:ro -i -t ubuntu pwd - ``` - - The `--volumes-from` flag mounts all the defined volumes from the referenced - containers. Containers can be specified by repetitions of the `--volumes-from` - argument. The container ID may be optionally suffixed with `:ro` or `:rw` to - mount the volumes in read-only or read-write mode, respectively. By default, - the volumes are mounted in the same mode (read write or read only) as - the reference container. - - Labeling systems like SELinux require that proper labels are placed on volume - content mounted into a container. Without a label, the security system might - prevent the processes running inside the container from using the content. By - default, Docker does not change the labels set by the OS. - - To change the label in the container context, you can add either of two suffixes - `:z` or `:Z` to the volume mount. These suffixes tell Docker to relabel file - objects on the shared volumes. The `z` option tells Docker that two containers - share the volume content. As a result, Docker labels the content with a shared - content label. Shared volume labels allow all containers to read/write content. - The `Z` option tells Docker to label the content with a private unshared label. - Only the current container can use a private volume. - - ### Attach to STDIN/STDOUT/STDERR (-a) - - The `-a` flag tells `docker run` to bind to the container's `STDIN`, `STDOUT` - or `STDERR`. This makes it possible to manipulate the output and input as - needed. - - ```bash - $ echo "test" | docker run -i -a stdin ubuntu cat - - ``` - - This pipes data into a container and prints the container's ID by attaching - only to the container's `STDIN`. - - ```bash - $ docker run -a stderr ubuntu echo test - ``` - - This isn't going to print anything unless there's an error because we've - only attached to the `STDERR` of the container. The container's logs - still store what's been written to `STDERR` and `STDOUT`. - - ```bash - $ cat somefile | docker run -i -a stdin mybuilder dobuild - ``` - - This is how piping a file into a container could be done for a build. - The container's ID will be printed after the build is done and the build - logs could be retrieved using `docker logs`. This is - useful if you need to pipe a file or something else into a container and - retrieve the container's ID once the container has finished running. - - ### Add host device to container (--device) - - ```bash - $ docker run --device=/dev/sdc:/dev/xvdc \ - --device=/dev/sdd --device=/dev/zero:/dev/nulo \ - -i -t \ - ubuntu ls -l /dev/{xvdc,sdd,nulo} - - brw-rw---- 1 root disk 8, 2 Feb 9 16:05 /dev/xvdc - brw-rw---- 1 root disk 8, 3 Feb 9 16:05 /dev/sdd - crw-rw-rw- 1 root root 1, 5 Feb 9 16:05 /dev/nulo - ``` - - It is often necessary to directly expose devices to a container. The `--device` - option enables that. For example, a specific block storage device or loop - device or audio device can be added to an otherwise unprivileged container - (without the `--privileged` flag) and have the application directly access it. - - By default, the container will be able to `read`, `write` and `mknod` these devices. - This can be overridden using a third `:rwm` set of options to each `--device` - flag: - - ```bash - $ docker run --device=/dev/sda:/dev/xvdc --rm -it ubuntu fdisk /dev/xvdc - - Command (m for help): q - $ docker run --device=/dev/sda:/dev/xvdc:r --rm -it ubuntu fdisk /dev/xvdc - You will not be able to write the partition table. - - Command (m for help): q - - $ docker run --device=/dev/sda:/dev/xvdc:rw --rm -it ubuntu fdisk /dev/xvdc - - Command (m for help): q - - $ docker run --device=/dev/sda:/dev/xvdc:m --rm -it ubuntu fdisk /dev/xvdc - fdisk: unable to open /dev/xvdc: Operation not permitted - ``` - - > **Note**: `--device` cannot be safely used with ephemeral devices. Block devices - > that may be removed should not be added to untrusted containers with - > `--device`. - - ### Restart policies (--restart) - - Use Docker's `--restart` to specify a container's *restart policy*. A restart - policy controls whether the Docker daemon restarts a container after exit. - Docker supports the following restart policies: - - | Policy | Result | - |:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `no` | Do not automatically restart the container when it exits. This is the default. | - | `on-failure[:max-retries]` | Restart only if the container exits with a non-zero exit status. Optionally, limit the number of restart retries the Docker daemon attempts. | - | `unless-stopped` | Restart the container unless it is explicitly stopped or Docker itself is stopped or restarted. | - | `always` | Always restart the container regardless of the exit status. When you specify always, the Docker daemon will try to restart the container indefinitely. The container will also always start on daemon startup, regardless of the current state of the container. | - - ```bash - $ docker run --restart=always redis - ``` - - This will run the `redis` container with a restart policy of **always** - so that if the container exits, Docker will restart it. - - More detailed information on restart policies can be found in the - [Restart Policies (--restart)](../run.md#restart-policies---restart) - section of the Docker run reference page. - - ### Add entries to container hosts file (--add-host) - - You can add other hosts into a container's `/etc/hosts` file by using one or - more `--add-host` flags. This example adds a static address for a host named - `docker`: - - ```bash - $ docker run --add-host=docker:10.180.0.1 --rm -it debian - - root@f38c87f2a42d:/# ping docker - PING docker (10.180.0.1): 48 data bytes - 56 bytes from 10.180.0.1: icmp_seq=0 ttl=254 time=7.600 ms - 56 bytes from 10.180.0.1: icmp_seq=1 ttl=254 time=30.705 ms - ^C--- docker ping statistics --- - 2 packets transmitted, 2 packets received, 0% packet loss - round-trip min/avg/max/stddev = 7.600/19.152/30.705/11.553 ms - ``` - - Sometimes you need to connect to the Docker host from within your - container. To enable this, pass the Docker host's IP address to - the container using the `--add-host` flag. To find the host's address, - use the `ip addr show` command. - - The flags you pass to `ip addr show` depend on whether you are - using IPv4 or IPv6 networking in your containers. Use the following - flags for IPv4 address retrieval for a network device named `eth0`: - - ```bash - $ HOSTIP=`ip -4 addr show scope global dev eth0 | grep inet | awk '{print \$2}' | cut -d / -f 1` - $ docker run --add-host=docker:${HOSTIP} --rm -it debian - ``` - - For IPv6 use the `-6` flag instead of the `-4` flag. For other network - devices, replace `eth0` with the correct device name (for example `docker0` - for the bridge device). - - ### Set ulimits in container (--ulimit) - - Since setting `ulimit` settings in a container requires extra privileges not - available in the default container, you can set these using the `--ulimit` flag. - `--ulimit` is specified with a soft and hard limit as such: - `=[:]`, for example: - - ```bash - $ docker run --ulimit nofile=1024:1024 --rm debian sh -c "ulimit -n" - 1024 - ``` - - > **Note**: If you do not provide a `hard limit`, the `soft limit` will be used - > for both values. If no `ulimits` are set, they will be inherited from - > the default `ulimits` set on the daemon. `as` option is disabled now. - > In other words, the following script is not supported: - > - > ```bash - > $ docker run -it --ulimit as=1024 fedora /bin/bash` - > ``` - - The values are sent to the appropriate `syscall` as they are set. - Docker doesn't perform any byte conversion. Take this into account when setting the values. - - #### For `nproc` usage - - Be careful setting `nproc` with the `ulimit` flag as `nproc` is designed by Linux to set the - maximum number of processes available to a user, not to a container. For example, start four - containers with `daemon` user: - - ```bash - $ docker run -d -u daemon --ulimit nproc=3 busybox top - - $ docker run -d -u daemon --ulimit nproc=3 busybox top - - $ docker run -d -u daemon --ulimit nproc=3 busybox top - - $ docker run -d -u daemon --ulimit nproc=3 busybox top - ``` - - The 4th container fails and reports "[8] System error: resource temporarily unavailable" error. - This fails because the caller set `nproc=3` resulting in the first three containers using up - the three processes quota set for the `daemon` user. - - ### Stop container with signal (--stop-signal) - - The `--stop-signal` flag sets the system call signal that will be sent to the container to exit. - This signal can be a valid unsigned number that matches a position in the kernel's syscall table, for instance 9, - or a signal name in the format SIGNAME, for instance SIGKILL. - - ### Optional security options (--security-opt) - - On Windows, this flag can be used to specify the `credentialspec` option. - The `credentialspec` must be in the format `file://spec.txt` or `registry://keyname`. - - ### Stop container with timeout (--stop-timeout) - - The `--stop-timeout` flag sets the timeout (in seconds) that a pre-defined (see `--stop-signal`) system call - signal that will be sent to the container to exit. After timeout elapses the container will be killed with SIGKILL. - - ### Specify isolation technology for container (--isolation) - - This option is useful in situations where you are running Docker containers on - Windows. The `--isolation ` option sets a container's isolation technology. - On Linux, the only supported is the `default` option which uses - Linux namespaces. These two commands are equivalent on Linux: - - ```bash - $ docker run -d busybox top - $ docker run -d --isolation default busybox top - ``` - - On Windows, `--isolation` can take one of these values: - - - | Value | Description | - |:----------|:-------------------------------------------------------------------------------------------| - | `default` | Use the value specified by the Docker daemon's `--exec-opt` or system default (see below). | - | `process` | Shared-kernel namespace isolation (not supported on Windows client operating systems). | - | `hyperv` | Hyper-V hypervisor partition-based isolation. | - - The default isolation on Windows server operating systems is `process`. The default (and only supported) - isolation on Windows client operating systems is `hyperv`. An attempt to start a container on a client - operating system with `--isolation process` will fail. - - On Windows server, assuming the default configuration, these commands are equivalent - and result in `process` isolation: - - ```PowerShell - PS C:\> docker run -d microsoft/nanoserver powershell echo process - PS C:\> docker run -d --isolation default microsoft/nanoserver powershell echo process - PS C:\> docker run -d --isolation process microsoft/nanoserver powershell echo process - ``` - - If you have set the `--exec-opt isolation=hyperv` option on the Docker `daemon`, or - are running against a Windows client-based daemon, these commands are equivalent and - result in `hyperv` isolation: - - ```PowerShell - PS C:\> docker run -d microsoft/nanoserver powershell echo hyperv - PS C:\> docker run -d --isolation default microsoft/nanoserver powershell echo hyperv - PS C:\> docker run -d --isolation hyperv microsoft/nanoserver powershell echo hyperv - ``` - - ### Specify hard limits on memory available to containers (-m, --memory) - - These parameters always set an upper limit on the memory available to the container. On Linux, this - is set on the cgroup and applications in a container can query it at `/sys/fs/cgroup/memory/memory.limit_in_bytes`. - - 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 - PS C:\> docker run -it -m 2GB --isolation=process microsoft/nanoserver powershell Get-ComputerInfo *memory* - - CsTotalPhysicalMemory : 17064509440 - CsPhyicallyInstalledMemory : 16777216 - OsTotalVisibleMemorySize : 16664560 - OsFreePhysicalMemory : 14646720 - OsTotalVirtualMemorySize : 19154928 - OsFreeVirtualMemory : 17197440 - 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 - PS C:\> docker run -it -m 2GB --isolation=hyperv microsoft/nanoserver powershell Get-ComputerInfo *memory* - - CsTotalPhysicalMemory : 2683355136 - CsPhyicallyInstalledMemory : - OsTotalVisibleMemorySize : 2620464 - OsFreePhysicalMemory : 2306552 - OsTotalVirtualMemorySize : 2620464 - OsFreeVirtualMemory : 2356692 - OsInUseVirtualMemory : 263772 - OsMaxProcessMemorySize : 137438953344 - ``` - - - ### Configure namespaced kernel parameters (sysctls) at runtime - - The `--sysctl` sets namespaced kernel parameters (sysctls) in the - container. For example, to turn on IP forwarding in the containers - network namespace, run this command: - - ```bash - $ docker run --sysctl net.ipv4.ip_forward=1 someimage - ``` - - > **Note**: Not all sysctls are namespaced. Docker does not support changing sysctls - > inside of a container that also modify the host system. As the kernel - > evolves we expect to see more sysctls become namespaced. - - #### Currently supported sysctls - - - `IPC Namespace`: - - ```none - kernel.msgmax, kernel.msgmnb, kernel.msgmni, kernel.sem, kernel.shmall, kernel.shmmax, kernel.shmmni, kernel.shm_rmid_forced - Sysctls beginning with fs.mqueue.* - ``` - - If you use the `--ipc=host` option these sysctls will not be allowed. - - - `Network Namespace`: - - Sysctls beginning with net.* - - If you use the `--network=host` option using these sysctls will not be allowed. -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_save.yaml b/_data/engine-cli-edge/docker_save.yaml deleted file mode 100644 index 5a23a1236b..0000000000 --- a/_data/engine-cli-edge/docker_save.yaml +++ /dev/null @@ -1,53 +0,0 @@ -command: docker save -short: Save one or more images to a tar archive (streamed to STDOUT by default) -long: |- - Produces a tarred repository to the standard output stream. - Contains all parent layers, and all tags + versions, or specified `repo:tag`, for - each argument provided. -usage: docker save [OPTIONS] IMAGE [IMAGE...] -pname: docker -plink: docker.yaml -options: -- option: output - shorthand: o - value_type: string - description: Write to a file, instead of STDOUT - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Create a backup that can then be used with `docker load`. - - ```bash - $ docker save busybox > busybox.tar - - $ ls -sh busybox.tar - - 2.7M busybox.tar - - $ docker save --output busybox.tar busybox - - $ ls -sh busybox.tar - - 2.7M busybox.tar - - $ docker save -o fedora-all.tar fedora - - $ docker save -o fedora-latest.tar fedora:latest - ``` - - ### Cherry-pick particular tags - - You can even cherry-pick particular tags of an image repository. - - ```bash - $ docker save -o ubuntu.tar ubuntu:lucid ubuntu:saucy - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_search.yaml b/_data/engine-cli-edge/docker_search.yaml deleted file mode 100644 index 1244637a86..0000000000 --- a/_data/engine-cli-edge/docker_search.yaml +++ /dev/null @@ -1,154 +0,0 @@ -command: docker search -short: Search the Docker Hub for images -long: |- - Search [Docker Hub](https://hub.docker.com) for images - - See [*Find Public Images on Docker Hub*](https://docs.docker.com/engine/tutorials/dockerrepos/#searching-for-images) for - more details on finding shared images from the command line. - - > **Note**: Search queries return a maximum of 25 results. -usage: docker search [OPTIONS] TERM -pname: docker -plink: docker.yaml -options: -- option: automated - value_type: bool - default_value: "false" - description: Only show automated builds - deprecated: true - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print search using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: limit - value_type: int - default_value: "25" - description: Max number of search results - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Don't truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stars - shorthand: s - value_type: uint - default_value: "0" - description: Only displays with at least x stars - deprecated: true - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Search images by name\n\nThis example displays images with a name containing - 'busybox':\n\n```none\n$ docker search busybox\n\nNAME DESCRIPTION - \ STARS OFFICIAL AUTOMATED\nbusybox Busybox - base image. 316 [OK] \nprogrium/busybox - \ 50 [OK]\nradial/busyboxplus - \ Full-chain, Internet enabled, busybox made... 8 [OK]\nodise/busybox-python - \ 2 [OK]\nazukiapp/busybox - \ This image is meant to be used as the base... 2 [OK]\nofayau/busybox-jvm - \ Prepare busybox to install a 32 bits JVM. 1 [OK]\nshingonoide/archlinux-busybox - \ Arch Linux, a lightweight and flexible Lin... 1 [OK]\nodise/busybox-curl - \ 1 [OK]\nofayau/busybox-libc32 - \ Busybox with 32 bits (and 64 bits) libs 1 [OK]\npeelsky/zulu-openjdk-busybox - \ 1 [OK]\nskomma/busybox-data - \ Docker image suitable for data volume cont... 1 [OK]\nelektritter/busybox-teamspeak - \ Lightweight teamspeak3 container based on... 1 [OK]\nsocketplane/busybox - \ 1 [OK]\noveits/docker-nginx-busybox - \ This is a tiny NginX docker image based on... 0 [OK]\nggtools/busybox-ubuntu - \ Busybox ubuntu version with extra goodies 0 [OK]\nnikfoundas/busybox-confd - \ Minimal busybox based distribution of confd 0 [OK]\nopenshift/busybox-http-app - \ 0 [OK]\njllopis/busybox - \ 0 [OK]\nswyckoff/busybox - \ 0 [OK]\npowellquiring/busybox - \ 0 [OK]\nwilliamyeh/busybox-sh - \ Docker image for BusyBox's sh 0 [OK]\nsimplexsys/busybox-cli-powered - \ Docker busybox images, with a few often us... 0 [OK]\nfhisamoto/busybox-java - \ Busybox java 0 [OK]\nscottabernethy/busybox - \ 0 [OK]\nmarclop/busybox-solr\n```\n\n### - Display non-truncated description (--no-trunc)\n\nThis example displays images with - a name containing 'busybox',\nat least 3 stars and the description isn't truncated - in the output:\n\n```bash\n$ docker search --stars=3 --no-trunc busybox\nNAME DESCRIPTION - \ STARS - \ OFFICIAL AUTOMATED\nbusybox Busybox base image. 325 - \ [OK] \nprogrium/busybox 50 - \ [OK]\nradial/busyboxplus Full-chain, Internet enabled, busybox - made from scratch. Comes in git and cURL flavors. 8 [OK]\n```\n\n### - Limit search results (--limit)\n\nThe flag `--limit` is the maximum number of results - returned by a search. This value could\nbe in the range between 1 and 100. The default - value of `--limit` is 25.\n\n### Filtering\n\nThe filtering flag (`-f` or `--filter`) - format is a `key=value` pair. If there is more\nthan one filter, then pass multiple - flags (e.g. `--filter \"foo=bar\" --filter \"bif=baz\"`)\n\nThe currently supported - filters are:\n\n* stars (int - number of stars the image has)\n* is-automated (boolean - - true or false) - is the image automated or not\n* is-official (boolean - true - or false) - is the image official or not\n\n#### stars\n\nThis example displays - images with a name containing 'busybox' and at\nleast 3 stars:\n\n```bash\n$ docker - search --filter stars=3 busybox\n\nNAME DESCRIPTION STARS - \ OFFICIAL AUTOMATED\nbusybox Busybox base image. 325 - \ [OK] \nprogrium/busybox 50 - \ [OK]\nradial/busyboxplus Full-chain, Internet enabled, busybox - made... 8 [OK]\n```\n\n#### is-automated\n\nThis example displays - images with a name containing 'busybox'\nand are automated builds:\n\n```bash\n$ - docker search --filter is-automated busybox\n\nNAME DESCRIPTION - \ STARS OFFICIAL AUTOMATED\nprogrium/busybox - \ 50 [OK]\nradial/busyboxplus - \ Full-chain, Internet enabled, busybox made... 8 [OK]\n```\n\n#### - is-official\n\nThis example displays images with a name containing 'busybox', at - least\n3 stars and are official builds:\n\n```bash\n$ docker search --filter \"is-official=true\" - --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```\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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_secret.yaml b/_data/engine-cli-edge/docker_secret.yaml deleted file mode 100644 index 9ec8a70621..0000000000 --- a/_data/engine-cli-edge/docker_secret.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker secret -short: Manage Docker secrets -long: Manage secrets. -usage: docker secret -pname: docker -plink: docker.yaml -cname: -- docker secret create -- docker secret inspect -- docker secret ls -- docker secret rm -clink: -- docker_secret_create.yaml -- docker_secret_inspect.yaml -- docker_secret_ls.yaml -- docker_secret_rm.yaml -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_secret_create.yaml b/_data/engine-cli-edge/docker_secret_create.yaml deleted file mode 100644 index cece92e299..0000000000 --- a/_data/engine-cli-edge/docker_secret_create.yaml +++ /dev/null @@ -1,102 +0,0 @@ -command: docker secret create -short: Create a secret from a file or STDIN as content -long: |- - Creates a secret using standard input or from a file for the secret content. You must run this command on a manager node. - - For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). -usage: docker secret create [OPTIONS] SECRET [file|-] -pname: docker secret -plink: docker_secret.yaml -options: -- option: driver - shorthand: d - value_type: string - description: Secret driver - deprecated: false - min_api_version: "1.37" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Secret labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: template-driver - value_type: string - description: Template driver - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Create a secret - - ```bash - $ printf | docker secret create my_secret - - - onakdyv307se2tl7nl20anokv - - $ docker secret ls - - ID NAME CREATED UPDATED - onakdyv307se2tl7nl20anokv my_secret 6 seconds ago 6 seconds ago - ``` - - ### Create a secret with a file - - ```bash - $ docker secret create my_secret ./secret.json - - dg426haahpi5ezmkkj5kyl3sn - - $ docker secret ls - - ID NAME CREATED UPDATED - dg426haahpi5ezmkkj5kyl3sn my_secret 7 seconds ago 7 seconds ago - ``` - - ### Create a secret with labels - - ```bash - $ docker secret create --label env=dev \ - --label rev=20170324 \ - my_secret ./secret.json - - eo7jnzguqgtpdah3cm5srfb97 - ``` - - ```none - $ docker secret inspect my_secret - - [ - { - "ID": "eo7jnzguqgtpdah3cm5srfb97", - "Version": { - "Index": 17 - }, - "CreatedAt": "2017-03-24T08:15:09.735271783Z", - "UpdatedAt": "2017-03-24T08:15:09.735271783Z", - "Spec": { - "Name": "my_secret", - "Labels": { - "env": "dev", - "rev": "20170324" - } - } - } - ] - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_secret_inspect.yaml b/_data/engine-cli-edge/docker_secret_inspect.yaml deleted file mode 100644 index e0b3a6c01a..0000000000 --- a/_data/engine-cli-edge/docker_secret_inspect.yaml +++ /dev/null @@ -1,89 +0,0 @@ -command: docker secret inspect -short: Display detailed information on one or more secrets -long: |- - Inspects the specified secret. This command has to be run targeting a manager - node. - - By default, this renders all results in a JSON array. If a format is specified, - the given template will be executed for each result. - - Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. - - For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). -usage: docker secret inspect [OPTIONS] SECRET [SECRET...] -pname: docker secret -plink: docker_secret.yaml -options: -- option: format - shorthand: f - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pretty - value_type: bool - default_value: "false" - description: Print the information in a human friendly format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Inspect a secret by name or ID - - You can inspect a secret, either by its *name*, or *ID* - - For example, given the following secret: - - ```bash - $ docker secret ls - - ID NAME CREATED UPDATED - eo7jnzguqgtpdah3cm5srfb97 my_secret 3 minutes ago 3 minutes ago - ``` - - ```none - $ docker secret inspect secret.json - - [ - { - "ID": "eo7jnzguqgtpdah3cm5srfb97", - "Version": { - "Index": 17 - }, - "CreatedAt": "2017-03-24T08:15:09.735271783Z", - "UpdatedAt": "2017-03-24T08:15:09.735271783Z", - "Spec": { - "Name": "my_secret", - "Labels": { - "env": "dev", - "rev": "20170324" - } - } - } - ] - ``` - - ### Formatting - - You can use the --format option to obtain specific information about a - secret. The following example command outputs the creation time of the - secret. - - ```bash - $ docker secret inspect --format='{{.CreatedAt}}' eo7jnzguqgtpdah3cm5srfb97 - - 2017-03-24 08:15:09.735271783 +0000 UTC - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_secret_ls.yaml b/_data/engine-cli-edge/docker_secret_ls.yaml deleted file mode 100644 index 9fba65db2f..0000000000 --- a/_data/engine-cli-edge/docker_secret_ls.yaml +++ /dev/null @@ -1,157 +0,0 @@ -command: docker secret ls -aliases: list -short: List secrets -long: |- - Run this command on a manager node to list the secrets in the swarm. - - For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). -usage: docker secret ls [OPTIONS] -pname: docker secret -plink: docker_secret.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print secrets using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker secret ls - - ID NAME CREATED UPDATED - 6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago - 9u9hk4br2ej0wgngkga6rp4hq my_secret 5 weeks ago 5 weeks ago - mem02h8n73mybpgqjf0kfi1n0 test_secret 3 seconds ago 3 seconds ago - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * [id](secret_ls.md#id) (secret's ID) - * [label](secret_ls.md#label) (`label=` or `label==`) - * [name](secret_ls.md#name) (secret's name) - - #### id - - The `id` filter matches all or prefix of a secret's id. - - ```bash - $ docker secret ls -f "id=6697bflskwj1998km1gnnjr38" - - ID NAME CREATED UPDATED - 6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago - ``` - - #### label - - The `label` filter matches secrets based on the presence of a `label` alone or - a `label` and a value. - - The following filter matches all secrets with a `project` label regardless of - its value: - - ```bash - $ docker secret ls --filter label=project - - ID NAME CREATED UPDATED - mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago - ``` - - The following filter matches only services with the `project` label with the - `project-a` value. - - ```bash - $ docker service ls --filter label=project=test - - ID NAME CREATED UPDATED - mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago - ``` - - #### name - - The `name` filter matches on all or prefix of a secret's name. - - The following filter matches secret with a name containing a prefix of `test`. - - ```bash - $ docker secret ls --filter name=test_secret - - ID NAME CREATED UPDATED - mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago - ``` - - ### Format the output - - The formatting option (`--format`) pretty prints secrets output - using a Go template. - - Valid placeholders for the Go template are listed below: - - | Placeholder | Description | - | ------------ | ------------------------------------------------------------------------------------ | - | `.ID` | Secret ID | - | `.Name` | Secret name | - | `.CreatedAt` | Time when the secret was created | - | `.UpdatedAt` | Time when the secret was updated | - | `.Labels` | All labels assigned to the secret | - | `.Label` | Value of a specific label for this secret. For example `{{.Label "secret.ssh.key"}}` | - - When using the `--format` option, the `secret ls` command will either - output the data exactly as the template declares or, when using the - `table` directive, will include column headers as well. - - The following example uses a template without headers and outputs the - `ID` and `Name` entries separated by a colon for all images: - - ```bash - $ docker secret ls --format "{{.ID}}: {{.Name}}" - - 77af4d6b9913: secret-1 - b6fa739cedf5: secret-2 - 78a85c484f71: secret-3 - ``` - - To list all secrets with their name and created date in a table format you - can use: - - ```bash - $ docker secret ls --format "table {{.ID}}\t{{.Name}}\t{{.CreatedAt}}" - - ID NAME CREATED - 77af4d6b9913 secret-1 5 minutes ago - b6fa739cedf5 secret-2 3 hours ago - 78a85c484f71 secret-3 10 days ago - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_secret_rm.yaml b/_data/engine-cli-edge/docker_secret_rm.yaml deleted file mode 100644 index 1f5f500508..0000000000 --- a/_data/engine-cli-edge/docker_secret_rm.yaml +++ /dev/null @@ -1,28 +0,0 @@ -command: docker secret rm -aliases: remove -short: Remove one or more secrets -long: |- - Removes the specified secrets from the swarm. This command has to be run - targeting a manager node. - - For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). -usage: docker secret rm SECRET [SECRET...] -pname: docker secret -plink: docker_secret.yaml -examples: |- - This example removes a secret: - - ```bash - $ docker secret rm secret.json - sapth4csdo5b6wz2p5uimh5xg - ``` - - > **Warning**: Unlike `docker rm`, this command does not ask for confirmation - > before removing a secret. -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service.yaml b/_data/engine-cli-edge/docker_service.yaml deleted file mode 100644 index 918bd3b6b9..0000000000 --- a/_data/engine-cli-edge/docker_service.yaml +++ /dev/null @@ -1,33 +0,0 @@ -command: docker service -short: Manage services -long: Manage services. -usage: docker service -pname: docker -plink: docker.yaml -cname: -- docker service create -- docker service inspect -- docker service logs -- docker service ls -- docker service ps -- docker service rm -- docker service rollback -- docker service scale -- docker service update -clink: -- docker_service_create.yaml -- docker_service_inspect.yaml -- docker_service_logs.yaml -- docker_service_ls.yaml -- docker_service_ps.yaml -- docker_service_rm.yaml -- docker_service_rollback.yaml -- docker_service_scale.yaml -- docker_service_update.yaml -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_create.yaml b/_data/engine-cli-edge/docker_service_create.yaml deleted file mode 100644 index c980fd5038..0000000000 --- a/_data/engine-cli-edge/docker_service_create.yaml +++ /dev/null @@ -1,952 +0,0 @@ -command: docker service create -short: Create a new service -long: |- - Creates a service as described by the specified parameters. You must run this - command on a manager node. -usage: docker service create [OPTIONS] IMAGE [COMMAND] [ARG...] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: constraint - value_type: list - description: Placement constraints - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: container-label - value_type: list - description: Container labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: credential-spec - value_type: credential-spec - description: Credential spec for managed service account (Windows only) - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach - shorthand: d - value_type: bool - default_value: "false" - description: | - Exit immediately instead of waiting for the service to converge - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns - value_type: list - description: Set custom DNS servers - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option - value_type: list - description: Set DNS options - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search - value_type: list - description: Set custom DNS search domains - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: endpoint-mode - value_type: string - default_value: vip - description: Endpoint mode (vip or dnsrr) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: command - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env - shorthand: e - value_type: list - description: Set environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-file - value_type: list - description: Read in a file of environment variables - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: generic-resource - value_type: list - description: User defined resources - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group - value_type: list - description: Set one or more supplementary user groups for the container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - description: Time between running the check (ms|s|m|h) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: health-timeout - value_type: duration - description: Maximum time to allow one check to run (ms|s|m|h) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: host - value_type: list - description: Set one or more custom host-to-IP mappings (host:ip) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - value_type: string - description: Container hostname - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Service container isolation mode - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - shorthand: l - value_type: list - description: Service labels - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: limit-cpu - value_type: decimal - description: Limit CPUs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: limit-memory - value_type: bytes - default_value: "0" - description: Limit Memory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for service - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Logging driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mode - value_type: string - default_value: replicated - description: Service mode (replicated or global) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount - value_type: mount - description: Attach a filesystem mount to the service - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Service name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network - value_type: network - description: Network attachments - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve-image - value_type: bool - default_value: "false" - description: | - Do not query the registry to resolve image digest and supported platforms - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: placement-pref - value_type: pref - description: Add a placement preference - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish - shorthand: p - value_type: port - description: Publish a port as a node port - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress progress output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: replicas - value_type: uint - description: Number of tasks - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: reserve-cpu - value_type: decimal - description: Reserve CPUs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: reserve-memory - value_type: bytes - default_value: "0" - description: Reserve Memory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-condition - value_type: string - description: | - Restart when condition is met ("none"|"on-failure"|"any") (default "any") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-delay - value_type: duration - description: Delay between restart attempts (ns|us|ms|s|m|h) (default 5s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-max-attempts - value_type: uint - description: Maximum number of restarts before giving up - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-window - value_type: duration - description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-delay - value_type: duration - default_value: 0s - description: Delay between task rollbacks (ns|us|ms|s|m|h) (default 0s) - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-failure-action - value_type: string - description: | - Action on rollback failure ("pause"|"continue") (default "pause") - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-max-failure-ratio - value_type: float - default_value: "0" - description: Failure rate to tolerate during a rollback (default 0) - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: secret - value_type: secret - description: Specify secrets to expose to the service - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-grace-period - value_type: duration - description: | - Time to wait before force killing a container (ns|us|ms|s|m|h) (default 10s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - description: Signal to stop the container - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-delay - value_type: duration - default_value: 0s - description: Delay between updates (ns|us|ms|s|m|h) (default 0s) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-failure-action - value_type: string - description: | - Action on update failure ("pause"|"continue"|"rollback") (default "pause") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-max-failure-ratio - value_type: float - default_value: "0" - description: Failure rate to tolerate during an update (default 0) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: with-registry-auth - value_type: bool - default_value: "false" - description: Send registry authentication details to swarm agents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Create a service\n\n```bash\n$ docker service create --name redis redis:3.0.6\n\ndmu1ept4cxcfe8k8lhtux3ro3\n\n$ - docker service create --mode global --name redis2 redis:3.0.6\n\na8q9dasaafudfs8q8w32udass\n\n$ - docker service ls\n\nID NAME MODE REPLICAS IMAGE\ndmu1ept4cxcf - \ redis replicated 1/1 redis:3.0.6\na8q9dasaafud redis2 global 1/1 - \ redis:3.0.6\n```\n\n#### Create a service using an image on a private registry\n\nIf - your image is available on a private registry which requires login, use the\n`--with-registry-auth` - flag with `docker service create`, after logging in. If\nyour image is stored on - `registry.example.com`, which is a private registry, use\na command like the following:\n\n```bash\n$ - docker login registry.example.com\n\n$ docker service create \\\n --with-registry-auth - \\\n --name my_service \\\n registry.example.com/acme/my_image:latest\n```\n\nThis - passes the login token from your local client to the swarm nodes where the\nservice - is deployed, using the encrypted WAL logs. With this information, the\nnodes are - able to log into the registry and pull the image.\n\n### Create a service with 5 - replica tasks (--replicas)\n\nUse the `--replicas` flag to set the number of replica - tasks for a replicated\nservice. The following command creates a `redis` service - with `5` replica tasks:\n\n```bash\n$ docker service create --name redis --replicas=5 - redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nThe above command sets the *desired* - number of tasks for the service. Even\nthough the command returns immediately, actual - scaling of the service may take\nsome time. The `REPLICAS` column shows both the - *actual* and *desired* number\nof replica tasks for the service.\n\nIn the following - example the desired state is `5` replicas, but the current\nnumber of `RUNNING` - tasks is `3`:\n\n```bash\n$ docker service ls\n\nID NAME MODE REPLICAS - \ IMAGE\n4cdgfyky7ozw redis replicated 3/5 redis:3.0.7\n```\n\nOnce all - the tasks are created and `RUNNING`, the actual number of tasks is\nequal to the - desired number:\n\n```bash\n$ docker service ls\n\nID NAME MODE REPLICAS - \ IMAGE\n4cdgfyky7ozw redis replicated 5/5 redis:3.0.7\n```\n\n### Create - a service with secrets\n\nUse the `--secret` flag to give a container access to - a\n[secret](secret_create.md).\n\nCreate a service specifying a secret:\n\n```bash\n$ - docker service create --name redis --secret secret.json redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nCreate - a service specifying the secret, target, user/group ID, and mode:\n\n```bash\n$ - docker service create --name redis \\\n --secret source=ssh-key,target=ssh \\\n - \ --secret source=app-key,target=app,uid=1000,gid=1001,mode=0400 \\\n redis:3.0.6\n\n4cdgfyky7ozwh3htjfw0d12qv\n```\n\nTo - grant a service access to multiple secrets, use multiple `--secret` flags.\n\nSecrets - are located in `/run/secrets` in the container. If no target is\nspecified, the - name of the secret will be used as the in memory file in the\ncontainer. If a target - is specified, that will be the filename. In the\nexample above, two files will - be created: `/run/secrets/ssh` and\n`/run/secrets/app` for each of the secret targets - specified.\n\n### Create a service with a rolling update policy\n\n```bash\n$ docker - service create \\\n --replicas 10 \\\n --name redis \\\n --update-delay 10s \\\n - \ --update-parallelism 2 \\\n redis:3.0.6\n```\n\nWhen you run a [service update](service_update.md), - the scheduler updates a\nmaximum of 2 tasks at a time, with `10s` between updates. - For more information,\nrefer to the [rolling updates\ntutorial](https://docs.docker.com/engine/swarm/swarm-tutorial/rolling-update/).\n\n### - Set environment variables (-e, --env)\n\nThis sets an environmental variable for - all tasks in a service. For example:\n\n```bash\n$ docker service create \\\n --name - redis_2 \\\n --replicas 5 \\\n --env MYVAR=foo \\\n redis:3.0.6\n```\n\nTo specify - multiple environment variables, specify multiple `--env` flags, each\nwith a separate - key-value pair.\n\n```bash\n$ docker service create \\\n --name redis_2 \\\n --replicas - 5 \\\n --env MYVAR=foo \\\n --env MYVAR2=bar \\\n redis:3.0.6\n```\n\n### Create - a service with specific hostname (--hostname)\n\nThis option sets the docker service - containers hostname to a specific string.\nFor example:\n\n```bash\n$ docker service - create --name redis --hostname myredis redis:3.0.6\n```\n\n### Set metadata on a - service (-l, --label)\n\nA label is a `key=value` pair that applies metadata to - a service. To label a\nservice with two labels:\n\n```bash\n$ docker service create - \\\n --name redis_2 \\\n --label com.example.foo=\"bar\"\n --label bar=baz \\\n - \ redis:3.0.6\n```\n\nFor more information about labels, refer to [apply custom\nmetadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).\n\n### - Add bind mounts, volumes or memory filesystems\n\nDocker supports three different - kinds of mounts, which allow containers to read\nfrom or write to files or directories, - either on the host operating system, or\non memory filesystems. These types are - _data volumes_ (often referred to simply\nas volumes), _bind mounts_, and _tmpfs_.\n\nA - **bind mount** makes a file or directory on the host available to the\ncontainer - it is mounted within. A bind mount may be either read-only or\nread-write. For example, - a container might share its host's DNS information by\nmeans of a bind mount of - the host's `/etc/resolv.conf` or a container might\nwrite logs to its host's `/var/log/myContainerLogs` - directory. If you use\nbind mounts and your host and containers have different notions - of permissions,\naccess controls, or other such details, you will run into portability - issues.\n\nA **named volume** is a mechanism for decoupling persistent data needed - by your\ncontainer from the image used to create the container and from the host - machine.\nNamed volumes are created and managed by Docker, and a named volume persists\neven - when no container is currently using it. Data in named volumes can be\nshared between - a container and the host machine, as well as between multiple\ncontainers. Docker - uses a _volume driver_ to create, manage, and mount volumes.\nYou can back up or - restore volumes using Docker commands.\n\nA **tmpfs** mounts a tmpfs inside a container - for volatile data.\n\nConsider a situation where your image starts a lightweight - web server. You could\nuse that image as a base image, copy in your website's HTML - files, and package\nthat into another image. Each time your website changed, you'd - need to update\nthe new image and redeploy all of the containers serving your website. - A better\nsolution is to store the website in a named volume which is attached to - each of\nyour web server containers when they start. To update the website, you - just\nupdate the named volume.\n\nFor more information about named volumes, see\n[Data - Volumes](https://docs.docker.com/engine/tutorials/dockervolumes/).\n\nThe following - table describes options which apply to both bind mounts and named\nvolumes in a - service:\n\n\n \n \n \n \n - \ \n \n \n \n \n \n \n - \ \n \n - \ \n \n \n \n - \ \n \n \n \n \n \n \n - \ \n \n \n \n \n - \ \n
OptionRequiredDescription
types\n

The - type of mount, can be either volume, bind, or tmpfs. - Defaults to volume if no type is specified.\n

    \n
  • volume: - mounts a managed - volume\n into the container.
  • bind:\n bind-mounts - a directory or file from the host into the container.
    • \n
  • tmpfs: - mount a tmpfs in the container
    • \n

\n
src or sourcefor type=bind only>\n
    \n
  • \n type=volume: src - is an optional way to specify the name of the volume (for example, src=my-volume).\n - \ If the named volume does not exist, it is automatically created. If no - src is specified, the volume is\n assigned a random name which - is guaranteed to be unique on the host, but may not be unique cluster-wide.\n A - randomly-named volume has the same lifecycle as its container and is destroyed when - the container\n is destroyed (which is upon service update, - or when scaling or re-balancing the service)\n
    • \n
  • \n type=bind: - src is required, and specifies an absolute path to the file or directory - to bind-mount\n (for example, src=/path/on/host/). An error is - produced if the file or directory does not exist.\n
    • \n
  • \n - \ type=tmpfs: src is not supported.\n
    • \n
\n - \

dst or destination or target

yes\n

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

\n

readonly - or ro

\n

The Engine mounts binds - and volumes read-write unless readonly option\n is given - when mounting the bind or volume.\n

    \n
  • true or 1 - or no value: Mounts the bind or volume read-only.
    • \n
  • false - or 0: Mounts the bind or volume read-write.
    • \n

\n
consistency\n

The - consistency requirements for the mount; one of\n

    \n
  • default: - Equivalent to consistent.
    • \n
  • consistent: Full - consistency. The container runtime and the host maintain an identical view of the - mount at all times.
    • \n
  • cached: The host's view of the - mount is authoritative. There may be delays before updates made on the host are - visible within a container.
    • \n
  • delegated: The container - runtime's view of the mount is authoritative. There may be delays before updates - made in a container are visible on the host.
    • \n
\n

\n
\n\n#### Bind Propagation\n\nBind propagation refers to whether - or not mounts created within a given\nbind mount or named volume can be propagated - to replicas of that mount. Consider\na mount point `/mnt`, which is also mounted - on `/tmp`. The propation settings\ncontrol whether a mount on `/tmp/a` would also - be available on `/mnt/a`. Each\npropagation setting has a recursive counterpoint. - In the case of recursion,\nconsider that `/tmp/a` is also mounted as `/foo`. The - propagation settings\ncontrol whether `/mnt/a` and/or `/tmp/a` would exist.\n\nThe - `bind-propagation` option defaults to `rprivate` for both bind mounts and\nvolume - mounts, and is only configurable for bind mounts. In other words, named\nvolumes - do not support bind propagation.\n\n- **`shared`**: Sub-mounts of the original mount - are exposed to replica mounts,\n and sub-mounts of replica mounts - are also propagated to the\n original mount.\n- **`slave`**: similar - to a shared mount, but only in one direction. If the\n original mount - exposes a sub-mount, the replica mount can see it.\n However, if the - replica mount exposes a sub-mount, the original\n mount cannot see - it.\n- **`private`**: The mount is private. Sub-mounts within it are not exposed - to\n replica mounts, and sub-mounts of replica mounts are not\n - \ exposed to the original mount.\n- **`rshared`**: The same as shared, - but the propagation also extends to and from\n mount points nested - within any of the original or replica mount\n points.\n- **`rslave`**: - The same as `slave`, but the propagation also extends to and from\n mount - points nested within any of the original or replica mount\n points.\n- - **`rprivate`**: The default. The same as `private`, meaning that no mount points\n - \ anywhere within the original or replica mount points propagate\n - \ in either direction.\n\nFor more information about bind propagation, - see the\n[Linux kernel documentation for shared subtree](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt).\n\n#### - Options for Named Volumes\n\nThe following options can only be used for named volumes - (`type=volume`):\n\n\n\n \n \n \n - \ \n \n \n \n \n \n \n \n \n \n \n - \ \n \n \n - \ \n \n \n
OptionDescription
volume-driver\n

Name of the - volume-driver plugin to use for the volume. Defaults to\n \"local\", - to use the local volume driver to create the volume if the\n volume does not - exist.

\n
volume-label\n - \ One or more custom metadata (\"labels\") to apply to the volume upon\n creation. - For example,\n volume-label=mylabel=hello-world,my-other-label=hello-mars. - For more\n information about labels, refer to\n apply - custom metadata.\n
volume-nocopy\n By default, if you attach an empty volume to a container, and files - or\n directories already existed at the mount-path in the container (dst),\n - \ the Engine copies those files and directories into the volume, allowing\n - \ the host to access them. Set volume-nocopy to disable copying files\n - \ from the container's filesystem to the volume and mount the empty volume.
\n\n A value is optional:\n\n
    \n
  • true or 1: - Default if you do not provide a value. Disables copying.
    • \n
  • false - or 0: Enables copying.
    • \n
\n
volume-opt\n Options specific to a given volume - driver, which will be passed to the\n driver when creating the volume. Options - are provided as a comma-separated\n list of key/value pairs, for example,\n - \ volume-opt=some-option=some-value,volume-opt=some-other-option=some-other-value.\n - \ For available options for a given driver, refer to that driver's\n documentation.\n - \
\n\n\n#### Options for tmpfs\n\nThe following options - can only be used for tmpfs mounts (`type=tmpfs`);\n\n\n\n \n \n - \ \n \n \n \n \n \n \n - \ \n \n \n
OptionDescription
tmpfs-sizeSize - of the tmpfs mount in bytes. Unlimited by default in Linux.
tmpfs-modeFile mode of the tmpfs in octal. (e.g. \"700\" - or \"0700\".) Defaults to \"1777\" in Linux.
\n\n\n#### - Differences between \"--mount\" and \"--volume\"\n\nThe `--mount` flag supports - most options that are supported by the `-v`\nor `--volume` flag for `docker run`, - with some important exceptions:\n\n- The `--mount` flag allows you to specify a - volume driver and volume driver\n options *per volume*, without creating the volumes - in advance. In contrast,\n `docker run` allows you to specify a single volume driver - which is shared\n by all volumes, using the `--volume-driver` flag.\n\n- The `--mount` - flag allows you to specify custom metadata (\"labels\") for a volume,\n before - the volume is created.\n\n- When you use `--mount` with `type=bind`, the host-path - must refer to an *existing*\n path on the host. The path will not be created for - you and the service will fail\n with an error if the path does not exist.\n\n- - The `--mount` flag does not allow you to relabel a volume with `Z` or `z` flags,\n - \ which are used for `selinux` labeling.\n\n#### Create a service using a named - volume\n\nThe following example creates a service that uses a named volume:\n\n```bash\n$ - docker service create \\\n --name my-service \\\n --replicas 3 \\\n --mount type=volume,source=my-volume,destination=/path/in/container,volume-label=\"color=red\",volume-label=\"shape=round\" - \\\n nginx:alpine\n```\n\nFor each replica of the service, the engine requests - a volume named \"my-volume\"\nfrom the default (\"local\") volume driver where the - task is deployed. If the\nvolume does not exist, the engine creates a new volume - and applies the \"color\"\nand \"shape\" labels.\n\nWhen the task is started, the - volume is mounted on `/path/in/container/` inside\nthe container.\n\nBe aware that - the default (\"local\") volume is a locally scoped volume driver.\nThis means that - depending on where a task is deployed, either that task gets a\n*new* volume named - \"my-volume\", or shares the same \"my-volume\" with other tasks\nof the same service. - Multiple containers writing to a single shared volume can\ncause data corruption - if the software running inside the container is not\ndesigned to handle concurrent - processes writing to the same location. Also take\ninto account that containers - can be re-scheduled by the Swarm orchestrator and\nbe deployed on a different node.\n\n#### - Create a service that uses an anonymous volume\n\nThe following command creates - a service with three replicas with an anonymous\nvolume on `/path/in/container`:\n\n```bash\n$ - docker service create \\\n --name my-service \\\n --replicas 3 \\\n --mount type=volume,destination=/path/in/container - \\\n nginx:alpine\n```\n\nIn this example, no name (`source`) is specified for - the volume, so a new volume\nis created for each task. This guarantees that each - task gets its own volume,\nand volumes are not shared between tasks. Anonymous volumes - are removed after\nthe task using them is complete.\n\n#### Create a service that - uses a bind-mounted host directory\n\nThe following example bind-mounts a host directory - at `/path/in/container` in\nthe containers backing the service:\n\n```bash\n$ docker - service create \\\n --name my-service \\\n --mount type=bind,source=/path/on/host,destination=/path/in/container - \\\n nginx:alpine\n```\n\n### Set service mode (--mode)\n\nThe service mode determines - whether this is a _replicated_ service or a _global_\nservice. A replicated service - runs as many tasks as specified, while a global\nservice runs on each active node - in the swarm.\n\nThe following command creates a global service:\n\n```bash\n$ docker - service create \\\n --name redis_2 \\\n --mode global \\\n redis:3.0.6\n```\n\n### - Specify service constraints (--constraint)\n\nYou can limit the set of nodes where - a task can be scheduled by defining\nconstraint expressions. Multiple constraints - find nodes that satisfy every\nexpression (AND match). Constraints can match node - or Docker Engine labels as\nfollows:\n\n\n\n \n \n - \ \n \n \n \n \n - \ \n \n \n \n - \ \n \n \n - \ \n \n \n \n \n - \ \n \n \n \n - \ \n \n \n \n - \ \n \n \n
node attributematchesexample
node.idNode IDnode.id==2ivku8v2gvtg4
node.hostnameNode hostnamenode.hostname!=node-2
node.roleNode rolenode.role==manager
node.labelsuser defined node labelsnode.labels.security==high
engine.labelsDocker Engine's labelsengine.labels.operatingsystem==ubuntu - 14.04
\n\n\n`engine.labels` apply to Docker Engine labels - like operating system,\ndrivers, etc. Swarm administrators add `node.labels` for - operational purposes by\nusing the [`docker node update`](node_update.md) command.\n\nFor - example, the following limits tasks for the redis service to nodes where the\nnode - type label equals queue:\n\n```bash\n$ docker service create \\\n --name redis_2 - \\\n --constraint 'node.labels.type == queue' \\\n redis:3.0.6\n```\n\n### Specify - service placement preferences (--placement-pref)\n\nYou can set up the service to - divide tasks evenly over different categories of\nnodes. One example of where this - can be useful is to balance tasks over a set\nof datacenters or availability zones. - The example below illustrates this:\n\n```bash\n$ docker service create \\\n --replicas - 9 \\\n --name redis_2 \\\n --placement-pref 'spread=node.labels.datacenter' \\\n - \ redis:3.0.6\n```\n\nThis uses `--placement-pref` with a `spread` strategy (currently - the only\nsupported strategy) to spread tasks evenly over the values of the `datacenter`\nnode - label. In this example, we assume that every node has a `datacenter` node\nlabel - attached to it. If there are three different values of this label among\nnodes in - the swarm, one third of the tasks will be placed on the nodes\nassociated with each - value. This is true even if there are more nodes with one\nvalue than another. For - example, consider the following set of nodes:\n\n- Three nodes with `node.labels.datacenter=east`\n- - Two nodes with `node.labels.datacenter=south`\n- One node with `node.labels.datacenter=west`\n\nSince - we are spreading over the values of the `datacenter` label and the\nservice has - 9 replicas, 3 replicas will end up in each datacenter. There are\nthree nodes associated - with the value `east`, so each one will get one of the\nthree replicas reserved - for this value. There are two nodes with the value\n`south`, and the three replicas - for this value will be divided between them,\nwith one receiving two replicas and - another receiving just one. Finally, `west`\nhas a single node that will get all - three replicas reserved for `west`.\n\nIf the nodes in one category (for example, - those with\n`node.labels.datacenter=south`) can't handle their fair share of tasks - due to\nconstraints or resource limitations, the extra tasks will be assigned to - other\nnodes instead, if possible.\n\nBoth engine labels and node labels are supported - by placement preferences. The\nexample above uses a node label, because the label - is referenced with\n`node.labels.datacenter`. To spread over the values of an engine - label, use\n`--placement-pref spread=engine.labels.`.\n\nIt is possible - to add multiple placement preferences to a service. This\nestablishes a hierarchy - of preferences, so that tasks are first divided over\none category, and then further - divided over additional categories. One example\nof where this may be useful is - dividing tasks fairly between datacenters, and\nthen splitting the tasks within - each datacenter over a choice of racks. To add\nmultiple placement preferences, - specify the `--placement-pref` flag multiple\ntimes. The order is significant, and - the placement preferences will be applied\nin the order given when making scheduling - decisions.\n\nThe following example sets up a service with multiple placement preferences.\nTasks - are spread first over the various datacenters, and then over racks\n(as indicated - by the respective labels):\n\n```bash\n$ docker service create \\\n --replicas - 9 \\\n --name redis_2 \\\n --placement-pref 'spread=node.labels.datacenter' \\\n - \ --placement-pref 'spread=node.labels.rack' \\\n redis:3.0.6\n```\n\nWhen updating - a service with `docker service update`, `--placement-pref-add`\nappends a new placement - preference after all existing placement preferences.\n`--placement-pref-rm` removes - an existing placement preference that matches the\nargument.\n\n### Attach a service - to an existing network (--network)\n\nYou can use overlay networks to connect one - or more services within the swarm.\n\nFirst, create an overlay network on a manager - node the docker network create\ncommand:\n\n```bash\n$ docker network create --driver - overlay my-network\n\netjpu59cykrptrgw0z0hk5snf\n```\n\nAfter you create an overlay - network in swarm mode, all manager nodes have\naccess to the network.\n\nWhen you - create a service and pass the `--network` flag to attach the service to\nthe overlay - network:\n\n```bash\n$ docker service create \\\n --replicas 3 \\\n --network - my-network \\\n --name my-web \\\n nginx\n\n716thylsndqma81j6kkkb5aus\n```\n\nThe - swarm extends my-network to each node running the service.\n\nContainers on the - same network can access each other using\n[service discovery](https://docs.docker.com/engine/swarm/networking/#use-swarm-mode-service-discovery).\n\nLong - form syntax of `--network` allows to specify list of aliases and driver options: - \ \n`--network name=my-network,alias=web1,driver-opt=field1=value1`\n\n### Publish - service ports externally to the swarm (-p, --publish)\n\nYou can publish service - ports to make them available externally to the swarm\nusing the `--publish` flag. - The `--publish` flag can take two different styles\nof arguments. The short version - is positional, and allows you to specify the\npublished port and target port separated - by a colon.\n\n```bash\n$ docker service create --name my_web --replicas 3 --publish - 8080:80 nginx\n```\n\nThere is also a long format, which is easier to read and allows - you to specify\nmore options. The long format is preferred. You cannot specify the - service's\nmode when using the short format. Here is an example of using the long - format\nfor the same service as above:\n\n```bash\n$ docker service create --name - my_web --replicas 3 --publish published=8080,target=80 nginx\n```\n\nThe options - you can specify are:\n\n\n\n\n \n \n - \ \n \n\n\n\n \n \n \n \n\n\n \n \n \n - \ \n\n\n - \ \n \n \n \n\n
OptionShort syntaxLong syntaxDescription
published - and target port--publish 8080:80--publish - published=8080,target=80

\n The target port within the container - and the port to map it to on the\n nodes, using the routing mesh (ingress) - or host-level networking.\n More options are available, later in this table. - The key-value syntax is\n preferred, because it is somewhat self-documenting.\n - \

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

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

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

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

\n\nWhen you publish a service port using - `ingress` mode, the swarm routing mesh\nmakes the service accessible at the published - port on every node regardless if\nthere is a task for the service running on the - node. If you use `host` mode,\nthe port is only bound on nodes where the service - is running, and a given port\non a node can only be bound once. You can only set - the publication mode using\nthe long syntax. For more information refer to\n[Use - swarm mode routing mesh](https://docs.docker.com/engine/swarm/ingress/).\n\n### - Provide credential specs for managed service accounts (Windows only)\n\nThis option - is only used for services using Windows containers. The\n`--credential-spec` must - be in the format `file://` or\n`registry://`.\n\nWhen using - the `file://` format, the referenced file must be\npresent in the `CredentialSpecs` - subdirectory in the docker data directory,\nwhich defaults to `C:\\ProgramData\\Docker\\` - on Windows. For example,\nspecifying `file://spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.\n\nWhen - using the `registry://` format, the credential spec is\nread from the - Windows registry on the daemon's host. The specified\nregistry value must be located - in:\n\n HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs\n\n\n### - Create services using templates\n\nYou can use templates for some flags of `service - create`, using the syntax\nprovided by the Go's [text/template](http://golang.org/pkg/text/template/) - package.\n\nThe supported flags are the following :\n\n- `--hostname`\n- `--mount`\n- - `--env`\n\nValid placeholders for the Go template are listed below:\n\n\n\n - \ \n \n \n \n \n \n - \ \n \n \n \n - \ \n \n \n \n - \ \n \n \n \n \n \n \n \n \n - \ \n \n \n \n \n - \ \n \n \n \n \n - \ \n \n \n
PlaceholderDescription
.Service.IDService ID
.Service.NameService name
.Service.LabelsService labels
.Node.IDNode - ID
.Node.HostnameNode Hostname
.Task.IDTask ID
.Task.NameTask name
.Task.SlotTask slot
\n\n\n#### - Template example\n\nIn this example, we are going to set the template of the created - containers based on the\nservice's name, the node's ID and hostname where it sits.\n\n```bash\n$ - docker service create --name hosttempl \\\n --hostname=\"{{.Node.Hostname}}-{{.Node.ID}}-{{.Service.Name}}\"\\\n - \ busybox top\n\nva8ew30grofhjoychbr6iot8c\n\n$ docker service - ps va8ew30grofhjoychbr6iot8c\n\nID NAME IMAGE NODE - \ DESIRED STATE CURRENT STATE ERROR PORTS\nwo41w8hg8qan - \ hosttempl.1 busybox:latest@sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912 - \ 2e7a8a9c4da2 Running Running about a minute ago\n\n$ docker inspect --format=\"{{.Config.Hostname}}\" - 2e7a8a9c4da2-wo41w8hg8qanxwjwsg4kxpprj-hosttempl\n\nx3ti0erg11rjpg64m75kej2mz-hosttempl\n```\n\n### - Specify isolation mode (Windows)\n\nBy default, tasks scheduled on Windows nodes - are run using the default isolation mode\nconfigured for this particular node. To - force a specific isolation mode, you can use\nthe `--isolation` flag:\n\n```bash\n$ - docker service create --name myservice --isolation=process microsoft/nanoserver\n```\n\nSupported - isolation modes on Windows are:\n- `default`: use default settings specified on - the node running the task\n- `process`: use process isolation (Windows server only)\n- - `hyperv`: use Hyper-V isolation\n\n### Create services requesting Generic Resources\n\nYou - can narrow the kind of nodes your task can land on through the using the\n`--generic-resource` - flag (if the nodes advertise these resources):\n\n```bash\n$ docker service create - --name cuda \\\n --generic-resource \"NVIDIA-GPU=2\" \\\n - \ --generic-resource \"SSD=1\" \\\n nvidia/cuda\n```" -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_inspect.yaml b/_data/engine-cli-edge/docker_service_inspect.yaml deleted file mode 100644 index 98bd4741b5..0000000000 --- a/_data/engine-cli-edge/docker_service_inspect.yaml +++ /dev/null @@ -1,71 +0,0 @@ -command: docker service inspect -short: Display detailed information on one or more services -long: |- - Inspects the specified service. This command has to be run targeting a manager - node. - - By default, this renders all results in a JSON array. If a format is specified, - the given template will be executed for each result. - - Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. -usage: docker service inspect [OPTIONS] SERVICE [SERVICE...] -pname: docker service -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: pretty - value_type: bool - default_value: "false" - description: Print the information in a human friendly format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Inspect a service by name or ID\n\nYou can inspect a service, either - by its *name*, or *ID*\n\nFor example, given the following service;\n\n```bash\n$ - docker service ls\nID NAME MODE REPLICAS IMAGE\ndmu1ept4cxcf - \ redis replicated 3/3 redis:3.0.6\n```\n\nBoth `docker service inspect - redis`, and `docker service inspect dmu1ept4cxcf`\nproduce the same result:\n\n```none\n$ - docker service inspect redis\n\n[\n {\n \"ID\": \"dmu1ept4cxcfe8k8lhtux3ro3\",\n - \ \"Version\": {\n \"Index\": 12\n },\n \"CreatedAt\": - \"2016-06-17T18:44:02.558012087Z\",\n \"UpdatedAt\": \"2016-06-17T18:44:02.558012087Z\",\n - \ \"Spec\": {\n \"Name\": \"redis\",\n \"TaskTemplate\": - {\n \"ContainerSpec\": {\n \"Image\": \"redis:3.0.6\"\n - \ },\n \"Resources\": {\n \"Limits\": - {},\n \"Reservations\": {}\n },\n \"RestartPolicy\": - {\n \"Condition\": \"any\",\n \"MaxAttempts\": - 0\n },\n \"Placement\": {}\n },\n \"Mode\": - {\n \"Replicated\": {\n \"Replicas\": 1\n }\n - \ },\n \"UpdateConfig\": {},\n \"EndpointSpec\": - {\n \"Mode\": \"vip\"\n }\n },\n \"Endpoint\": - {\n \"Spec\": {}\n }\n }\n]\n```\n\n```bash\n$ docker service - inspect dmu1ept4cxcf\n\n[\n {\n \"ID\": \"dmu1ept4cxcfe8k8lhtux3ro3\",\n - \ \"Version\": {\n \"Index\": 12\n },\n ...\n }\n]\n```\n\n### - Formatting\n\nYou can print the inspect output in a human-readable format instead - of the default\nJSON output, by using the `--pretty` option:\n\n```bash\n$ docker - service inspect --pretty frontend\n\nID:\t\tc8wgl7q4ndfd52ni6qftkvnnp\nName:\t\tfrontend\nLabels:\n - - org.example.projectname=demo-app\nService Mode:\tREPLICATED\n Replicas:\t\t5\nPlacement:\nUpdateConfig:\n - Parallelism:\t0\n On failure:\tpause\n Max failure ratio:\t0\nContainerSpec:\n Image:\t\tnginx:alpine\nResources:\nNetworks:\tnet1\nEndpoint - Mode: vip\nPorts:\n PublishedPort = 4443\n Protocol = tcp\n TargetPort = 443\n - \ PublishMode = ingress\n```\n\nYou can also use `--format pretty` for the same - effect.\n\n\n#### Find the number of tasks running as part of a service\n\nThe `--format` - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_logs.yaml b/_data/engine-cli-edge/docker_service_logs.yaml deleted file mode 100644 index d6a75a07bb..0000000000 --- a/_data/engine-cli-edge/docker_service_logs.yaml +++ /dev/null @@ -1,139 +0,0 @@ -command: docker service logs -short: Fetch the logs of a service or task -long: |- - The `docker service logs` command batch-retrieves logs present at the time of execution. - - The `docker service logs` command can be used with either the name or ID of a - service, or with the ID of a task. If a service is passed, it will display logs - for all of the containers in that service. If a task is passed, it will only - display logs from that particular task. - - > **Note**: This command is only functional for services that are started with - > the `json-file` or `journald` logging driver. - - For more information about selecting and configuring logging drivers, refer to - [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/). - - The `docker service logs --follow` command will continue streaming the new output from - the service's `STDOUT` and `STDERR`. - - Passing a negative number or a non-integer to `--tail` is invalid and the - value is set to `all` in that case. - - The `docker service logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) - , for example `2014-09-16T06:17:46.000000000Z`, to each - log entry. To ensure that the timestamps are aligned the - nano-second part of the timestamp will be padded with zero when necessary. - - The `docker service logs --details` command will add on extra attributes, such as - environment variables and labels, provided to `--log-opt` when creating the - service. - - The `--since` option shows only the service logs generated after - a given date. You can specify the date as an RFC 3339 date, a UNIX - timestamp, or a Go duration string (e.g. `1m30s`, `3h`). Besides RFC3339 date - format you may also use RFC3339Nano, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the client will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. You can combine the - `--since` option with either or both of the `--follow` or `--tail` options. -usage: docker service logs [OPTIONS] SERVICE|TASK -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: follow - shorthand: f - value_type: bool - default_value: "false" - description: Follow log output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve - value_type: bool - default_value: "false" - description: Do not map IDs to Names in output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-task-ids - value_type: bool - default_value: "false" - description: Do not include task IDs in output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: raw - value_type: bool - default_value: "false" - description: Do not neatly format logs - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: since - value_type: string - description: | - Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tail - value_type: string - default_value: all - description: Number of lines to show from the end of the logs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: timestamps - shorthand: t - value_type: bool - default_value: "false" - description: Show timestamps - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.29" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_ls.yaml b/_data/engine-cli-edge/docker_service_ls.yaml deleted file mode 100644 index 0407b5088f..0000000000 --- a/_data/engine-cli-edge/docker_service_ls.yaml +++ /dev/null @@ -1,160 +0,0 @@ -command: docker service ls -aliases: list -short: List services -long: |- - This command when run targeting a manager, lists services are running in the - swarm. -usage: docker service ls [OPTIONS] -pname: docker service -plink: docker_service.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print services using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - On a manager node: - - ```bash - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - c8wgl7q4ndfd frontend replicated 5/5 nginx:alpine - dmu1ept4cxcf redis replicated 3/3 redis:3.0.6 - iwe3278osahj mongo global 7/7 mongo:3.3 - ``` - - The `REPLICAS` column shows both the *actual* and *desired* number of tasks for - the service. - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * [id](service_ls.md#id) - * [label](service_ls.md#label) - * [mode](service_ls.md#mode) - * [name](service_ls.md#name) - - #### id - - The `id` filter matches all or part of a service's id. - - ```bash - $ docker service ls -f "id=0bcjw" - ID NAME MODE REPLICAS IMAGE - 0bcjwfh8ychr redis replicated 1/1 redis:3.0.6 - ``` - - #### label - - The `label` filter matches services based on the presence of a `label` alone or - a `label` and a value. - - The following filter matches all services with a `project` label regardless of - its value: - - ```bash - $ docker service ls --filter label=project - ID NAME MODE REPLICAS IMAGE - 01sl1rp6nj5u frontend2 replicated 1/1 nginx:alpine - 36xvvwwauej0 frontend replicated 5/5 nginx:alpine - 74nzcxxjv6fq backend replicated 3/3 redis:3.0.6 - ``` - - The following filter matches only services with the `project` label with the - `project-a` value. - - ```bash - $ docker service ls --filter label=project=project-a - ID NAME MODE REPLICAS IMAGE - 36xvvwwauej0 frontend replicated 5/5 nginx:alpine - 74nzcxxjv6fq backend replicated 3/3 redis:3.0.6 - ``` - - #### mode - - The `mode` filter matches on the mode (either `replicated` or `global`) of a service. - - The following filter matches only `global` services. - - ```bash - $ docker service ls --filter mode=global - ID NAME MODE REPLICAS IMAGE - w7y0v2yrn620 top global 1/1 busybox - ``` - - #### name - - The `name` filter matches on all or part of a service's name. - - The following filter matches services with a name containing `redis`. - - ```bash - $ docker service ls --filter name=redis - ID NAME MODE REPLICAS IMAGE - 0bcjwfh8ychr redis replicated 1/1 redis:3.0.6 - ``` - - ### Formatting - - The formatting options (`--format`) pretty-prints services output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ------------|------------------------------------------------------------------------------------------ - `.ID` | Service ID - `.Name` | Service name - `.Mode` | Service mode (replicated, global) - `.Replicas` | Service replicas - `.Image` | Service image - `.Ports` | Service ports published in ingress mode - - When using the `--format` option, the `service ls` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `ID`, `Mode`, and `Replicas` entries separated by a colon for all services: - - ```bash - $ docker service ls --format "{{.ID}}: {{.Mode}} {{.Replicas}}" - - 0zmvwuiu3vue: replicated 10/10 - fm6uf97exkul: global 5/5 - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_ps.yaml b/_data/engine-cli-edge/docker_service_ps.yaml deleted file mode 100644 index 1b61790b9d..0000000000 --- a/_data/engine-cli-edge/docker_service_ps.yaml +++ /dev/null @@ -1,207 +0,0 @@ -command: docker service ps -short: List the tasks of one or more services -long: |- - Lists the tasks that are running as part of the specified services. This command - has to be run targeting a manager node. -usage: docker service ps [OPTIONS] SERVICE [SERVICE...] -pname: docker service -plink: docker_service.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print tasks using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve - value_type: bool - default_value: "false" - description: Do not map IDs to Names - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display task IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### List the tasks that are part of a service - - The following command shows all the tasks that are part of the `redis` service: - - ```bash - $ docker service ps redis - - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - 0qihejybwf1x redis.1 redis:3.0.5 manager1 Running Running 8 seconds - bk658fpbex0d redis.2 redis:3.0.5 worker2 Running Running 9 seconds - 5ls5s5fldaqg redis.3 redis:3.0.5 worker1 Running Running 9 seconds - 8ryt076polmc redis.4 redis:3.0.5 worker1 Running Running 9 seconds - 1x0v8yomsncd redis.5 redis:3.0.5 manager1 Running Running 8 seconds - 71v7je3el7rr redis.6 redis:3.0.5 worker2 Running Running 9 seconds - 4l3zm9b7tfr7 redis.7 redis:3.0.5 worker2 Running Running 9 seconds - 9tfpyixiy2i7 redis.8 redis:3.0.5 worker1 Running Running 9 seconds - 3w1wu13yupln redis.9 redis:3.0.5 manager1 Running Running 8 seconds - 8eaxrb2fqpbn redis.10 redis:3.0.5 manager1 Running Running 8 seconds - ``` - - In addition to _running_ tasks, the output also shows the task history. For - example, after updating the service to use the `redis:3.0.6` image, the output - may look like this: - - ```bash - $ docker service ps redis - - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - 50qe8lfnxaxk redis.1 redis:3.0.6 manager1 Running Running 6 seconds ago - ky2re9oz86r9 \_ redis.1 redis:3.0.5 manager1 Shutdown Shutdown 8 seconds ago - 3s46te2nzl4i redis.2 redis:3.0.6 worker2 Running Running less than a second ago - nvjljf7rmor4 \_ redis.2 redis:3.0.6 worker2 Shutdown Rejected 23 seconds ago "No such image: redis@sha256:6…" - vtiuz2fpc0yb \_ redis.2 redis:3.0.5 worker2 Shutdown Shutdown 1 second ago - jnarweeha8x4 redis.3 redis:3.0.6 worker1 Running Running 3 seconds ago - vs448yca2nz4 \_ redis.3 redis:3.0.5 worker1 Shutdown Shutdown 4 seconds ago - jf1i992619ir redis.4 redis:3.0.6 worker1 Running Running 10 seconds ago - blkttv7zs8ee \_ redis.4 redis:3.0.5 worker1 Shutdown Shutdown 11 seconds ago - ``` - - The number of items in the task history is determined by the - `--task-history-limit` option that was set when initializing the swarm. You can - change the task history retention limit using the - [`docker swarm update`](swarm_update.md) command. - - When deploying a service, docker resolves the digest for the service's - image, and pins the service to that digest. The digest is not shown by - default, but is printed if `--no-trunc` is used. The `--no-trunc` option - also shows the non-truncated task ID, and error-messages, as can be seen below; - - ```bash - $ docker service ps --no-trunc redis - - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - 50qe8lfnxaxksi9w2a704wkp7 redis.1 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 manager1 Running Running 5 minutes ago - ky2re9oz86r9556i2szb8a8af \_ redis.1 redis:3.0.5@sha256:f8829e00d95672c48c60f468329d6693c4bdd28d1f057e755f8ba8b40008682e worker2 Shutdown Shutdown 5 minutes ago - bk658fpbex0d57cqcwoe3jthu redis.2 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 worker2 Running Running 5 seconds - nvjljf7rmor4htv7l8rwcx7i7 \_ redis.2 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 worker2 Shutdown Rejected 5 minutes ago "No such image: redis@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842" - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there - is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). - Multiple filter flags are combined as an `OR` filter. For example, - `-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks. - - The currently supported filters are: - - * [id](#id) - * [name](#name) - * [node](#node) - * [desired-state](#desired-state) - - - #### id - - The `id` filter matches on all or a prefix of a task's ID. - - ```bash - $ docker service ps -f "id=8" redis - - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - 8ryt076polmc redis.4 redis:3.0.6 worker1 Running Running 9 seconds - 8eaxrb2fqpbn redis.10 redis:3.0.6 manager1 Running Running 8 seconds - ``` - - #### name - - The `name` filter matches on task names. - - ```bash - $ docker service ps -f "name=redis.1" redis - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - qihejybwf1x5 redis.1 redis:3.0.6 manager1 Running Running 8 seconds - ``` - - - #### node - - The `node` filter matches on a node name or a node ID. - - ```bash - $ docker service ps -f "node=manager1" redis - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - 0qihejybwf1x redis.1 redis:3.0.6 manager1 Running Running 8 seconds - 1x0v8yomsncd redis.5 redis:3.0.6 manager1 Running Running 8 seconds - 3w1wu13yupln redis.9 redis:3.0.6 manager1 Running Running 8 seconds - 8eaxrb2fqpbn redis.10 redis:3.0.6 manager1 Running Running 8 seconds - ``` - - #### desired-state - - The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`. - - ### Formatting - - The formatting options (`--format`) pretty-prints tasks output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ----------------|------------------------------------------------------------------------------------------ - `.ID` | Task ID - `.Name` | Task name - `.Image` | Task image - `.Node` | Node ID - `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`) - `.CurrentState` | Current state of the task - `.Error` | Error - `.Ports` | Task published ports - - When using the `--format` option, the `service ps` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Name` and `Image` entries separated by a colon for all tasks: - - ```bash - $ docker service ps --format "{{.Name}}: {{.Image}}" top - top.1: busybox - top.2: busybox - top.3: busybox - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_rm.yaml b/_data/engine-cli-edge/docker_service_rm.yaml deleted file mode 100644 index 8d1e623d94..0000000000 --- a/_data/engine-cli-edge/docker_service_rm.yaml +++ /dev/null @@ -1,31 +0,0 @@ -command: docker service rm -aliases: remove -short: Remove one or more services -long: |- - Removes the specified services from the swarm. This command has to be run - targeting a manager node. -usage: docker service rm SERVICE [SERVICE...] -pname: docker service -plink: docker_service.yaml -examples: |- - Remove the `redis` service: - - ```bash - $ docker service rm redis - - redis - - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - ``` - - > **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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_rollback.yaml b/_data/engine-cli-edge/docker_service_rollback.yaml deleted file mode 100644 index 29e80c391e..0000000000 --- a/_data/engine-cli-edge/docker_service_rollback.yaml +++ /dev/null @@ -1,87 +0,0 @@ -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: "false" - description: | - Exit immediately instead of waiting for the service to converge - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress progress output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_scale.yaml b/_data/engine-cli-edge/docker_service_scale.yaml deleted file mode 100644 index f1208dbc24..0000000000 --- a/_data/engine-cli-edge/docker_service_scale.yaml +++ /dev/null @@ -1,90 +0,0 @@ -command: docker service scale -short: Scale one or multiple replicated services -long: |- - The scale command enables you to scale one or more replicated services either up - or down to the desired number of replicas. This command cannot be applied on - services which are global mode. The command will return immediately, but the - actual scaling of the service may take some time. To stop all replicas of a - service while keeping the service active in the swarm you can set the scale to 0. -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: "false" - description: | - Exit immediately instead of waiting for the service to converge - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Scale a single service - - The following command scales the "frontend" service to 50 tasks. - - ```bash - $ docker service scale frontend=50 - - frontend scaled to 50 - ``` - - The following command tries to scale a global service to 10 tasks and returns an error. - - ```bash - $ docker service create --mode global --name backend backend:latest - - b4g08uwuairexjub6ome6usqh - - $ docker service scale backend=10 - - backend: scale can only be used with replicated mode - ``` - - Directly afterwards, run `docker service ls`, to see the actual number of - replicas. - - ```bash - $ docker service ls --filter name=frontend - - ID NAME MODE REPLICAS IMAGE - 3pr5mlvu3fh9 frontend replicated 15/50 nginx:alpine - ``` - - You can also scale a service using the [`docker service update`](service_update.md) - command. The following commands are equivalent: - - ```bash - $ docker service scale frontend=50 - $ docker service update --replicas=50 frontend - ``` - - ### Scale multiple services - - The `docker service scale` command allows you to set the desired number of - tasks for multiple services at once. The following example scales both the - backend and frontend services: - - ```bash - $ docker service scale backend=3 frontend=5 - - backend scaled to 3 - frontend scaled to 5 - - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_service_update.yaml b/_data/engine-cli-edge/docker_service_update.yaml deleted file mode 100644 index 2769d0c3e2..0000000000 --- a/_data/engine-cli-edge/docker_service_update.yaml +++ /dev/null @@ -1,920 +0,0 @@ -command: docker service update -short: Update a service -long: |- - Updates a service as described by the specified parameters. This command has to be run targeting a manager node. - The parameters are the same as [`docker service create`](service_create.md). Please look at the description there - for further information. - - Normally, updating a service will only cause the service's tasks to be replaced with new ones if a change to the - service requires recreating the tasks for it to take effect. For example, only changing the - `--update-parallelism` setting will not recreate the tasks, because the individual tasks are not affected by this - setting. However, the `--force` flag will cause the tasks to be recreated anyway. This can be used to perform a - rolling restart without any changes to the service parameters. -usage: docker service update [OPTIONS] SERVICE -pname: docker service -plink: docker_service.yaml -options: -- option: args - value_type: command - description: Service command args - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: config-add - value_type: config - description: Add or update a config file on a service - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: config-rm - value_type: list - description: Remove a configuration file - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: constraint-add - value_type: list - description: Add or update a placement constraint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: constraint-rm - value_type: list - description: Remove a constraint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: container-label-add - value_type: list - description: Add or update a container label - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: container-label-rm - value_type: list - description: Remove a container label by its key - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: credential-spec - value_type: credential-spec - description: Credential spec for managed service account (Windows only) - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach - shorthand: d - value_type: bool - default_value: "false" - description: | - Exit immediately instead of waiting for the service to converge - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-add - value_type: list - description: Add or update a custom DNS server - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option-add - value_type: list - description: Add or update a DNS option - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-option-rm - value_type: list - description: Remove a DNS option - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-rm - value_type: list - description: Remove a custom DNS server - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search-add - value_type: list - description: Add or update a custom DNS search domain - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dns-search-rm - value_type: list - description: Remove a DNS search domain - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: endpoint-mode - value_type: string - description: Endpoint mode (vip or dnsrr) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: entrypoint - value_type: command - description: Overwrite the default ENTRYPOINT of the image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-add - value_type: list - description: Add or update an environment variable - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: env-rm - value_type: list - description: Remove an environment variable - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force - value_type: bool - default_value: "false" - description: Force update even if no changes require it - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: generic-resource-add - value_type: list - description: Add a Generic resource - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: generic-resource-rm - value_type: list - description: Remove a Generic resource - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-add - value_type: list - description: Add an additional supplementary user group to the container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: group-rm - value_type: list - description: | - Remove a previously added supplementary user group from the container - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-cmd - value_type: string - description: Command to run to check health - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-interval - value_type: duration - description: Time between running the check (ms|s|m|h) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: health-retries - value_type: int - default_value: "0" - description: Consecutive failures needed to report unhealthy - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: health-timeout - value_type: duration - description: Maximum time to allow one check to run (ms|s|m|h) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: host-add - value_type: list - description: Add a custom host-to-IP mapping (host:ip) - deprecated: false - min_api_version: "1.32" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: host-rm - value_type: list - description: Remove a custom host-to-IP mapping (host:ip) - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: hostname - value_type: string - description: Container hostname - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: image - value_type: string - description: Service image tag - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: isolation - value_type: string - description: Service container isolation mode - deprecated: false - min_api_version: "1.35" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-add - value_type: list - description: Add or update a service label - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label-rm - value_type: list - description: Remove a label by its key - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: limit-cpu - value_type: decimal - description: Limit CPUs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: limit-memory - value_type: bytes - default_value: "0" - description: Limit Memory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-driver - value_type: string - description: Logging driver for service - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: log-opt - value_type: list - description: Logging driver options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount-add - value_type: mount - description: Add or update a mount on a service - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: mount-rm - value_type: list - description: Remove a mount by its target path - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-add - value_type: network - description: Add a network - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: network-rm - value_type: list - description: Remove a network - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-healthcheck - value_type: bool - default_value: "false" - description: Disable any container-specified HEALTHCHECK - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve-image - value_type: bool - default_value: "false" - description: | - Do not query the registry to resolve image digest and supported platforms - deprecated: false - min_api_version: "1.30" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: placement-pref-add - value_type: pref - description: Add a placement preference - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: placement-pref-rm - value_type: pref - description: Remove a placement preference - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-add - value_type: port - description: Add or update a published port - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: publish-rm - value_type: port - description: Remove a published port by its target port - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress progress output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: read-only - value_type: bool - default_value: "false" - description: Mount the container's root filesystem as read only - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: replicas - value_type: uint - description: Number of tasks - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: reserve-cpu - value_type: decimal - description: Reserve CPUs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: reserve-memory - value_type: bytes - default_value: "0" - description: Reserve Memory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-condition - value_type: string - description: Restart when condition is met ("none"|"on-failure"|"any") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-delay - value_type: duration - description: Delay between restart attempts (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-max-attempts - value_type: uint - description: Maximum number of restarts before giving up - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart-window - value_type: duration - description: Window used to evaluate the restart policy (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback - value_type: bool - default_value: "false" - description: Rollback to previous specification - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-failure-action - value_type: string - description: Action on rollback failure ("pause"|"continue") - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-max-failure-ratio - value_type: float - default_value: "0" - description: Failure rate to tolerate during a rollback - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-order - value_type: string - description: Rollback order ("start-first"|"stop-first") - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rollback-parallelism - value_type: uint64 - default_value: "0" - description: | - Maximum number of tasks rolled back simultaneously (0 to roll back all at once) - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: secret-add - value_type: secret - description: Add or update a secret on a service - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: secret-rm - value_type: list - description: Remove a secret - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-grace-period - value_type: duration - description: | - Time to wait before force killing a container (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: stop-signal - value_type: string - description: Signal to stop the container - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: tty - shorthand: t - value_type: bool - default_value: "false" - description: Allocate a pseudo-TTY - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-delay - value_type: duration - default_value: 0s - description: Delay between updates (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-failure-action - value_type: string - description: Action on update failure ("pause"|"continue"|"rollback") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-max-failure-ratio - value_type: float - default_value: "0" - description: Failure rate to tolerate during an update - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: update-order - value_type: string - description: Update order ("start-first"|"stop-first") - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: update-parallelism - value_type: uint64 - default_value: "0" - description: | - Maximum number of tasks updated simultaneously (0 to update all at once) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: user - shorthand: u - value_type: string - description: 'Username or UID (format: [:])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: with-registry-auth - value_type: bool - default_value: "false" - description: Send registry authentication details to swarm agents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: workdir - shorthand: w - value_type: string - description: Working directory inside the container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Update a service - - ```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 - ``` - - ### Add or remove published service ports - - Use the `--publish-add` or `--publish-rm` flags to add or remove a published - port for a service. You can use the short or long syntax discussed in the - [docker service create](service_create/#publish-service-ports-externally-to-the-swarm) - reference. - - The following example adds a published service port to an existing service. - - ```bash - $ docker service update \ - --publish-add published=8080,target=80 \ - myservice - ``` - - ### Add or remove network - - Use the `--network-add` or `--network-rm` flags to add or remove a network for - a service. You can use the short or long syntax discussed in the - [docker service create](service_create/#attach-a-service-to-an-existing-network-network) - reference. - - The following example adds a new alias name to an existing service already connected to network my-network: - - ```bash - $ docker service update \ - --network-rm my-network \ - --network-add name=my-network,alias=web1 \ - myservice - ``` - - ### Roll back to the previous version of a service - - Use the `--rollback` option to roll back to the previous version of the service. - - 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. - - - ### Specify isolation mode (Windows) - - `service update` supports the same `--isolation` flag as `service create` - See [`service create`](./service_create.md) for the reference. -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack.yaml b/_data/engine-cli-edge/docker_stack.yaml deleted file mode 100644 index ed80ae2518..0000000000 --- a/_data/engine-cli-edge/docker_stack.yaml +++ /dev/null @@ -1,43 +0,0 @@ -command: docker stack -short: Manage Docker stacks -long: Manage stacks. -usage: docker stack -pname: docker -plink: docker.yaml -cname: -- docker stack deploy -- docker stack ls -- docker stack ps -- docker stack rm -- docker stack services -clink: -- docker_stack_deploy.yaml -- docker_stack_ls.yaml -- docker_stack_ps.yaml -- docker_stack_rm.yaml -- docker_stack_services.yaml -options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack_deploy.yaml b/_data/engine-cli-edge/docker_stack_deploy.yaml deleted file mode 100644 index 270f677c74..0000000000 --- a/_data/engine-cli-edge/docker_stack_deploy.yaml +++ /dev/null @@ -1,181 +0,0 @@ -command: docker stack deploy -aliases: up -short: Deploy a new stack or update an existing stack -long: |- - Create and update a stack from a `compose` or a `dab` file on the swarm. This command - has to be run targeting a manager node. -usage: docker stack deploy [OPTIONS] STACK -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 - experimentalcli: false - kubernetes: false - swarm: true -- option: compose-file - shorthand: c - value_type: stringSlice - default_value: '[]' - description: Path to a Compose file - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: prune - value_type: bool - default_value: "false" - description: Prune services that are no longer referenced - deprecated: false - min_api_version: "1.27" - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -- 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 - experimentalcli: false - kubernetes: false - swarm: true -- option: with-registry-auth - value_type: bool - default_value: "false" - description: Send registry authentication details to Swarm agents - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -inherited_options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - ### Compose file - - The `deploy` command supports compose file version `3.0` and above. - - ```bash - $ docker stack deploy --compose-file docker-compose.yml 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 - ``` - - 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 - ``` - - If your configuration is split between multiple Compose files, e.g. a base - configuration and environment-specific overrides, you can provide multiple - `--compose-file` flags. - - ```bash - $ docker stack deploy --compose-file docker-compose.yml -c docker-compose.prod.yml 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 - ``` - - You can verify that the services were correctly created: - - ```bash - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - 29bv0vnlm903 vossibility_lookupd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4awt47624qwh vossibility_nsqd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4tjx9biia6fs vossibility_elasticsearch replicated 1/1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa - 7563uuzr9eys vossibility_kibana replicated 1/1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03 - 9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe - axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba - ``` - - ### DAB file - - ```bash - $ docker stack deploy --bundle-file vossibility-stack.dab vossibility - - Loading bundle from vossibility-stack.dab - Creating service vossibility_elasticsearch - Creating service vossibility_kibana - Creating service vossibility_logstash - Creating service vossibility_lookupd - Creating service vossibility_nsqd - Creating service vossibility_vossibility-collector - ``` - - You can verify that the services were correctly created: - - ```bash - $ docker service ls - - ID NAME MODE REPLICAS IMAGE - 29bv0vnlm903 vossibility_lookupd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4awt47624qwh vossibility_nsqd replicated 1/1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 - 4tjx9biia6fs vossibility_elasticsearch replicated 1/1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa - 7563uuzr9eys vossibility_kibana replicated 1/1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03 - 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 -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack_ls.yaml b/_data/engine-cli-edge/docker_stack_ls.yaml deleted file mode 100644 index 830b1d16a1..0000000000 --- a/_data/engine-cli-edge/docker_stack_ls.yaml +++ /dev/null @@ -1,75 +0,0 @@ -command: docker stack ls -aliases: list -short: List stacks -long: Lists the stacks. -usage: docker stack ls -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 - experimentalcli: false - kubernetes: false - swarm: false -inherited_options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - The following command shows all stacks and some additional information: - - ```bash - $ docker stack ls - - ID SERVICES - vossibility-stack 6 - myapp 2 - ``` - - ### Formatting - - The formatting option (`--format`) pretty-prints stacks using a Go template. - - Valid placeholders for the Go template are listed below: - - | Placeholder | Description | - | ----------- | ------------------ | - | `.Name` | Stack name | - | `.Services` | Number of services | - - When using the `--format` option, the `stack ls` command either outputs - the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Name` and `Services` entries separated by a colon for all stacks: - - ```bash - $ docker stack ls --format "{{.Name}}: {{.Services}}" - web-server: 1 - web-cache: 4 - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack_ps.yaml b/_data/engine-cli-edge/docker_stack_ps.yaml deleted file mode 100644 index 843816ca78..0000000000 --- a/_data/engine-cli-edge/docker_stack_ps.yaml +++ /dev/null @@ -1,265 +0,0 @@ -command: docker stack ps -short: List the tasks in the stack -long: |- - Lists the tasks that are running as part of the specified stack. This - command has to be run targeting a manager node. -usage: docker stack ps [OPTIONS] STACK -pname: docker stack -plink: docker_stack.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -- option: format - value_type: string - description: Pretty-print tasks using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-resolve - value_type: bool - default_value: "false" - description: Do not map IDs to Names - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display task IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -inherited_options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - ### List the tasks that are part of a stack - - The following command shows all the tasks that are part of the `voting` stack: - - ```bash - $ docker stack ps voting - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - xim5bcqtgk1b voting_worker.1 dockersamples/examplevotingapp_worker:latest node2 Running Running 2 minutes ago - q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 2 minutes ago - rx5yo0866nfx voting_vote.1 dockersamples/examplevotingapp_vote:before node3 Running Running 2 minutes ago - tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 2 minutes ago - w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 3 minutes ago - 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 2 minutes ago - kqgdmededccb voting_vote.2 dockersamples/examplevotingapp_vote:before node2 Running Running 2 minutes ago - t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 3 minutes ago - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there - is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). - Multiple filter flags are combined as an `OR` filter. For example, - `-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks. - - The currently supported filters are: - - * [id](#id) - * [name](#name) - * [node](#node) - * [desired-state](#desired-state) - - #### id - - The `id` filter matches on all or a prefix of a task's ID. - - ```bash - $ docker stack ps -f "id=t" voting - ID NAME IMAGE NODE DESIRED STATE CURRENTSTATE ERROR PORTS - tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 14 minutes ago - t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 14 minutes ago - ``` - - #### name - - The `name` filter matches on task names. - - ```bash - $ docker stack ps -f "name=voting_redis" voting - ID NAME IMAGE NODE DESIRED STATE CURRENTSTATE ERROR PORTS - w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 17 minutes ago - t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 17 minutes ago - ``` - - #### node - - The `node` filter matches on a node name or a node ID. - - ```bash - $ docker stack ps -f "node=node1" voting - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 18 minutes ago - tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 18 minutes ago - 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 18 minutes ago - ``` - - #### desired-state - - The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`. - - ```bash - $ docker stack ps -f "desired-state=running" voting - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - xim5bcqtgk1b voting_worker.1 dockersamples/examplevotingapp_worker:latest node2 Running Running 21 minutes ago - q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 21 minutes ago - rx5yo0866nfx voting_vote.1 dockersamples/examplevotingapp_vote:before node3 Running Running 21 minutes ago - tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 21 minutes ago - w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 21 minutes ago - 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 21 minutes ago - kqgdmededccb voting_vote.2 dockersamples/examplevotingapp_vote:before node2 Running Running 21 minutes ago - t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 21 minutes ago - ``` - - ### Formatting - - The formatting options (`--format`) pretty-prints tasks output using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ----------------|------------------------------------------------------------------------------------------ - `.ID` | Task ID - `.Name` | Task name - `.Image` | Task image - `.Node` | Node ID - `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`) - `.CurrentState` | Current state of the task - `.Error` | Error - `.Ports` | Task published ports - - When using the `--format` option, the `stack ps` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Name` and `Image` entries separated by a colon for all tasks: - - ```bash - $ docker stack ps --format "{{.Name}}: {{.Image}}" voting - voting_worker.1: dockersamples/examplevotingapp_worker:latest - voting_result.1: dockersamples/examplevotingapp_result:before - voting_vote.1: dockersamples/examplevotingapp_vote:before - voting_db.1: postgres:9.4 - voting_redis.1: redis:alpine - voting_visualizer.1: dockersamples/visualizer:stable - voting_vote.2: dockersamples/examplevotingapp_vote:before - voting_redis.2: redis:alpine - ``` - - ### Do not map IDs to Names - - The `--no-resolve` option shows IDs for task name, without mapping IDs to Names. - - ```bash - $ docker stack ps --no-resolve voting - ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS - xim5bcqtgk1b 10z9fjfqzsxnezo4hb81p8mqg.1 dockersamples/examplevotingapp_worker:latest qaqt4nrzo775jrx6detglho01 Running Running 30 minutes ago - q7yik0ks1in6 hbxltua1na7mgqjnidldv5m65.1 dockersamples/examplevotingapp_result:before mxpaef1tlh23s052erw88a4w5 Running Running 30 minutes ago - rx5yo0866nfx qyprtqw1g5nrki557i974ou1d.1 dockersamples/examplevotingapp_vote:before kanqcxfajd1r16wlnqcblobmm Running Running 31 minutes ago - tz6j82jnwrx7 122f0xxngg17z52be7xspa72x.1 postgres:9.4 mxpaef1tlh23s052erw88a4w5 Running Running 31 minutes ago - w48spazhbmxc tg61x8myx563ueo3urmn1ic6m.1 redis:alpine qaqt4nrzo775jrx6detglho01 Running Running 31 minutes ago - 6jj1m02freg1 8cqlyi444kzd3panjb7edh26v.1 dockersamples/visualizer:stable mxpaef1tlh23s052erw88a4w5 Running Running 31 minutes ago - kqgdmededccb qyprtqw1g5nrki557i974ou1d.2 dockersamples/examplevotingapp_vote:before qaqt4nrzo775jrx6detglho01 Running Running 31 minutes ago - t72q3z038jeh tg61x8myx563ueo3urmn1ic6m.2 redis:alpine kanqcxfajd1r16wlnqcblobmm Running Running 31 minutes ago - ``` - - ### Do not truncate output - - When deploying a service, docker resolves the digest for the service's - image, and pins the service to that digest. The digest is not shown by - default, but is printed if `--no-trunc` is used. The `--no-trunc` option - also shows the non-truncated task IDs, and error-messages, as can be seen below: - - ```bash - $ docker stack ps --no-trunc voting - ID NAME IMAGE NODE DESIRED STATE CURREN STATE ERROR PORTS - xim5bcqtgk1bxqz91jzo4a1s5 voting_worker.1 dockersamples/examplevotingapp_worker:latest@sha256:3e4ddf59c15f432280a2c0679c4fc5a2ee5a797023c8ef0d3baf7b1385e9fed node2 Running Runnin 32 minutes ago - q7yik0ks1in6kv32gg6y6yjf7 voting_result.1 dockersamples/examplevotingapp_result:before@sha256:83b56996e930c292a6ae5187fda84dd6568a19d97cdb933720be15c757b7463 node1 Running Runnin 32 minutes ago - rx5yo0866nfxc58zf4irsss6n voting_vote.1 dockersamples/examplevotingapp_vote:before@sha256:8e64b182c87de902f2b72321c89b4af4e2b942d76d0b772532ff27ec4c6ebf6 node3 Running Runnin 32 minutes ago - tz6j82jnwrx7n2offljp3mn03 voting_db.1 postgres:9.4@sha256:6046af499eae34d2074c0b53f9a8b404716d415e4a03e68bc1d2f8064f2b027 node1 Running Runnin 32 minutes ago - w48spazhbmxcmbjfi54gs7x90 voting_redis.1 redis:alpine@sha256:9cd405cd1ec1410eaab064a1383d0d8854d1ef74a54e1e4a92fb4ec7bdc3ee7 node2 Running Runnin 32 minutes ago - 6jj1m02freg1n3z9n1evrzsbl voting_visualizer.1 dockersamples/visualizer:stable@sha256:f924ad66c8e94b10baaf7bdb9cd491ef4e982a1d048a56a17e02bf5945401e5 node1 Running Runnin 32 minutes ago - kqgdmededccbhz2wuc0e9hx7g voting_vote.2 dockersamples/examplevotingapp_vote:before@sha256:8e64b182c87de902f2b72321c89b4af4e2b942d76d0b772532ff27ec4c6ebf6 node2 Running Runnin 32 minutes ago - t72q3z038jehe1wbh9gdum076 voting_redis.2 redis:alpine@sha256:9cd405cd1ec1410eaab064a1383d0d8854d1ef74a54e1e4a92fb4ec7bdc3ee7 node3 Running Runnin 32 minutes ago - ``` - - ### Only display task IDs - - The `-q ` or `--quiet` option only shows IDs of the tasks in the stack. - This example outputs all task IDs of the "voting" stack; - - ```bash - $ docker stack ps -q voting - xim5bcqtgk1b - q7yik0ks1in6 - rx5yo0866nfx - tz6j82jnwrx7 - w48spazhbmxc - 6jj1m02freg1 - kqgdmededccb - t72q3z038jeh - ``` - - This option can be used to perform batch operations. For example, you can use - the task IDs as input for other commands, such as `docker inspect`. The - following example inspects all tasks of the "voting" stack; - - ```bash - $ docker inspect $(docker stack ps -q voting) - - [ - { - "ID": "xim5bcqtgk1b1gk0krq1", - "Version": { - (...) - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack_rm.yaml b/_data/engine-cli-edge/docker_stack_rm.yaml deleted file mode 100644 index 2e95860df7..0000000000 --- a/_data/engine-cli-edge/docker_stack_rm.yaml +++ /dev/null @@ -1,70 +0,0 @@ -command: docker stack rm -aliases: remove, down -short: Remove one or more stacks -long: |- - Remove the stack from the swarm. This command has to be run targeting - a manager node. -usage: docker stack rm STACK [STACK...] -pname: docker stack -plink: docker_stack.yaml -inherited_options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - ### Remove a stack - - This will remove the stack with the name `myapp`. Services, networks, and secrets associated with the stack will be removed. - - ```bash - $ docker stack rm myapp - - Removing service myapp_redis - Removing service myapp_web - Removing service myapp_lb - Removing network myapp_default - Removing network myapp_frontend - ``` - - ### Remove multiple stacks - - This will remove all the specified stacks, `myapp` and `vossibility`. Services, networks, and secrets associated with all the specified stacks will be removed. - - ```bash - $ docker stack rm myapp vossibility - - Removing service myapp_redis - Removing service myapp_web - Removing service myapp_lb - Removing network myapp_default - Removing network myapp_frontend - Removing service vossibility_nsqd - Removing service vossibility_logstash - Removing service vossibility_elasticsearch - Removing service vossibility_kibana - Removing service vossibility_ghollector - Removing service vossibility_lookupd - Removing network vossibility_default - Removing network vossibility_vossibility - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_stack_services.yaml b/_data/engine-cli-edge/docker_stack_services.yaml deleted file mode 100644 index 13d2741388..0000000000 --- a/_data/engine-cli-edge/docker_stack_services.yaml +++ /dev/null @@ -1,122 +0,0 @@ -command: docker stack services -short: List the services in the stack -long: |- - Lists the services that are running as part of the specified stack. This - command has to be run targeting a manager node. -usage: docker stack services [OPTIONS] STACK -pname: docker stack -plink: docker_stack.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: true -- option: format - value_type: string - description: Pretty-print services using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display IDs - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -inherited_options: -- option: kubeconfig - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -- option: namespace - value_type: string - default_value: default - description: Kubernetes namespace to use - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - The following command shows all services in the `myapp` stack: - - ```bash - $ docker stack services myapp - - ID NAME REPLICAS IMAGE COMMAND - 7be5ei6sqeye myapp_web 1/1 nginx@sha256:23f809e7fd5952e7d5be065b4d3643fbbceccd349d537b62a123ef2201bc886f - dn7m7nhhfb9y myapp_db 1/1 mysql@sha256:a9a5b559f8821fe73d58c3606c812d1c044868d42c63817fa5125fd9d8b7b539 - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there - is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). - Multiple filter flags are combined as an `OR` filter. - - The following command shows both the `web` and `db` services: - - ```bash - $ docker stack services --filter name=myapp_web --filter name=myapp_db myapp - - ID NAME REPLICAS IMAGE COMMAND - 7be5ei6sqeye myapp_web 1/1 nginx@sha256:23f809e7fd5952e7d5be065b4d3643fbbceccd349d537b62a123ef2201bc886f - dn7m7nhhfb9y myapp_db 1/1 mysql@sha256:a9a5b559f8821fe73d58c3606c812d1c044868d42c63817fa5125fd9d8b7b539 - ``` - - The currently supported filters are: - - * id / ID (`--filter id=7be5ei6sqeye`, or `--filter ID=7be5ei6sqeye`) - * name (`--filter name=myapp_web`) - * label (`--filter label=key=value`) - - ### Formatting - - The formatting options (`--format`) pretty-prints services output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ------------|------------------------------------------------------------------------------------------ - `.ID` | Service ID - `.Name` | Service name - `.Mode` | Service mode (replicated, global) - `.Replicas` | Service replicas - `.Image` | Service image - - When using the `--format` option, the `stack services` command will either - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `ID`, `Mode`, and `Replicas` entries separated by a colon for all services: - - ```bash - $ docker stack services --format "{{.ID}}: {{.Mode}} {{.Replicas}}" - - 0zmvwuiu3vue: replicated 10/10 - fm6uf97exkul: global 5/5 - ``` -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: true -swarm: true - diff --git a/_data/engine-cli-edge/docker_start.yaml b/_data/engine-cli-edge/docker_start.yaml deleted file mode 100644 index a78f25143f..0000000000 --- a/_data/engine-cli-edge/docker_start.yaml +++ /dev/null @@ -1,61 +0,0 @@ -command: docker start -short: Start one or more stopped containers -long: Start one or more stopped containers -usage: docker start [OPTIONS] CONTAINER [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: checkpoint - value_type: string - description: Restore from this checkpoint - deprecated: false - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: checkpoint-dir - value_type: string - description: Use a custom checkpoint storage directory - deprecated: false - experimental: true - experimentalcli: false - kubernetes: false - swarm: false -- option: detach-keys - value_type: string - description: Override the key sequence for detaching a container - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: interactive - shorthand: i - value_type: bool - default_value: "false" - description: Attach container's STDIN - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker start my_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_stats.yaml b/_data/engine-cli-edge/docker_stats.yaml deleted file mode 100644 index 8940ff9911..0000000000 --- a/_data/engine-cli-edge/docker_stats.yaml +++ /dev/null @@ -1,188 +0,0 @@ -command: docker stats -short: Display a live stream of container(s) resource usage statistics -long: |- - The `docker stats` command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data. - - If you want more detailed information about a container's resource usage, use the `/containers/(id)/stats` API endpoint. - - > **Note**: On Linux, the Docker CLI reports memory usage by subtracting page cache usage from the total memory usage. The API does not perform such a calculation but rather provides the total memory usage and the amount from the page cache so that clients can use the data as needed. -usage: docker stats [OPTIONS] [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print images using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-stream - value_type: bool - default_value: "false" - description: Disable streaming stats and only pull the first result - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: no-trunc - value_type: bool - default_value: "false" - description: Do not truncate output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Running `docker stats` on all running containers against a Linux daemon. - - ```bash - $ docker stats - - CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS - b95a83497c91 awesome_brattain 0.28% 5.629MiB / 1.952GiB 0.28% 916B / 0B 147kB / 0B 9 - 67b2525d8ad1 foobar 0.00% 1.727MiB / 1.952GiB 0.09% 2.48kB / 0B 4.11MB / 0B 2 - e5c383697914 test-1951.1.kay7x1lh1twk9c0oig50sd5tr 0.00% 196KiB / 1.952GiB 0.01% 71.2kB / 0B 770kB / 0B 1 - 4bda148efbc0 random.1.vnc8on831idyr42slu578u3cr 0.00% 1.672MiB / 1.952GiB 0.08% 110kB / 0B 578kB / 0B 2 - ``` - - If you don't [specify a format string using `--format`](#formatting), the - following columns are shown. - - | Column name | Description | - |---------------------------|-----------------------------------------------------------------------------------------------| - | `CONTAINER ID` and `Name` | the ID and name of the container | - | `CPU %` and `MEM %` | the percentage of the host's CPU and memory the container is using | - | `MEM USAGE / LIMIT` | the total memory the container is using, and the total amount of memory it is allowed to use | - | `NET I/O` | The amount of data the container has sent and received over its network interface | - | `BLOCK I/O` | The amount of data the container has read to and written from block devices on the host | - | `PIDs` | the number of processes or threads the container has created | - - Running `docker stats` on multiple containers by name and id against a Linux daemon. - - ```bash - $ docker stats awesome_brattain 67b2525d8ad1 - - CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS - b95a83497c91 awesome_brattain 0.28% 5.629MiB / 1.952GiB 0.28% 916B / 0B 147kB / 0B 9 - 67b2525d8ad1 foobar 0.00% 1.727MiB / 1.952GiB 0.09% 2.48kB / 0B 4.11MB / 0B 2 - ``` - - Running `docker stats` with customized format on all (Running and Stopped) containers. - - ```bash - $ docker stats --all --format "table {{.Container}}\t{{.CPUPerc}}\t{{.MemUsage}}" fervent_panini 5acfcb1b4fd1 drunk_visvesvaraya big_heisenberg - - CONTAINER CPU % MEM USAGE / LIMIT - fervent_panini 0.00% 56KiB / 15.57GiB - 5acfcb1b4fd1 0.07% 32.86MiB / 15.57GiB - drunk_visvesvaraya 0.00% 0B / 0B - big_heisenberg 0.00% 0B / 0B - ``` - - `drunk_visvesvaraya` and `big_heisenberg` are stopped containers in the above example. - - Running `docker stats` on all running containers against a Windows daemon. - - ```powershell - PS E:\> docker stats - CONTAINER ID CPU % PRIV WORKING SET NET I/O BLOCK I/O - 09d3bb5b1604 6.61% 38.21 MiB 17.1 kB / 7.73 kB 10.7 MB / 3.57 MB - 9db7aa4d986d 9.19% 38.26 MiB 15.2 kB / 7.65 kB 10.6 MB / 3.3 MB - 3f214c61ad1d 0.00% 28.64 MiB 64 kB / 6.84 kB 4.42 MB / 6.93 MB - ``` - - Running `docker stats` on multiple containers by name and id against a Windows daemon. - - ```powershell - PS E:\> docker ps -a - CONTAINER ID NAME IMAGE COMMAND CREATED STATUS PORTS NAMES - 3f214c61ad1d awesome_brattain nanoserver "cmd" 2 minutes ago Up 2 minutes big_minsky - 9db7aa4d986d mad_wilson windowsservercore "cmd" 2 minutes ago Up 2 minutes mad_wilson - 09d3bb5b1604 fervent_panini windowsservercore "cmd" 2 minutes ago Up 2 minutes affectionate_easley - - PS E:\> docker stats 3f214c61ad1d mad_wilson - CONTAINER ID NAME CPU % PRIV WORKING SET NET I/O BLOCK I/O - 3f214c61ad1d awesome_brattain 0.00% 46.25 MiB 76.3 kB / 7.92 kB 10.3 MB / 14.7 MB - 9db7aa4d986d mad_wilson 9.59% 40.09 MiB 27.6 kB / 8.81 kB 17 MB / 20.1 MB - ``` - - ### Formatting - - The formatting option (`--format`) pretty prints container output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - ------------ | -------------------------------------------- - `.Container` | Container name or ID (user input) - `.Name` | Container name - `.ID` | Container ID - `.CPUPerc` | CPU percentage - `.MemUsage` | Memory usage - `.NetIO` | Network IO - `.BlockIO` | Block IO - `.MemPerc` | Memory percentage (Not available on Windows) - `.PIDs` | Number of PIDs (Not available on Windows) - - - When using the `--format` option, the `stats` command either - outputs the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Container` and `CPUPerc` entries separated by a colon for all images: - - ```bash - $ docker stats --format "{{.Container}}: {{.CPUPerc}}" - - 09d3bb5b1604: 6.61% - 9db7aa4d986d: 9.19% - 3f214c61ad1d: 0.00% - ``` - - To list all containers statistics with their name, CPU percentage and memory - usage in a table format you can use: - - ```bash - $ docker stats --format "table {{.Container}}\t{{.CPUPerc}}\t{{.MemUsage}}" - - CONTAINER CPU % PRIV WORKING SET - 1285939c1fd3 0.07% 796 KiB / 64 MiB - 9c76f7834ae2 0.07% 2.746 MiB / 64 MiB - d1ea048f04e4 0.03% 4.583 MiB / 64 MiB - ``` - - The default format is as follows: - - On Linux: - - "table {{.ID}}\t{{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}\t{{.MemPerc}}\t{{.NetIO}}\t{{.BlockIO}}\t{{.PIDs}}" - - On Windows: - - "table {{.ID}}\t{{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}\t{{.NetIO}}\t{{.BlockIO}}" - - - > **Note**: On Docker 17.09 and older, the `{{.Container}}` column was used, in - > stead of `{{.ID}}\t{{.Name}}`. -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_stop.yaml b/_data/engine-cli-edge/docker_stop.yaml deleted file mode 100644 index 3d775e86e3..0000000000 --- a/_data/engine-cli-edge/docker_stop.yaml +++ /dev/null @@ -1,29 +0,0 @@ -command: docker stop -short: Stop one or more running containers -long: |- - The main process inside the container will receive `SIGTERM`, and after a grace - period, `SIGKILL`. -usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] -pname: docker -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker stop my_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_swarm.yaml b/_data/engine-cli-edge/docker_swarm.yaml deleted file mode 100644 index e5e071d76c..0000000000 --- a/_data/engine-cli-edge/docker_swarm.yaml +++ /dev/null @@ -1,31 +0,0 @@ -command: docker swarm -short: Manage Swarm -long: Manage the swarm. -usage: docker swarm -pname: docker -plink: docker.yaml -cname: -- docker swarm ca -- docker swarm init -- docker swarm join -- docker swarm join-token -- docker swarm leave -- docker swarm unlock -- docker swarm unlock-key -- docker swarm update -clink: -- docker_swarm_ca.yaml -- docker_swarm_init.yaml -- docker_swarm_join.yaml -- docker_swarm_join-token.yaml -- docker_swarm_leave.yaml -- docker_swarm_unlock.yaml -- docker_swarm_unlock-key.yaml -- docker_swarm_update.yaml -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_ca.yaml b/_data/engine-cli-edge/docker_swarm_ca.yaml deleted file mode 100644 index c4f4cac7dd..0000000000 --- a/_data/engine-cli-edge/docker_swarm_ca.yaml +++ /dev/null @@ -1,156 +0,0 @@ -command: docker swarm 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] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: ca-key - value_type: pem-file - description: | - Path to the PEM-formatted root CA key to use for the new cluster - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cert-expiry - value_type: duration - default_value: 2160h0m0s - description: Validity period for node certificates (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: detach - shorthand: d - value_type: bool - default_value: "false" - description: | - Exit immediately instead of waiting for the root rotation to converge - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: external-ca - value_type: external-ca - description: Specifications of one or more certificate signing endpoints - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Suppress progress output - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Run the `docker swarm ca` command without any options to view the current root CA certificate - in PEM format. - - ```bash - $ docker swarm ca - -----BEGIN CERTIFICATE----- - MIIBazCCARCgAwIBAgIUJPzo67QC7g8Ebg2ansjkZ8CbmaswCgYIKoZIzj0EAwIw - EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAzMTcxMDAwWhcNMzcwNDI4MTcx - MDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH - A0IABKL6/C0sihYEb935wVPRA8MqzPLn3jzou0OJRXHsCLcVExigrMdgmLCC+Va4 - +sJ+SLVO1eQbvLHH8uuDdF/QOU6jQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB - Af8EBTADAQH/MB0GA1UdDgQWBBSfUy5bjUnBAx/B0GkOBKp91XvxzjAKBggqhkjO - PQQDAgNJADBGAiEAnbvh0puOS5R/qvy1PMHY1iksYKh2acsGLtL/jAIvO4ACIQCi - lIwQqLkJ48SQqCjG1DBTSBsHmMSRT+6mE2My+Z3GKA== - -----END CERTIFICATE----- - ``` - - Pass the `--rotate` flag (and optionally a `--ca-cert`, along with a `--ca-key` or - `--external-ca` parameter flag), in order to rotate the current swarm root CA. - - ``` - $ docker swarm ca --rotate - desired root digest: sha256:05da740cf2577a25224c53019e2cce99bcc5ba09664ad6bb2a9425d9ebd1b53e - rotated TLS certificates: [=========================> ] 1/2 nodes - rotated CA certificates: [> ] 0/2 nodes - ``` - - Once the rotation os finished (all the progress bars have completed) the now-current - CA certificate will be printed: - - ``` - $ docker swarm ca --rotate - desired root digest: sha256:05da740cf2577a25224c53019e2cce99bcc5ba09664ad6bb2a9425d9ebd1b53e - rotated TLS certificates: [==================================================>] 2/2 nodes - rotated CA certificates: [==================================================>] 2/2 nodes - -----BEGIN CERTIFICATE----- - MIIBazCCARCgAwIBAgIUFynG04h5Rrl4lKyA4/E65tYKg8IwCgYIKoZIzj0EAwIw - EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTE2MDAxMDAwWhcNMzcwNTExMDAx - MDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH - A0IABC2DuNrIETP7C7lfiEPk39tWaaU0I2RumUP4fX4+3m+87j0DU0CsemUaaOG6 - +PxHhGu2VXQ4c9pctPHgf7vWeVajQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB - Af8EBTADAQH/MB0GA1UdDgQWBBSEL02z6mCI3SmMDmITMr12qCRY2jAKBggqhkjO - PQQDAgNJADBGAiEA263Eb52+825EeNQZM0AME+aoH1319Zp9/J5ijILW+6ACIQCg - gyg5u9Iliel99l7SuMhNeLkrU7fXs+Of1nTyyM73ig== - -----END CERTIFICATE----- - ``` - - ### `--rotate` - - Root CA Rotation is recommended if one or more of the swarm managers have been - compromised, so that those managers can no longer connect to or be trusted by - any other node in the cluster. - - Alternately, root CA rotation can be used to give control of the swarm CA - to an external CA, or to take control back from an external CA. - - The `--rotate` flag does not require any parameters to do a rotation, but you can - optionally specify a certificate and key, or a certificate and external CA URL, - and those will be used instead of an automatically-generated certificate/key pair. - - Because the root CA key should be kept secret, if provided it will not be visible - when viewing swarm any information via the CLI or API. - - The root CA rotation will not be completed until all registered nodes have - rotated their TLS certificates. If the rotation is not completing within a - reasonable amount of time, try running - `docker node ls --format '{{.ID}} {{.Hostname}} {{.Status}} {{.TLSStatus}}'` to - see if any nodes are down or otherwise unable to rotate TLS certificates. - - - ### `--detach` - - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_init.yaml b/_data/engine-cli-edge/docker_swarm_init.yaml deleted file mode 100644 index c1f175d0c0..0000000000 --- a/_data/engine-cli-edge/docker_swarm_init.yaml +++ /dev/null @@ -1,238 +0,0 @@ -command: docker swarm init -short: Initialize a swarm -long: |- - Initialize a swarm. The docker engine targeted by this command becomes a manager - in the newly created single-node swarm. -usage: docker swarm init [OPTIONS] -pname: docker swarm -plink: docker_swarm.yaml -options: -- option: advertise-addr - value_type: string - description: 'Advertised address (format: [:port])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: availability - value_type: string - default_value: active - description: Availability of the node ("active"|"pause"|"drain") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cert-expiry - value_type: duration - default_value: 2160h0m0s - description: Validity period for node certificates (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: data-path-addr - value_type: string - description: | - Address or interface to use for data path traffic (format: ) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dispatcher-heartbeat - value_type: duration - default_value: 5s - description: Dispatcher heartbeat period (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: external-ca - value_type: external-ca - description: Specifications of one or more certificate signing endpoints - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force-new-cluster - value_type: bool - default_value: "false" - description: Force create a new cluster from current state - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: listen-addr - value_type: node-addr - default_value: 0.0.0.0:2377 - description: 'Listen address (format: [:port])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: max-snapshots - value_type: uint64 - default_value: "0" - description: Number of additional Raft snapshots to retain - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: task-history-limit - value_type: int64 - default_value: "5" - description: Task history retention limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker swarm init --advertise-addr 192.168.99.121 - Swarm initialized: current node (bvz81updecsj6wjz393c09vti) is now a manager. - - To add a worker to this swarm, run the following command: - - docker swarm join \ - --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx \ - 172.17.0.2:2377 - - To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions. - ``` - - `docker swarm init` generates two random tokens, a worker token and a manager token. When you join - a new node to the swarm, the node joins as a worker or manager node based upon the token you pass - to [swarm join](swarm_join.md). - - After you create the swarm, you can display or rotate the token using - [swarm join-token](swarm_join_token.md). - - ### `--autolock` - - This flag enables automatic locking of managers with an encryption key. The - private keys and data stored by all managers will be protected by the - encryption key printed in the output, and will not be accessible without it. - Thus, it is very important to store this key in order to activate a manager - after it restarts. The key can be passed to `docker swarm unlock` to reactivate - the manager. Autolock can be disabled by running - `docker swarm update --autolock=false`. After disabling it, the encryption key - is no longer required to start the manager, and it will start up on its own - without user intervention. - - ### `--cert-expiry` - - This flag sets the validity period for node certificates. - - ### `--dispatcher-heartbeat` - - This flag sets the frequency with which nodes are told to use as a - period to report their health. - - ### `--external-ca` - - This flag sets up the swarm to use an external CA to issue node certificates. The value takes - the form `protocol=X,url=Y`. The value for `protocol` specifies what protocol should be used - to send signing requests to the external CA. Currently, the only supported value is `cfssl`. - The URL specifies the endpoint where signing requests should be submitted. - - ### `--force-new-cluster` - - This flag forces an existing node that was part of a quorum that was lost to restart as a single node Manager without losing its data. - - ### `--listen-addr` - - The node listens for inbound swarm manager traffic on this address. The default is to listen on - 0.0.0.0:2377. It is also possible to specify a network interface to listen on that interface's - address; for example `--listen-addr eth0:2377`. - - Specifying a port is optional. If the value is a bare IP address or interface - name, the default port 2377 will be used. - - ### `--advertise-addr` - - This flag specifies the address that will be advertised to other members of the - swarm for API access and overlay networking. If unspecified, Docker will check - if the system has a single IP address, and use that IP address with the - listening port (see `--listen-addr`). If the system has multiple IP addresses, - `--advertise-addr` must be specified so that the correct address is chosen for - inter-manager communication and overlay networking. - - It is also possible to specify a network interface to advertise that interface's address; - for example `--advertise-addr eth0:2377`. - - Specifying a port is optional. If the value is a bare IP address or interface - name, the default port 2377 will be used. - - ### `--data-path-addr` - - This flag specifies the address that global scope network drivers will publish towards - other nodes in order to reach the containers running on this node. - Using this parameter it is then possible to separate the container's data traffic from the - management traffic of the cluster. - If unspecified, Docker will use the same IP address or interface that is used for the - advertise address. - - ### `--task-history-limit` - - This flag sets up task history retention limit. - - ### `--max-snapshots` - - This flag sets the number of old Raft snapshots to retain in addition to the - current Raft snapshots. By default, no old snapshots are retained. This option - may be used for debugging, or to store old snapshots of the swarm state for - disaster recovery purposes. - - ### `--snapshot-interval` - - This flag specifies how many log entries to allow in between Raft snapshots. - Setting this to a higher number will trigger snapshots less frequently. - Snapshots compact the Raft log and allow for more efficient transfer of the - state to new managers. However, there is a performance cost to taking snapshots - frequently. - - ### `--availability` - - This flag specifies the availability of the node at the time the node joins a master. - Possible availability values are `active`, `pause`, or `drain`. - - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_join-token.yaml b/_data/engine-cli-edge/docker_swarm_join-token.yaml deleted file mode 100644 index 61a73127df..0000000000 --- a/_data/engine-cli-edge/docker_swarm_join-token.yaml +++ /dev/null @@ -1,33 +0,0 @@ -command: docker swarm join-token -short: Manage join tokens -long: Manage join tokens -usage: docker swarm join-token [OPTIONS] (worker|manager) -pname: docker swarm -plink: docker_swarm.yaml -options: -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display token - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rotate - value_type: bool - default_value: "false" - description: Rotate join token - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_join.yaml b/_data/engine-cli-edge/docker_swarm_join.yaml deleted file mode 100644 index 8fdbcf5e59..0000000000 --- a/_data/engine-cli-edge/docker_swarm_join.yaml +++ /dev/null @@ -1,144 +0,0 @@ -command: docker swarm join -short: Join a swarm as a node and/or manager -long: |- - Join a node to a swarm. The node joins as a manager node or worker node based upon the token you - pass with the `--token` flag. If you pass a manager token, the node joins as a manager. If you - pass a worker token, the node joins as a worker. -usage: docker swarm join [OPTIONS] HOST:PORT -pname: docker swarm -plink: docker_swarm.yaml -options: -- option: advertise-addr - value_type: string - description: 'Advertised address (format: [:port])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: availability - value_type: string - default_value: active - description: Availability of the node ("active"|"pause"|"drain") - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: data-path-addr - value_type: string - description: | - Address or interface to use for data path traffic (format: ) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: listen-addr - value_type: node-addr - default_value: 0.0.0.0:2377 - description: 'Listen address (format: [:port])' - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: token - value_type: string - description: Token for entry into the swarm - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Join a node to swarm as a manager - - The example below demonstrates joining a manager node using a manager token. - - ```bash - $ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2 192.168.99.121:2377 - This node joined a swarm as a manager. - $ docker node ls - ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS - dkp8vy1dq1kxleu9g4u78tlag * manager2 Ready Active Reachable - dvfxp4zseq4s0rih1selh0d20 manager1 Ready Active Leader - ``` - - A cluster should only have 3-7 managers at most, because a majority of managers must be available - for the cluster to function. Nodes that aren't meant to participate in this management quorum - should join as workers instead. Managers should be stable hosts that have static IP addresses. - - ### Join a node to swarm as a worker - - The example below demonstrates joining a worker node using a worker token. - - ```bash - $ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx 192.168.99.121:2377 - This node joined a swarm as a worker. - $ docker node ls - ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS - 7ln70fl22uw2dvjn2ft53m3q5 worker2 Ready Active - dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active Reachable - dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader - ``` - - ### `--listen-addr value` - - If the node is a manager, it will listen for inbound swarm manager traffic on this - address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a - network interface to listen on that interface's address; for example `--listen-addr eth0:2377`. - - Specifying a port is optional. If the value is a bare IP address, or interface - name, the default port 2377 will be used. - - This flag is generally not necessary when joining an existing swarm. - - ### `--advertise-addr value` - - This flag specifies the address that will be advertised to other members of the - swarm for API access. If unspecified, Docker will check if the system has a - single IP address, and use that IP address with the listening port (see - `--listen-addr`). If the system has multiple IP addresses, `--advertise-addr` - must be specified so that the correct address is chosen for inter-manager - communication and overlay networking. - - It is also possible to specify a network interface to advertise that interface's address; - for example `--advertise-addr eth0:2377`. - - Specifying a port is optional. If the value is a bare IP address, or interface - name, the default port 2377 will be used. - - This flag is generally not necessary when joining an existing swarm. If - you're joining new nodes through a load balancer, you should use this flag to - ensure the node advertises its IP address and not the IP address of the load - balancer. - - ### `--data-path-addr` - - This flag specifies the address that global scope network drivers will publish towards - other nodes in order to reach the containers running on this node. - Using this parameter it is then possible to separate the container's data traffic from the - management traffic of the cluster. - If unspecified, Docker will use the same IP address or interface that is used for the - advertise address. - - ### `--token string` - - Secret value required for nodes to join the swarm - - ### `--availability` - - This flag specifies the availability of the node at the time the node joins a master. - Possible availability values are `active`, `pause`, or `drain`. - - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_leave.yaml b/_data/engine-cli-edge/docker_swarm_leave.yaml deleted file mode 100644 index fa9a9f2f3f..0000000000 --- a/_data/engine-cli-edge/docker_swarm_leave.yaml +++ /dev/null @@ -1,54 +0,0 @@ -command: docker swarm leave -short: Leave the swarm -long: |- - When you run this command on a worker, that worker leaves the swarm. - - You can use the `--force` option on a manager to remove it from the swarm. - However, this does not reconfigure the swarm to ensure that there are enough - managers to maintain a quorum in the swarm. The safe way to remove a manager - from a swarm is to demote it to a worker and then direct it to leave the quorum - without using `--force`. Only use `--force` in situations where the swarm will - no longer be used after the manager leaves, such as in a single-node swarm. -usage: docker swarm leave [OPTIONS] -pname: docker swarm -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Consider the following swarm, as seen from the manager: - - ```bash - $ docker node ls - ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS - 7ln70fl22uw2dvjn2ft53m3q5 worker2 Ready Active - dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active - dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader - ``` - - To remove `worker2`, issue the following command from `worker2` itself: - - ```bash - $ docker swarm leave - Node left the default swarm. - ``` - - The node will still appear in the node list, and marked as `down`. It no longer - 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 -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_unlock-key.yaml b/_data/engine-cli-edge/docker_swarm_unlock-key.yaml deleted file mode 100644 index a714bccf67..0000000000 --- a/_data/engine-cli-edge/docker_swarm_unlock-key.yaml +++ /dev/null @@ -1,33 +0,0 @@ -command: docker swarm unlock-key -short: Manage the unlock key -long: Manage the unlock key -usage: docker swarm unlock-key [OPTIONS] -pname: docker swarm -plink: docker_swarm.yaml -options: -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display token - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: rotate - value_type: bool - default_value: "false" - description: Rotate unlock key - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_unlock.yaml b/_data/engine-cli-edge/docker_swarm_unlock.yaml deleted file mode 100644 index 1c35a0d596..0000000000 --- a/_data/engine-cli-edge/docker_swarm_unlock.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker swarm unlock -short: Unlock swarm -long: |- - Unlocks a locked manager using a user-supplied unlock key. This command must be - used to reactivate a manager after its Docker daemon restarts if the autolock - setting is turned on. The unlock key is printed at the time when autolock is - enabled, and is also available from the `docker swarm unlock-key` command. -usage: docker swarm unlock -pname: docker swarm -plink: docker_swarm.yaml -examples: |- - ```bash - $ docker swarm unlock - Please enter unlock key: - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_swarm_update.yaml b/_data/engine-cli-edge/docker_swarm_update.yaml deleted file mode 100644 index b0dcdd2815..0000000000 --- a/_data/engine-cli-edge/docker_swarm_update.yaml +++ /dev/null @@ -1,83 +0,0 @@ -command: docker swarm update -short: Update the swarm -long: Updates a swarm with new parameter values. This command must target a manager - node. -usage: docker swarm update [OPTIONS] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: cert-expiry - value_type: duration - default_value: 2160h0m0s - description: Validity period for node certificates (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: dispatcher-heartbeat - value_type: duration - default_value: 5s - description: Dispatcher heartbeat period (ns|us|ms|s|m|h) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: external-ca - value_type: external-ca - description: Specifications of one or more certificate signing endpoints - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: max-snapshots - value_type: uint64 - default_value: "0" - description: Number of additional Raft snapshots to retain - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: task-history-limit - value_type: int64 - default_value: "5" - description: Task history retention limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker swarm update --cert-expiry 720h - ``` -deprecated: false -min_api_version: "1.24" -experimental: false -experimentalcli: false -kubernetes: false -swarm: true - diff --git a/_data/engine-cli-edge/docker_system.yaml b/_data/engine-cli-edge/docker_system.yaml deleted file mode 100644 index a1bc57fcf2..0000000000 --- a/_data/engine-cli-edge/docker_system.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker system -short: Manage Docker -long: Manage Docker. -usage: docker system -pname: docker -plink: docker.yaml -cname: -- docker system df -- docker system events -- docker system info -- docker system prune -clink: -- docker_system_df.yaml -- docker_system_events.yaml -- docker_system_info.yaml -- docker_system_prune.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_system_df.yaml b/_data/engine-cli-edge/docker_system_df.yaml deleted file mode 100644 index 99954d3d5b..0000000000 --- a/_data/engine-cli-edge/docker_system_df.yaml +++ /dev/null @@ -1,79 +0,0 @@ -command: docker system df -short: Show docker disk usage -long: |- - The `docker system df` command displays information regarding the - amount of disk space used by the docker daemon. -usage: docker system df [OPTIONS] -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: verbose - shorthand: v - value_type: bool - default_value: "false" - description: Show detailed information on space usage - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - By default the command will just show a summary of the data used: - - ```bash - $ docker system df - - TYPE TOTAL ACTIVE SIZE RECLAIMABLE - Images 5 2 16.43 MB 11.63 MB (70%) - Containers 2 0 212 B 212 B (100%) - Local Volumes 2 1 36 B 0 B (0%) - ``` - - A more detailed view can be requested using the `-v, --verbose` flag: - - ```bash - $ docker system df -v - - Images space usage: - - REPOSITORY TAG IMAGE ID CREATED SIZE SHARED SIZE UNIQUE SIZE CONTAINERS - my-curl latest b2789dd875bf 6 minutes ago 11 MB 11 MB 5 B 0 - my-jq latest ae67841be6d0 6 minutes ago 9.623 MB 8.991 MB 632.1 kB 0 - a0971c4015c1 6 minutes ago 11 MB 11 MB 0 B 0 - alpine latest 4e38e38c8ce0 9 weeks ago 4.799 MB 0 B 4.799 MB 1 - alpine 3.3 47cf20d8c26c 9 weeks ago 4.797 MB 4.797 MB 0 B 1 - - Containers space usage: - - CONTAINER ID IMAGE COMMAND LOCAL VOLUMES SIZE CREATED STATUS NAMES - 4a7f7eebae0f alpine:latest "sh" 1 0 B 16 minutes ago Exited (0) 5 minutes ago hopeful_yalow - f98f9c2aa1ea alpine:3.3 "sh" 1 212 B 16 minutes ago Exited (0) 48 seconds ago anon-vol - - Local Volumes space usage: - - NAME LINKS SIZE - 07c7bdf3e34ab76d921894c2b834f073721fccfbbcba792aa7648e3a7a664c2e 2 36 B - my-named-vol 0 0 B - ``` - - * `SHARED SIZE` is the amount of space that an image shares with another one (i.e. their common data) - * `UNIQUE SIZE` is the amount of space that is only used by a given image - * `SIZE` is the virtual size of the image, it is the sum of `SHARED SIZE` and `UNIQUE SIZE` - - > **Note**: Network information is not shown because it doesn't consume the disk - > space. -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_system_events.yaml b/_data/engine-cli-edge/docker_system_events.yaml deleted file mode 100644 index 8f584ace55..0000000000 --- a/_data/engine-cli-edge/docker_system_events.yaml +++ /dev/null @@ -1,357 +0,0 @@ -command: docker system events -short: Get real time events from the server -long: |- - Use `docker system events` to get real-time events from the server. These - events differ per Docker object type. - - ### Object types - - #### Containers - - Docker containers report the following events: - - - `attach` - - `commit` - - `copy` - - `create` - - `destroy` - - `detach` - - `die` - - `exec_create` - - `exec_detach` - - `exec_start` - - `export` - - `health_status` - - `kill` - - `oom` - - `pause` - - `rename` - - `resize` - - `restart` - - `start` - - `stop` - - `top` - - `unpause` - - `update` - - #### Images - - Docker images report the following events: - - - `delete` - - `import` - - `load` - - `pull` - - `push` - - `save` - - `tag` - - `untag` - - #### Plugins - - Docker plugins report the following events: - - - `install` - - `enable` - - `disable` - - `remove` - - #### Volumes - - Docker volumes report the following events: - - - `create` - - `mount` - - `unmount` - - `destroy` - - #### Networks - - Docker networks report the following events: - - - `create` - - `connect` - - `disconnect` - - `destroy` - - #### Daemons - - Docker daemons report the following events: - - - `reload` - - ### Limiting, filtering, and formatting the output - - #### Limit events by time - - The `--since` and `--until` parameters can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the client machine’s time. If you do not provide the `--since` option, - the command returns only new and/or live events. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the client will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - #### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If you would - like to use multiple filters, pass multiple flags (e.g., - `--filter "foo=bar" --filter "bif=baz"`) - - Using the same filter multiple times will be handled as a *OR*; for example - `--filter container=588a23dac085 --filter container=a8f7720b8c22` will display - events for container 588a23dac085 *OR* container a8f7720b8c22 - - Using multiple filters will be handled as a *AND*; for example - `--filter container=588a23dac085 --filter event=start` will display events for - container container 588a23dac085 *AND* the event type is *start* - - The currently supported filters are: - - * container (`container=`) - * daemon (`daemon=`) - * event (`event=`) - * image (`image=`) - * label (`label=` or `label==`) - * network (`network=`) - * plugin (`plugin=`) - * type (`type=`) - * volume (`volume=`) - - #### Format - - If a format (`--format`) is specified, the given template will be executed - instead of the default - format. Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. - - If a format is set to `{{json .}}`, the events are streamed as valid JSON - Lines. For information about JSON Lines, please refer to http://jsonlines.org/ . -usage: docker system events [OPTIONS] -pname: docker system -plink: docker_system.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Filter output based on conditions provided - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: since - value_type: string - description: Show all events created since timestamp - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: until - value_type: string - description: Stream events until this timestamp - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Basic example - - You'll need two shells for this example. - - **Shell 1: Listening for events:** - - ```bash - $ docker system events - ``` - - **Shell 2: Start and Stop containers:** - - ```bash - $ docker create --name test alpine:latest top - $ docker start test - $ docker stop test - ``` - - **Shell 1: (Again .. now showing events):** - - ```none - 2017-01-05T00:35:58.859401177+08:00 container create 0fdb48addc82871eb34eb23a847cfd033dedd1a0a37bef2e6d9eb3870fc7ff37 (image=alpine:latest, name=test) - 2017-01-05T00:36:04.703631903+08:00 network connect e2e1f5ceda09d4300f3a846f0acfaa9a8bb0d89e775eb744c5acecd60e0529e2 (container=0fdb...ff37, name=bridge, type=bridge) - 2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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) - ``` - - To exit the `docker system events` command, use `CTRL+C`. - - ### Filter events by time - - You can filter the output by an absolute timestamp or relative time on the host - machine, using the following different time syntaxes: - - ```bash - $ docker system events --since 1483283804 - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 system events --since '2017-01-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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 system events --since '2013-09-03T15:49:29' - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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 system events --since '10m' - 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) - 2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 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) - ``` - - ### Filter events by criteria - - The following commands show several different ways to filter the `docker event` - output. - - ```bash - $ docker system events --filter 'event=stop' - - 2017-01-05T00:40:22.880175420+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:41:17.888104182+08:00 container stop 2a8f...4e78 (image=alpine, name=kickass_brattain) - - $ docker system events --filter 'image=alpine' - - 2017-01-05T00:41:55.784240236+08:00 container create d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:41:55.913156783+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:42:01.106875249+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=15) - 2017-01-05T00:42:11.111934041+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=9) - 2017-01-05T00:42:11.119578204+08:00 container die d9cd...4d70 (exitCode=137, image=alpine, name=happy_meitner) - 2017-01-05T00:42:11.173276611+08:00 container stop d9cd...4d70 (image=alpine, name=happy_meitner) - - $ docker system events --filter 'container=test' - - 2017-01-05T00:43:00.139719934+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:43:09.259951086+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) - 2017-01-05T00:43:09.270102715+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) - 2017-01-05T00:43:09.312556440+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) - - $ docker system events --filter 'container=test' --filter 'container=d9cdb1525ea8' - - 2017-01-05T00:44:11.517071981+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) - 2017-01-05T00:44:17.685870901+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) - 2017-01-05T00:44:29.757658470+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=9) - 2017-01-05T00:44:29.767718510+08:00 container die 0fdb...ff37 (exitCode=137, image=alpine:latest, name=test) - 2017-01-05T00:44:29.815798344+08:00 container destroy 0fdb...ff37 (image=alpine:latest, name=test) - - $ docker system events --filter 'container=test' --filter 'event=stop' - - 2017-01-05T00:46:13.664099505+08:00 container stop a9d1...e130 (image=alpine, name=test) - - $ docker system events --filter 'type=volume' - - 2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) - 2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562f...5025, destination=/foo, driver=local, propagation=rprivate) - 2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562f...5025, driver=local) - 2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - - $ docker system events --filter 'type=network' - - 2015-12-23T21:38:24.705709133Z network create 8b11...2c5b (name=test-event-network-local, type=bridge) - 2015-12-23T21:38:25.119625123Z network connect 8b11...2c5b (name=test-event-network-local, container=b4be...c54e, type=bridge) - - $ docker system events --filter 'container=container_1' --filter 'container=container_2' - - 2014-09-03T15:49:29.999999999Z07:00 container die 4386fb97867d (image=ubuntu-1:14.04) - 2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu-1:14.04) - 2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (imager=redis:2.8) - 2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8) - - $ docker system events --filter 'type=volume' - - 2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) - 2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, destination=/foo, driver=local, propagation=rprivate) - 2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, driver=local) - 2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - - $ docker system events --filter 'type=network' - - 2015-12-23T21:38:24.705709133Z network create 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, type=bridge) - 2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge) - - $ docker system events --filter 'type=plugin' - - 2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) - 2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) - ``` - - ### Format the output - - ```bash - $ docker system events --filter 'type=container' --format 'Type={{.Type}} Status={{.Status}} ID={{.ID}}' - - Type=container Status=create ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=attach ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=start ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=resize ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=die ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 - ``` - - #### Format as JSON - - ```none - $ docker system events --format '{{json .}}' - - {"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - {"status":"attach","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - {"Type":"network","Action":"connect","Actor":{"ID":"1b50a5bf755f6021dfa78e.. - {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. - {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_system_info.yaml b/_data/engine-cli-edge/docker_system_info.yaml deleted file mode 100644 index 9662751bf0..0000000000 --- a/_data/engine-cli-edge/docker_system_info.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker system info -short: Display system-wide information -long: Display system-wide information -usage: docker system info [OPTIONS] -pname: docker system -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 - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_system_prune.yaml b/_data/engine-cli-edge/docker_system_prune.yaml deleted file mode 100644 index 2cad5d8db4..0000000000 --- a/_data/engine-cli-edge/docker_system_prune.yaml +++ /dev/null @@ -1,159 +0,0 @@ -command: docker system prune -short: Remove unused data -long: |- - Remove all unused containers, networks, images (both dangling and unreferenced), - and optionally, volumes. -usage: docker system prune [OPTIONS] -pname: docker system -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 - experimentalcli: false - kubernetes: false - swarm: false -- option: filter - value_type: filter - description: Provide filter values (e.g. 'label==') - deprecated: false - min_api_version: "1.28" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: Do not prompt for confirmation - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: volumes - value_type: bool - default_value: "false" - description: Prune volumes - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker system prune - - WARNING! This will remove: - - all stopped containers - - all networks not used by at least one container - - all dangling images - - all build cache - Are you sure you want to continue? [y/N] y - - Deleted Containers: - f44f9b81948b3919590d5f79a680d8378f1139b41952e219830a33027c80c867 - 792776e68ac9d75bce4092bc1b5cc17b779bc926ab04f4185aec9bf1c0d4641f - - Deleted Networks: - network1 - network2 - - Deleted Images: - untagged: hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f - deleted: sha256:1815c82652c03bfd8644afda26fb184f2ed891d921b20a0703b46768f9755c57 - deleted: sha256:45761469c965421a92a69cc50e92c01e0cfa94fe026cdd1233445ea00e96289a - - Total reclaimed space: 1.84kB - ``` - - By default, volumes are not removed to prevent important data from being - deleted if there is currently no container using the volume. Use the `--volumes` - flag when running the command to prune volumes as well: - - ```bash - $ docker system prune -a --volumes - - WARNING! This will remove: - - all stopped containers - - all networks not used by at least one container - - all volumes not used by at least one container - - all images without at least one container associated to them - - all build cache - Are you sure you want to continue? [y/N] y - - Deleted Containers: - 0998aa37185a1a7036b0e12cf1ac1b6442dcfa30a5c9650a42ed5010046f195b - 73958bfb884fa81fa4cc6baf61055667e940ea2357b4036acbbe25a60f442a4d - - Deleted Networks: - my-network-a - my-network-b - - Deleted Volumes: - named-vol - - Deleted Images: - untagged: my-curl:latest - deleted: sha256:7d88582121f2a29031d92017754d62a0d1a215c97e8f0106c586546e7404447d - deleted: sha256:dd14a93d83593d4024152f85d7c63f76aaa4e73e228377ba1d130ef5149f4d8b - untagged: alpine:3.3 - deleted: sha256:695f3d04125db3266d4ab7bbb3c6b23aa4293923e762aa2562c54f49a28f009f - untagged: alpine:latest - deleted: sha256:ee4603260daafe1a8c2f3b78fd760922918ab2441cbb2853ed5c439e59c52f96 - deleted: sha256:9007f5987db353ec398a223bc5a135c5a9601798ba20a1abba537ea2f8ac765f - deleted: sha256:71fa90c8f04769c9721459d5aa0936db640b92c8c91c9b589b54abd412d120ab - deleted: sha256:bb1c3357b3c30ece26e6604aea7d2ec0ace4166ff34c3616701279c22444c0f3 - untagged: my-jq:latest - deleted: sha256:6e66d724542af9bc4c4abf4a909791d7260b6d0110d8e220708b09e4ee1322e1 - deleted: sha256:07b3fa89d4b17009eb3988dfc592c7d30ab3ba52d2007832dffcf6d40e3eda7f - deleted: sha256:3a88a5c81eb5c283e72db2dbc6d65cbfd8e80b6c89bb6e714cfaaa0eed99c548 - - Total reclaimed space: 13.5 MB - ``` - - > **Note**: The `--volumes` option was added in Docker 17.06.1. Older versions - > of Docker prune volumes by default, along with other Docker objects. On older - > versions, run `docker container prune`, `docker network prune`, and - > `docker image prune` separately to remove unused containers, networks, and - > images, without removing volumes. - - - ### Filtering - - The filtering flag (`--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * until (``) - only remove containers, images, and networks created before given timestamp - * label (`label=`, `label==`, `label!=`, or `label!==`) - only remove containers, images, networks, and volumes with (or without, in case `label!=...` is used) the specified labels. - - The `until` filter can be Unix timestamps, date formatted - timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed - relative to the daemon machine’s time. Supported formats for date - formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, - `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local - timezone on the daemon will be used if you do not provide either a `Z` or a - `+-00:00` timezone offset at the end of the timestamp. When providing Unix - timestamps enter seconds[.nanoseconds], where seconds is the number of seconds - that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap - seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a - fraction of a second no more than nine digits long. - - The `label` filter accepts two formats. One is the `label=...` (`label=` or `label==`), - which removes containers, images, networks, and volumes with the specified labels. The other - format is the `label!=...` (`label!=` or `label!==`), which removes - containers, images, networks, and volumes without the specified labels. -deprecated: false -min_api_version: "1.25" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_tag.yaml b/_data/engine-cli-edge/docker_tag.yaml deleted file mode 100644 index 969be4c94a..0000000000 --- a/_data/engine-cli-edge/docker_tag.yaml +++ /dev/null @@ -1,66 +0,0 @@ -command: docker tag -short: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE -long: |- - An image name is made up of slash-separated name components, optionally prefixed - by a registry hostname. The hostname must comply with standard DNS rules, but - may not contain underscores. If a hostname is present, it may optionally be - followed by a port number in the format `:8080`. If not present, the command - uses Docker's public registry located at `registry-1.docker.io` by default. Name - components may contain lowercase letters, digits and separators. A separator - is defined as a period, one or two underscores, or one or more dashes. A name - component may not start or end with a separator. - - A tag name must be valid ASCII and may contain lowercase and uppercase letters, - digits, underscores, periods and dashes. A tag name may not start with a - period or a dash and may contain a maximum of 128 characters. - - You can group your images together using names and tags, and then upload them - to [*Share Images via Repositories*](https://docs.docker.com/engine/tutorials/dockerrepos/#/contributing-to-docker-hub). -usage: docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] -pname: docker -plink: docker.yaml -examples: |- - ### Tag an image referenced by ID - - To tag a local image with ID "0e5574283393" into the "fedora" repository with - "version1.0": - - ```bash - $ docker tag 0e5574283393 fedora/httpd:version1.0 - ``` - - ### Tag an image referenced by Name - - To tag a local image with name "httpd" into the "fedora" repository with - "version1.0": - - ```bash - $ docker tag httpd fedora/httpd:version1.0 - ``` - - Note that since the tag name is not specified, the alias is created for an - existing local version `httpd:latest`. - - ### Tag an image referenced by Name and Tag - - To tag a local image with name "httpd" and tag "test" into the "fedora" - repository with "version1.0.test": - - ```bash - $ docker tag httpd:test fedora/httpd:version1.0.test - ``` - - ### Tag an image for a private repository - - To push an image to a private registry and not the central Docker - registry you must tag it with the registry hostname and port (if needed). - - ```bash - $ docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0 - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_top.yaml b/_data/engine-cli-edge/docker_top.yaml deleted file mode 100644 index 100de43b61..0000000000 --- a/_data/engine-cli-edge/docker_top.yaml +++ /dev/null @@ -1,12 +0,0 @@ -command: docker top -short: Display the running processes of a container -long: Display the running processes of a container -usage: docker top CONTAINER [ps OPTIONS] -pname: docker -plink: docker.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust.yaml b/_data/engine-cli-edge/docker_trust.yaml deleted file mode 100644 index d3219d7407..0000000000 --- a/_data/engine-cli-edge/docker_trust.yaml +++ /dev/null @@ -1,24 +0,0 @@ -command: docker trust -short: Manage trust on Docker images -long: Manage trust on Docker images -usage: docker trust -pname: docker -plink: docker.yaml -cname: -- docker trust inspect -- docker trust key -- docker trust revoke -- docker trust sign -- docker trust signer -clink: -- docker_trust_inspect.yaml -- docker_trust_key.yaml -- docker_trust_revoke.yaml -- docker_trust_sign.yaml -- docker_trust_signer.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_inspect.yaml b/_data/engine-cli-edge/docker_trust_inspect.yaml deleted file mode 100644 index 8e4034ce52..0000000000 --- a/_data/engine-cli-edge/docker_trust_inspect.yaml +++ /dev/null @@ -1,173 +0,0 @@ -command: docker trust inspect -short: Return low-level information about keys and signatures -long: |- - `docker trust inspect` provides low-level JSON information on signed repositories. - This includes all image tags that are signed, who signed them, and who can sign - new tags. -usage: docker trust inspect IMAGE[:TAG] [IMAGE[:TAG]...] -pname: docker trust -plink: docker_trust.yaml -options: -- option: pretty - value_type: bool - default_value: "false" - description: Print the information in a human friendly format - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Get low-level details about signatures for a single image tag\n\nUse - the `docker trust inspect` to get trust information about an image. The\nfollowing - example prints trust information for the `alpine:latest` image:\n\n```bash\n$ docker - trust inspect alpine:latest\n[\n {\n \"Name\": \"alpine:latest\",\n \"SignedTags\": - [\n {\n \"SignedTag\": \"latest\",\n \"Digest\": \"d6bfc3baf615dc9618209a8d607ba2a8103d9c8a405b3bd8741d88b4bef36478\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n }\n ],\n \"Signers\": - [],\n \"AdminstrativeKeys\": [\n {\n \"Name\": \"Repository\",\n - \ \"Keys\": [\n {\n \"ID\": \"5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\"\n - \ }\n ]\n },\n {\n \"Name\": \"Root\",\n \"Keys\": - [\n {\n \"ID\": \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n - \ }\n ]\n }\n ]\n }\n]\n```\n\nThe `SignedTags` key will - list the `SignedTag` name, its `Digest`,\nand the `Signers` responsible for the - signature.\n\n`AdministrativeKeys` will list the `Repository` and `Root` keys.\n\nIf - signers are set up for the repository via other `docker trust`\ncommands, `docker - trust inspect` includes a `Signers` key:\n\n```bash\n$ docker trust inspect my-image:purple\n[\n - \ {\n \"Name\": \"my-image:purple\",\n \"SignedTags\": [\n {\n \"SignedTag\": - \"purple\",\n \"Digest\": \"941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557\",\n - \ \"Signers\": [\n \"alice\",\n \"bob\",\n \"carol\"\n - \ ]\n }\n ],\n \"Signers\": [\n {\n \"Name\": \"alice\",\n - \ \"Keys\": [\n {\n \"ID\": \"04dd031411ed671ae1e12f47ddc8646d98f135090b01e54c3561e843084484a3\"\n - \ },\n {\n \"ID\": \"6a11e4898a4014d400332ab0e096308c844584ff70943cdd1d6628d577f45fd8\"\n - \ }\n ]\n },\n {\n \"Name\": \"bob\",\n \"Keys\": - [\n {\n \"ID\": \"433e245c656ae9733cdcc504bfa560f90950104442c4528c9616daa45824ccba\"\n - \ }\n ]\n },\n {\n \"Name\": \"carol\",\n \"Keys\": - [\n {\n \"ID\": \"d32fa8b5ca08273a2880f455fcb318da3dc80aeae1a30610815140deef8f30d9\"\n - \ },\n {\n \"ID\": \"9a8bbec6ba2af88a5fad6047d428d17e6d05dbdd03d15b4fc8a9a0e8049cd606\"\n - \ }\n ]\n }\n ],\n \"AdminstrativeKeys\": [\n {\n - \ \"Name\": \"Repository\",\n \"Keys\": [\n {\n \"ID\": - \"27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\"\n }\n - \ ]\n },\n {\n \"Name\": \"Root\",\n \"Keys\": [\n - \ {\n \"ID\": \"40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\"\n - \ }\n ]\n }\n ]\n }\n]\n```\n\nIf the image tag is unsigned - or unavailable, `docker trust inspect` does not\ndisplay any signed tags.\n\n```bash\n$ - docker trust inspect unsigned-img\nNo signatures or cannot access unsigned-img\n```\n\nHowever, - if other tags are signed in the same image repository,\n`docker trust inspect` reports - relevant key information:\n\n```bash\n$ docker trust inspect alpine:unsigned\n[\n - \ {\n \"Name\": \"alpine:unsigned\",\n \"Signers\": [],\n \"AdminstrativeKeys\": - [\n {\n \"Name\": \"Repository\",\n \"Keys\": [\n {\n - \ \"ID\": \"5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\"\n - \ }\n ]\n },\n {\n \"Name\": \"Root\",\n \"Keys\": - [\n {\n \"ID\": \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n - \ }\n ]\n }\n ]\n }\n]\n```\n\n### Get details about signatures - for all image tags in a repository\n\nIf no tag is specified, `docker trust inspect` - will report details for all\nsigned tags in the repository:\n\n```bash\n$ docker - trust inspect alpine\n[\n {\n \"Name\": \"alpine\",\n \"SignedTags\": - [\n {\n \"SignedTag\": \"3.5\",\n \"Digest\": - \"b007a354427e1880de9cdba533e8e57382b7f2853a68a478a17d447b302c219c\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n },\n {\n - \ \"SignedTag\": \"3.6\",\n \"Digest\": \"d6bfc3baf615dc9618209a8d607ba2a8103d9c8a405b3bd8741d88b4bef36478\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n - \ },\n {\n \"SignedTag\": \"edge\",\n \"Digest\": - \"23e7d843e63a3eee29b6b8cfcd10e23dd1ef28f47251a985606a31040bf8e096\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n },\n {\n - \ \"SignedTag\": \"latest\",\n \"Digest\": \"d6bfc3baf615dc9618209a8d607ba2a8103d9c8a405b3bd8741d88b4bef36478\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n - \ }\n ],\n \"Signers\": [],\n \"AdminstrativeKeys\": - [\n {\n \"Name\": \"Repository\",\n \"Keys\": - [\n {\n \"ID\": \"5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\"\n - \ }\n ]\n },\n {\n \"Name\": - \"Root\",\n \"Keys\": [\n {\n \"ID\": - \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n }\n - \ ]\n }\n ]\n }\n]\n```\n\n\n### Get details - about signatures for multiple images\n\n`docker trust inspect` can take multiple - repositories and images as arguments,\nand reports the results in an ordered list:\n\n```bash\n$ - docker trust inspect alpine notary\n[\n {\n \"Name\": \"alpine\",\n \"SignedTags\": - [\n {\n \"SignedTag\": \"3.5\",\n \"Digest\": - \"b007a354427e1880de9cdba533e8e57382b7f2853a68a478a17d447b302c219c\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n },\n {\n - \ \"SignedTag\": \"3.6\",\n \"Digest\": \"d6bfc3baf615dc9618209a8d607ba2a8103d9c8a405b3bd8741d88b4bef36478\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n - \ },\n {\n \"SignedTag\": \"edge\",\n \"Digest\": - \"23e7d843e63a3eee29b6b8cfcd10e23dd1ef28f47251a985606a31040bf8e096\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n },\n {\n - \ \"SignedTag\": \"integ-test-base\",\n \"Digest\": - \"3952dc48dcc4136ccdde37fbef7e250346538a55a0366e3fccc683336377e372\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n },\n {\n - \ \"SignedTag\": \"latest\",\n \"Digest\": \"d6bfc3baf615dc9618209a8d607ba2a8103d9c8a405b3bd8741d88b4bef36478\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n - \ }\n ],\n \"Signers\": [],\n \"AdminstrativeKeys\": - [\n {\n \"Name\": \"Repository\",\n \"Keys\": - [\n {\n \"ID\": \"5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\"\n - \ }\n ]\n },\n {\n \"Name\": - \"Root\",\n \"Keys\": [\n {\n \"ID\": - \"a2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\"\n }\n - \ ]\n }\n ]\n },\n {\n \"Name\": \"notary\",\n - \ \"SignedTags\": [\n {\n \"SignedTag\": \"server\",\n - \ \"Digest\": \"71f64ab718a3331dee103bc5afc6bc492914738ce37c2d2f127a8133714ecf5c\",\n - \ \"Signers\": [\n \"Repo Admin\"\n ]\n - \ },\n {\n \"SignedTag\": \"signer\",\n \"Digest\": - \"a6122d79b1e74f70b5dd933b18a6d1f99329a4728011079f06b245205f158fe8\",\n \"Signers\": - [\n \"Repo Admin\"\n ]\n }\n ],\n - \ \"Signers\": [],\n \"AdminstrativeKeys\": [\n {\n \"Name\": - \"Root\",\n \"Keys\": [\n {\n \"ID\": - \"8cdcdef5bd039f4ab5a029126951b5985eebf57cabdcdc4d21f5b3be8bb4ce92\"\n }\n - \ ]\n },\n {\n \"Name\": \"Repository\",\n - \ \"Keys\": [\n {\n \"ID\": - \"85bfd031017722f950d480a721f845a2944db26a3dc084040a70f1b0d9bbb3df\"\n }\n - \ ]\n }\n ]\n }\n]\n```\n\n### Formatting\n\nYou - can print the inspect output in a human-readable format instead of the default\nJSON - output, by using the `--pretty` option:\n\n### Get details about signatures for - a single image tag\n\n```bash\n$ docker trust inspect --pretty alpine:latest\n\nSIGNED - TAG DIGEST SIGNERS\nlatest - \ 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe (Repo - Admin)\n\nAdministrative keys for alpine:latest:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot - Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nThe - `SIGNED TAG` is the signed image tag with a unique content-addressable\n`DIGEST`. - `SIGNERS` lists all entities who have signed.\n\nThe administrative keys listed - specify the root key of trust, as well as\nthe administrative repository key. These - keys are responsible for modifying\nsigners, and rotating keys for the signed repository.\n\nIf - signers are set up for the repository via other `docker trust` commands,\n`docker - trust inspect --pretty` displays them appropriately as a `SIGNER`\nand specify their - `KEYS`:\n\n```bash\n$ docker trust inspect --pretty my-image:purple\nSIGNED TAG - \ DIGEST SIGNERS\npurple - \ 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557 alice, - bob, carol\n\nList of signers and their keys:\n\nSIGNER KEYS\nalice - \ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol - \ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot - Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```\n\nHowever, - if other tags are signed in the same image repository,\n`docker trust inspect` reports - relevant key information.\n\n```bash\n$ docker trust inspect --pretty alpine:unsigned\n\nNo - signatures for alpine:unsigned\n\n\nAdministrative keys for alpine:unsigned:\nRepository - Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\n### - Get details about signatures for all image tags in a repository\n\n```bash\n$ docker - trust inspect --pretty alpine\nSIGNED TAG DIGEST SIGNERS\n2.6 - \ 9ace551613070689a12857d62c30ef0daa9a376107ec0fff0e34786cedb3399b - \ (Repo Admin)\n2.7 9f08005dff552038f0ad2f46b8e65ff3d25641747d3912e3ea8da6785046561a - \ (Repo Admin)\n3.1 d9477888b78e8c6392e0be8b2e73f8c67e2894ff9d4b8e467d1488fcceec21c8 - \ (Repo Admin)\n3.2 19826d59171c2eb7e90ce52bfd822993bef6a6fe3ae6bb4a49f8c1d0a01e99c7 - \ (Repo Admin)\n3.3 8fd4b76819e1e5baac82bd0a3d03abfe3906e034cc5ee32100d12aaaf3956dc7 - \ (Repo Admin)\n3.4 833ad81ace8277324f3ca8c91c02bdcf1d13988d8ecf8a3f97ecdd69d0390ce9 - \ (Repo Admin)\n3.5 af2a5bd2f8de8fc1ecabf1c76611cdc6a5f1ada1a2bdd7d3816e121b70300308 - \ (Repo Admin)\n3.6 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe - \ (Repo Admin)\nedge 79d50d15bd7ea48ea00cf3dd343b0e740c1afaa8e899bee475236ef338e1b53b - \ (Repo Admin)\nlatest 1072e499f3f655a032e88542330cf75b02e7bdf673278f701d7ba61629ee3ebe - \ (Repo Admin)\n\nAdministrative keys for alpine:\nRepository Key:\t5a46c9aaa82ff150bb7305a2d17d0c521c2d784246807b2dc611f436a69041fd\nRoot - Key:\ta2489bcac7a79aa67b19b96c4a3bf0c675ffdf00c6d2fabe1a5df1115e80adce\n```\n\nHere's - an example with signers that are set up by `docker trust` commands:\n\n```bash\n$ - docker trust inspect --pretty my-image\nSIGNED TAG DIGEST SIGNERS\nred - \ 852cc04935f930a857b630edc4ed6131e91b22073bcc216698842e44f64d2943 - \ alice\nblue f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197 - \ alice, bob\ngreen cae8fedc840f90c8057e1c24637d11865743ab1e61a972c1c9da06ec2de9a139 - \ alice, bob\nyellow 9cc65fc3126790e683d1b92f307a71f48f75fa7dd47a7b03145a123eaf0b45ba - \ carol\npurple 941d3dba358621ce3c41ef67b47cf80f701ff80cdf46b5cc86587eaebfe45557 - \ alice, bob, carol\norange d6c271baa6d271bcc24ef1cbd65abf39123c17d2e83455bdab545a1a9093fc1c - \ alice\n\nList of signers and their keys for my-image:\n\nSIGNER KEYS\nalice - \ 47caae5b3e61, a85aab9d20a4\nbob 034370bcbd77, 82a66673242c\ncarol - \ b6f9f8e1aab0\n\nAdministrative keys for my-image:\nRepository Key:\t27df2c8187e7543345c2e0bf3a1262e0bc63a72754e9a7395eac3f747ec23a44\nRoot - Key:\t40b66ccc8b176be8c7d365a17f3e046d1c3494e053dd57cfeacfe2e19c4f8e8f\n```" -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_key.yaml b/_data/engine-cli-edge/docker_trust_key.yaml deleted file mode 100644 index c6bee2f411..0000000000 --- a/_data/engine-cli-edge/docker_trust_key.yaml +++ /dev/null @@ -1,18 +0,0 @@ -command: docker trust key -short: Manage keys for signing Docker images -long: Manage keys for signing Docker images -usage: docker trust key -pname: docker trust -plink: docker_trust.yaml -cname: -- docker trust key generate -- docker trust key load -clink: -- docker_trust_key_generate.yaml -- docker_trust_key_load.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_key_generate.yaml b/_data/engine-cli-edge/docker_trust_key_generate.yaml deleted file mode 100644 index 6431db6305..0000000000 --- a/_data/engine-cli-edge/docker_trust_key_generate.yaml +++ /dev/null @@ -1,21 +0,0 @@ -command: docker trust key generate -short: Generate and load a signing key-pair -long: Generate and load a signing key-pair -usage: docker trust key generate NAME -pname: docker trust key -plink: docker_trust_key.yaml -options: -- option: dir - value_type: string - description: Directory to generate key in, defaults to current directory - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_key_load.yaml b/_data/engine-cli-edge/docker_trust_key_load.yaml deleted file mode 100644 index b215aaa98b..0000000000 --- a/_data/engine-cli-edge/docker_trust_key_load.yaml +++ /dev/null @@ -1,22 +0,0 @@ -command: docker trust key load -short: Load a private key file for signing -long: Load a private key file for signing -usage: docker trust key load [OPTIONS] KEYFILE -pname: docker trust key -plink: docker_trust_key.yaml -options: -- option: name - value_type: string - default_value: signer - description: Name for the loaded key - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_revoke.yaml b/_data/engine-cli-edge/docker_trust_revoke.yaml deleted file mode 100644 index 76a3aac27c..0000000000 --- a/_data/engine-cli-edge/docker_trust_revoke.yaml +++ /dev/null @@ -1,61 +0,0 @@ -command: docker trust revoke -short: Remove trust for an image -long: '`docker trust revoke` removes signatures from tags in signed repositories.' -usage: docker trust revoke [OPTIONS] IMAGE[:TAG] -pname: docker trust -plink: docker_trust.yaml -options: -- option: "yes" - shorthand: "y" - value_type: bool - default_value: "false" - description: Do not prompt for confirmation - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Revoke signatures from a signed tag\n\nHere's an example of a repo - with two signed tags:\n\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED - TAG DIGEST SIGNERS\nred - \ 852cc04935f930a857b630edc4ed6131e91b22073bcc216698842e44f64d2943 - \ alice\nblue f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197 - \ alice, bob\n\nList of signers and their keys for example/trust-demo:\n\nSIGNER - \ KEYS\nalice 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```\n\nWhen - `alice`, one of the signers, runs `docker trust revoke`:\n\n```bash\n$ docker trust - revoke example/trust-demo:red\nEnter passphrase for delegation key with ID 27d42a8:\nSuccessfully - deleted signature for example/trust-demo:red\n```\n\nAfter revocation, the tag is - removed from the list of released tags:\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED - TAG DIGEST SIGNERS\nblue - \ f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197 - \ alice, bob\n\nList of signers and their keys for example/trust-demo:\n\nSIGNER - \ KEYS\nalice 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```\n\n### - Revoke signatures on all tags in a repository\n\nWhen no tag is specified, `docker - trust` revokes all signatures that you have a signing key for.\n\n```bash\n$ docker - trust view example/trust-demo\nSIGNED TAG DIGEST SIGNERS\nred - \ 852cc04935f930a857b630edc4ed6131e91b22073bcc216698842e44f64d2943 - \ alice\nblue f1c38dbaeeb473c36716f6494d803fbfbe9d8a76916f7c0093f227821e378197 - \ alice, bob\n\nList of signers and their keys for example/trust-demo:\n\nSIGNER - \ KEYS\nalice 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```\n\nWhen - `alice`, one of the signers, runs `docker trust revoke`:\n\n```bash\n$ docker trust - revoke example/trust-demo\nPlease confirm you would like to delete all signature - data for example/trust-demo? [y/N] y\nEnter passphrase for delegation key with ID - 27d42a8:\nSuccessfully deleted signature for example/trust-demo\n```\n\nAll tags - that have `alice`'s signature on them are removed from the list of released tags:\n\n```bash\n$ - docker trust view example/trust-demo\n\nNo signatures for example/trust-demo\n\n\nList - of signers and their keys for example/trust-demo:\n\nSIGNER KEYS\nalice - \ 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```" -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_sign.yaml b/_data/engine-cli-edge/docker_trust_sign.yaml deleted file mode 100644 index b42c46e27a..0000000000 --- a/_data/engine-cli-edge/docker_trust_sign.yaml +++ /dev/null @@ -1,60 +0,0 @@ -command: docker trust sign -short: Sign an image -long: '`docker trust sign` adds signatures to tags to create signed repositories.' -usage: docker trust sign IMAGE:TAG -pname: docker trust -plink: docker_trust.yaml -options: -- option: local - value_type: bool - default_value: "false" - description: Sign a locally tagged image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: "### Sign a tag as a repo admin\n\nGiven an image:\n\n```bash\n$ docker - trust view example/trust-demo\nSIGNED TAG DIGEST SIGNERS\nv1 - \ c24134c079c35e698060beabe110bb83ab285d0d978de7d92fed2c8c83570a41 - \ (Repo Admin)\n\nAdministrative keys for example/trust-demo:\nRepository Key:\t36d4c3601102fa7c5712a343c03b94469e5835fb27c191b529c06fd19c14a942\nRoot - Key:\t246d360f7c53a9021ee7d4259e3c5692f3f1f7ad4737b1ea8c7b8da741ad980b\n```\n\nSign - a new tag with `docker trust sign`:\n\n```bash\n$ docker trust sign example/trust-demo:v2\nSigning - and pushing trust metadata for example/trust-demo:v2\nThe push refers to a repository - [docker.io/example/trust-demo]\need4e566104a: Layer already exists\n77edfb6d1e3c: - Layer already exists\nc69f806905c2: Layer already exists\n582f327616f1: Layer already - exists\na3fbb648f0bd: Layer already exists\n5eac2de68a97: Layer already exists\n8d4d1ab5ff74: - Layer already exists\nv2: digest: sha256:8f6f460abf0436922df7eb06d28b3cdf733d2cac1a185456c26debbff0839c56 - size: 1787\nSigning and pushing trust metadata\nEnter passphrase for repository - key with ID 36d4c36:\nSuccessfully signed docker.io/example/trust-demo:v2\n```\n\n`docker - trust view` lists the new signature:\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED - TAG DIGEST SIGNERS\nv1 - \ c24134c079c35e698060beabe110bb83ab285d0d978de7d92fed2c8c83570a41 - \ (Repo Admin)\nv2 8f6f460abf0436922df7eb06d28b3cdf733d2cac1a185456c26debbff0839c56 - \ (Repo Admin)\n\nAdministrative keys for example/trust-demo:\nRepository Key:\t36d4c3601102fa7c5712a343c03b94469e5835fb27c191b529c06fd19c14a942\nRoot - Key:\t246d360f7c53a9021ee7d4259e3c5692f3f1f7ad4737b1ea8c7b8da741ad980b\n```\n\n### - Sign a tag as a signer\n\nGiven an image:\n\n```bash\n$ docker trust view example/trust-demo\n\nNo - signatures for example/trust-demo\n\n\nList of signers and their keys for example/trust-demo:\n\nSIGNER - \ KEYS\nalice 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```\n\nSign - a new tag with `docker trust sign`:\n\n```bash\n$ docker trust sign example/trust-demo:v1\nSigning - and pushing trust metadata for example/trust-demo:v1\nThe push refers to a repository - [docker.io/example/trust-demo]\n26b126eb8632: Layer already exists\n220d34b5f6c9: - Layer already exists\n8a5132998025: Layer already exists\naca233ed29c3: Layer already - exists\ne5d2f035d7a4: Layer already exists\nv1: digest: sha256:74d4bfa917d55d53c7df3d2ab20a8d926874d61c3da5ef6de15dd2654fc467c4 - size: 1357\nSigning and pushing trust metadata\nEnter passphrase for delegation - key with ID 27d42a8:\nSuccessfully signed docker.io/example/trust-demo:v1\n```\n\n`docker - trust view` lists the new signature:\n\n```bash\n$ docker trust view example/trust-demo\nSIGNED - TAG DIGEST SIGNERS\nv1 - \ 74d4bfa917d55d53c7df3d2ab20a8d926874d61c3da5ef6de15dd2654fc467c4 - \ alice\n\nList of signers and their keys for example/trust-demo:\n\nSIGNER KEYS\nalice - \ 05e87edcaecb\nbob 5600f5ab76a2\n\nAdministrative - keys for example/trust-demo:\nRepository Key:\tecc457614c9fc399da523a5f4e24fe306a0a6ee1cc79a10e4555b3c6ab02f71e\nRoot - Key:\t3cb2228f6561e58f46dbc4cda4fcaff9d5ef22e865a94636f82450d1d2234949\n```" -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_signer.yaml b/_data/engine-cli-edge/docker_trust_signer.yaml deleted file mode 100644 index b279973d20..0000000000 --- a/_data/engine-cli-edge/docker_trust_signer.yaml +++ /dev/null @@ -1,18 +0,0 @@ -command: docker trust signer -short: Manage entities who can sign Docker images -long: Manage entities who can sign Docker images -usage: docker trust signer -pname: docker trust -plink: docker_trust.yaml -cname: -- docker trust signer add -- docker trust signer remove -clink: -- docker_trust_signer_add.yaml -- docker_trust_signer_remove.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_signer_add.yaml b/_data/engine-cli-edge/docker_trust_signer_add.yaml deleted file mode 100644 index 4133511d85..0000000000 --- a/_data/engine-cli-edge/docker_trust_signer_add.yaml +++ /dev/null @@ -1,21 +0,0 @@ -command: docker trust signer add -short: Add a signer -long: Add a signer -usage: 'docker trust signer add OPTIONS NAME REPOSITORY [REPOSITORY...] ' -pname: docker trust signer -plink: docker_trust_signer.yaml -options: -- option: key - value_type: list - description: Path to the signer's public key file - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_trust_signer_remove.yaml b/_data/engine-cli-edge/docker_trust_signer_remove.yaml deleted file mode 100644 index bd9109e77d..0000000000 --- a/_data/engine-cli-edge/docker_trust_signer_remove.yaml +++ /dev/null @@ -1,24 +0,0 @@ -command: docker trust signer remove -short: Remove a signer -long: Remove a signer -usage: docker trust signer remove [OPTIONS] NAME REPOSITORY [REPOSITORY...] -pname: docker trust signer -plink: docker_trust_signer.yaml -options: -- option: force - shorthand: f - value_type: bool - default_value: "false" - description: | - Do not prompt for confirmation before removing the most recent signer - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_unpause.yaml b/_data/engine-cli-edge/docker_unpause.yaml deleted file mode 100644 index 284bd5f2e9..0000000000 --- a/_data/engine-cli-edge/docker_unpause.yaml +++ /dev/null @@ -1,23 +0,0 @@ -command: docker unpause -short: Unpause all processes within one or more containers -long: |- - The `docker unpause` command un-suspends all processes in the specified containers. - On Linux, it does this using the cgroups freezer. - - See the - [cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt) - for further details. -usage: docker unpause CONTAINER [CONTAINER...] -pname: docker -plink: docker.yaml -examples: |- - ```bash - $ docker unpause my_container - my_container - ``` -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_update.yaml b/_data/engine-cli-edge/docker_update.yaml deleted file mode 100644 index 23c9bd665b..0000000000 --- a/_data/engine-cli-edge/docker_update.yaml +++ /dev/null @@ -1,225 +0,0 @@ -command: docker update -short: Update configuration of one or more containers -long: |- - The `docker update` command dynamically updates container configuration. - You can use this command to prevent containers from consuming too many - resources from their Docker host. With a single command, you can place - limits on a single container or on many. To specify more than one container, - provide space-separated list of container names or IDs. - - With the exception of the `--kernel-memory` option, you can specify these - 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 - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-period - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) period - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-quota - value_type: int64 - default_value: "0" - description: Limit CPU CFS (Completely Fair Scheduler) quota - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-period - value_type: int64 - default_value: "0" - description: Limit the CPU real-time period in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-rt-runtime - value_type: int64 - default_value: "0" - description: Limit the CPU real-time runtime in microseconds - deprecated: false - min_api_version: "1.25" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpu-shares - shorthand: c - value_type: int64 - default_value: "0" - description: CPU shares (relative weight) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpus - value_type: decimal - description: Number of CPUs - deprecated: false - min_api_version: "1.29" - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-cpus - value_type: string - description: CPUs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: cpuset-mems - value_type: string - description: MEMs in which to allow execution (0-3, 0,1) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kernel-memory - value_type: bytes - default_value: "0" - description: Kernel memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory - shorthand: m - value_type: bytes - default_value: "0" - description: Memory limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-reservation - value_type: bytes - default_value: "0" - description: Memory soft limit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: memory-swap - value_type: bytes - default_value: "0" - description: | - Swap limit equal to memory plus swap: '-1' to enable unlimited swap - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: restart - value_type: string - description: Restart policy to apply when a container exits - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - The following sections illustrate ways to use this command. - - ### Update a container's cpu-shares - - To limit a container's cpu-shares to 512, first identify the container - name or ID. You can use `docker ps` to find these values. You can also - use the ID returned from the `docker run` command. Then, do the following: - - ```bash - $ docker update --cpu-shares 512 abebf7571666 - ``` - - ### Update a container with cpu-shares and memory - - To update multiple resource configurations for multiple containers: - - ```bash - $ docker update --cpu-shares 512 -m 300M abebf7571666 hopeful_morse - ``` - - ### Update a container's kernel memory constraints - - You can update a container's kernel memory limit using the `--kernel-memory` - option. On kernel version older than 4.6, this option can be updated on a - running container only if the container was started with `--kernel-memory`. - If the container was started *without* `--kernel-memory` you need to stop - the container before updating kernel memory. - - For example, if you started a container with this command: - - ```bash - $ docker run -dit --name test --kernel-memory 50M ubuntu bash - ``` - - You can update kernel memory while the container is running: - - ```bash - $ docker update --kernel-memory 80M test - ``` - - If you started a container *without* kernel memory initialized: - - ```bash - $ docker run -dit --name test2 --memory 300M ubuntu bash - ``` - - Update kernel memory of running container `test2` will fail. You need to stop - the container before updating the `--kernel-memory` setting. The next time you - start it, the container uses the new value. - - Kernel version newer than (include) 4.6 does not have this limitation, you - can use `--kernel-memory` the same way as other options. - - ### Update a container's restart policy - - You can change a container's restart policy on a running container. The new - restart policy takes effect instantly after you run `docker update` on a - container. - - To update restart policy for one or more containers: - - ```bash - $ docker update --restart=on-failure:3 abebf7571666 hopeful_morse - ``` - - 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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_version.yaml b/_data/engine-cli-edge/docker_version.yaml deleted file mode 100644 index cf6adc7bd7..0000000000 --- a/_data/engine-cli-edge/docker_version.yaml +++ /dev/null @@ -1,74 +0,0 @@ -command: docker version -short: Show the Docker version information -long: |- - By default, this will render all version information in an easy to read - layout. If a format is specified, the given template will be executed instead. - - Go's [text/template](http://golang.org/pkg/text/template/) package - describes all the details of the format. -usage: docker version [OPTIONS] -pname: docker -plink: docker.yaml -options: -- option: format - shorthand: f - value_type: string - description: Format the output using the given Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: kubeconfig - shorthand: k - value_type: string - description: Kubernetes config file - deprecated: false - experimental: false - experimentalcli: true - kubernetes: true - swarm: false -examples: |- - ### Default output - - ```bash - $ docker version - - Client: - Version: 1.8.0 - API version: 1.20 - Go version: go1.4.2 - Git commit: f5bae0a - Built: Tue Jun 23 17:56:00 UTC 2015 - OS/Arch: linux/amd64 - - Server: - Version: 1.8.0 - API version: 1.20 - Go version: go1.4.2 - Git commit: f5bae0a - Built: Tue Jun 23 17:56:00 UTC 2015 - OS/Arch: linux/amd64 - ``` - - ### Get the server version - - ```bash - $ docker version --format '{{.Server.Version}}' - - 1.8.0 - ``` - - ### Dump raw JSON data - - ```bash - $ docker version --format '{{json .}}' - - {"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 -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_volume.yaml b/_data/engine-cli-edge/docker_volume.yaml deleted file mode 100644 index 26aead5194..0000000000 --- a/_data/engine-cli-edge/docker_volume.yaml +++ /dev/null @@ -1,27 +0,0 @@ -command: docker volume -short: Manage volumes -long: |- - Manage volumes. You can use subcommands to create, inspect, list, remove, or - prune volumes. -usage: docker volume COMMAND -pname: docker -plink: docker.yaml -cname: -- docker volume create -- docker volume inspect -- docker volume ls -- docker volume prune -- docker volume rm -clink: -- docker_volume_create.yaml -- docker_volume_inspect.yaml -- docker_volume_ls.yaml -- docker_volume_prune.yaml -- docker_volume_rm.yaml -deprecated: false -min_api_version: "1.21" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_volume_create.yaml b/_data/engine-cli-edge/docker_volume_create.yaml deleted file mode 100644 index cba2d0084d..0000000000 --- a/_data/engine-cli-edge/docker_volume_create.yaml +++ /dev/null @@ -1,134 +0,0 @@ -command: docker volume create -short: Create a volume -long: |- - Creates a new volume that containers can consume and store data in. If a name is - not specified, Docker generates a random name. -usage: docker volume create [OPTIONS] [VOLUME] -pname: docker volume -plink: docker_volume.yaml -options: -- option: driver - shorthand: d - value_type: string - default_value: local - description: Specify volume driver name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: label - value_type: list - description: Set metadata for a volume - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: name - value_type: string - description: Specify volume name - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: opt - shorthand: o - value_type: map - default_value: map[] - description: Set driver specific options - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - Create a volume and then configure the container to use it: - - ```bash - $ docker volume create hello - - hello - - $ docker run -d -v hello:/world busybox ls /world - ``` - - The mount is created inside the container's `/world` directory. Docker does not - support relative paths for mount points inside the container. - - Multiple containers can use the same volume in the same time period. This is - useful if two containers need access to shared data. For example, if one - container writes and the other reads the data. - - Volume names must be unique among drivers. This means you cannot use the same - volume name with two different drivers. If you attempt this `docker` returns an - error: - - ```none - A volume named "hello" already exists with the "some-other" driver. Choose a different volume name. - ``` - - If you specify a volume name already in use on the current driver, Docker - assumes you want to re-use the existing volume and does not return an error. - - ### Driver-specific options - - Some volume drivers may take options to customize the volume creation. Use the - `-o` or `--opt` flags to pass driver options: - - ```bash - $ docker volume create --driver fake \ - --opt tardis=blue \ - --opt timey=wimey \ - foo - ``` - - These options are passed directly to the volume driver. Options for - different volume drivers may do different things (or nothing at all). - - The built-in `local` driver on Windows does not support any options. - - The built-in `local` driver on Linux accepts options similar to the linux - `mount` command. You can provide multiple options by passing the `--opt` flag - multiple times. Some `mount` options (such as the `o` option) can take a - comma-separated list of options. Complete list of available mount options can be - found [here](http://man7.org/linux/man-pages/man8/mount.8.html). - - For example, the following creates a `tmpfs` volume called `foo` with a size of - 100 megabyte and `uid` of 1000. - - ```bash - $ docker volume create --driver local \ - --opt type=tmpfs \ - --opt device=tmpfs \ - --opt o=size=100m,uid=1000 \ - foo - ``` - - Another example that uses `btrfs`: - - ```bash - $ docker volume create --driver local \ - --opt type=btrfs \ - --opt device=/dev/sda2 \ - foo - ``` - - Another example that uses `nfs` to mount the `/path/to/dir` in `rw` mode from - `192.168.1.1`: - - ```bash - $ docker volume create --driver local \ - --opt type=nfs \ - --opt o=addr=192.168.1.1,rw \ - --opt device=:/path/to/dir \ - foo - ``` -deprecated: false -min_api_version: "1.21" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_volume_inspect.yaml b/_data/engine-cli-edge/docker_volume_inspect.yaml deleted file mode 100644 index 36c69979bd..0000000000 --- a/_data/engine-cli-edge/docker_volume_inspect.yaml +++ /dev/null @@ -1,45 +0,0 @@ -command: docker volume inspect -short: Display detailed information on one or more volumes -long: |- - Returns information about a volume. By default, this command renders all results - in a JSON array. You can specify an alternate format to execute a - given template for each result. Go's - [text/template](http://golang.org/pkg/text/template/) package describes all the - details of the format. -usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...] -pname: docker volume -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 - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ```bash - $ docker volume create - 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d - $ docker volume inspect 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d - [ - { - "Name": "85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d", - "Driver": "local", - "Mountpoint": "/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data", - "Status": null - } - ] - - $ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d - /var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data - ``` -deprecated: false -min_api_version: "1.21" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_volume_ls.yaml b/_data/engine-cli-edge/docker_volume_ls.yaml deleted file mode 100644 index 7d843627c8..0000000000 --- a/_data/engine-cli-edge/docker_volume_ls.yaml +++ /dev/null @@ -1,193 +0,0 @@ -command: docker volume ls -aliases: list -short: List volumes -long: |- - List all the volumes known to Docker. You can filter using the `-f` or - `--filter` flag. Refer to the [filtering](#filtering) section for more - information about available filter options. -usage: docker volume ls [OPTIONS] -pname: docker volume -plink: docker_volume.yaml -options: -- option: filter - shorthand: f - value_type: filter - description: Provide filter values (e.g. 'dangling=true') - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print volumes using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display volume names - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -examples: |- - ### Create a volume - ```bash - $ docker volume create rosemary - - rosemary - - $ docker volume create tyler - - tyler - - $ docker volume ls - - DRIVER VOLUME NAME - local rosemary - local tyler - ``` - - ### Filtering - - The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more - than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) - - The currently supported filters are: - - * dangling (boolean - true or false, 0 or 1) - * driver (a volume driver's name) - * label (`label=` or `label==`) - * name (a volume's name) - - #### dangling - - The `dangling` filter matches on all volumes not referenced by any containers - - ```bash - $ docker run -d -v tyler:/tmpwork busybox - - f86a7dd02898067079c99ceacd810149060a70528eff3754d0b0f1a93bd0af18 - $ docker volume ls -f dangling=true - DRIVER VOLUME NAME - local rosemary - ``` - - #### driver - - The `driver` filter matches volumes based on their driver. - - The following example matches volumes that are created with the `local` driver: - - ```bash - $ docker volume ls -f driver=local - - DRIVER VOLUME NAME - local rosemary - local tyler - ``` - - #### label - - The `label` filter matches volumes based on the presence of a `label` alone or - a `label` and a value. - - First, let's create some volumes to illustrate this; - - ```bash - $ docker volume create the-doctor --label is-timelord=yes - - the-doctor - $ docker volume create daleks --label is-timelord=no - - daleks - ``` - - The following example filter matches volumes with the `is-timelord` label - regardless of its value. - - ```bash - $ docker volume ls --filter label=is-timelord - - DRIVER VOLUME NAME - local daleks - local the-doctor - ``` - - As the above example demonstrates, both volumes with `is-timelord=yes`, and - `is-timelord=no` are returned. - - Filtering on both `key` *and* `value` of the label, produces the expected result: - - ```bash - $ docker volume ls --filter label=is-timelord=yes - - DRIVER VOLUME NAME - local the-doctor - ``` - - Specifying multiple label filter produces an "and" search; all conditions - should be met; - - ```bash - $ docker volume ls --filter label=is-timelord=yes --filter label=is-timelord=no - - DRIVER VOLUME NAME - ``` - - #### name - - The `name` filter matches on all or part of a volume's name. - - The following filter matches all volumes with a name containing the `rose` string. - - ```bash - $ docker volume ls -f name=rose - - DRIVER VOLUME NAME - local rosemary - ``` - - ### Formatting - - The formatting options (`--format`) pretty-prints volumes output - using a Go template. - - Valid placeholders for the Go template are listed below: - - Placeholder | Description - --------------|------------------------------------------------------------------------------------------ - `.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 - output the data exactly as the template declares or, when using the - `table` directive, includes column headers as well. - - The following example uses a template without headers and outputs the - `Name` and `Driver` entries separated by a colon for all volumes: - - ```bash - $ docker volume ls --format "{{.Name}}: {{.Driver}}" - - vol1: local - vol2: local - vol3: local - ``` -deprecated: false -min_api_version: "1.21" -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli-edge/docker_volume_prune.yaml b/_data/engine-cli-edge/docker_volume_prune.yaml deleted file mode 100644 index 1b1eabc858..0000000000 --- a/_data/engine-cli-edge/docker_volume_prune.yaml +++ /dev/null @@ -1,45 +0,0 @@ -command: docker volume prune -short: Remove all unused local volumes -long: Remove all unused local volumes. Unused local volumes are those which are not - referenced by any containers -usage: docker volume prune [OPTIONS] -pname: docker volume -plink: docker_volume.yaml -options: -- option: filter - value_type: filter - description: Provide filter values (e.g. 'label=