iSharkFly-Docs
/
Docker-Docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

init submit all files

This commit is contained in:
YuCheng Hu 2020-11-18 13:32:27 -05:00
parent 7601e6a37f
commit e8587dc33f
1687 changed files with 147660 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.dockerignore Normal file
View File

@ -0,0 +1,19 @@
.dockerignore
.DS_Store
.git
.github
.gitignore
.gitmodules
.idea
.jekyll-metadata
.sass-cache
tests
_site
CONTRIBUTING.md
Dockerfile
Dockerfile.archive
docker-compose.yml
Gemfile
Gemfile.lock
_website*.json

2
.env Normal file
View File

@ -0,0 +1,2 @@
COMPOSE_DOCKER_CLI_BUILD=1
DOCKER_BUILDKIT=1

3
.eslintignore Normal file
View File

@ -0,0 +1,3 @@
webpack.config.js
server/index.js
server/env.js

9
.gitignore vendored Normal file
View File

@ -0,0 +1,9 @@
**/.DS_Store
**/desktop.ini
.bundle/**
.jekyll-metadata
_site/**
.sass-cache/**
CNAME
Gemfile.lock
_kbase/**

12
.gitmodules vendored Normal file
View File

@ -0,0 +1,12 @@
[submodule "tests/src/github.com/gdevillele/frontparser"]
path = tests/src/github.com/gdevillele/frontparser
url = https://github.com/gdevillele/frontparser.git
branch = f28e87c7b9dae139855b574e96f22822986249a8
[submodule "tests/src/golang.org/x/net"]
path = tests/src/golang.org/x/net
url = https://github.com/golang/net
branch = 45e771701b814666a7eb299e6c7a57d0b1799e91
[submodule "tests/src/gopkg.in/yaml.v2"]
path = tests/src/gopkg.in/yaml.v2
url = https://github.com/go-yaml/yaml.git
branch = a5b47d31c556af34a302ce5d659e6fea44d90de0

5
.markdownlint.json Normal file
View File

@ -0,0 +1,5 @@
{
"default": true,
"MD013": { "line_length": -1 },
"MD030": { "ol_multi": 2 }
}

1
.ruby-version Normal file
View File

@ -0,0 +1 @@
2.3.6

15
404.html Normal file
View File

@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="1; url=https://docs.docker.com" />
<title>Docker Documentation</title>
</head>
<body>
<p>We have moved away from the <strong>docker.github.io</strong> domain. If you're not automatically redirected, please visit us at <a href="https://docs.docker.com">docs.docker.com</a>.</p>
<script>
window.location.assign("https://docs.docker.com" + window.location.pathname);
</script>
</body>
</html>

33
404.md Normal file
View File

@ -0,0 +1,33 @@
---
title: "Sorry, we can't find that page"
permalink: /404.html
noratings: true
notoc: true
sitemap: false
skip_read_time: true
---
There might be a mistake in the URL or you might've clicked a link to content
that no longer exists. If you think it's the latter, please file an issue in
our [issue tracker on GitHub](https://github.com/docker/docker.github.io/issues/new)
and let us know what happened. Please also include a link to where the error
occurred, if applicable.
[**Click here to create a new ticket**](https://github.com/docker/docker.github.io/issues/new){:.newissue.button.primary-btn}
[![404 page not found](/images/404-docs.png)](https://docs.docker.com/ "Go to the homepage")
<script>
let el = document.querySelector("a.newissue");
if (el) {
let url = new URL("https://github.com/docker/docker.github.io/issues/new");
url.searchParams.set("title", "404 at " + window.location.pathname);
let body = "I found a broken link : " + window.location.href;
if (document.referrer !== "") {
body += "\nI arrived on this page through: " + document.referrer
}
url.searchParams.set("body", body);
el.setAttribute("href", url.toString());
}
</script>

94
Dockerfile Normal file
View File

@ -0,0 +1,94 @@
# This Dockerfile builds the docs for https://docs.docker.com/
# from the master branch of https://github.com/docker/docker.github.io
#
# Here is the sequence:
# 1. Set up base stages for building and deploying
# 2. Collect and build the reference documentation (from upstream resources)
# 3. Build static HTML from the current branch
# 4. Build the final image, combining the reference docs and current version
# of the documentation
#
# When the image is run, it starts Nginx and serves the docs at port 4000
# Jekyll environment (development/production)
ARG JEKYLL_ENV=development
# Engine
ARG ENGINE_BRANCH="19.03"
# Distribution
ARG DISTRIBUTION_BRANCH="release/2.7"
###
# Set up base stages for building and deploying
###
FROM starefossen/github-pages:198 AS builderbase
ENV TARGET=/usr/share/nginx/html
WORKDIR /usr/src/app/md_source/
# Set vars used by fetch-upstream-resources.sh script as an environment variable,
# so that they are persisted in the image for use in later stages.
ARG ENGINE_BRANCH
ENV ENGINE_BRANCH=${ENGINE_BRANCH}
ARG DISTRIBUTION_BRANCH
ENV DISTRIBUTION_BRANCH=${DISTRIBUTION_BRANCH}
# Fetch upstream resources (reference documentation)
# Only add the files that are needed to build these reference docs, so that these
# docs are only rebuilt if changes were made to ENGINE_BRANCH or DISTRIBUTION_BRANCH.
# Disable caching (docker build --no-cache) to force updating these docs.
FROM alpine AS upstream-resources
RUN apk add --no-cache subversion wget
WORKDIR /usr/src/app/md_source/
COPY ./_scripts/fetch-upstream-resources.sh ./_scripts/
ARG ENGINE_BRANCH
ARG DISTRIBUTION_BRANCH
RUN ./_scripts/fetch-upstream-resources.sh .
# Build the static HTML for the current docs.
# After building with jekyll, fix up some links
FROM builderbase AS current
COPY . .
COPY --from=upstream-resources /usr/src/app/md_source/. ./
# substitute the "{site.latest_engine_api_version}" in the title for the latest
# API docs, based on the latest_engine_api_version parameter in _config.yml
RUN ./_scripts/update-api-toc.sh
ARG JEKYLL_ENV
RUN echo "Building docs for ${JEKYLL_ENV} environment"
RUN set -eu; \
if [ "${JEKYLL_ENV}" = "production" ]; then \
jekyll build --profile -d ${TARGET} --config _config.yml,_config_production.yml; \
sed -i 's#<loc>/#<loc>https://docs.docker.com/#' "${TARGET}/sitemap.xml"; \
else \
jekyll build --profile -d ${TARGET}; \
echo '[]' > ${TARGET}/js/metadata.json; \
fi; \
find ${TARGET} -type f -name '*.html' | while read i; do sed -i 's#\(<a[^>]* href="\)https://docs.docker.com/#\1/#g' "$i"; done;
# This stage only contains the generated files. It can be used to host the
# documentation on a non-containerised service (e.g. to deploy to an s3 bucket).
# When using BuildKit, use the '--output' option to build the files and to copy
# them to your local filesystem.
#
# DOCKER_BUILDKIT=1 docker build --target=deploy-source --output=./_site .
FROM scratch AS deploy-source
COPY --from=current /usr/share/nginx/html /
# Final stage, which includes nginx, and the current docs.
#
# To build current docs:
# DOCKER_BUILDKIT=1 docker build -t docs .
FROM nginx:alpine AS deploy
ENV TARGET=/usr/share/nginx/html
WORKDIR $TARGET
COPY --from=current /usr/share/nginx/html .
# Configure NGINX
COPY _deploy/nginx/default.conf /etc/nginx/conf.d/default.conf
ARG JEKYLL_ENV
ENV JEKYLL_ENV=${JEKYLL_ENV}
CMD echo -e "Docker docs are viewable at:\nhttp://0.0.0.0:4000 (build target: ${JEKYLL_ENV})"; exec nginx -g 'daemon off;'

43
Gemfile Normal file
View File

@ -0,0 +1,43 @@
source "https://rubygems.org"
# Update me once in a while: https://github.com/github/pages-gem/releases
# Please ensure, before upgrading, that this version exists as a tag in starefossen/github-pages here:
# https://hub.docker.com/r/starefossen/github-pages/tags/
#
# Fresh install?
#
# Windows:
# Install Ruby 2.3.3 x64 and download the Development Kit for 64-bit:
# https://rubyinstaller.org/downloads/
#
# Run this to install devkit after extracting:
# ruby <path_to_devkit>/dk.rb init
# ruby <path_to_devkit>/dk.rb install
#
# then:
# gem install bundler
# bundle install
#
# Mac/Linux:
# Install Ruby 2.3.x and then:
# gem install bundler
# bundle install
#
# ---------------------
# Upgrading? Probably best to reset your environment:
#
# Remove all gems:
# gem uninstall -aIx
#
# (If Windows, do the dk.rb bits above, then go to the next step below)
# Install anew:
# gem install bundler
# bundle install
# This only affects interactive builds (local build, Netlify) and not the
# live site deploy, which uses the Dockerfiles found in the publish-tools
# branch.
gem "github-pages", "198"
gem 'wdm' if Gem.win_platform?

72
_config.yml Normal file
View File

@ -0,0 +1,72 @@
##
# Default configuration file
#
# This file overrides options set in _config.yml for production / deploy
##
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: true
permalink: pretty
safe: false
lsi: false
exclude: ["_samples", "_scripts", "404.html", "datacenter", "ee", "index.html", "js/metadata.json"]
# Component versions -- address like site.docker_ce_version
# You can't have - characters in these for non-YAML reasons
latest_engine_api_version: "1.40"
docker_ce_version: "19.03"
compose_version: "1.27.4"
compose_file_v3: "3.8"
compose_file_v2: "2.4"
machine_version: "0.16.0"
distribution_version: "2.7"
# List of plugins to enable for local development builds. Mostly the same as
# for production, but without the "jekyll-sitemap" plugin, which is not needed
# for previewing, and excluding saves some time to build
plugins:
- jekyll-redirect-from
- jekyll-relative-links
# Assets
#
# We specify the directory for Jekyll so we can use @imports.
#
# For local development, we build css with the "expanded" format to produce
# human-readable output for easier debugging.
sass:
sass_dir: _scss
style: expanded
# Set default options / metadata for some paths.
#
# Setting options here prevents having to repeat the same option in front-matter
# on every page. Avoid using wildcards, such as "path: engine/api/v1.*", as
# limitations in Jekyll cause those to introduce a _severe_ impact on build-time,
# affecting generation of (e.g.) sitemap.xml and metadata.json, resulting in the
# total build to take 60 seconds longer to build (!).
#
# The list below is for "development" (local builds, and PR previews) builds only,
# and should be kept minimal to allow for fast builds. Other options should go
# into _config_production.yml, which is used for production deploys.
defaults:
- scope:
path: ""
type: "pages"
values:
layout: docs
sitemap: false
toc_min: 2
toc_max: 3
- scope:
path: engine/reference/commandline
values:
skip_read_time: true

115
_config_production.yml Normal file
View File

@ -0,0 +1,115 @@
##
# This file overrides options set in _config.yml for production / deploy
##
# Override the exclusion list to include files that are excluded in "development",
# such as the "enterprise" stubs, which are in place to facilitate redirects
# to Mirantis.
exclude: ["_scripts", "404.html", "index.html"]
# Google Analytics, etc.
google_analytics: GTM-WL2QLG5
polldaddy_id: 8453675
# Enable search autocompletion (requires metadata.json to be generated)
local_search: true
plugins:
- jekyll-redirect-from
- jekyll-relative-links
- jekyll-sitemap
# Assets
#
# For production/deploy, we build css with the "compressed" format, to produce
# smaller files.
sass:
style: compressed
collections:
samples:
output: true
# Set default options / metadata for some paths.
#
# Setting options here prevents having to repeat the same option in front-matter
# on every page. Avoid using wildcards, such as "path: engine/api/v1.*", as
# limitations in Jekyll cause those to introduce a _severe_ impact on build-time,
# affecting generation of (e.g.) sitemap.xml and metadata.json, resulting in the
# total build to take 60 seconds longer to build (!).
#
# The list below is used for *production* deploys, and overrides the one defined
# in "_config.yml", which is used for local builds and pull-request previews.
defaults:
- scope:
path: ""
type: "pages"
values:
layout: docs
toc_min: 2
toc_max: 3
# Set the correct edit-URL for upstream resources. We usually don't create a direct
# edit link for these, and instead point to the directory that contains the file.
- scope:
path: engine/deprecated.md
values:
edit_url: "https://github.com/docker/cli/tree/master/docs/"
- scope:
path: engine/extend.md
values:
edit_url: "https://github.com/docker/cli/tree/master/docs/extend"
- scope:
path: engine/reference
values:
edit_url: "https://github.com/docker/cli/tree/master/docs/reference"
- scope:
path: engine/reference/commandline
values:
edit_url: "https://github.com/docker/cli/tree/master/docs/reference/commandline"
skip_read_time: true
- scope:
path: glossary.md
values:
edit_url: "https://github.com/docker/docker.github.io/blob/master/_data/glossary.yaml"
- scope:
path: notary/reference
values:
edit_url: "https://github.com/theupdateframework/notary/tree/master/docs/reference"
- scope:
path: registry/configuration
values:
edit_url: "https://github.com/docker/distribution/tree/master/docs"
- scope:
path: registry/spec
values:
edit_url: "https://github.com/docker/distribution/tree/master/docs/spec"
- scope:
path: compliance
values:
edit_url: "https://github.com/mirantis/compliance/tree/master/docs/compliance"
# Hide Enterprise content from sitemap. These directories still contains stubs
# that are needed to redirect old URLs
- scope:
path: "datacenter"
values:
sitemap: false
title: Docker Enterprise moved to Mirantis
- scope:
path: "desktop/enterprise"
values:
sitemap: false
- scope:
path: "ee"
values:
sitemap: false
title: Docker Enterprise moved to Mirantis
- scope:
path: "machine"
values:
sitemap: false
- scope:
path: "samples/library"
values:
sitemap: false

20
_data/advisories.yaml Normal file
View File

@ -0,0 +1,20 @@
#TODO: work out how to add a data dir to any repo that has documentation
# atm, repo's have a docs dir that is akin to the hugo content dir.
# Define Advisory texts
# can be used in page frontmatter, e.g.:
# advisory: experimental
texts:
experimental: "The functionality described on this page is marked as Experimental, and as such, may change before it becomes generally available."
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker Desktop for Mac](/docker-for-mac/) or [Docker Desktop for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
# URL based advisories
# any URL that begins with "/engine/" will get the "engine" advisory
# will be over-ridden by the `advisory` frontmatter in the topic
# [paths]
# "/engine/" = "engine"
# "/swarm/" = "swarm"

46
_data/buildx/docker_buildx.yaml Normal file
View File

@ -0,0 +1,46 @@
command: docker buildx
short: Build with BuildKit
long: Build with BuildKit
pname: docker
plink: docker.yaml
cname:
- docker buildx bake
- docker buildx build
- docker buildx create
- docker buildx du
- docker buildx imagetools
- docker buildx inspect
- docker buildx ls
- docker buildx prune
- docker buildx rm
- docker buildx stop
- docker buildx use
- docker buildx version
clink:
- docker_buildx_bake.yaml
- docker_buildx_build.yaml
- docker_buildx_create.yaml
- docker_buildx_du.yaml
- docker_buildx_imagetools.yaml
- docker_buildx_inspect.yaml
- docker_buildx_ls.yaml
- docker_buildx_prune.yaml
- docker_buildx_rm.yaml
- docker_buildx_stop.yaml
- docker_buildx_use.yaml
- docker_buildx_version.yaml
options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

97
_data/buildx/docker_buildx_bake.yaml Normal file
View File

@ -0,0 +1,97 @@
command: docker buildx bake
aliases: f
short: Build from a file
long: Build from a file
usage: docker buildx bake [OPTIONS] [TARGET...]
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: file
shorthand: f
value_type: stringArray
default_value: '[]'
description: Build definition file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: load
value_type: bool
default_value: "false"
description: Shorthand for --set=*.output=type=docker
deprecated: false
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: print
value_type: bool
default_value: "false"
description: Print the options without building
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
Set type of progress output (auto, plain, tty). Use plain to show container output
deprecated: false
experimental: false
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: push
value_type: bool
default_value: "false"
description: Shorthand for --set=*.output=type=registry
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
value_type: stringArray
default_value: '[]'
description: 'Override target value (eg: targetpattern.key=value)'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

359
_data/buildx/docker_buildx_build.yaml Normal file
View File

@ -0,0 +1,359 @@
command: docker buildx build
aliases: b
short: Start a build
long: Start a build
usage: docker buildx build [OPTIONS] PATH | URL | -
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: add-host
value_type: stringSlice
default_value: '[]'
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: allow
value_type: stringSlice
default_value: '[]'
description: |
Allow extra privileged entitlement, e.g. network.host, security.insecure
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg
value_type: stringArray
default_value: '[]'
description: Set build-time variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from
value_type: stringArray
default_value: '[]'
description: |
External cache sources (eg. user/app:cache, type=local,src=path/to/dir)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-to
value_type: stringArray
default_value: '[]'
description: |
Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)
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: 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: stringArray
default_value: '[]'
description: Set metadata for an image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: load
value_type: bool
default_value: "false"
description: Shorthand for --output=type=docker
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: string
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: string
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
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: output
shorthand: o
value_type: stringArray
default_value: '[]'
description: 'Output destination (format: type=local,dest=path)'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: stringArray
default_value: '[]'
description: Set target platform for build
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
Set type of progress output (auto, plain, tty). Use plain to show container output
deprecated: false
experimental: false
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: push
value_type: bool
default_value: "false"
description: Shorthand for --output=type=registry
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: secret
value_type: stringArray
default_value: '[]'
description: |
Secret file to expose to the build: id=mysecret,src=/local/secret
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: string
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
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ssh
value_type: stringArray
default_value: '[]'
description: |
SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]])
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: stringArray
default_value: '[]'
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: string
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

107
_data/buildx/docker_buildx_create.yaml Normal file
View File

@ -0,0 +1,107 @@
command: docker buildx create
short: Create a new builder instance
long: Create a new builder instance
usage: docker buildx create [OPTIONS] [CONTEXT|ENDPOINT]
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: append
value_type: bool
default_value: "false"
description: Append a node to builder instead of changing it
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: buildkitd-flags
value_type: string
description: Flags for buildkitd daemon
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: config
value_type: string
description: BuildKit config file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: driver
value_type: string
description: 'Driver to use (available: [])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: driver-opt
value_type: stringArray
default_value: '[]'
description: Options for the driver
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave
value_type: bool
default_value: "false"
description: Remove a node from builder instead of changing it
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Builder instance name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: node
value_type: string
description: Create/modify node with given name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: stringArray
default_value: '[]'
description: Fixed platforms for current node
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: use
value_type: bool
default_value: "false"
description: Set the current builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

39
_data/buildx/docker_buildx_du.yaml Normal file
View File

@ -0,0 +1,39 @@
command: docker buildx du
short: Disk usage
long: Disk usage
usage: docker buildx du
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: filter
value_type: filter
description: Provide filter values
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose
value_type: bool
default_value: "false"
description: Provide a more verbose output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

26
_data/buildx/docker_buildx_imagetools.yaml Normal file
View File

@ -0,0 +1,26 @@
command: docker buildx imagetools
short: Commands to work on images in registry
long: Commands to work on images in registry
pname: docker buildx
plink: docker_buildx.yaml
cname:
- docker buildx imagetools create
- docker buildx imagetools inspect
clink:
- docker_buildx_imagetools_create.yaml
- docker_buildx_imagetools_inspect.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

60
_data/buildx/docker_buildx_imagetools_create.yaml Normal file
View File

@ -0,0 +1,60 @@
command: docker buildx imagetools create
short: Create a new image based on source images
long: Create a new image based on source images
usage: docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]
pname: docker buildx imagetools
plink: docker_buildx_imagetools.yaml
options:
- option: append
value_type: bool
default_value: "false"
description: Append to existing manifest
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dry-run
value_type: bool
default_value: "false"
description: Show final image instead of pushing
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: stringArray
default_value: '[]'
description: Read source descriptor from file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: stringArray
default_value: '[]'
description: Set reference for new image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

31
_data/buildx/docker_buildx_imagetools_inspect.yaml Normal file
View File

@ -0,0 +1,31 @@
command: docker buildx imagetools inspect
short: Show details of image in the registry
long: Show details of image in the registry
usage: docker buildx imagetools inspect [OPTIONS] NAME
pname: docker buildx imagetools
plink: docker_buildx_imagetools.yaml
options:
- option: raw
value_type: bool
default_value: "false"
description: Show original JSON manifest
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

31
_data/buildx/docker_buildx_inspect.yaml Normal file
View File

@ -0,0 +1,31 @@
command: docker buildx inspect
short: Inspect current builder instance
long: Inspect current builder instance
usage: docker buildx inspect [NAME]
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: bootstrap
value_type: bool
default_value: "false"
description: Ensure builder has booted before inspecting
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

21
_data/buildx/docker_buildx_ls.yaml Normal file
View File

@ -0,0 +1,21 @@
command: docker buildx ls
short: List builder instances
long: List builder instances
usage: docker buildx ls
pname: docker buildx
plink: docker_buildx.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

68
_data/buildx/docker_buildx_prune.yaml Normal file
View File

@ -0,0 +1,68 @@
command: docker buildx prune
short: 'Remove build cache '
long: 'Remove build cache '
usage: docker buildx prune
pname: docker buildx
plink: docker_buildx.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=24h')
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
- option: keep-storage
value_type: bytes
default_value: "0"
description: Amount of disk space to keep for cache
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose
value_type: bool
default_value: "false"
description: Provide a more verbose output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

21
_data/buildx/docker_buildx_rm.yaml Normal file
View File

@ -0,0 +1,21 @@
command: docker buildx rm
short: Remove a builder instance
long: Remove a builder instance
usage: docker buildx rm [NAME]
pname: docker buildx
plink: docker_buildx.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

21
_data/buildx/docker_buildx_stop.yaml Normal file
View File

@ -0,0 +1,21 @@
command: docker buildx stop
short: Stop builder instance
long: Stop builder instance
usage: docker buildx stop [NAME]
pname: docker buildx
plink: docker_buildx.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

40
_data/buildx/docker_buildx_use.yaml Normal file
View File

@ -0,0 +1,40 @@
command: docker buildx use
short: Set the current builder instance
long: Set the current builder instance
usage: docker buildx use [OPTIONS] NAME
pname: docker buildx
plink: docker_buildx.yaml
options:
- option: default
value_type: bool
default_value: "false"
description: Set builder as default for current context
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: global
value_type: bool
default_value: "false"
description: Builder persists context changes
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

21
_data/buildx/docker_buildx_version.yaml Normal file
View File

@ -0,0 +1,21 @@
command: docker buildx version
short: 'Show buildx version information '
long: 'Show buildx version information '
usage: docker buildx version
pname: docker buildx
plink: docker_buildx.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

49
_data/cluster/docker_cluster.yaml Normal file
View File

@ -0,0 +1,49 @@
command: docker cluster
short: Docker Cluster
long: A tool to build and manage Docker Clusters.
pname: docker
plink: docker.yaml
cname:
- docker cluster backup
- docker cluster create
- docker cluster inspect
- docker cluster ls
- docker cluster restore
- docker cluster rm
- docker cluster update
- docker cluster version
clink:
- docker_cluster_backup.yaml
- docker_cluster_create.yaml
- docker_cluster_inspect.yaml
- docker_cluster_ls.yaml
- docker_cluster_restore.yaml
- docker_cluster_rm.yaml
- docker_cluster_update.yaml
- docker_cluster_version.yaml
options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

60
_data/cluster/docker_cluster_backup.yaml Normal file
View File

@ -0,0 +1,60 @@
command: docker cluster backup
short: Backup a running cluster
long: Backup a running cluster
usage: docker cluster backup [OPTIONS] cluster
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: env
shorthand: e
value_type: stringSlice
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
value_type: string
default_value: backup.tar.gz
description: Cluster backup filename
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: passphrase
value_type: string
description: Cluster backup passphrase
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

81
_data/cluster/docker_cluster_create.yaml Normal file
View File

@ -0,0 +1,81 @@
command: docker cluster create
short: Create a new Docker Cluster
long: Create a new Docker Cluster
usage: docker cluster create [OPTIONS]
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: env
shorthand: e
value_type: stringSlice
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: example
value_type: string
default_value: aws
description: Display an example cluster declaration
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
default_value: cluster.yml
description: Cluster declaration
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
shorthand: "n"
value_type: string
description: Name for the cluster
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: switch-context
shorthand: s
value_type: bool
default_value: "false"
description: Switch context after cluster create.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

43
_data/cluster/docker_cluster_inspect.yaml Normal file
View File

@ -0,0 +1,43 @@
command: docker cluster inspect
short: Display detailed information about a cluster
long: Display detailed information about a cluster
usage: docker cluster inspect [OPTIONS] cluster
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Display complete info about cluster
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

43
_data/cluster/docker_cluster_ls.yaml Normal file
View File

@ -0,0 +1,43 @@
command: docker cluster ls
short: List all available clusters
long: List all available clusters
usage: docker cluster ls [OPTIONS]
pname: docker cluster
plink: docker_cluster.yaml
options:
- 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
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

60
_data/cluster/docker_cluster_restore.yaml Normal file
View File

@ -0,0 +1,60 @@
command: docker cluster restore
short: Restore a cluster from a backup
long: Restore a cluster from a backup
usage: docker cluster restore [OPTIONS] cluster
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: env
shorthand: e
value_type: stringSlice
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
value_type: string
default_value: backup.tar.gz
description: Cluster backup filename
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: passphrase
value_type: string
description: Cluster backup passphrase
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

53
_data/cluster/docker_cluster_rm.yaml Normal file
View File

@ -0,0 +1,53 @@
command: docker cluster rm
short: Remove a cluster
long: Remove a cluster
usage: docker cluster rm [OPTIONS] cluster
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: env
shorthand: e
value_type: stringSlice
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force removal of the cluster files
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

52
_data/cluster/docker_cluster_update.yaml Normal file
View File

@ -0,0 +1,52 @@
command: docker cluster update
short: Update a running cluster's desired state
long: Update a running cluster's desired state
usage: docker cluster update [OPTIONS] cluster
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: env
shorthand: e
value_type: stringSlice
default_value: '[]'
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
description: Cluster definition
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

42
_data/cluster/docker_cluster_version.yaml Normal file
View File

@ -0,0 +1,42 @@
command: docker cluster version
short: Print Version, Commit, and Build type
long: Print Version, Commit, and Build type
usage: docker cluster version
pname: docker cluster
plink: docker_cluster.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Formats output as JSON. Implies '--log-level error'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: dry-run
value_type: bool
default_value: "false"
description: Skip provisioning resources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-level
value_type: string
default_value: warn
description: |
Set the logging level ("trace"|"debug"|"info"|"warn"|"error"|"fatal")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

45
_data/docker-app/docker_app.yaml Normal file
View File

@ -0,0 +1,45 @@
command: docker app
short: Docker Application
long: A tool to build and manage Docker Applications.
pname: docker
plink: docker.yaml
cname:
- docker app bundle
- docker app completion
- docker app init
- docker app inspect
- docker app install
- docker app list
- docker app merge
- docker app pull
- docker app push
- docker app render
- docker app split
- docker app status
- docker app uninstall
- docker app upgrade
- docker app validate
- docker app version
clink:
- docker_app_bundle.yaml
- docker_app_completion.yaml
- docker_app_init.yaml
- docker_app_inspect.yaml
- docker_app_install.yaml
- docker_app_list.yaml
- docker_app_merge.yaml
- docker_app_pull.yaml
- docker_app_push.yaml
- docker_app_render.yaml
- docker_app_split.yaml
- docker_app_status.yaml
- docker_app_uninstall.yaml
- docker_app_upgrade.yaml
- docker_app_validate.yaml
- docker_app_version.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

24
_data/docker-app/docker_app_bundle.yaml Normal file
View File

@ -0,0 +1,24 @@
command: docker app bundle
short: Create a CNAB invocation image and `bundle.json` for the application
long: Create a CNAB invocation image and `bundle.json` for the application
usage: docker app bundle [APP_NAME] [--output OUTPUT_FILE]
pname: docker app
plink: docker_app.yaml
options:
- option: output
shorthand: o
value_type: string
default_value: bundle.json
description: Output file (- for stdout)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app bundle myapp.dockerapp
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

24
_data/docker-app/docker_app_completion.yaml Normal file
View File

@ -0,0 +1,24 @@
command: docker app completion
short: Generates completion scripts for the specified shell (bash or zsh)
long: |
# Load the "docker app" completion code for bash into the current shell
. <(docker app completion bash)
# Set the "docker app" completion code for bash to autoload on startup in your ~/.bashrc,
# ~/.profile or ~/.bash_profile
. <(docker app completion bash)
# Note: bash-completion is needed.
# Load the "docker app" completion code for zsh into the current shell
source <(docker app completion zsh)
# Set the "docker app" completion code for zsh to autoload on startup in your ~/.zshrc,
source <(docker app completion zsh)
usage: docker app completion SHELL
pname: docker app
plink: docker_app.yaml
examples: $ . <(docker app completion bash)
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

51
_data/docker-app/docker_app_init.yaml Normal file
View File

@ -0,0 +1,51 @@
command: docker app init
short: Initialize Docker Application definition
long: Start building a Docker Application package. If there is a docker-compose.yml
file in the current directory it will be copied and used.
usage: docker app init APP_NAME [--compose-file COMPOSE_FILE] [--description DESCRIPTION]
[--maintainer NAME:EMAIL ...] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: compose-file
value_type: string
description: Compose file to use as application base (optional)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: description
value_type: string
description: Human readable description of your application (optional)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: maintainer
value_type: stringArray
default_value: '[]'
description: |
Name and email address of person responsible for the application (name:email) (optional)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: single-file
value_type: bool
default_value: "false"
description: Create a single-file Docker Application definition
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app init myapp --description "a useful description"
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

52
_data/docker-app/docker_app_inspect.yaml Normal file
View File

@ -0,0 +1,52 @@
command: docker app inspect
short: Shows metadata, parameters and a summary of the Compose file for a given application
long: Shows metadata, parameters and a summary of the Compose file for a given application
usage: docker app inspect [APP_NAME] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Pull the bundle
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app inspect myapp.dockerapp
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

115
_data/docker-app/docker_app_install.yaml Normal file
View File

@ -0,0 +1,115 @@
command: docker app install
aliases: deploy
short: Install an application
long: |-
Install an application.
By default, the application definition in the current directory will be
installed. The APP_NAME can also be:
- a path to a Docker Application definition (.dockerapp) or a CNAB bundle.json
- a registry Application Package reference
usage: docker app install [APP_NAME] [--name INSTALLATION_NAME] [--target-context
TARGET_CONTEXT] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: credential-set
value_type: stringArray
default_value: '[]'
description: |
Use a YAML file containing a credential set or a credential set present in the credential store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kubernetes-namespace
value_type: string
default_value: default
description: Kubernetes namespace to install into
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Installation name (defaults to application name)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: orchestrator
value_type: string
description: Orchestrator to install on (swarm, kubernetes)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Pull the bundle
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target-context
value_type: string
description: |
Context on which the application is installed (default: <current-context>)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Sends registry auth
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
$ docker app install myapp.dockerapp --name myinstallation --target-context=mycontext
$ docker app install myrepo/myapp:mytag --name myinstallation --target-context=mycontext
$ docker app install bundle.json --name myinstallation --credential-set=mycredentials.yml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/docker-app/docker_app_list.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker app list
aliases: ls
short: List the installations and their last known installation result
long: List the installations and their last known installation result
usage: docker app list [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: target-context
value_type: string
description: List installations on this context
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

23
_data/docker-app/docker_app_merge.yaml Normal file
View File

@ -0,0 +1,23 @@
command: docker app merge
short: Merge a directory format Docker Application definition into a single file
long: Merge a directory format Docker Application definition into a single file
usage: docker app merge [APP_NAME] [--output OUTPUT_FILE]
pname: docker app
plink: docker_app.yaml
options:
- option: output
shorthand: o
value_type: string
description: 'Output file (default: in-place)'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app merge myapp.dockerapp --output myapp-single.dockerapp
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

24
_data/docker-app/docker_app_pull.yaml Normal file
View File

@ -0,0 +1,24 @@
command: docker app pull
short: Pull an application package from a registry
long: Pull an application package from a registry
usage: docker app pull NAME:TAG [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app pull docker/app-example:0.1.0
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

44
_data/docker-app/docker_app_push.yaml Normal file
View File

@ -0,0 +1,44 @@
command: docker app push
short: Push an application package to a registry
long: Push an application package to a registry
usage: docker app push [APP_NAME] --tag TARGET_REFERENCE [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: stringSlice
default_value: '[]'
description: |
For multi-arch service images, only push the specified platforms
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: string
description: |
Target registry reference (default: <name>:<version> from metadata)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app push myapp --tag myrepo/myapp:mytag
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

72
_data/docker-app/docker_app_render.yaml Normal file
View File

@ -0,0 +1,72 @@
command: docker app render
short: Render the Compose file for an Application Package
long: Render the Compose file for an Application Package
usage: docker app render [APP_NAME] [--set KEY=VALUE ...] [--parameters-file PARAMETERS-FILE
...] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: formatter
value_type: string
default_value: yaml
description: Configure the output format (yaml|json)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: output
shorthand: o
value_type: string
default_value: '-'
description: Output file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Pull the bundle
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app render myapp.dockerapp --set key=value
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

23
_data/docker-app/docker_app_split.yaml Normal file
View File

@ -0,0 +1,23 @@
command: docker app split
short: Split a single-file Docker Application definition into the directory format
long: Split a single-file Docker Application definition into the directory format
usage: docker app split [APP_NAME] [--output OUTPUT_DIRECTORY]
pname: docker app
plink: docker_app.yaml
options:
- option: output
shorthand: o
value_type: string
description: 'Output directory (default: in-place)'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app split myapp.dockerapp --output myapp-directory.dockerapp
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

43
_data/docker-app/docker_app_status.yaml Normal file
View File

@ -0,0 +1,43 @@
command: docker app status
short: Get the installation status of an application
long: Get the installation status of an application. If the installation is a Docker
Application, the status shows the stack services.
usage: docker app status INSTALLATION_NAME [--target-context TARGET_CONTEXT] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: credential-set
value_type: stringArray
default_value: '[]'
description: |
Use a YAML file containing a credential set or a credential set present in the credential store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target-context
value_type: string
description: |
Context on which the application is installed (default: <current-context>)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Sends registry auth
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app status myinstallation --target-context=mycontext
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

51
_data/docker-app/docker_app_uninstall.yaml Normal file
View File

@ -0,0 +1,51 @@
command: docker app uninstall
short: Uninstall an application
long: Uninstall an application
usage: docker app uninstall INSTALLATION_NAME [--target-context TARGET_CONTEXT] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: credential-set
value_type: stringArray
default_value: '[]'
description: |
Use a YAML file containing a credential set or a credential set present in the credential store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force
value_type: bool
default_value: "false"
description: Force removal of installation
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target-context
value_type: string
description: |
Context on which the application is installed (default: <current-context>)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Sends registry auth
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app uninstall myinstallation --target-context=mycontext
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

88
_data/docker-app/docker_app_upgrade.yaml Normal file
View File

@ -0,0 +1,88 @@
command: docker app upgrade
short: Upgrade an installed application
long: Upgrade an installed application
usage: docker app upgrade INSTALLATION_NAME [--target-context TARGET_CONTEXT] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: app-name
value_type: string
description: Override the installation with another Application Package
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: credential-set
value_type: stringArray
default_value: '[]'
description: |
Use a YAML file containing a credential set or a credential set present in the credential store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Pull the bundle
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target-context
value_type: string
description: |
Context on which the application is installed (default: <current-context>)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Sends registry auth
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: $ docker app upgrade myinstallation --target-context=mycontext --set key=value
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

32
_data/docker-app/docker_app_validate.yaml Normal file
View File

@ -0,0 +1,32 @@
command: docker app validate
short: Checks the rendered application is syntactically correct
long: Checks the rendered application is syntactically correct
usage: docker app validate [APP_NAME] [--set KEY=VALUE ...] [--parameters-file PARAMETERS_FILE]
pname: docker app
plink: docker_app.yaml
options:
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

12
_data/docker-app/docker_app_version.yaml Normal file
View File

@ -0,0 +1,12 @@
command: docker app version
short: Print version information
long: Print version information
usage: docker app version
pname: docker app
plink: docker_app.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

15
_data/docsarchive/archives.yaml Normal file
View File

@ -0,0 +1,15 @@
- archive:
name: v19.03
image: docs/docker.github.io:latest
current: true
# When you make a new stable archive version, create a new entry below with the
# appropriate docker image. The current release should always be latest.
- archive:
name: v18.09
image: docs/docker.github.io:v18.09
- archive:
name: v18.03
image: docs/docker.github.io:v18.03
- archive:
name: v17.06
image: docs/docker.github.io:v17.06

125
_data/engine-cli/docker.yaml Normal file
View File

@ -0,0 +1,125 @@
command: docker
short: The base command for the Docker CLI.
long: The base command for the Docker CLI.
cname:
- docker attach
- docker build
- docker builder
- docker checkpoint
- docker commit
- docker config
- docker container
- docker context
- docker cp
- docker create
- 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_builder.yaml
- docker_checkpoint.yaml
- docker_commit.yaml
- docker_config.yaml
- docker_container.yaml
- docker_context.yaml
- docker_cp.yaml
- docker_create.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

166
_data/engine-cli/docker_attach.yaml Normal file
View File

@ -0,0 +1,166 @@
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. If the container was run with `-i` and `-t`, 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="<sequence>"` flag with the `docker attach` command. The format of
the `<sequence>` 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

1022
_data/engine-cli/docker_build.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

19
_data/engine-cli/docker_builder.yaml Normal file
View File

@ -0,0 +1,19 @@
command: docker builder
short: Manage builds
long: Manage builds
usage: docker builder
pname: docker
plink: docker.yaml
cname:
- docker builder build
- docker builder prune
clink:
- docker_builder_build.yaml
- docker_builder_prune.yaml
deprecated: false
min_api_version: "1.31"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

335
_data/engine-cli/docker_builder_build.yaml Normal file
View File

@ -0,0 +1,335 @@
command: docker builder build
short: Build an image from a Dockerfile
long: Build an image from a Dockerfile
usage: docker builder build [OPTIONS] PATH | URL | -
pname: docker builder
plink: docker_builder.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: output
shorthand: o
value_type: stringArray
default_value: '[]'
description: 'Output destination (format: type=local,dest=path)'
deprecated: false
min_api_version: "1.40"
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.38"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
Set type of progress output (auto, plain, tty). Use plain to show container output
deprecated: false
experimental: false
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: secret
value_type: stringArray
default_value: '[]'
description: |
Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
deprecated: false
min_api_version: "1.39"
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: ssh
value_type: stringArray
default_value: '[]'
description: |
SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])
deprecated: false
min_api_version: "1.39"
experimental: false
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
min_api_version: "1.31"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

51
_data/engine-cli/docker_builder_prune.yaml Normal file
View File

@ -0,0 +1,51 @@
command: docker builder prune
short: Remove build cache
long: Remove build cache
usage: docker builder prune
pname: docker builder
plink: docker_builder.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Remove all unused build cache, 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=24h')
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
- option: keep-storage
value_type: bytes
default_value: "0"
description: Amount of disk space to keep for cache
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.39"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

22
_data/engine-cli/docker_checkpoint.yaml Normal file
View File

@ -0,0 +1,22 @@
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
os_type: linux

32
_data/engine-cli/docker_checkpoint_create.yaml Normal file
View File

@ -0,0 +1,32 @@
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
os_type: linux

24
_data/engine-cli/docker_checkpoint_ls.yaml Normal file
View File

@ -0,0 +1,24 @@
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
os_type: linux

24
_data/engine-cli/docker_checkpoint_rm.yaml Normal file
View File

@ -0,0 +1,24 @@
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
os_type: linux

133
_data/engine-cli/docker_commit.yaml Normal file
View File

@ -0,0 +1,133 @@
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 <hannibal@a-team.com>")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
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

23
_data/engine-cli/docker_config.yaml Normal file
View File

@ -0,0 +1,23 @@
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

32
_data/engine-cli/docker_config_create.yaml Normal file
View File

@ -0,0 +1,32 @@
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
min_api_version: "1.37"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

32
_data/engine-cli/docker_config_inspect.yaml Normal file
View File

@ -0,0 +1,32 @@
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

42
_data/engine-cli/docker_config_ls.yaml Normal file
View File

@ -0,0 +1,42 @@
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

14
_data/engine-cli/docker_config_rm.yaml Normal file
View File

@ -0,0 +1,14 @@
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

64
_data/engine-cli/docker_container.yaml Normal file
View File

@ -0,0 +1,64 @@
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

39
_data/engine-cli/docker_container_attach.yaml Normal file
View File

@ -0,0 +1,39 @@
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

50
_data/engine-cli/docker_container_commit.yaml Normal file
View File

@ -0,0 +1,50 @@
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 <hannibal@a-team.com>")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
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

40
_data/engine-cli/docker_container_cp.yaml Normal file
View File

@ -0,0 +1,40 @@
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

871
_data/engine-cli/docker_container_create.yaml Normal file
View File

@ -0,0 +1,871 @@
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
os_type: windows
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
os_type: windows
- 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: domainname
value_type: string
description: Container NIS domain name
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: gpus
value_type: gpu-request
description: GPU devices to add to the container ('all' to pass all GPUs)
deprecated: false
min_api_version: "1.40"
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
os_type: windows
- 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
os_type: windows
- 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: network
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: network
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: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns
value_type: string
description: User namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts
value_type: string
description: UTS namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
shorthand: v
value_type: list
description: Bind mount a volume
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver
value_type: string
description: Optional volume driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from
value_type: list
description: Mount volumes from the specified container(s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli/docker_container_diff.yaml Normal file
View File

@ -0,0 +1,12 @@
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

89
_data/engine-cli/docker_container_exec.yaml Normal file
View File

@ -0,0 +1,89 @@
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: <name|uid>[:<group|gid>])'
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

22
_data/engine-cli/docker_container_export.yaml Normal file
View File

@ -0,0 +1,22 @@
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

32
_data/engine-cli/docker_container_inspect.yaml Normal file
View File

@ -0,0 +1,32 @@
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

23
_data/engine-cli/docker_container_kill.yaml Normal file
View File

@ -0,0 +1,23 @@
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

70
_data/engine-cli/docker_container_logs.yaml Normal file
View File

@ -0,0 +1,70 @@
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

90
_data/engine-cli/docker_container_ls.yaml Normal file
View File

@ -0,0 +1,90 @@
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

12
_data/engine-cli/docker_container_pause.yaml Normal file
View File

@ -0,0 +1,12 @@
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

12
_data/engine-cli/docker_container_port.yaml Normal file
View File

@ -0,0 +1,12 @@
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

116
_data/engine-cli/docker_container_prune.yaml Normal file
View File

@ -0,0 +1,116 @@
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=<timestamp>')
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 (`<timestamp>`) - only remove containers created before given timestamp
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - 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=<key>` or `label=<key>=<value>`),
which removes containers with the specified labels. The other
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), 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

12
_data/engine-cli/docker_container_rename.yaml Normal file
View File

@ -0,0 +1,12 @@
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

23
_data/engine-cli/docker_container_restart.yaml Normal file
View File

@ -0,0 +1,23 @@
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

43
_data/engine-cli/docker_container_rm.yaml Normal file
View File

@ -0,0 +1,43 @@
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 anonymous 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

898
_data/engine-cli/docker_container_run.yaml Normal file
View File

@ -0,0 +1,898 @@
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
os_type: windows
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
os_type: windows
- 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: domainname
value_type: string
description: Container NIS domain name
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: gpus
value_type: gpu-request
description: GPU devices to add to the container ('all' to pass all GPUs)
deprecated: false
min_api_version: "1.40"
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
os_type: windows
- 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
os_type: windows
- 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: network
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: network
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: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns
value_type: string
description: User namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts
value_type: string
description: UTS namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
shorthand: v
value_type: list
description: Bind mount a volume
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver
value_type: string
description: Optional volume driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from
value_type: list
description: Mount volumes from the specified container(s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

59
_data/engine-cli/docker_container_start.yaml Normal file
View File

@ -0,0 +1,59 @@
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
os_type: linux
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: linux
- 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

49
_data/engine-cli/docker_container_stats.yaml Normal file
View File

@ -0,0 +1,49 @@
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

23
_data/engine-cli/docker_container_stop.yaml Normal file
View File

@ -0,0 +1,23 @@
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

12
_data/engine-cli/docker_container_top.yaml Normal file
View File

@ -0,0 +1,12 @@
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

12
_data/engine-cli/docker_container_unpause.yaml Normal file
View File

@ -0,0 +1,12 @@
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

152
_data/engine-cli/docker_container_update.yaml Normal file
View File

@ -0,0 +1,152 @@
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: pids-limit
value_type: int64
default_value: "0"
description: Tune container pids limit (set -1 for unlimited)
deprecated: false
min_api_version: "1.40"
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

12
_data/engine-cli/docker_container_wait.yaml Normal file
View File

@ -0,0 +1,12 @@
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

30
_data/engine-cli/docker_context.yaml Normal file
View File

@ -0,0 +1,30 @@
command: docker context
short: Manage contexts
long: Manage contexts
usage: docker context
pname: docker
plink: docker.yaml
cname:
- docker context create
- docker context export
- docker context import
- docker context inspect
- docker context ls
- docker context rm
- docker context update
- docker context use
clink:
- docker_context_create.yaml
- docker_context_export.yaml
- docker_context_import.yaml
- docker_context_inspect.yaml
- docker_context_ls.yaml
- docker_context_rm.yaml
- docker_context_update.yaml
- docker_context_use.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

125
_data/engine-cli/docker_context_create.yaml Normal file
View File

@ -0,0 +1,125 @@
command: docker context create
short: Create a context
long: |-
Creates a new `context`. This allows you to quickly switch the cli
configuration to connect to different clusters or single nodes.
usage: docker context create [OPTIONS] CONTEXT
pname: docker context
plink: docker_context.yaml
options:
- option: default-stack-orchestrator
value_type: string
description: |
Default orchestrator for stack operations to use with this context (swarm|kubernetes|all)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: description
value_type: string
description: Description of the context
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: docker
value_type: stringToString
default_value: '[]'
description: set the docker endpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: from
value_type: string
description: create context from a named context
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kubernetes
value_type: stringToString
default_value: '[]'
description: set the kubernetes endpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### Create a context with a docker and kubernetes endpoint
To create a context from scratch provide the docker and, if required,
kubernetes options. The example below creates the context `my-context`
with a docker endpoint of `/var/run/docker.sock` and a kubernetes configuration
sourced from the file `/home/me/my-kube-config`:
```bash
$ docker context create \
--docker host=unix:///var/run/docker.sock \
--kubernetes config-file=/home/me/my-kube-config \
my-context
```
### Create a context based on an existing context
Use the `--from=<context-name>` option to create a new context from
an existing context. The example below creates a new context named `my-context`
from the existing context `existing-context`:
```bash
$ docker context create --from existing-context my-context
```
If the `--from` option is not set, the `context` is created from the current context:
```bash
$ docker context create my-context
```
This can be used to create a context out of an existing `DOCKER_HOST` based script:
```bash
$ source my-setup-script.sh
$ docker context create my-context
```
To source only the `docker` endpoint configuration from an existing context
use the `--docker from=<context-name>` option. The example below creates a
new context named `my-context` using the docker endpoint configuration from
the existing context `existing-context` and a kubernetes configuration sourced
from the file `/home/me/my-kube-config`:
```bash
$ docker context create \
--docker from=existing-context \
--kubernetes config-file=/home/me/my-kube-config \
my-context
```
To source only the `kubernetes` configuration from an existing context use the
`--kubernetes from=<context-name>` option. The example below creates a new
context named `my-context` using the kuberentes configuration from the existing
context `existing-context` and a docker endpoint of `/var/run/docker.sock`:
```bash
$ docker context create \
--docker host=unix:///var/run/docker.sock \
--kubernetes from=existing-context \
my-context
```
Docker and Kubernetes endpoints configurations, as well as default stack
orchestrator and description can be modified with `docker context update`.
Refer to the [`docker context update` reference](context_update.md) for details.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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