docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into patch-1

This commit is contained in:
Ali Oğuzhan Yıldız 2019-09-25 23:10:41 +03:00 committed by GitHub
parent 9031360ae7 9a28b67c84
commit f2349251f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3767 changed files with 174828 additions and 114150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -6,5 +6,4 @@ _site/**
.sass-cache/**
CNAME
Gemfile.lock
_samples/library/**
_kbase/**

2
.gitmodules vendored
View File

@ -4,7 +4,7 @@
branch = f28e87c7b9dae139855b574e96f22822986249a8
[submodule "tests/src/golang.org/x/net"]
path = tests/src/golang.org/x/net
url = https://go.googlesource.com/net
url = https://github.com/golang/net
branch = 45e771701b814666a7eb299e6c7a57d0b1799e91
[submodule "tests/src/gopkg.in/yaml.v2"]
path = tests/src/gopkg.in/yaml.v2

0
.nojekyll Normal file
View File

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>

10
404.md
View File

@ -6,11 +6,5 @@ notoc: true
tree: false
---
It seems the page you're looking for doesn't exist. Maybe you're on the wrong
track, maybe you found a broken link. Who knows?
Either way, here's a couple of options for you:
* [Open an issue](https://github.com/docker/docker.github.io/issues/new?title=I%20found%20a%20broken%20link&body=%3CDescribe%20how%20you%20got%20there%3E)
* [Go to back](/)
* [Tweet us something](https://twitter.com/docker)
![https://docs.docker.com/](/images/404-docs.png)
Please file an issue at [https://github.com/docker/docker.github.io](https://github.com/docker/docker.github.io/issues/new).

11
CONTRIBUTING.md
View File

@ -7,7 +7,7 @@ help. If a reviewer realizes you have based your work on the wrong branch, we'll
let you know so that you can rebase it.
>**Note**: To contribute code to Docker projects, see the
[Contribution guidelines](opensource/).
[Contribution guidelines](/opensource/).
### Files not edited here
@ -30,7 +30,7 @@ you give it a try!
### Overall doc improvements
Most commits will be made against the `master` branch. This include:
Most commits will be made against the `master` branch. This includes:
- Conceptual and task-based information not specific to new features
- Restructuring / rewriting
@ -121,8 +121,5 @@ know.
## Style guide
If you have questions about how to write for Docker's documentation, have a look
at the [style guide](/opensource/doc-style/). The style
guide provides guidance about grammar, syntax, formatting, styling, language, or
tone. If something isn't clear in the guide, submit an issue to let us
know or submit a pull request to help us improve it.
Docker does not currently maintain a style guide. Use your best judgment, and
try to follow the example set by the existing documentation.

122
Dockerfile
View File

@ -2,90 +2,92 @@
# from the master branch of https://github.com/docker/docker.github.io
#
# Here is the sequence:
# 1. Set up the build
# 2. Fetch upstream resources
# 3. Build static HTML from master
# 4. Reset to clean tiny nginx image
# 5. Copy Nginx config and archive HTML, which don't change often and can be cached
# 6. Copy static HTML from previous build stage (step 3)
# 1. Set up base stages for building and deploying
# 2. Collect and build the archived documentation
# 3. Collect and build the reference documentation (from upstream resources)
# 4. Build static HTML from the current branch
# 5. Build the final image, combining the archives, reference docs, and
# current version of the documentation
#
# When the image is run, it starts Nginx and serves the docs at port 4000
# Get basic configs and Jekyll env
FROM docs/docker.github.io:docs-builder AS builder
# Set the target again
ENV TARGET=/usr/share/nginx/html
# Set the source directory to md_source
ENV SOURCE=md_source
# Get the current docs from the checked out branch
# ${SOURCE} will contain a directory for each archive
COPY . ${SOURCE}
####### START UPSTREAM RESOURCES ########
# Set vars used by fetch-upstream-resources.sh script
## Branch to pull from, per ref doc
## To get master from svn the svn branch needs to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname'
# Engine
ENV ENGINE_SVN_BRANCH="branches/17.09.x"
ENV ENGINE_BRANCH="17.09.x"
ARG ENGINE_BRANCH="19.03.x"
# Distribution
ENV DISTRIBUTION_SVN_BRANCH="branches/release/2.6"
ENV DISTRIBUTION_BRANCH="release/2.6"
# Fetch upstream resources
RUN bash ./${SOURCE}/_scripts/fetch-upstream-resources.sh ${SOURCE}
####### END UPSTREAM RESOURCES ########
ARG DISTRIBUTION_BRANCH="release/2.7"
# Build the static HTML, now that everything is in place
###
# Set up base stages for building and deploying
###
RUN jekyll build -s ${SOURCE} -d ${TARGET} --config ${SOURCE}/_config.yml
# Get basic configs and Jekyll env
FROM docs/docker.github.io:docs-builder AS builderbase
ENV TARGET=/usr/share/nginx/html
WORKDIR /usr/src/app/md_source/
# Fix up some links, don't touch the archives
RUN find ${TARGET} -type f -name '*.html' | grep -vE "v[0-9]+\." | while read i; do sed -i 's#href="https://docs.docker.com/#href="/#g' "$i"; done
# Set vars used by fetch-upstream-resources.sh script
# Branch to pull from, per ref doc. To get master from svn the svn branch needs
# to be 'trunk'. To get a branch from svn it needs to be 'branches/branchname'
ARG ENGINE_BRANCH
ENV ENGINE_BRANCH=${ENGINE_BRANCH}
ENV ENGINE_SVN_BRANCH=branches/${ENGINE_BRANCH}
ARG DISTRIBUTION_BRANCH
ENV DISTRIBUTION_BRANCH=${DISTRIBUTION_BRANCH}
ENV DISTRIBUTION_SVN_BRANCH=branches/${DISTRIBUTION_BRANCH}
# BUILD OF MASTER DOCS IS NOW DONE!
# Reset to alpine so we don't get any docs source or extra apps
FROM nginx:alpine
# Set the target again
FROM nginx:alpine AS deploybase
ENV TARGET=/usr/share/nginx/html
# Get the nginx config from the nginx-onbuild image
# This hardly ever changes so should usually be cached
COPY --from=docs/docker.github.io:nginx-onbuild /etc/nginx/conf.d/default.conf /etc/nginx/conf.d/default.conf
# Get all the archive static HTML and put it into place
# Go oldest-to-newest to take advantage of the fact that we change older
# archives less often than new ones.
# To add a new archive, add it here
# AND ALSO edit _data/docsarchives/archives.yaml to add it to the drop-down
COPY --from=docs/docker.github.io:v1.4 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.5 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.6 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.7 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.8 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.9 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.10 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.11 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.12 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v1.13 ${TARGET} ${TARGET}
# Set the default command to serve the static HTML site
CMD echo -e "Docker docs are viewable at:\nhttp://0.0.0.0:4000"; exec nginx -g 'daemon off;'
# Build the archived docs
# these docs barely change, so can be cached
FROM deploybase AS archives
# Get all the archive static HTML and put it into place. To add a new archive,
# add it here, and ALSO edit _data/docsarchives/archives.yaml to add it to the drop-down
COPY --from=docs/docker.github.io:v17.03 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v17.06 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v17.09 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v17.12 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v18.03 ${TARGET} ${TARGET}
COPY --from=docs/docker.github.io:v18.09 ${TARGET} ${TARGET}
# Get the built docs output from the previous build stage
# This ordering means all previous layers can come from cache unless an archive
# changes
# 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 the configuration.
FROM builderbase AS upstream-resources
COPY ./_scripts/fetch-upstream-resources.sh ./_scripts/
COPY ./_config.yml .
COPY ./_data/toc.yaml ./_data/
RUN bash ./_scripts/fetch-upstream-resources.sh .
COPY --from=builder ${TARGET} ${TARGET}
# Serve the site (target), which is now all static HTML
CMD echo -e "Docker docs are viewable at:\nhttp://0.0.0.0:4000"; exec nginx -g 'daemon off;'
# Build the current docs from the checked out branch
FROM builderbase AS current
COPY . .
COPY --from=upstream-resources /usr/src/app/md_source/. ./
# Build the static HTML, now that everything is in place
RUN jekyll build -d ${TARGET}
# Fix up some links, don't touch the archives
RUN find ${TARGET} -type f -name '*.html' | grep -vE "v[0-9]+\." | while read i; do sed -i 's#href="https://docs.docker.com/#href="/#g' "$i"; done
# Docs with archives (for deploy)
FROM archives AS deploy
# Add the current version of the docs
COPY --from=current ${TARGET} ${TARGET}

136
Jenkinsfile vendored
View File

@ -1,25 +1,117 @@
wrappedNode(label: 'ubuntu-1604 && x86_64') {
timeout(time: 60, unit: 'MINUTES') {
deleteDir()
stage "checkout"
checkout scm
sh "git submodule update --init --recursive"
stage "test"
def reg = [credentialsId: 'csebuildbot', url: 'https://index.docker.io/v1/']
/* Jekyll creates html files to implement client side redirects.
There are absolute links to docs.docker.com in these htmls
we don't want them to be parsed by the tests for now.
Removing jekyll-redirect-from option will make sure these pages
are not generated when building with Jekyll. */
sh "awk '/jekyll-redirect-from/{n=1}; n {n--; next}; 1' < _config.yml > _config.yml.tmp"
sh "mv _config.yml.tmp _config.yml"
sh "docker build -t docs:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`"
sh "docker build -t tests:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`/tests"
sh "docker run -v /usr/src/app/allvbuild --name docs-${JOB_BASE_NAME}-${BUILD_NUMBER} docs:${JOB_BASE_NAME}-${BUILD_NUMBER} /bin/true"
sh "docker run --rm --volumes-from docs-${JOB_BASE_NAME}-${BUILD_NUMBER} -v `pwd`:/docs tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
sh "docker rm -fv docs-${JOB_BASE_NAME}-${BUILD_NUMBER}"
sh "docker rmi docs:${JOB_BASE_NAME}-${BUILD_NUMBER} tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
deleteDir()
pipeline {
agent {
label 'ubuntu-1604-aufs-stable'
}
environment {
DTR_URL = credentials('dtr-url')
DOCKER_HOST_STRING = credentials('docker-host')
UCP_BUNDLE = credentials('ucp-bundle')
SUCCESS_BOT_TOKEN = credentials('success-bot-token')
SLACK = credentials('slack-docs-webhook')
}
options {
timeout(time: 1, unit: 'HOURS')
}
stages {
stage( 'docker.github.io' ) {
when {
expression { env.GIT_URL == 'https://github.com/Docker/docker.github.io.git' }
}
stages {
stage( 'build + push stage image, update stage swarm' ) {
when {
branch 'master'
}
steps {
sh """
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
docker build -t $DTR_URL/docker/docker.github.io:stage-${env.BUILD_NUMBER} .
docker push $DTR_URL/docker/docker.github.io:stage-${env.BUILD_NUMBER}
unzip -o $UCP_BUNDLE
export DOCKER_TLS_VERIFY=1
export COMPOSE_TLS_VERSION=TLSv1_2
export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot
export DOCKER_HOST=$DOCKER_HOST_STRING
docker service update --detach=false --force --image $DTR_URL/docker/docker.github.io:stage-${env.BUILD_NUMBER} docs-stage-docker-com_docs --with-registry-auth
"""
}
}
stage( 'build + push prod image, update prod swarm' ) {
when {
branch 'published'
}
steps {
withDockerRegistry(reg) {
sh """
docker build -t docs/docker.github.io:prod-${env.BUILD_NUMBER} .
docker tag docs/docker.github.io:prod-${env.BUILD_NUMBER} docs/docker.github.io:latest
docker push docs/docker.github.io:prod-${env.BUILD_NUMBER}
docker push docs/docker.github.io:latest
unzip -o $UCP_BUNDLE
cd ucp-bundle-success_bot
export DOCKER_TLS_VERIFY=1
export COMPOSE_TLS_VERSION=TLSv1_2
export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot
export DOCKER_HOST=$DOCKER_HOST_STRING
docker service update --detach=false --force --image docs/docker.github.io:prod-${env.BUILD_NUMBER} docs-docker-com_docs --with-registry-auth
curl -X POST -H 'Content-type: application/json' --data '{"text":"Successfully published docs. https://docs.docker.com/"}' $SLACK
"""
}
}
}
}
}
stage( 'docs-private' ) {
when {
expression { env.GIT_URL == "https://github.com/docker/docs-private.git" }
}
stages {
stage( 'build + push beta-stage image, update beta-stage swarm' ) {
when {
branch 'amberjack'
}
steps {
sh """
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
docker build -t $DTR_URL/docker/docs-private:beta-stage-${env.BUILD_NUMBER} .
docker push $DTR_URL/docker/docs-private:beta-stage-${env.BUILD_NUMBER}
unzip -o $UCP_BUNDLE
export DOCKER_TLS_VERIFY=1
export COMPOSE_TLS_VERSION=TLSv1_2
export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot
export DOCKER_HOST=$DOCKER_HOST_STRING
docker service update --detach=false --force --image $DTR_URL/docker/docs-private:beta-stage-${env.BUILD_NUMBER} docs-beta-stage-docker-com_docs --with-registry-auth
"""
}
}
stage( 'build + push beta image, update beta swarm' ) {
when {
branch 'published'
}
steps {
sh """
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
docker build -t $DTR_URL/docker/docs-private:beta-${env.BUILD_NUMBER} .
docker push $DTR_URL/docker/docs-private:beta-${env.BUILD_NUMBER}
unzip -o $UCP_BUNDLE
export DOCKER_TLS_VERIFY=1
export COMPOSE_TLS_VERSION=TLSv1_2
export DOCKER_CERT_PATH=${WORKSPACE}/ucp-bundle-success_bot
export DOCKER_HOST=$DOCKER_HOST_STRING
docker service update --detach=false --force --image $DTR_URL/docker/docs-private:beta-${env.BUILD_NUMBER} docs-beta-docker-com_docs --with-registry-auth
"""
}
}
}
}
}
post {
unsuccessful {
sh """
curl -X POST -H 'Content-type: application/json' --data '{"text":"Error in docker.github.io:published build. Please contact the Customer Success Engineering team for help."}' $SLACK
"""
}
}
}

67
README.md
View File

@ -6,6 +6,30 @@ Welcome to the repo for our documentation. This is the source for
Feel free to send us pull requests and file issues. Our docs are completely
open source and we deeply appreciate contributions from our community!
## Table of Contents
- [Providing feedback](#providing-feedback)
- [Contributing](#contributing)
- [Files not edited here](#files-not-edited-here)
- [Overall doc improvements](#overall-doc-improvements)
- [Specific new features for a project](#specific-new-features-for-a-project)
- [Per-PR staging on GitHub](#per-pr-staging-on-github)
- [Staging the docs](#staging-the-docs)
- [Read these docs offline](#read-these-docs-offline)
- [Important files](#important-files)
- [Relative linking for GitHub viewing](#relative-linking-for-github-viewing)
- [Testing changes and practical guidance](#testing-changes-and-practical-guidance)
- [Per-page front-matter](#per-page-front-matter)
- [Creating tabs](#creating-tabs)
- [Running in-page Javascript](#running-in-page-javascript)
- [Images](#images)
- [Beta content disclaimer](#beta-content-disclaimer)
- [Accessing unsupported archived documentation](#accessing-unsupported-archived-documentation)
- [Building archives and the live published docs](#building-archives-and-the-live-published-docs)
- [Creating a new archive](#creating-a-new-archive)
- [Copyright and license](#copyright-and-license)
## Providing feedback
We really want your feedback, and we've made it easy. You can edit a page or
@ -169,12 +193,23 @@ You have three options:
running on http://localhost:4000/ by default. To stop it, use `CTRL+C`.
You can continue working in a second terminal and Jekyll will rebuild the
website incrementally. Refresh the browser to preview your changes.
3. Build and run a Docker image for your working branch.
```bash
$ docker build -t docker build -t docs/docker.github.io:<branch_name> .
$ docker run --rm -it -p 4000:4000 docs/docker.github.io:<branch_name>
```
After the `docker run` command, copy the URL provided in the container build output in a browser,
http://0.0.0.0:4000, and verify your changes.
## Read these docs offline
To read the docs offline, you can use either a standalone container or a swarm service.
To see all available tags, go to
[Docker Cloud](https://cloud.docker.com/app/docs/repository/docker/docs/docker.github.io/tags).
[Docker Hub](https://docs.docker.com/docker-hub/).
The following examples use the `latest` tag:
- Run a single container:
@ -197,7 +232,7 @@ Either way, you can now access the docs at port 4000 on your Docker host.
- `/_data/toc.yaml` defines the left-hand navigation for the docs
- `/js/menu.js` defines most of the docs-specific JS such as TOC generation and menu syncing
- `/css/documentation.css` defines the docs-specific style rules
- `/css/style.scss` defines the docs-specific style rules
- `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content
## Relative linking for GitHub viewing
@ -307,11 +342,33 @@ In order to keep the Git repository light, _please_ compress the images
(losslessly). On Mac you may use (ImageOptim)[https://imageoptim.com] for
instance. Be sure to compress the images *before* adding them to the
repository, doing it afterwards actually worsens the impact on the Git repo (but
still optimizes the bandwith during browsing).
still optimizes the bandwidth during browsing).
## Beta content disclaimer
```bash
> BETA DISCLAIMER
>
> This is beta content. It is not yet complete and should be considered a work in progress. This content is subject to change without notice.
```
## Accessing unsupported archived documentation
Supported documentation includes the current version plus the previous five versions.
If you are using a version of the documentation that is no longer supported, which means that the version number is not listed in the site dropdown list, you can still access that documentation in the following ways:
- By entering your version number and selecting it from the branch selection list for this repo
- By directly accessing the Github URL for your version. For example, https://github.com/docker/docker.github.io/tree/v1.9 for `v1.9`
- By running a container of the specific [tag for your documentation version](https://cloud.docker.com/u/docs/repository/docker/docs/docker.github.io/general#read-these-docs-offline)
in Docker Hub. For example, run the following to access `v1.9`:
```bash
docker run -it -p 4000:4000 docs/docker.github.io:v1.9
```
## Building archives and the live published docs
All the images described below are automatically built using Docker Cloud. To
All the images described below are automatically built using Docker Hub. To
build the site manually, from scratch, including all utility and archive images,
see the [README in the publish-tools
branch](https://github.com/docker/docker.github.io/blob/publish-tools/README.md).
@ -330,7 +387,7 @@ branch](https://github.com/docker/docker.github.io/blob/publish-tools/README.md)
## Creating a new archive
When a new Docker CE Stable version is released, the previous state of `master`
When a new Docker Engine - Community Stable version is released, the previous state of `master`
is archived into a version-specific branch like `v17.09`, by doing the following:
1. Create branch based off the commit hash before the new version was released.

102
_config.yml
View File

@ -13,26 +13,31 @@ safe: false
lsi: false
url: https://docs.docker.com
# This needs to have all the directories you expect to be in the archives (delivered by docs-base in the Dockerfile)
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13", "v17.03", "v17.06", "v17.09", "v17.12"]
exclude: ["_scripts", "apidocs/layouts", "Gemfile", "hooks"]
keep_files: ["v17.03", "v17.06", "v17.09", "v17.12", "v18.03", "v18.09"]
exclude: ["_scripts", "apidocs/layouts", "Gemfile", "hooks", "index.html", "404.html"]
# Component versions -- address like site.docker_ce_stable_version
# Component versions -- address like site.docker_ce_version
# You can't have - characters in these for non-YAML reasons
latest_stable_docker_engine_api_version: "1.37"
docker_ce_stable_version: "18.03"
docker_ce_edge_version: "18.05"
docker_ee_version: "17.06"
compose_version: "1.22.0"
machine_version: "0.14.0"
distribution_version: "2.6"
dtr_version: "2.5"
ucp_version: "3.0"
latest_engine_api_version: "1.40"
docker_ce_version: "19.03"
docker_ee_version: "19.03"
compose_version: "1.24.1"
compose_file_v3: "3.7"
compose_file_v2: "2.4"
machine_version: "0.16.0"
distribution_version: "2.7"
dtr_version: "2.7"
ucp_version: "3.2"
ucp_versions:
- version: "3.0"
- version: "3.2"
path: /ee/ucp/
latest: true
- version: "3.1"
path: /datacenter/ucp/3.1/guides/
- version: "3.0"
path: /datacenter/ucp/3.0/guides/
- version: "2.2"
path: /datacenter/ucp/2.2/guides/
- version: "2.1"
@ -43,9 +48,13 @@ ucp_versions:
path: /datacenter/ucp/1.1/overview/
dtr_versions:
- version: "2.5"
- version: "2.7"
path: /ee/dtr/
latest: true
- version: "2.6"
path: /datacenter/dtr/2.6/guides/
- version: "2.5"
path: /datacenter/dtr/2.5/guides/
- version: "2.4"
path: /datacenter/dtr/2.4/guides/
- version: "2.3"
@ -58,11 +67,22 @@ dtr_versions:
path: /datacenter/dtr/2.0/
tablabels:
dee-2.0: Docker Enterprise Edition 2.0 Beta2
dee-3.0: Docker Enterprise Edition 3.0
dee-2.1: Docker Enterprise Edition 2.1
dee-2.0: Docker Enterprise Edition 2.0
ucp-3.2: Universal Control Plane 3.2
ucp-3.1: Universal Control Plane 3.1
ucp-3.0: Universal Control Plane 3.0
ucp-2.2: Universal Control Plane 2.2
dtr-2.7: Docker Trusted Registry 2.7
dtr-2.6: Docker Trusted Registry 2.6
dtr-2.5: Docker Trusted Registry 2.5
dtr-2.4: Docker Trusted Registry 2.4
engine-19.03: Docker EE Engine 19.03
engine-18.09: Docker EE Engine 18.09
engine-18.03: Docker EE Engine 18.03
engine-17.12: Docker EE Engine 17.12
engine-17.09: Docker EE Engine 17.09
engine-17.06: Docker EE Engine 17.06
engine-17.03: Docker EE Engine 17.03
docker-cli-linux: Docker CLI on Mac/Linux
@ -80,8 +100,7 @@ plugins:
- jekyll-sitemap
defaults:
-
scope:
- scope:
path: ""
type: "pages"
values:
@ -92,37 +111,56 @@ defaults:
- scope:
path: "install"
values:
win_latest_build: "docker-17.06.2-ee-16"
win_latest_build: "docker-19.03.2"
- scope:
path: "datacenter"
values:
enterprise: true
# Latest Enterprise Platform Release
- scope:
path: "ee/dtr"
path: "ee"
values:
ucp_org: "docker"
ucp_repo: "ucp"
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.5.3"
ucp_version: "3.2.1"
dtr_version: "2.7.2"
# Previous DTR Releases
- scope:
path: "datacenter/dtr/2.6"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.6.9"
- scope:
path: "datacenter/dtr/2.5"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.5.14"
- scope:
path: "datacenter/dtr/2.4"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.4.6"
dtr_version: "2.4.14"
- scope:
path: "datacenter/dtr/2.3"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.3.8"
dtr_version: "2.3.11"
- scope:
path: "datacenter/dtr/2.2"
values:
ucp_version: "2.1"
dtr_version: "2.2"
docker_image: "docker/dtr:2.2.12"
docker_image: "docker/dtr:2.2.11"
- scope:
path: "datacenter/dtr/2.1"
values:
@ -133,28 +171,28 @@ defaults:
values:
ucp_version: "1.1"
dtr_version: "2.0"
# Previous UCP Releases
- scope:
path: "ee/ucp"
path: "datacenter/ucp/3.1"
values:
hide_from_sitemap: true
ucp_org: "docker"
ucp_repo: "ucp"
ucp_version: "3.0.4"
- scope: # This is a bit of a hack for the get-support.md topic.
path: "ee"
ucp_version: "3.1.10"
- scope:
path: "datacenter/ucp/3.0"
values:
hide_from_sitemap: true
ucp_org: "docker"
ucp_repo: "ucp"
dtr_repo: "dtr"
ucp_version: "3.0.4"
dtr_version: "2.5.0"
dtr_latest_image: "docker/dtr:2.5.3"
ucp_version: "3.0.14"
- scope:
path: "datacenter/ucp/2.2"
values:
hide_from_sitemap: true
ucp_org: "docker"
ucp_repo: "ucp"
ucp_version: "2.2.12"
ucp_version: "2.2.21"
- scope:
path: "datacenter/ucp/2.1"
values:

93
_config_authoring.yml
View File

@ -2,36 +2,40 @@ name: Docker Documentation
markdown: kramdown
kramdown:
input: GFM
gfm_quirks: [paragraph_end, no_auto_typographic]
html_to_native: true
hard_wrap: false
syntax_highlighter: rouge
toc_levels: 2..3
incremental: false
permalink: pretty
safe: false
lsi: false
url: https://docs.docker.com
incremental: false
# Component versions -- address like site.docker_ce_stable_version
# Component versions -- address like site.docker_ce_version
# You can't have - characters in these for non-YAML reasons
# TO USE ME:
# jekyll serve --incremental --config _config_authoring.yml
docker_ce_stable_version: "17.09"
latest_stable_docker_engine_api_version: "1.32"
docker_ce_edge_version: "17.09"
docker_ee_version: "17.06"
compose_version: "1.16.1"
machine_version: "0.12.2"
latest_engine_api_version: "1.40"
docker_ce_version: "19.03"
docker_ee_version: "19.03"
compose_version: "1.24.1"
compose_file_v3: "3.7"
compose_file_v2: "2.4"
machine_version: "0.16.0"
distribution_version: "2.6"
dtr_version: "2.5"
ucp_version: "3.0"
dtr_version: "2.6"
ucp_version: "3.1"
ucp_versions:
- version: "3.0"
- version: "3.1"
path: /ee/ucp/
latest: true
- version: "3.0"
path: /datacenter/ucp/3.0/guides/
- version: "2.2"
path: /datacenter/ucp/2.2/guides/
- version: "2.1"
@ -42,9 +46,11 @@ ucp_versions:
path: /datacenter/ucp/1.1/overview/
dtr_versions:
- version: "2.5"
- version: "2.6"
path: /ee/dtr/
latest: true
- version: "2.5"
path: /datacenter/dtr/2.5/guides/
- version: "2.4"
path: /datacenter/dtr/2.4/guides/
- version: "2.3"
@ -57,7 +63,7 @@ dtr_versions:
path: /datacenter/dtr/2.0/
tablabels:
dee-2.0: Docker Enterprise Edition 2.0 Beta2
dee-2.0: Docker Enterprise Edition 2.0
ucp-3.0: Universal Control Plane 3.0
ucp-2.2: Universal Control Plane 2.2
dtr-2.5: Docker Trusted Registry 2.5
@ -69,52 +75,65 @@ tablabels:
kubectl: Kubernetes CLI
cli: CLI
collections:
samples:
output: true
plugins:
- jekyll-redirect-from
- jekyll-relative-links
- jekyll-sitemap
defaults:
-
scope:
- scope:
path: ""
type: "pages"
values:
layout: docs
defaultassignee: johndmulhausen
toc_min: 2
toc_max: 3
tree: true
- scope:
path: "engine"
path: "install"
values:
win_latest_build: "docker-17.06.2-ee-6"
win_latest_build: "docker-19.03.0"
- scope:
path: "datacenter"
values:
ucp_latest_image: "docker/ucp:3.0.0-beta2"
dtr_latest_image: "docker/dtr:2.5.0-beta3"
enterprise: true
- scope:
path: "ee/dtr"
values:
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.5.0-beta3"
dtr_version: "2.6.1"
- scope:
path: "datacenter/dtr/2.5"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.5.7"
- scope:
path: "datacenter/dtr/2.4"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.4.1"
dtr_version: "2.4.8"
- scope:
path: "datacenter/dtr/2.3"
values:
hide_from_sitemap: true
dtr_org: "docker"
dtr_repo: "dtr"
dtr_version: "2.3.4"
dtr_version: "2.3.10"
- scope:
path: "datacenter/dtr/2.2"
values:
ucp_version: "2.1"
dtr_version: "2.2"
docker_image: "docker/dtr:2.2.9"
docker_image: "docker/dtr:2.2.11"
- scope:
path: "datacenter/dtr/2.1"
values:
@ -130,29 +149,47 @@ defaults:
values:
ucp_org: "docker"
ucp_repo: "ucp"
ucp_version: "3.0.0-beta2"
ucp_version: "3.1.2"
- scope: # This is a bit of a hack for the get-support.md topic.
path: "ee"
values:
ucp_org: "docker"
ucp_repo: "ucp"
dtr_repo: "dtr"
ucp_version: "3.1.2"
dtr_version: "2.6.1"
- scope:
path: "datacenter/ucp/3.0"
values:
hide_from_sitemap: true
ucp_org: "docker"
ucp_repo: "ucp"
ucp_version: "3.0.8"
- scope:
path: "datacenter/ucp/2.2"
values:
hide_from_sitemap: true
ucp_org: "docker"
ucp_repo: "ucp"
ucp_version: "2.2.3"
ucp_version: "2.2.15"
- scope:
path: "datacenter/ucp/2.1"
values:
hide_from_sitemap: true
ucp_version: "2.1"
dtr_version: "2.2"
docker_image: "docker/ucp:2.1.5"
docker_image: "docker/ucp:2.1.8"
- scope:
path: "datacenter/ucp/2.0"
values:
hide_from_sitemap: true
ucp_version: "2.0"
dtr_version: "2.1"
docker_image: "docker/ucp:2.0.3"
docker_image: "docker/ucp:2.0.4"
- scope:
path: "datacenter/ucp/1.1"
values:
hide_from_sitemap: true
ucp_version: "1.1"
dtr_version: "2.0"

11
_data/advisories.yaml
View File

@ -10,14 +10,13 @@
texts:
experimental: "The functionality described on this page is marked as Experimental, and as such, may change before it becomes generally available."
rc: "The Swarm mode feature included in Docker Engine 1.12 is a release candidate feature and might be subject to non backward-compatible changes. Some functionality may change before the feature becomes generally available."
docker4mac-beta: "Docker for Mac is currently in public beta. Some functionality may change before the product becomes generally available."
docker4win-beta: "Docker for Windows is currently in public beta. Some functionality may change before the product becomes generally available."
toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker for Mac](/docker-for-mac/) and [Docker for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible."
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker for Mac](/docker-for-mac/) or [Docker for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
docker4mac-beta: "Docker Desktop for Mac is currently in public beta. Some functionality may change before the product becomes generally available."
docker4win-beta: "Docker Desktop for Windows is currently in public beta. Some functionality may change before the product becomes generally available."
toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker Desktop for Mac](/docker-for-mac/) and [Docker Desktop for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible."
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."
swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product."
swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. In Docker 1.12 and higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode &#8212; a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/), [Swarm mode CLI commands](/engine/swarm/index.md#swarm-mode-cli-commands), and the [Get started with Docker walkthrough](/get-started/)). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."
engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker for Mac and Docker for Windows are currently in Beta."
cloud-swarm: "**Beta Feature.** Swarm Mode for Docker Cloud is currently a public Beta."
engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker Desktop for Mac and Docker Desktop for Windows are currently in Beta."
# URL based advisories

23
_data/application-template/docker_template.yaml Normal file
View File

@ -0,0 +1,23 @@
command: docker template
short: Use templates to quickly create new services
long: Use templates to quickly create new services
pname: docker
plink: docker.yaml
cname:
- docker template config
- docker template inspect
- docker template list
- docker template scaffold
- docker template version
clink:
- docker_template_config.yaml
- docker_template_inspect.yaml
- docker_template_list.yaml
- docker_template_scaffold.yaml
- docker_template_version.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

17
_data/application-template/docker_template_config.yaml Normal file
View File

@ -0,0 +1,17 @@
command: docker template config
short: Modify docker template configuration
long: Modify docker template configuration
pname: docker template
plink: docker_template.yaml
cname:
- docker template config set
- docker template config view
clink:
- docker_template_config_set.yaml
- docker_template_config_view.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

48
_data/application-template/docker_template_config_set.yaml Normal file
View File

@ -0,0 +1,48 @@
command: docker template config set
short: set default values for docker template
long: set default values for docker template
usage: docker template config set
pname: docker template config
plink: docker_template_config.yaml
options:
- option: feedback
value_type: bool
default_value: "false"
description: |
Send anonymous feedback about usage (performance, failure status, os, version)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-feedback
value_type: bool
default_value: "false"
description: Don't send anonymous feedback
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: org
value_type: string
description: Set default organization / docker hub user
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: server
value_type: string
description: Set default registry server (host[:port])
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/application-template/docker_template_config_view.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker template config view
short: view default values for docker template
long: view default values for docker template
usage: docker template config view
pname: docker template config
plink: docker_template_config.yaml
options:
- option: format
value_type: string
default_value: yaml
description: Configure the output format (json|yaml)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/application-template/docker_template_inspect.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker template inspect
short: Inspect service templates or application templates
long: Inspect service templates or application templates
usage: docker template inspect <service or application>
pname: docker template
plink: docker_template.yaml
options:
- option: format
value_type: string
default_value: pretty
description: Configure the output format (pretty|json|yaml)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

32
_data/application-template/docker_template_list.yaml Normal file
View File

@ -0,0 +1,32 @@
command: docker template list
aliases: ls
short: List available templates with their informations
long: List available templates with their informations
usage: docker template list
pname: docker template
plink: docker_template.yaml
options:
- option: format
value_type: string
default_value: pretty
description: Configure the output format (pretty|json|yaml)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: type
value_type: string
default_value: all
description: Filter by type (application|service|all)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

70
_data/application-template/docker_template_scaffold.yaml Normal file
View File

@ -0,0 +1,70 @@
command: docker template scaffold
short: Choose an application template or service template(s) and scaffold a new project
long: Choose an application template or service template(s) and scaffold a new project
usage: docker template scaffold application [<alias=service>...] OR scaffold [alias=]service
[<[alias=]service>...]
pname: docker template
plink: docker_template.yaml
options:
- option: name
value_type: string
description: Application name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: org
value_type: string
description: |
Deploy to a specific organization / docker hub user (if not specified, it will use your current hub login)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: path
value_type: string
description: Deploy to a specific path
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
default_value: linux
description: Target platform (linux|windows)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: server
value_type: string
description: Deploy to a specific registry server (host[:port])
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameters values (service.name=value)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "docker template scaffold react-java-mysql -s back.java=10 -s front.externalPort=80
\ndocker template scaffold react-java-mysql java=back reactjs=front -s reactjs.externalPort=80
\ndocker template scaffold back=spring front=react -s back.externalPort=9000 \ndocker
template scaffold react-java-mysql --server=myregistry:5000 --org=myorg"
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

12
_data/application-template/docker_template_version.yaml Normal file
View File

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

64
_data/assemble/docker_assemble.yaml Normal file
View File

@ -0,0 +1,64 @@
command: docker assemble
short: assemble is a high-level build tool
long: assemble is a high-level build tool
pname: docker
plink: docker.yaml
cname:
- docker assemble backend
- docker assemble build
- docker assemble version
clink:
- docker_assemble_backend.yaml
- docker_assemble_build.yaml
- docker_assemble_version.yaml
options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlscacert
value_type: string
description: |
specify CA certificate to use when validating the backend service's TLS certificate
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlscert
value_type: string
description: |
specify client certificate to use when connecting to backend service
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlskey
value_type: string
description: specify client key to use when connecting to backend service
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlsservername
value_type: string
description: |
override server name for validation of the backend service's TLS certificate
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

35
_data/assemble/docker_assemble_backend.yaml Normal file
View File

@ -0,0 +1,35 @@
command: docker assemble backend
short: Manage build backend service
long: Manage build backend service
pname: docker assemble
plink: docker_assemble.yaml
cname:
- docker assemble backend cache
- docker assemble backend image
- docker assemble backend info
- docker assemble backend logs
- docker assemble backend start
- docker assemble backend stop
clink:
- docker_assemble_backend_cache.yaml
- docker_assemble_backend_image.yaml
- docker_assemble_backend_info.yaml
- docker_assemble_backend_logs.yaml
- docker_assemble_backend_start.yaml
- docker_assemble_backend_stop.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

27
_data/assemble/docker_assemble_backend_cache.yaml Normal file
View File

@ -0,0 +1,27 @@
command: docker assemble backend cache
short: Manage build cache
long: Manage build cache
pname: docker assemble backend
plink: docker_assemble_backend.yaml
cname:
- docker assemble backend cache purge
- docker assemble backend cache usage
clink:
- docker_assemble_backend_cache_purge.yaml
- docker_assemble_backend_cache_usage.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/assemble/docker_assemble_backend_cache_purge.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker assemble backend cache purge
short: Purge build cache
long: Purge build cache
usage: docker assemble backend cache purge
pname: docker assemble backend cache
plink: docker_assemble_backend_cache.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/assemble/docker_assemble_backend_cache_usage.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker assemble backend cache usage
short: Show build cache contents
long: Show build cache contents
usage: docker assemble backend cache usage
pname: docker assemble backend cache
plink: docker_assemble_backend_cache.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

31
_data/assemble/docker_assemble_backend_image.yaml Normal file
View File

@ -0,0 +1,31 @@
command: docker assemble backend image
short: Print image to be used as backend
long: |-
Print image to be used as backend.
This can be useful to do:
docker save -o assemble-backend.tar $(docker assemble backend image)
In order to transport "assemble-backend.tar" to an offline system and:
docker load < assemble-backend.tar
usage: docker assemble backend image
pname: docker assemble backend
plink: docker_assemble_backend.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/assemble/docker_assemble_backend_info.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker assemble backend info
short: Print information about build backend service
long: Print information about build backend service
usage: docker assemble backend info
pname: docker assemble backend
plink: docker_assemble_backend.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

32
_data/assemble/docker_assemble_backend_logs.yaml Normal file
View File

@ -0,0 +1,32 @@
command: docker assemble backend logs
short: Show logs for build backend service
long: Show logs for build backend service
usage: docker assemble backend logs
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: follow
value_type: bool
default_value: "false"
description: follow log output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

60
_data/assemble/docker_assemble_backend_start.yaml Normal file
View File

@ -0,0 +1,60 @@
command: docker assemble backend start
short: Start build backend service
long: Start build backend service
usage: docker assemble backend start
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: allow-host-port
value_type: uintSlice
default_value: '[5000]'
description: |
allow the backend to access a host port by starting a proxy container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-volume
value_type: string
description: |
named volume to use as build cache (default "docker-assemble-backend-cache-root" if it exists, otherwise an anonymous volume)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: host-port
value_type: uint16
default_value: "0"
description: host port to expose build service (0 is a random port)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: image
value_type: string
default_value: scratch
description: image to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

32
_data/assemble/docker_assemble_backend_stop.yaml Normal file
View File

@ -0,0 +1,32 @@
command: docker assemble backend stop
short: Stop build backend service
long: Stop build backend service
usage: docker assemble backend stop
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: keep
value_type: bool
default_value: "false"
description: stop but don't destroy the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

150
_data/assemble/docker_assemble_build.yaml Normal file
View File

@ -0,0 +1,150 @@
command: docker assemble build
short: Build a project into a container
long: Build a project into a container
usage: docker assemble build [PATH]
pname: docker assemble
plink: docker_assemble.yaml
options:
- option: debug-dump-config
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-dump-image
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-dump-llb
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-skip-build
value_type: bool
default_value: "false"
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: frontend
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: frontend-devel
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
value_type: stringArray
default_value: '[]'
description: label to write into the image as `KEY=VALUE`
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: |
build image with repository `NAME` (default taken from project metadata)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: namespace
value_type: string
description: |
build image within repository `NAMESPACE` (default no namespace)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: option
shorthand: o
value_type: stringArray
default_value: '[]'
description: set an option as `OPTION=VALUE`
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: port
value_type: stringArray
default_value: '[]'
description: port to expose from container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
set type of progress (auto, plain, tty). Use plain to show container output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: push
value_type: bool
default_value: "false"
description: push result to registry, not local image store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: push-insecure
value_type: bool
default_value: "false"
description: |
push result to insecure (http) registry, not local image store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
value_type: string
description: |
tag image with `TAG` (default taken from project metadata or "latest")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

22
_data/assemble/docker_assemble_version.yaml Normal file
View File

@ -0,0 +1,22 @@
command: docker assemble version
short: Print the version number of docker assemble
long: Print the version number of docker assemble
usage: docker assemble version
pname: docker assemble
plink: docker_assemble.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,33 @@
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 imagetools
- docker buildx inspect
- docker buildx ls
- 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_imagetools.yaml
- docker_buildx_inspect.yaml
- docker_buildx_ls.yaml
- docker_buildx_rm.yaml
- docker_buildx_stop.yaml
- docker_buildx_use.yaml
- docker_buildx_version.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,70 @@
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: 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: set
value_type: stringArray
default_value: '[]'
description: 'Override target value (eg: target.key=value)'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,340 @@
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: 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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,73 @@
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: driver
value_type: string
description: 'Driver to use (available: [])'
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,17 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,51 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,22 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,22 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,12 @@
command: docker buildx ls
short: List builder instances
long: List builder instances
usage: docker buildx ls
pname: docker buildx
plink: docker_buildx.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,12 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,12 @@
command: docker buildx stop
short: Stop builder instance
long: Stop builder instance
usage: docker buildx stop [NAME]
pname: docker buildx
plink: docker_buildx.yaml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

@ -0,0 +1,31 @@
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
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false

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

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

355
_data/ddc_offline_files_2.yaml
View File

@ -3,9 +3,215 @@
# environment that can't access the internet
# Used by _includes/components/ddc_url_list_2.html
- product: "ucp"
version: "3.2"
tar-files:
- description: "3.2.1 Linux"
url: https://packages.docker.com/caas/ucp_images_3.2.1.tar.gz
- description: "3.2.1 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.2.1.tar.gz
- description: "3.2.1 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.2.1.tar.gz
- description: "3.2.0 Linux"
url: https://packages.docker.com/caas/ucp_images_3.2.0.tar.gz
- description: "3.2.0 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.2.0.tar.gz
- description: "3.2.0 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.2.0.tar.gz
- product: "ucp"
version: "3.1"
tar-files:
- description: "3.1.10 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.10.tar.gz
- description: "3.1.10 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.10.tar.gz
- description: "3.1.10 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.10.tar.gz
- description: "3.1.10 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.10.tar.gz
- description: "3.1.9 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.9.tar.gz
- description: "3.1.9 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.9.tar.gz
- description: "3.1.9 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.9.tar.gz
- description: "3.1.9 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.9.tar.gz
- description: "3.1.8 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.8.tar.gz
- description: "3.1.8 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.8.tar.gz
- description: "3.1.8 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.8.tar.gz
- description: "3.1.8 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.8.tar.gz
- description: "3.1.7 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.7.tar.gz
- description: "3.1.7 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.7.tar.gz
- description: "3.1.7 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.7.tar.gz
- description: "3.1.7 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.7.tar.gz
- description: "3.1.7 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.7.tar.gz
- description: "3.1.6 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.6.tar.gz
- description: "3.1.6 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.6.tar.gz
- description: "3.1.6 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.6.tar.gz
- description: "3.1.6 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.6.tar.gz
- description: "3.1.6 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.6.tar.gz
- description: "3.1.5 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.5.tar.gz
- description: "3.1.5 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.5.tar.gz
- description: "3.1.5 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.5.tar.gz
- description: "3.1.5 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.5.tar.gz
- description: "3.1.5 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.5.tar.gz
- description: "3.1.4 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.4.tar.gz
- description: "3.1.4 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.4.tar.gz
- description: "3.1.4 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.4.tar.gz
- description: "3.1.4 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.4.tar.gz
- description: "3.1.4 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.4.tar.gz
- description: "3.1.3 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.3.tar.gz
- description: "3.1.3 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.3.tar.gz
- description: "3.1.3 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.3.tar.gz
- description: "3.1.3 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.3.tar.gz
- description: "3.1.3 Windows Server 2019 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2019_3.1.3.tar.gz
- description: "3.1.2 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.2.tar.gz
- description: "3.1.2 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.2.tar.gz
- description: "3.1.2 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.2.tar.gz
- description: "3.1.2 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.2.tar.gz
- description: "3.1.1 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.1.tar.gz
- description: "3.1.1 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.1.tar.gz
- description: "3.1.1 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.1.tar.gz
- description: "3.1.1 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.1.tar.gz
- description: "3.1.0 Linux"
url: https://packages.docker.com/caas/ucp_images_3.1.0.tar.gz
- description: "3.1.0 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.1.0.tar.gz
- description: "3.1.0 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.1.0.tar.gz
- description: "3.1.0 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.1.0.tar.gz
- product: "ucp"
version: "3.0"
tar-files:
- description: "3.0.14 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.14.tar.gz
- description: "3.0.14 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.14.tar.gz
- description: "3.0.14 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.14.tar.gz
- description: "3.0.14 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.14.tar.gz
- description: "3.0.13 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.13.tar.gz
- description: "3.0.13 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.13.tar.gz
- description: "3.0.13 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.13.tar.gz
- description: "3.0.13 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.13.tar.gz
- description: "3.0.12 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.12.tar.gz
- description: "3.0.12 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.12.tar.gz
- description: "3.0.12 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.12.tar.gz
- description: "3.0.12 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.12.tar.gz
- description: "3.0.11 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.11.tar.gz
- description: "3.0.11 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.11.tar.gz
- description: "3.0.11 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.11.tar.gz
- description: "3.0.11 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.11.tar.gz
- description: "3.0.11 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.11.tar.gz
- description: "3.0.10 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.10.tar.gz
- description: "3.0.10 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.10.tar.gz
- description: "3.0.10 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.10.tar.gz
- description: "3.0.10 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.10.tar.gz
- description: "3.0.10 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.10.tar.gz
- description: "3.0.9 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.9.tar.gz
- description: "3.0.9 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.9.tar.gz
- description: "3.0.9 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.9.tar.gz
- description: "3.0.9 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.9.tar.gz
- description: "3.0.9 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.9.tar.gz
- description: "3.0.8 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.8.tar.gz
- description: "3.0.8 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.8.tar.gz
- description: "3.0.8 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.8.tar.gz
- description: "3.0.8 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.8.tar.gz
- description: "3.0.7 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.7.tar.gz
- description: "3.0.7 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.7.tar.gz
- description: "3.0.7 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.7.tar.gz
- description: "3.0.7 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.7.tar.gz
- description: "3.0.6 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.6.tar.gz
- description: "3.0.6 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.6.tar.gz
- description: "3.0.6 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.6.tar.gz
- description: "3.0.6 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.6.tar.gz
- description: "3.0.6 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.6.tar.gz
- description: "3.0.5 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.5.tar.gz
- description: "3.0.5 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_3.0.5.tar.gz
- description: "3.0.5 Windows Server 2016 LTSC"
url: https://packages.docker.com/caas/ucp_images_win_2016_3.0.5.tar.gz
- description: "3.0.5 Windows Server 1709"
url: https://packages.docker.com/caas/ucp_images_win_1709_3.0.5.tar.gz
- description: "3.0.5 Windows Server 1803"
url: https://packages.docker.com/caas/ucp_images_win_1803_3.0.5.tar.gz
- description: "3.0.4 Linux"
url: https://packages.docker.com/caas/ucp_images_3.0.4.tar.gz
- description: "3.0.4 IBM Z"
@ -43,18 +249,72 @@
- product: "ucp"
version: "2.2"
tar-files:
- description: "2.2.21 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.21.tar.gz
- description: "2.2.21 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.21.tar.gz
- description: "2.2.21 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.21.tar.gz
- description: "2.2.20 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.20.tar.gz
- description: "2.2.20 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.20.tar.gz
- description: "2.2.20 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.20.tar.gz
- description: "2.2.19 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.19.tar.gz
- description: "2.2.19 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.19.tar.gz
- description: "2.2.19 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.19.tar.gz
- description: "2.2.18 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.18.tar.gz
- description: "2.2.18 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.18.tar.gz
- description: "2.2.18 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.18.tar.gz
- description: "2.2.17 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.17.tar.gz
- description: "2.2.17 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.17.tar.gz
- description: "2.2.17 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.17.tar.gz
- description: "2.2.16 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.16.tar.gz
- description: "2.2.16 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.16.tar.gz
- description: "2.2.16 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.16.tar.gz
- description: "2.2.15 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.15.tar.gz
- description: "2.2.15 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.15.tar.gz
- description: "2.2.15 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.15.tar.gz
- description: "2.2.14 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.14.tar.gz
- description: "2.2.14 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.14.tar.gz
- description: "2.2.14 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.14.tar.gz
- description: "2.2.13 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.13.tar.gz
- description: "2.2.13 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.13.tar.gz
- description: "2.2.13 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.13.tar.gz
- description: "2.2.12 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.12.tar.gz
- description: "2.2.12 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.12.tar.gz
- description: "2.2.12 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.12.tar.gz
url: https://packages.docker.com/caas/ucp_images_win_2.2.12.tar.gz
- description: "2.2.11 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.11.tar.gz
- description: "2.2.11 IBM Z"
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.11.tar.gz
- description: "2.2.11 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.11.tar.gz
url: https://packages.docker.com/caas/ucp_images_win_2.2.11.tar.gz
- description: "2.2.10 Linux"
url: https://packages.docker.com/caas/ucp_images_2.2.10.tar.gz
- description: "2.2.10 IBM Z"
@ -109,36 +369,92 @@
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.0.tar.gz
- description: "2.2.0 Windows"
url: https://packages.docker.com/caas/ucp_images_win_2.2.0.tar.gz
- product: "dtr"
version: "2.7"
tar-files:
- description: "DTR 2.7.2 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.7.2.tar.gz
- description: "DTR 2.7.1 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.7.1.tar.gz
- description: "DTR 2.7.0 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.7.0.tar.gz
- product: "dtr"
version: "2.6"
tar-files:
- description: "DTR 2.6.9 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.9.tar.gz
- description: "DTR 2.6.8 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.8.tar.gz
- description: "DTR 2.6.7 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.7.tar.gz
- description: "DTR 2.6.6 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.6.tar.gz
- description: "DTR 2.6.5 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.5.tar.gz
- description: "DTR 2.6.4 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.4.tar.gz
- description: "DTR 2.6.3 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.3.tar.gz
- description: "DTR 2.6.2 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.2.tar.gz
- description: "DTR 2.6.1 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.1.tar.gz
- description: "DTR 2.6.0 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.6.0.tar.gz
- product: "dtr"
version: "2.5"
tar-files:
- description: "DTR 2.5.4 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.4.tar.gz
- description: "DTR 2.5.4 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.5.4.tar.gz
- description: "DTR 2.5.14 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.14.tar.gz
- description: "DTR 2.5.13 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.13.tar.gz
- description: "DTR 2.5.12 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.12.tar.gz
- description: "DTR 2.5.11 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.11.tar.gz
- description: "DTR 2.5.10 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.10.tar.gz
- description: "DTR 2.5.9 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.9.tar.gz
- description: "DTR 2.5.8 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.8.tar.gz
- description: "DTR 2.5.7 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.7.tar.gz
- description: "DTR 2.5.6 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.6.tar.gz
- description: "DTR 2.5.5 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.5.tar.gz
- description: "DTR 2.5.3 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.3.tar.gz
- description: "DTR 2.5.3 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.5.3.tar.gz
- description: "DTR 2.5.2 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.2.tar.gz
- description: "DTR 2.5.2 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.5.2.tar.gz
- description: "DTR 2.5.1 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.1.tar.gz
- description: "DTR 2.5.1 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.5.1.tar.gz
- description: "DTR 2.5.0 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.5.0.tar.gz
- description: "DTR 2.5.0 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.5.0.tar.gz
- product: "dtr"
version: "2.4"
tar-files:
- description: "DTR 2.4.14 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.14.tar.gz
- description: "DTR 2.4.13 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.13.tar.gz
- description: "DTR 2.4.12 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.12.tar.gz
- description: "DTR 2.4.11 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.11.tar.gz
- description: "DTR 2.4.10 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.10.tar.gz
- description: "DTR 2.4.9 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.9.tar.gz
- description: "DTR 2.4.8 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.8.tar.gz
- description: "DTR 2.4.7 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.7.tar.gz
- description: "DTR 2.4.6 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.6.tar.gz
- description: "DTR 2.4.6 IBM Z"
url: https://packages.docker.com/caas/dtr_images_s390x_2.4.6.tar.gz
url: https://packages.docker.com/caas/dtr_images_s390x_2.4.6.tar.gz
- description: "DTR 2.4.5 Linux x86"
url: https://packages.docker.com/caas/dtr_images_2.4.5.tar.gz
- description: "DTR 2.4.5 IBM Z"
@ -166,8 +482,14 @@
- product: "dtr"
version: "2.3"
tar-files:
- description: "DTR 2.3.11"
url: https://packages.docker.com/caas/dtr_images_2.3.11.tar.gz
- description: "DTR 2.3.10"
url: https://packages.docker.com/caas/dtr_images_2.3.10.tar.gz
- description: "DTR 2.3.9"
url: https://packages.docker.com/caas/dtr_images_2.3.9.tar.gz
- description: "DTR 2.3.8"
url: https://packages.docker.com/caas/dtr_images_2.3.8.tar.gz
url: https://packages.docker.com/caas/dtr_images_2.3.8.tar.gz
- description: "DTR 2.3.7"
url: https://packages.docker.com/caas/dtr_images_2.3.7.tar.gz
- description: "DTR 2.3.6"
@ -184,3 +506,4 @@
url: https://packages.docker.com/caas/dtr-2.3.1.tar.gz
- description: "DTR 2.3.0"
url: https://packages.docker.com/caas/dtr-2.3.0.tar.gz

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

38
_data/docsarchive/archives.yaml
View File

@ -1,5 +1,5 @@
- archive:
name: v18.03
name: v19.03
image: docs/docker.github.io:latest
current: true
# When you make a new stable archive version, move the edge one to be second in
@ -7,6 +7,12 @@
- archive:
name: edge
image: docs/docker.github.io: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.12
image: docs/docker.github.io:v17.12
@ -19,33 +25,3 @@
- archive:
name: v17.03
image: docs/docker.github.io:v17.03
- archive:
name: v1.13
image: docs/docker.github.io:v1.13
- archive:
name: v1.12
image: docs/docker.github.io:v1.12
- archive:
name: v1.11
image: docs/docker.github.io:v1.11
- archive:
name: v1.10
image: docs/docker.github.io:v1.10
- archive:
name: v1.9
image: docs/docker.github.io:v1.9
- archive:
name: v1.8
image: docs/docker.github.io:v1.8
- archive:
name: v1.7
image: docs/docker.github.io:v1.7
- archive:
name: v1.6
image: docs/docker.github.io:v1.6
- archive:
name: v1.5
image: docs/docker.github.io:v1.5
- archive:
name: v1.4
image: docs/docker.github.io:v1.4

121
_data/engine-cli-edge/docker.yaml
View File

@ -1,121 +0,0 @@
command: docker
cname:
- docker attach
- docker build
- docker checkpoint
- docker commit
- docker config
- docker container
- docker cp
- docker create
- docker deploy
- docker diff
- docker events
- docker exec
- docker export
- docker history
- docker image
- docker images
- docker import
- docker info
- docker inspect
- docker kill
- docker load
- docker login
- docker logout
- docker logs
- docker manifest
- docker network
- docker node
- docker pause
- docker plugin
- docker port
- docker ps
- docker pull
- docker push
- docker rename
- docker restart
- docker rm
- docker rmi
- docker run
- docker save
- docker search
- docker secret
- docker service
- docker stack
- docker start
- docker stats
- docker stop
- docker swarm
- docker system
- docker tag
- docker top
- docker trust
- docker unpause
- docker update
- docker version
- docker volume
- docker wait
clink:
- docker_attach.yaml
- docker_build.yaml
- docker_checkpoint.yaml
- docker_commit.yaml
- docker_config.yaml
- docker_container.yaml
- docker_cp.yaml
- docker_create.yaml
- docker_deploy.yaml
- docker_diff.yaml
- docker_events.yaml
- docker_exec.yaml
- docker_export.yaml
- docker_history.yaml
- docker_image.yaml
- docker_images.yaml
- docker_import.yaml
- docker_info.yaml
- docker_inspect.yaml
- docker_kill.yaml
- docker_load.yaml
- docker_login.yaml
- docker_logout.yaml
- docker_logs.yaml
- docker_manifest.yaml
- docker_network.yaml
- docker_node.yaml
- docker_pause.yaml
- docker_plugin.yaml
- docker_port.yaml
- docker_ps.yaml
- docker_pull.yaml
- docker_push.yaml
- docker_rename.yaml
- docker_restart.yaml
- docker_rm.yaml
- docker_rmi.yaml
- docker_run.yaml
- docker_save.yaml
- docker_search.yaml
- docker_secret.yaml
- docker_service.yaml
- docker_stack.yaml
- docker_start.yaml
- docker_stats.yaml
- docker_stop.yaml
- docker_swarm.yaml
- docker_system.yaml
- docker_tag.yaml
- docker_top.yaml
- docker_trust.yaml
- docker_unpause.yaml
- docker_update.yaml
- docker_version.yaml
- docker_volume.yaml
- docker_wait.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

166
_data/engine-cli-edge/docker_attach.yaml
View File

@ -1,166 +0,0 @@
command: docker attach
short: Attach local standard input, output, and error streams to a running container
long: |-
Use `docker attach` to attach your terminal's standard input, output, and error
(or any combination of the three) to a running container using the container's
ID or name. This allows you to view its ongoing output or to control it
interactively, as though the commands were running directly in your terminal.
> **Note:**
> The `attach` command will display the output of the `ENTRYPOINT/CMD` process. This
> can appear as if the attach command is hung when in fact the process may simply
> not be interacting with the terminal at that time.
You can attach to the same contained process multiple times simultaneously,
from different sessions on the Docker host.
To stop a container, use `CTRL-c`. This key sequence sends `SIGKILL` to the
container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to
the container. You can detach from a container and leave it running using the
`CTRL-p CTRL-q` key sequence.
> **Note:**
> A process running as PID 1 inside a container is treated specially by
> Linux: it ignores any signal with the default action. So, the process
> will not terminate on `SIGINT` or `SIGTERM` unless it is coded to do
> so.
It is forbidden to redirect the standard input of a `docker attach` command
while attaching to a tty-enabled container (i.e.: launched with `-t`).
While a client is connected to container's stdio using `docker attach`, Docker
uses a ~1MB memory buffer to maximize the throughput of the application. If
this buffer is filled, the speed of the API connection will start to have an
effect on the process output writing speed. This is similar to other
applications like SSH. Because of this, it is not recommended to run
performance critical applications that generate a lot of output in the
foreground over a slow client connection. Instead, users should use the
`docker logs` command to get access to the logs.
### Override the detach sequence
If you want, you can configure an override the Docker key sequence for detach.
This is useful if the Docker default sequence conflicts with key sequence you
use for other applications. There are two ways to define your own detach key
sequence, as a per-container override or as a configuration property on your
entire configuration.
To override the sequence for an individual container, use the
`--detach-keys="<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

580
_data/engine-cli-edge/docker_build.yaml
View File

@ -1,580 +0,0 @@
command: docker build
short: Build an image from a Dockerfile
long: |-
The `docker build` command builds Docker images from a Dockerfile and a
"context". A build's context is the set of files located in the specified
`PATH` or `URL`. The build process can refer to any of the files in the
context. For example, your build can use a [*COPY*](../builder.md#copy)
instruction to reference a file in the context.
The `URL` parameter can refer to three kinds of resources: Git repositories,
pre-packaged tarball contexts and plain text files.
### Git repositories
When the `URL` parameter points to the location of a Git repository, the
repository acts as the build context. The system recursively fetches the
repository and its submodules. The commit history is not preserved. A
repository is first pulled into a temporary directory on your local host. After
that succeeds, the directory is sent to the Docker daemon as the context.
Local copy gives you the ability to access private repositories using local
user credentials, VPN's, and so forth.
> **Note:**
> If the `URL` parameter contains a fragment the system will recursively clone
> the repository and its submodules using a `git clone --recursive` command.
Git URLs accept context configuration in their fragment section, separated by a
colon `:`. The first part represents the reference that Git will check out,
and can be either a branch, a tag, or a remote reference. The second part
represents a subdirectory inside the repository that will be used as a build
context.
For example, run this command to use a directory called `docker` in the branch
`container`:
```bash
$ docker build https://github.com/docker/rootfs.git#container:docker
```
The following table represents all the valid suffixes with their build
contexts:
Build Syntax Suffix | Commit Used | Build Context Used
--------------------------------|-----------------------|-------------------
`myrepo.git` | `refs/heads/master` | `/`
`myrepo.git#mytag` | `refs/tags/mytag` | `/`
`myrepo.git#mybranch` | `refs/heads/mybranch` | `/`
`myrepo.git#pull/42/head` | `refs/pull/42/head` | `/`
`myrepo.git#:myfolder` | `refs/heads/master` | `/myfolder`
`myrepo.git#master:myfolder` | `refs/heads/master` | `/myfolder`
`myrepo.git#mytag:myfolder` | `refs/tags/mytag` | `/myfolder`
`myrepo.git#mybranch:myfolder` | `refs/heads/mybranch` | `/myfolder`
### Tarball contexts
If you pass an URL to a remote tarball, the URL itself is sent to the daemon:
```bash
$ docker build http://server/context.tar.gz
```
The download operation will be performed on the host the Docker daemon is
running on, which is not necessarily the same host from which the build command
is being issued. The Docker daemon will fetch `context.tar.gz` and use it as the
build context. Tarball contexts must be tar archives conforming to the standard
`tar` UNIX format and can be compressed with any one of the 'xz', 'bzip2',
'gzip' or 'identity' (no compression) formats.
### Text files
Instead of specifying a context, you can pass a single `Dockerfile` in the
`URL` or pipe the file in via `STDIN`. To pipe a `Dockerfile` from `STDIN`:
```bash
$ docker build - < Dockerfile
```
With Powershell on Windows, you can run:
```powershell
Get-Content Dockerfile | docker build -
```
If you use `STDIN` or specify a `URL` pointing to a plain text file, the system
places the contents into a file called `Dockerfile`, and any `-f`, `--file`
option is ignored. In this scenario, there is no context.
By default the `docker build` command will look for a `Dockerfile` at the root
of the build context. The `-f`, `--file`, option lets you specify the path to
an alternative file to use instead. This is useful in cases where the same set
of files are used for multiple builds. The path must be to a file within the
build context. If a relative path is specified then it is interpreted as
relative to the root of the context.
In most cases, it's best to put each Dockerfile in an empty directory. Then,
add to that directory only the files needed for building the Dockerfile. To
increase the build's performance, you can exclude files and directories by
adding a `.dockerignore` file to that directory as well. For information on
creating one, see the [.dockerignore file](../builder.md#dockerignore-file).
If the Docker client loses connection to the daemon, the build is canceled.
This happens if you interrupt the Docker client with `CTRL-c` or if the Docker
client is killed for any reason. If the build initiated a pull which is still
running at the time the build is cancelled, the pull is cancelled as well.
usage: docker build [OPTIONS] PATH | URL | -
pname: docker
plink: docker.yaml
options:
- option: add-host
value_type: list
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg
value_type: list
description: Set build-time variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from
value_type: stringSlice
default_value: '[]'
description: Images to consider as cache sources
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: compress
value_type: bool
default_value: "false"
description: Compress the build context using gzip
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
default_value: "0"
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file
shorthand: f
value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm
value_type: bool
default_value: "false"
description: Always remove intermediate containers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: iidfile
value_type: string
description: Write the image ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
value_type: list
description: Set metadata for an image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
default_value: "0"
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
description: |
Set the networking mode for the RUN instructions during build
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Suppress the build output and print image ID on success
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "true"
description: Remove intermediate containers after a successful build
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: stringSlice
default_value: '[]'
description: Security options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: squash
value_type: bool
default_value: "false"
description: Squash newly built layers into a single new layer
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: stream
value_type: bool
default_value: "false"
description: Stream attaches to server to negotiate build context
deprecated: false
min_api_version: "1.31"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
shorthand: t
value_type: list
description: Name and optionally a tag in the 'name:tag' format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target
value_type: string
description: Set the target build stage to build.
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240
bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284
MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh
/\n ---> Running in 9c9e81692ae9\ntotal 24\ndrwxr-xr-x 2 root root 4.0K
Mar 12 2013 bin\ndrwxr-xr-x 5 root root 4.0K Oct 19 00:19 dev\ndrwxr-xr-x
\ 2 root root 4.0K Oct 19 00:19 etc\ndrwxr-xr-x 2 root root
\ 4.0K Nov 15 23:34 lib\nlrwxrwxrwx 1 root root 3 Mar 12
\ 2013 lib64 -> lib\ndr-xr-xr-x 116 root root 0 Nov 15 23:34 proc\nlrwxrwxrwx
\ 1 root root 3 Mar 12 2013 sbin -> bin\ndr-xr-xr-x 13 root root
\ 0 Nov 15 23:34 sys\ndrwxr-xr-x 2 root root 4.0K Mar 12
\ 2013 tmp\ndrwxr-xr-x 2 root root 4.0K Nov 15 23:34 usr\n ---> b35f4035db3f\nStep
3/3 : CMD echo Hello world\n ---> Running in 02071fceb21b\n ---> f52f38b7823e\nSuccessfully
built f52f38b7823e\nRemoving intermediate container 9c9e81692ae9\nRemoving intermediate
container 02071fceb21b\n```\n\nThis example specifies that the `PATH` is `.`, and
so all the files in the\nlocal directory get `tar`d and sent to the Docker daemon.
The `PATH` specifies\nwhere to find the files for the \"context\" of the build on
the Docker daemon.\nRemember that the daemon could be running on a remote machine
and that no\nparsing of the Dockerfile happens at the client side (where you're
running\n`docker build`). That means that *all* the files at `PATH` get sent, not
just\nthe ones listed to [*ADD*](../builder.md#add) in the Dockerfile.\n\nThe transfer
of context from the local machine to the Docker daemon is what the\n`docker` client
means when you see the \"Sending build context\" message.\n\nIf you wish to keep
the intermediate containers after the build is complete,\nyou must use `--rm=false`.
This does not affect the build cache.\n\n### Build with URL\n\n```bash\n$ docker
build github.com/creack/docker-firefox\n```\n\nThis will clone the GitHub repository
and use the cloned repository as context.\nThe Dockerfile at the root of the repository
is used as Dockerfile. You can\nspecify an arbitrary Git repository by using the
`git://` or `git@` scheme.\n\n```bash\n$ docker build -f ctx/Dockerfile http://server/ctx.tar.gz\n\nDownloading
context: http://server/ctx.tar.gz [===================>] 240 B/240 B\nStep 1/3
: FROM busybox\n ---> 8c2e06607696\nStep 2/3 : ADD ctx/container.cfg /\n ---> e7829950cee3\nRemoving
intermediate container b35224abf821\nStep 3/3 : CMD /bin/ls\n ---> Running in fbc63d321d73\n
---> 3286931702ad\nRemoving intermediate container fbc63d321d73\nSuccessfully built
377c409b35e4\n```\n\nThis sends the URL `http://server/ctx.tar.gz` to the Docker
daemon, which\ndownloads and extracts the referenced tarball. The `-f ctx/Dockerfile`\nparameter
specifies a path inside `ctx.tar.gz` to the `Dockerfile` that is used\nto build
the image. Any `ADD` commands in that `Dockerfile` that refers to local\npaths must
be relative to the root of the contents inside `ctx.tar.gz`. In the\nexample above,
the tarball contains a directory `ctx/`, so the `ADD\nctx/container.cfg /` operation
works as expected.\n\n### Build with -\n\n```bash\n$ docker build - < Dockerfile\n```\n\nThis
will read a Dockerfile from `STDIN` without context. Due to the lack of a\ncontext,
no contents of any local directory will be sent to the Docker daemon.\nSince there
is no context, a Dockerfile `ADD` only works if it refers to a\nremote URL.\n\n```bash\n$
docker build - < context.tar.gz\n```\n\nThis will build an image for a compressed
context read from `STDIN`. Supported\nformats are: bzip2, gzip and xz.\n\n### Use
a .dockerignore file\n\n```bash\n$ docker build .\n\nUploading context 18.829 MB\nUploading
context\nStep 1/2 : FROM busybox\n ---> 769b9341d937\nStep 2/2 : CMD echo Hello
world\n ---> Using cache\n ---> 99cc1ad10469\nSuccessfully built 99cc1ad10469\n$
echo \".git\" > .dockerignore\n$ docker build .\nUploading context 6.76 MB\nUploading
context\nStep 1/2 : FROM busybox\n ---> 769b9341d937\nStep 2/2 : CMD echo Hello
world\n ---> Using cache\n ---> 99cc1ad10469\nSuccessfully built 99cc1ad10469\n```\n\nThis
example shows the use of the `.dockerignore` file to exclude the `.git`\ndirectory
from the context. Its effect can be seen in the changed size of the\nuploaded context.
The builder reference contains detailed information on\n[creating a .dockerignore
file](../builder.md#dockerignore-file)\n\n### Tag an image (-t)\n\n```bash\n$ docker
build -t vieux/apache:2.0 .\n```\n\nThis will build like the previous example, but
it will then tag the resulting\nimage. The repository name will be `vieux/apache`
and the tag will be `2.0`.\n[Read more about valid tags](tag.md).\n\nYou can apply
multiple tags to an image. For example, you can apply the `latest`\ntag to a newly
built image and add another tag that references a specific\nversion.\nFor example,
to tag an image both as `whenry/fedora-jboss:latest` and\n`whenry/fedora-jboss:v2.1`,
use the following:\n\n```bash\n$ docker build -t whenry/fedora-jboss:latest -t whenry/fedora-jboss:v2.1
.\n```\n\n### Specify a Dockerfile (-f)\n\n```bash\n$ docker build -f Dockerfile.debug
.\n```\n\nThis will use a file called `Dockerfile.debug` for the build instructions\ninstead
of `Dockerfile`.\n\n```bash\n$ curl example.com/remote/Dockerfile | docker build
-f - .\n```\n\nThe above command will use the current directory as the build context
and read\na Dockerfile from stdin.\n\n```bash\n$ docker build -f dockerfiles/Dockerfile.debug
-t myapp_debug .\n$ docker build -f dockerfiles/Dockerfile.prod -t myapp_prod .\n```\n\nThe
above commands will build the current build context (as specified by the\n`.`) twice,
once using a debug version of a `Dockerfile` and once using a\nproduction version.\n\n```bash\n$
cd /home/me/myapp/some/dir/really/deep\n$ docker build -f /home/me/myapp/dockerfiles/debug
/home/me/myapp\n$ docker build -f ../../../../dockerfiles/debug /home/me/myapp\n```\n\nThese
two `docker build` commands do the exact same thing. They both use the\ncontents
of the `debug` file instead of looking for a `Dockerfile` and will use\n`/home/me/myapp`
as the root of the build context. Note that `debug` is in the\ndirectory structure
of the build context, regardless of how you refer to it on\nthe command line.\n\n>
**Note:**\n> `docker build` will return a `no such file or directory` error if the\n>
file or directory does not exist in the uploaded context. This may\n> happen if
there is no context, or if you specify a file that is\n> elsewhere on the Host system.
The context is limited to the current\n> directory (and its children) for security
reasons, and to ensure\n> repeatable builds on remote Docker hosts. This is also
the reason why\n> `ADD ../file` will not work.\n\n### Use a custom parent cgroup
(--cgroup-parent)\n\nWhen `docker build` is run with the `--cgroup-parent` option
the containers\nused in the build will be run with the [corresponding `docker run`\nflag](../run.md#specifying-custom-cgroups).\n\n###
Set ulimits in container (--ulimit)\n\nUsing the `--ulimit` option with `docker
build` will cause each build step's\ncontainer to be started using those [`--ulimit`\nflag
values](./run.md#set-ulimits-in-container-ulimit).\n\n### Set build-time variables
(--build-arg)\n\nYou can use `ENV` instructions in a Dockerfile to define variable\nvalues.
These values persist in the built image. However, often\npersistence is not what
you want. Users want to specify variables differently\ndepending on which host they
build an image on.\n\nA good example is `http_proxy` or source versions for pulling
intermediate\nfiles. The `ARG` instruction lets Dockerfile authors define values
that users\ncan set at build-time using the `--build-arg` flag:\n\n```bash\n$ docker
build --build-arg HTTP_PROXY=http://10.20.30.2:1234 --build-arg FTP_PROXY=http://40.50.60.5:4567
.\n```\n\nThis flag allows you to pass the build-time variables that are\naccessed
like regular environment variables in the `RUN` instruction of the\nDockerfile.
Also, these values don't persist in the intermediate or final images\nlike `ENV`
values do. You must add `--build-arg` for each build argument. \n\nUsing this
flag will not alter the output you see when the `ARG` lines from the\nDockerfile
are echoed during the build process.\n\nFor detailed information on using `ARG`
and `ENV` instructions, see the\n[Dockerfile reference](../builder.md).\n\nYou may
also use the `--build-arg` flag without a value, in which case the value\nfrom the
local environment will be propagated into the Docker container being\nbuilt:\n\n```bash\n$
export HTTP_PROXY=http://10.20.30.2:1234\n$ docker build --build-arg HTTP_PROXY
.\n```\n\nThis is similar to how `docker run -e` works. Refer to the [`docker run`
documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)\nfor
more information.\n\n### Optional security options (--security-opt)\n\nThis flag
is only supported on a daemon running on Windows, and only supports\nthe `credentialspec`
option. The `credentialspec` must be in the format\n`file://spec.txt` or `registry://keyname`.\n\n###
Specify isolation technology for container (--isolation)\n\nThis option is useful
in situations where you are running Docker containers on\nWindows. The `--isolation=<value>`
option sets a container's isolation\ntechnology. On Linux, the only supported is
the `default` option which uses\nLinux namespaces. On Microsoft Windows, you can
specify these values:\n\n\n| Value | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|
`default` | Use the value specified by the Docker daemon's `--exec-opt` . If the
`daemon` does not specify an isolation technology, Microsoft Windows uses `process`
as its default value. |\n| `process` | Namespace isolation only. |\n|
`hyperv` | Hyper-V hypervisor partition-based isolation. |\n\nSpecifying
the `--isolation` flag without a value is the same as setting `--isolation=\"default\"`.\n\n###
Add entries to container hosts file (--add-host)\n\nYou can add other hosts into
a container's `/etc/hosts` file by using one or\nmore `--add-host` flags. This example
adds a static address for a host named\n`docker`:\n\n $ docker build --add-host=docker:10.180.0.1
.\n\n### Specifying target build stage (--target)\n\nWhen building a Dockerfile
with multiple build stages, `--target` can be used to\nspecify an intermediate build
stage by name as a final stage for the resulting\nimage. Commands after the target
stage will be skipped.\n\n```Dockerfile\nFROM debian AS build-env\n...\n\nFROM alpine
AS production-env\n...\n```\n\n```bash\n$ docker build -t mybuildimage --target
build-env .\n```\n\n### Squash an image's layers (--squash) (experimental)\n\n####
Overview\n\nOnce the image is built, squash the new layers into a new image with
a single\nnew layer. Squashing does not destroy any existing image, rather it creates
a new\nimage with the content of the squashed layers. This effectively makes it
look\nlike all `Dockerfile` commands were created with a single layer. The build\ncache
is preserved with this method.\n\nThe `--squash` option is an experimental feature,
and should not be considered\nstable.\n\n\nSquashing layers can be beneficial if
your Dockerfile produces multiple layers\nmodifying the same files, for example,
file that are created in one step, and\nremoved in another step. For other use-cases,
squashing images may actually have\na negative impact on performance; when pulling
an image consisting of multiple\nlayers, layers can be pulled in parallel, and allows
sharing layers between\nimages (saving space).\n\nFor most use cases, multi-stage
are a better alternative, as they give more\nfine-grained control over your build,
and can take advantage of future\noptimizations in the builder. Refer to the [use
multi-stage builds](https://docs.docker.com/engine/userguide/eng-image/multistage-build/)\nsection
in the userguide for more information.\n\n\n#### Known limitations\n\nThe `--squash`
option has a number of known limitations:\n\n- When squashing layers, the resulting
image cannot take advantage of layer\n sharing with other images, and may use significantly
more space. Sharing the\n base image is still supported.\n- When using this option
you may see significantly more space used due to\n storing two copies of the image,
one for the build cache with all the cache\n layers in tact, and one for the squashed
version.\n- While squashing layers may produce smaller images, it may have a negative\n
\ impact on performance, as a single layer takes longer to extract, and\n downloading
a single layer cannot be parallelized.\n- When attempting to squash an image that
does not make changes to the\n filesystem (for example, the Dockerfile only contains
`ENV` instructions),\n the squash step will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n####
Prerequisites\n\nThe example on this page is using experimental mode in Docker 1.13.\n\nExperimental
mode can be enabled by using the `--experimental` flag when starting the Docker
daemon or setting `experimental: true` in the `daemon.json` configuration file.\n\nBy
default, experimental mode is disabled. To see the current configuration, use the
`docker version` command.\n\n```none\nServer:\n Version: 1.13.1\n API version:
\ 1.26 (minimum version 1.12)\n Go version: go1.7.5\n Git commit: 092cba3\n
Built: Wed Feb 8 06:35:24 2017\n OS/Arch: linux/amd64\n Experimental:
false\n\n [...]\n```\n\nTo enable experimental mode, users need to restart the docker
daemon with the experimental flag enabled.\n\n#### Enable Docker experimental\n\nExperimental
features are now included in the standard Docker binaries as of version 1.13.0.
For enabling experimental features, you need to start the Docker daemon with `--experimental`
flag. You can also enable the daemon flag via /etc/docker/daemon.json. e.g.\n\n```json\n{\n
\ \"experimental\": true\n}\n```\n\nThen make sure the experimental flag is enabled:\n\n```bash\n$
docker version -f '{{.Server.Experimental}}'\ntrue\n```\n\n#### Build an image with
`--squash` argument\n\nThe following is an example of docker build with `--squash`
argument\n\n```Dockerfile\nFROM busybox\nRUN echo hello > /hello\nRUN echo world
>> /hello\nRUN touch remove_me /remove_me\nENV HELLO world\nRUN rm /remove_me\n```\n\nAn
image named `test` is built with `--squash` argument.\n\n```bash\n$ docker build
--squash -t test .\n\n[...]\n```\n\nIf everything is right, the history will look
like this:\n\n```bash\n$ docker history test\n\nIMAGE CREATED CREATED
BY SIZE COMMENT\n4e10cb5b4cac
\ 3 seconds ago 12 B
\ merge sha256:88a7b0112a41826885df0e7072698006ee8f621c6ab99fca7fe9151d7b599702
to sha256:47bcc53f74dc94b1920f0b34f6036096526296767650f223433fe65c35f149eb\n<missing>
\ 5 minutes ago /bin/sh -c rm /remove_me 0
B\n<missing> 5 minutes ago /bin/sh -c #(nop) ENV HELLO=world 0
B\n<missing> 5 minutes ago /bin/sh -c touch remove_me /remove_me
\ 0 B\n<missing> 5 minutes ago /bin/sh -c echo world >>
/hello 0 B\n<missing> 6 minutes ago /bin/sh -c echo
hello > /hello 0 B\n<missing> 7 weeks ago /bin/sh
-c #(nop) CMD [\"sh\"] 0 B\n<missing> 7 weeks ago /bin/sh
-c #(nop) ADD file:47ca6e777c36a4cfff 1.113 MB\n```\n\nWe could find that all
layer's name is `<missing>`, and there is a new layer with COMMENT `merge`.\n\nTest
the image, check for `/remove_me` being gone, make sure `hello\\nworld` is in `/hello`,
make sure the `HELLO` envvar's value is `world`."
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

21
_data/engine-cli-edge/docker_checkpoint.yaml
View File

@ -1,21 +0,0 @@
command: docker checkpoint
short: Manage checkpoints
long: Manage checkpoints
usage: docker checkpoint
pname: docker
plink: docker.yaml
cname:
- docker checkpoint create
- docker checkpoint ls
- docker checkpoint rm
clink:
- docker_checkpoint_create.yaml
- docker_checkpoint_ls.yaml
- docker_checkpoint_rm.yaml
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

31
_data/engine-cli-edge/docker_checkpoint_create.yaml
View File

@ -1,31 +0,0 @@
command: docker checkpoint create
short: Create a checkpoint from a running container
long: Create a checkpoint from a running container
usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave-running
value_type: bool
default_value: "false"
description: Leave the container running after checkpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

23
_data/engine-cli-edge/docker_checkpoint_ls.yaml
View File

@ -1,23 +0,0 @@
command: docker checkpoint ls
aliases: list
short: List checkpoints for a container
long: List checkpoints for a container
usage: docker checkpoint ls [OPTIONS] CONTAINER
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

23
_data/engine-cli-edge/docker_checkpoint_rm.yaml
View File

@ -1,23 +0,0 @@
command: docker checkpoint rm
aliases: remove
short: Remove a checkpoint
long: Remove a checkpoint
usage: docker checkpoint rm [OPTIONS] CONTAINER CHECKPOINT
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false

133
_data/engine-cli-edge/docker_commit.yaml
View File

@ -1,133 +0,0 @@
command: docker commit
short: Create a new image from a container's changes
long: |-
It can be useful to commit a container's file changes or settings into a new
image. This allows you to debug a container by running an interactive shell, or to
export a working dataset to another server. Generally, it is better to use
Dockerfiles to manage your images in a documented and maintainable way.
[Read more about valid image names and tags](tag.md).
The commit operation will not include any data contained in
volumes mounted inside the container.
By default, the container being committed and its processes will be paused
while the image is committed. This reduces the likelihood of encountering data
corruption during the process of creating the commit. If this behavior is
undesired, set the `--pause` option to false.
The `--change` option will apply `Dockerfile` instructions to the image that is
created. Supported `Dockerfile` instructions:
`CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`LABEL`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
pname: docker
plink: docker.yaml
options:
- option: author
shorthand: a
value_type: string
description: Author (e.g., "John Hannibal Smith <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-edge/docker_config.yaml
View File

@ -1,23 +0,0 @@
command: docker config
short: Manage Docker configs
long: Manage Docker configs
usage: docker config
pname: docker
plink: docker.yaml
cname:
- docker config create
- docker config inspect
- docker config ls
- docker config rm
clink:
- docker_config_create.yaml
- docker_config_inspect.yaml
- docker_config_ls.yaml
- docker_config_rm.yaml
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

31
_data/engine-cli-edge/docker_config_create.yaml
View File

@ -1,31 +0,0 @@
command: docker config create
short: Create a config from a file or STDIN
long: Create a config from a file or STDIN
usage: docker config create [OPTIONS] CONFIG file|-
pname: docker config
plink: docker_config.yaml
options:
- option: label
shorthand: l
value_type: list
description: Config labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: template-driver
value_type: string
description: Template driver
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

32
_data/engine-cli-edge/docker_config_inspect.yaml
View File

@ -1,32 +0,0 @@
command: docker config inspect
short: Display detailed information on one or more configs
long: Display detailed information on one or more configs
usage: docker config inspect [OPTIONS] CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pretty
value_type: bool
default_value: "false"
description: Print the information in a human friendly format
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

42
_data/engine-cli-edge/docker_config_ls.yaml
View File

@ -1,42 +0,0 @@
command: docker config ls
aliases: list
short: List configs
long: List configs
usage: docker config ls [OPTIONS]
pname: docker config
plink: docker_config.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print configs using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

14
_data/engine-cli-edge/docker_config_rm.yaml
View File

@ -1,14 +0,0 @@
command: docker config rm
aliases: remove
short: Remove one or more configs
long: Remove one or more configs
usage: docker config rm CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml
deprecated: false
min_api_version: "1.30"
experimental: false
experimentalcli: false
kubernetes: false
swarm: true

64
_data/engine-cli-edge/docker_container.yaml
View File

@ -1,64 +0,0 @@
command: docker container
short: Manage containers
long: Manage containers.
usage: docker container
pname: docker
plink: docker.yaml
cname:
- docker container attach
- docker container commit
- docker container cp
- docker container create
- docker container diff
- docker container exec
- docker container export
- docker container inspect
- docker container kill
- docker container logs
- docker container ls
- docker container pause
- docker container port
- docker container prune
- docker container rename
- docker container restart
- docker container rm
- docker container run
- docker container start
- docker container stats
- docker container stop
- docker container top
- docker container unpause
- docker container update
- docker container wait
clink:
- docker_container_attach.yaml
- docker_container_commit.yaml
- docker_container_cp.yaml
- docker_container_create.yaml
- docker_container_diff.yaml
- docker_container_exec.yaml
- docker_container_export.yaml
- docker_container_inspect.yaml
- docker_container_kill.yaml
- docker_container_logs.yaml
- docker_container_ls.yaml
- docker_container_pause.yaml
- docker_container_port.yaml
- docker_container_prune.yaml
- docker_container_rename.yaml
- docker_container_restart.yaml
- docker_container_rm.yaml
- docker_container_run.yaml
- docker_container_start.yaml
- docker_container_stats.yaml
- docker_container_stop.yaml
- docker_container_top.yaml
- docker_container_unpause.yaml
- docker_container_update.yaml
- docker_container_wait.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

39
_data/engine-cli-edge/docker_container_attach.yaml
View File

@ -1,39 +0,0 @@
command: docker container attach
short: Attach local standard input, output, and error streams to a running container
long: Attach local standard input, output, and error streams to a running container
usage: docker container attach [OPTIONS] CONTAINER
pname: docker container
plink: docker_container.yaml
options:
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stdin
value_type: bool
default_value: "false"
description: Do not attach STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy all received signals to the process
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

50
_data/engine-cli-edge/docker_container_commit.yaml
View File

@ -1,50 +0,0 @@
command: docker container commit
short: Create a new image from a container's changes
long: Create a new image from a container's changes
usage: docker container commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
pname: docker container
plink: docker_container.yaml
options:
- option: author
shorthand: a
value_type: string
description: Author (e.g., "John Hannibal Smith <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-edge/docker_container_cp.yaml
View File

@ -1,40 +0,0 @@
command: docker container cp
short: Copy files/folders between a container and the local filesystem
long: |-
Copy files/folders between a container and the local filesystem
Use '-' as the source to read a tar archive from stdin
and extract it to a directory destination in a container.
Use '-' as the destination to stream a tar archive of a
container source to stdout.
usage: "docker container cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-\n\tdocker cp
[OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH"
pname: docker container
plink: docker_container.yaml
options:
- option: archive
shorthand: a
value_type: bool
default_value: "false"
description: Archive mode (copy all uid/gid information)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link
shorthand: L
value_type: bool
default_value: "false"
description: Always follow symbol link in SRC_PATH
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

852
_data/engine-cli-edge/docker_container_create.yaml
View File

@ -1,852 +0,0 @@
command: docker container create
short: Create a new container
long: Create a new container
usage: docker container create [OPTIONS] IMAGE [COMMAND] [ARG...]
pname: docker container
plink: docker_container.yaml
options:
- option: add-host
value_type: list
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach
shorthand: a
value_type: list
description: Attach to STDIN, STDOUT or STDERR
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight
value_type: uint16
default_value: "0"
description: |
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device
value_type: list
default_value: '[]'
description: Block IO weight (relative device weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add
value_type: list
description: Add Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop
value_type: list
description: Drop Linux capabilities
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile
value_type: string
description: Write the container ID to the file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count
value_type: int64
default_value: "0"
description: CPU count (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent
value_type: int64
default_value: "0"
description: CPU percent (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
description: Limit CPU real-time period in microseconds
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
description: Limit CPU real-time runtime in microseconds
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares
shorthand: c
value_type: int64
default_value: "0"
description: CPU shares (relative weight)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device
value_type: list
description: Add a host device to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule
value_type: list
description: Add a rule to the cgroup allowed devices list
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps
value_type: list
default_value: '[]'
description: Limit read rate (bytes per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops
value_type: list
default_value: '[]'
description: Limit read rate (IO per second) from a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps
value_type: list
default_value: '[]'
description: Limit write rate (bytes per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops
value_type: list
default_value: '[]'
description: Limit write rate (IO per second) to a device
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns
value_type: list
description: Set custom DNS servers
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option
value_type: list
description: Set DNS options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search
value_type: list
description: Set custom DNS search domains
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: entrypoint
value_type: string
description: Overwrite the default ENTRYPOINT of the image
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file
value_type: list
description: Read in a file of environment variables
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose
value_type: list
description: Expose a port or a range of ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: group-add
value_type: list
description: Add additional groups to join
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd
value_type: string
description: Command to run to check health
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval
value_type: duration
default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries
value_type: int
default_value: "0"
description: Consecutive failures needed to report unhealthy
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period
value_type: duration
default_value: 0s
description: |
Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
deprecated: false
min_api_version: "1.29"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout
value_type: duration
default_value: 0s
description: |
Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname
shorthand: h
value_type: string
description: Container host name
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init
value_type: bool
default_value: "false"
description: |
Run an init inside the container that forwards signals and reaps processes
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth
value_type: bytes
default_value: "0"
description: |
Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops
value_type: uint64
default_value: "0"
description: Maximum IOps limit for the system drive (Windows only)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip
value_type: string
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6
value_type: string
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc
value_type: string
description: IPC mode to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
shorthand: l
value_type: list
description: Set meta data on a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file
value_type: list
description: Read in a line delimited file of labels
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link
value_type: list
description: Add link to another container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip
value_type: list
description: Container IPv4/IPv6 link-local addresses
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver
value_type: string
description: Logging driver for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt
value_type: list
description: Log driver options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address
value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
shorthand: m
value_type: bytes
default_value: "0"
description: Memory limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap
value_type: bytes
default_value: "0"
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness
value_type: int64
default_value: "-1"
description: Tune container memory swappiness (0 to 100)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount
value_type: mount
description: Attach a filesystem mount to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Assign a name to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network
value_type: string
default_value: default
description: Connect a container to a network
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias
value_type: list
description: Add network-scoped alias for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck
value_type: bool
default_value: "false"
description: Disable any container-specified HEALTHCHECK
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable
value_type: bool
default_value: "false"
description: Disable OOM Killer
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj
value_type: int
default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid
value_type: string
description: PID namespace to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit
value_type: int64
default_value: "0"
description: Tune container pids limit (set -1 for unlimited)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: platform
value_type: string
description: Set platform if server is multi-platform capable
deprecated: false
min_api_version: "1.32"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish
shorthand: p
value_type: list
description: Publish a container's port(s) to the host
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all
shorthand: P
value_type: bool
default_value: "false"
description: Publish all exposed ports to random ports
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only
value_type: bool
default_value: "false"
description: Mount the container's root filesystem as read only
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart
value_type: string
default_value: "no"
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
value_type: bool
default_value: "false"
description: Automatically remove the container when it exits
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime
value_type: string
description: Runtime to use for this container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt
value_type: list
description: Security Options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal
value_type: string
default_value: SIGTERM
description: Signal to stop a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout
value_type: int
default_value: "0"
description: Timeout (in seconds) to stop a container
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt
value_type: list
description: Storage driver options for the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl
value_type: map
default_value: map[]
description: Sysctl options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs
value_type: list
description: Mount a tmpfs directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
default_value: "false"
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <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-edge/docker_container_diff.yaml
View File

@ -1,12 +0,0 @@
command: docker container diff
short: Inspect changes to files or directories on a container's filesystem
long: Inspect changes to files or directories on a container's filesystem
usage: docker container diff CONTAINER
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

89
_data/engine-cli-edge/docker_container_exec.yaml
View File

@ -1,89 +0,0 @@
command: docker container exec
short: Run a command in a running container
long: Run a command in a running container
usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]
pname: docker container
plink: docker_container.yaml
options:
- option: detach
shorthand: d
value_type: bool
default_value: "false"
description: 'Detached mode: run command in the background'
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the command
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
shorthand: t
value_type: bool
default_value: "false"
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <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-edge/docker_container_export.yaml
View File

@ -1,22 +0,0 @@
command: docker container export
short: Export a container's filesystem as a tar archive
long: Export a container's filesystem as a tar archive
usage: docker container export [OPTIONS] CONTAINER
pname: docker container
plink: docker_container.yaml
options:
- option: output
shorthand: o
value_type: string
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

32
_data/engine-cli-edge/docker_container_inspect.yaml
View File

@ -1,32 +0,0 @@
command: docker container inspect
short: Display detailed information on one or more containers
long: Display detailed information on one or more containers
usage: docker container inspect [OPTIONS] CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

23
_data/engine-cli-edge/docker_container_kill.yaml
View File

@ -1,23 +0,0 @@
command: docker container kill
short: Kill one or more running containers
long: Kill one or more running containers
usage: docker container kill [OPTIONS] CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
options:
- option: signal
shorthand: s
value_type: string
default_value: KILL
description: Signal to send to the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

70
_data/engine-cli-edge/docker_container_logs.yaml
View File

@ -1,70 +0,0 @@
command: docker container logs
short: Fetch the logs of a container
long: Fetch the logs of a container
usage: docker container logs [OPTIONS] CONTAINER
pname: docker container
plink: docker_container.yaml
options:
- option: details
value_type: bool
default_value: "false"
description: Show extra details provided to logs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow
shorthand: f
value_type: bool
default_value: "false"
description: Follow log output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tail
value_type: string
default_value: all
description: Number of lines to show from the end of the logs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps
shorthand: t
value_type: bool
default_value: "false"
description: Show timestamps
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until
value_type: string
description: |
Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false
min_api_version: "1.35"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

90
_data/engine-cli-edge/docker_container_ls.yaml
View File

@ -1,90 +0,0 @@
command: docker container ls
aliases: ps, list
short: List containers
long: List containers
usage: docker container ls [OPTIONS]
pname: docker container
plink: docker_container.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all containers (default shows just running)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format
value_type: string
description: Pretty-print containers using a Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: last
shorthand: "n"
value_type: int
default_value: "-1"
description: Show n last created containers (includes all states)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: latest
shorthand: l
value_type: bool
default_value: "false"
description: Show the latest created container (includes all states)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display numeric IDs
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli-edge/docker_container_pause.yaml
View File

@ -1,12 +0,0 @@
command: docker container pause
short: Pause all processes within one or more containers
long: Pause all processes within one or more containers
usage: docker container pause CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

12
_data/engine-cli-edge/docker_container_port.yaml
View File

@ -1,12 +0,0 @@
command: docker container port
short: List port mappings or a specific mapping for the container
long: List port mappings or a specific mapping for the container
usage: docker container port CONTAINER [PRIVATE_PORT[/PROTO]]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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