mirror of https://github.com/docker/docs.git
Merge pull request #9098 from ollypom/privateintopublic
Merge remote-tracking branch 'private/master' into public
This commit is contained in:
Olly P
GitHub
commit
aa4c53c42d
|
|
@ -5,7 +5,6 @@ pipeline {
|
||||||
label 'ubuntu-1604-aufs-stable'
|
label 'ubuntu-1604-aufs-stable'
|
||||||
}
|
}
|
||||||
environment {
|
environment {
|
||||||
DTR_VPN_ADDRESS = credentials('dtr-vpn-address')
|
|
||||||
DTR_URL = credentials('dtr-url')
|
DTR_URL = credentials('dtr-url')
|
||||||
DOCKER_HOST_STRING = credentials('docker-host')
|
DOCKER_HOST_STRING = credentials('docker-host')
|
||||||
UCP_BUNDLE = credentials('ucp-bundle')
|
UCP_BUNDLE = credentials('ucp-bundle')
|
||||||
|
|
@ -26,7 +25,6 @@ pipeline {
|
||||||
branch 'master'
|
branch 'master'
|
||||||
}
|
}
|
||||||
steps {
|
steps {
|
||||||
withVpn("$DTR_VPN_ADDRESS") {
|
|
||||||
sh """
|
sh """
|
||||||
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
|
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 build -t $DTR_URL/docker/docker.github.io:stage-${env.BUILD_NUMBER} .
|
||||||
|
|
@ -40,13 +38,11 @@ pipeline {
|
||||||
"""
|
"""
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
stage( 'build + push prod image, update prod swarm' ) {
|
stage( 'build + push prod image, update prod swarm' ) {
|
||||||
when {
|
when {
|
||||||
branch 'published'
|
branch 'published'
|
||||||
}
|
}
|
||||||
steps {
|
steps {
|
||||||
withVpn("$DTR_VPN_ADDRESS") {
|
|
||||||
withDockerRegistry(reg) {
|
withDockerRegistry(reg) {
|
||||||
sh """
|
sh """
|
||||||
docker build -t docs/docker.github.io:prod-${env.BUILD_NUMBER} .
|
docker build -t docs/docker.github.io:prod-${env.BUILD_NUMBER} .
|
||||||
|
|
@ -65,7 +61,6 @@ pipeline {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
stage( 'docs-private' ) {
|
stage( 'docs-private' ) {
|
||||||
when {
|
when {
|
||||||
expression { env.GIT_URL == "https://github.com/docker/docs-private.git" }
|
expression { env.GIT_URL == "https://github.com/docker/docs-private.git" }
|
||||||
|
|
@ -76,7 +71,6 @@ pipeline {
|
||||||
branch 'amberjack'
|
branch 'amberjack'
|
||||||
}
|
}
|
||||||
steps {
|
steps {
|
||||||
withVpn("$DTR_VPN_ADDRESS") {
|
|
||||||
sh """
|
sh """
|
||||||
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
|
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 build -t $DTR_URL/docker/docs-private:beta-stage-${env.BUILD_NUMBER} .
|
||||||
|
|
@ -90,13 +84,11 @@ pipeline {
|
||||||
"""
|
"""
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
stage( 'build + push beta image, update beta swarm' ) {
|
stage( 'build + push beta image, update beta swarm' ) {
|
||||||
when {
|
when {
|
||||||
branch 'published'
|
branch 'published'
|
||||||
}
|
}
|
||||||
steps {
|
steps {
|
||||||
withVpn("$DTR_VPN_ADDRESS") {
|
|
||||||
sh """
|
sh """
|
||||||
cat $SUCCESS_BOT_TOKEN | docker login $DTR_URL --username 'success_bot' --password-stdin
|
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 build -t $DTR_URL/docker/docs-private:beta-${env.BUILD_NUMBER} .
|
||||||
|
|
@ -113,5 +105,4 @@ pipeline {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -363,7 +363,7 @@ branch](https://github.com/docker/docker.github.io/blob/publish-tools/README.md)
|
||||||
|
|
||||||
## Creating a new archive
|
## 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:
|
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.
|
1. Create branch based off the commit hash before the new version was released.
|
||||||
|
|
|
||||||
|
|
@ -82,6 +82,7 @@ tablabels:
|
||||||
engine-18.09: Docker EE Engine 18.09
|
engine-18.09: Docker EE Engine 18.09
|
||||||
engine-18.03: Docker EE Engine 18.03
|
engine-18.03: Docker EE Engine 18.03
|
||||||
engine-17.12: Docker EE Engine 17.12
|
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.06: Docker EE Engine 17.06
|
||||||
engine-17.03: Docker EE Engine 17.03
|
engine-17.03: Docker EE Engine 17.03
|
||||||
docker-cli-linux: Docker CLI on Mac/Linux
|
docker-cli-linux: Docker CLI on Mac/Linux
|
||||||
|
|
@ -170,7 +171,7 @@ defaults:
|
||||||
values:
|
values:
|
||||||
ucp_org: "docker"
|
ucp_org: "docker"
|
||||||
ucp_repo: "ucp"
|
ucp_repo: "ucp"
|
||||||
ucp_version: "3.1.9"
|
ucp_version: "3.2.0"
|
||||||
- scope: # This is a bit of a hack for the get-support.md topic.
|
- scope: # This is a bit of a hack for the get-support.md topic.
|
||||||
path: "ee"
|
path: "ee"
|
||||||
values:
|
values:
|
||||||
|
|
|
||||||
|
|
@ -19,9 +19,9 @@ url: https://docs.docker.com
|
||||||
# TO USE ME:
|
# TO USE ME:
|
||||||
# jekyll serve --incremental --config _config_authoring.yml
|
# jekyll serve --incremental --config _config_authoring.yml
|
||||||
|
|
||||||
latest_engine_api_version: "1.39"
|
latest_engine_api_version: "1.40"
|
||||||
docker_ce_version: "18.09"
|
docker_ce_version: "19.03"
|
||||||
docker_ee_version: "18.09"
|
docker_ee_version: "19.03"
|
||||||
compose_version: "1.24.1"
|
compose_version: "1.24.1"
|
||||||
compose_file_v3: "3.7"
|
compose_file_v3: "3.7"
|
||||||
compose_file_v2: "2.4"
|
compose_file_v2: "2.4"
|
||||||
|
|
@ -96,7 +96,7 @@ defaults:
|
||||||
- scope:
|
- scope:
|
||||||
path: "install"
|
path: "install"
|
||||||
values:
|
values:
|
||||||
win_latest_build: "docker-18.09.1"
|
win_latest_build: "docker-19.03.0"
|
||||||
- scope:
|
- scope:
|
||||||
path: "datacenter"
|
path: "datacenter"
|
||||||
values:
|
values:
|
||||||
|
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -3,6 +3,15 @@
|
||||||
# environment that can't access the internet
|
# environment that can't access the internet
|
||||||
|
|
||||||
# Used by _includes/components/ddc_url_list_2.html
|
# Used by _includes/components/ddc_url_list_2.html
|
||||||
|
- product: "ucp"
|
||||||
|
version: "3.2"
|
||||||
|
tar-files:
|
||||||
|
- 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"
|
- product: "ucp"
|
||||||
version: "3.1"
|
version: "3.1"
|
||||||
tar-files:
|
tar-files:
|
||||||
|
|
@ -332,6 +341,11 @@
|
||||||
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.0.tar.gz
|
url: https://packages.docker.com/caas/ucp_images_s390x_2.2.0.tar.gz
|
||||||
- description: "2.2.0 Windows"
|
- description: "2.2.0 Windows"
|
||||||
url: https://packages.docker.com/caas/ucp_images_win_2.2.0.tar.gz
|
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.0 Linux x86"
|
||||||
|
url: https://packages.docker.com/caas/dtr_images_2.7.0.tar.gz
|
||||||
- product: "dtr"
|
- product: "dtr"
|
||||||
version: "2.6"
|
version: "2.6"
|
||||||
tar-files:
|
tar-files:
|
||||||
|
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -7,6 +7,7 @@ cname:
|
||||||
- docker commit
|
- docker commit
|
||||||
- docker config
|
- docker config
|
||||||
- docker container
|
- docker container
|
||||||
|
- docker context
|
||||||
- docker cp
|
- docker cp
|
||||||
- docker create
|
- docker create
|
||||||
- docker deploy
|
- docker deploy
|
||||||
|
|
@ -66,6 +67,7 @@ clink:
|
||||||
- docker_commit.yaml
|
- docker_commit.yaml
|
||||||
- docker_config.yaml
|
- docker_config.yaml
|
||||||
- docker_container.yaml
|
- docker_container.yaml
|
||||||
|
- docker_context.yaml
|
||||||
- docker_cp.yaml
|
- docker_cp.yaml
|
||||||
- docker_create.yaml
|
- docker_create.yaml
|
||||||
- docker_deploy.yaml
|
- docker_deploy.yaml
|
||||||
|
|
|
||||||
|
|
@ -16,8 +16,8 @@ long: |-
|
||||||
|
|
||||||
To stop a container, use `CTRL-c`. This key sequence sends `SIGKILL` to the
|
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
|
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
|
the container. If the container was run with `-i` and `-t`, you can detach from
|
||||||
`CTRL-p CTRL-q` key sequence.
|
a container and leave it running using the `CTRL-p CTRL-q` key sequence.
|
||||||
|
|
||||||
> **Note:**
|
> **Note:**
|
||||||
> A process running as PID 1 inside a container is treated specially by
|
> A process running as PID 1 inside a container is treated specially by
|
||||||
|
|
|
||||||
|
|
@ -284,6 +284,17 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: output
|
||||||
|
shorthand: o
|
||||||
|
value_type: stringArray
|
||||||
|
default_value: '[]'
|
||||||
|
description: 'Output destination (format: type=local,dest=path)'
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: platform
|
- option: platform
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Set platform if server is multi-platform capable
|
description: Set platform if server is multi-platform capable
|
||||||
|
|
@ -551,13 +562,13 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
|
||||||
is preserved with this method.\n\nThe `--squash` option is an experimental feature,
|
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
|
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,
|
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,
|
files 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
|
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
|
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
|
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,
|
builds are a better alternative, as they give more\nfine-grained control over your
|
||||||
and can take advantage of future\noptimizations in the builder. Refer to the [use
|
build, and can take advantage of future\noptimizations in the builder. Refer to
|
||||||
multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/)\nsection
|
the [use multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/)\nsection
|
||||||
in the userguide for more information.\n\n\n#### Known limitations\n\nThe `--squash`
|
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
|
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
|
image cannot take advantage of layer\n sharing with other images, and may use significantly
|
||||||
|
|
@ -568,7 +579,7 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
|
||||||
\ impact on performance, as a single layer takes longer to extract, and\n downloading
|
\ 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
|
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
|
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####
|
`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
|
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
|
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
|
daemon or setting `experimental: true` in the `daemon.json` configuration file.\n\nBy
|
||||||
|
|
|
||||||
|
|
@ -5,10 +5,13 @@ usage: docker builder
|
||||||
pname: docker
|
pname: docker
|
||||||
plink: docker.yaml
|
plink: docker.yaml
|
||||||
cname:
|
cname:
|
||||||
|
- docker builder build
|
||||||
- docker builder prune
|
- docker builder prune
|
||||||
clink:
|
clink:
|
||||||
|
- docker_builder_build.yaml
|
||||||
- docker_builder_prune.yaml
|
- docker_builder_prune.yaml
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.31"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,335 @@
|
||||||
|
command: docker builder build
|
||||||
|
short: Build an image from a Dockerfile
|
||||||
|
long: Build an image from a Dockerfile
|
||||||
|
usage: docker builder build [OPTIONS] PATH | URL | -
|
||||||
|
pname: docker builder
|
||||||
|
plink: docker_builder.yaml
|
||||||
|
options:
|
||||||
|
- option: add-host
|
||||||
|
value_type: list
|
||||||
|
description: Add a custom host-to-IP mapping (host:ip)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: build-arg
|
||||||
|
value_type: list
|
||||||
|
description: Set build-time variables
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cache-from
|
||||||
|
value_type: stringSlice
|
||||||
|
default_value: '[]'
|
||||||
|
description: Images to consider as cache sources
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cgroup-parent
|
||||||
|
value_type: string
|
||||||
|
description: Optional parent cgroup for the container
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: compress
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Compress the build context using gzip
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cpu-period
|
||||||
|
value_type: int64
|
||||||
|
default_value: "0"
|
||||||
|
description: Limit the CPU CFS (Completely Fair Scheduler) period
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cpu-quota
|
||||||
|
value_type: int64
|
||||||
|
default_value: "0"
|
||||||
|
description: Limit the CPU CFS (Completely Fair Scheduler) quota
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cpu-shares
|
||||||
|
shorthand: c
|
||||||
|
value_type: int64
|
||||||
|
default_value: "0"
|
||||||
|
description: CPU shares (relative weight)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cpuset-cpus
|
||||||
|
value_type: string
|
||||||
|
description: CPUs in which to allow execution (0-3, 0,1)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: cpuset-mems
|
||||||
|
value_type: string
|
||||||
|
description: MEMs in which to allow execution (0-3, 0,1)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: disable-content-trust
|
||||||
|
value_type: bool
|
||||||
|
default_value: "true"
|
||||||
|
description: Skip image verification
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: file
|
||||||
|
shorthand: f
|
||||||
|
value_type: string
|
||||||
|
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: force-rm
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Always remove intermediate containers
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: iidfile
|
||||||
|
value_type: string
|
||||||
|
description: Write the image ID to the file
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: isolation
|
||||||
|
value_type: string
|
||||||
|
description: Container isolation technology
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: label
|
||||||
|
value_type: list
|
||||||
|
description: Set metadata for an image
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: memory
|
||||||
|
shorthand: m
|
||||||
|
value_type: bytes
|
||||||
|
default_value: "0"
|
||||||
|
description: Memory limit
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: memory-swap
|
||||||
|
value_type: bytes
|
||||||
|
default_value: "0"
|
||||||
|
description: |
|
||||||
|
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: network
|
||||||
|
value_type: string
|
||||||
|
default_value: default
|
||||||
|
description: |
|
||||||
|
Set the networking mode for the RUN instructions during build
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.25"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: no-cache
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Do not use cache when building the image
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: output
|
||||||
|
shorthand: o
|
||||||
|
value_type: stringArray
|
||||||
|
default_value: '[]'
|
||||||
|
description: 'Output destination (format: type=local,dest=path)'
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: platform
|
||||||
|
value_type: string
|
||||||
|
description: Set platform if server is multi-platform capable
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.32"
|
||||||
|
experimental: true
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: progress
|
||||||
|
value_type: string
|
||||||
|
default_value: auto
|
||||||
|
description: |
|
||||||
|
Set type of progress output (auto, plain, tty). Use plain to show container output
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: pull
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Always attempt to pull a newer version of the image
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: quiet
|
||||||
|
shorthand: q
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Suppress the build output and print image ID on success
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: rm
|
||||||
|
value_type: bool
|
||||||
|
default_value: "true"
|
||||||
|
description: Remove intermediate containers after a successful build
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: secret
|
||||||
|
value_type: stringArray
|
||||||
|
default_value: '[]'
|
||||||
|
description: |
|
||||||
|
Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.39"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: security-opt
|
||||||
|
value_type: stringSlice
|
||||||
|
default_value: '[]'
|
||||||
|
description: Security options
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: shm-size
|
||||||
|
value_type: bytes
|
||||||
|
default_value: "0"
|
||||||
|
description: Size of /dev/shm
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: squash
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Squash newly built layers into a single new layer
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.25"
|
||||||
|
experimental: true
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: ssh
|
||||||
|
value_type: stringArray
|
||||||
|
default_value: '[]'
|
||||||
|
description: |
|
||||||
|
SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.39"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: stream
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Stream attaches to server to negotiate build context
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.31"
|
||||||
|
experimental: true
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: tag
|
||||||
|
shorthand: t
|
||||||
|
value_type: list
|
||||||
|
description: Name and optionally a tag in the 'name:tag' format
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: target
|
||||||
|
value_type: string
|
||||||
|
description: Set the target build stage to build.
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: ulimit
|
||||||
|
value_type: ulimit
|
||||||
|
default_value: '[]'
|
||||||
|
description: Ulimit options
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.31"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -18,6 +18,7 @@ options:
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Template driver
|
description: Template driver
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.37"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -259,6 +259,14 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: domainname
|
||||||
|
value_type: string
|
||||||
|
description: Container NIS domain name
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: entrypoint
|
- option: entrypoint
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Overwrite the default ENTRYPOINT of the image
|
description: Overwrite the default ENTRYPOINT of the image
|
||||||
|
|
@ -292,6 +300,15 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: gpus
|
||||||
|
value_type: gpu-request
|
||||||
|
description: GPU devices to add to the container ('all' to pass all GPUs)
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: group-add
|
- option: group-add
|
||||||
value_type: list
|
value_type: list
|
||||||
description: Add additional groups to join
|
description: Add additional groups to join
|
||||||
|
|
@ -560,8 +577,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: net
|
- option: net
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
@ -577,8 +593,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: network
|
- option: network
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
|
||||||
|
|
@ -277,6 +277,14 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: domainname
|
||||||
|
value_type: string
|
||||||
|
description: Container NIS domain name
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: entrypoint
|
- option: entrypoint
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Overwrite the default ENTRYPOINT of the image
|
description: Overwrite the default ENTRYPOINT of the image
|
||||||
|
|
@ -310,6 +318,15 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: gpus
|
||||||
|
value_type: gpu-request
|
||||||
|
description: GPU devices to add to the container ('all' to pass all GPUs)
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: group-add
|
- option: group-add
|
||||||
value_type: list
|
value_type: list
|
||||||
description: Add additional groups to join
|
description: Add additional groups to join
|
||||||
|
|
@ -578,8 +595,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: net
|
- option: net
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
@ -595,8 +611,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: network
|
- option: network
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
|
||||||
|
|
@ -126,6 +126,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: pids-limit
|
||||||
|
value_type: int64
|
||||||
|
default_value: "0"
|
||||||
|
description: Tune container pids limit (set -1 for unlimited)
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: restart
|
- option: restart
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Restart policy to apply when a container exits
|
description: Restart policy to apply when a container exits
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
command: docker context
|
||||||
|
short: Manage contexts
|
||||||
|
long: Manage contexts
|
||||||
|
usage: docker context
|
||||||
|
pname: docker
|
||||||
|
plink: docker.yaml
|
||||||
|
cname:
|
||||||
|
- docker context create
|
||||||
|
- docker context export
|
||||||
|
- docker context import
|
||||||
|
- docker context inspect
|
||||||
|
- docker context ls
|
||||||
|
- docker context rm
|
||||||
|
- docker context update
|
||||||
|
- docker context use
|
||||||
|
clink:
|
||||||
|
- docker_context_create.yaml
|
||||||
|
- docker_context_export.yaml
|
||||||
|
- docker_context_import.yaml
|
||||||
|
- docker_context_inspect.yaml
|
||||||
|
- docker_context_ls.yaml
|
||||||
|
- docker_context_rm.yaml
|
||||||
|
- docker_context_update.yaml
|
||||||
|
- docker_context_use.yaml
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,116 @@
|
||||||
|
command: docker context create
|
||||||
|
short: Create a context
|
||||||
|
long: |-
|
||||||
|
Creates a new `context`. This allows you to quickly switch the cli
|
||||||
|
configuration to connect to different clusters or single nodes.
|
||||||
|
|
||||||
|
To create a context from scratch provide the docker and, if required,
|
||||||
|
kubernetes options. The example below creates the context `my-context`
|
||||||
|
with a docker endpoint of `/var/run/docker.sock` and a kubernetes configuration
|
||||||
|
sourced from the file `/home/me/my-kube-config`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context create my-context \
|
||||||
|
--docker host=/var/run/docker.sock \
|
||||||
|
--kubernetes config-file=/home/me/my-kube-config
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the `--from=<context-name>` option to create a new context from
|
||||||
|
an existing context. The example below creates a new context named `my-context`
|
||||||
|
from the existing context `existing-context`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context create my-context --from existing-context
|
||||||
|
```
|
||||||
|
|
||||||
|
If the `--from` option is not set, the `context` is created from the current context:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context create my-context
|
||||||
|
```
|
||||||
|
|
||||||
|
This can be used to create a context out of an existing `DOCKER_HOST` based script:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ source my-setup-script.sh
|
||||||
|
$ docker context create my-context
|
||||||
|
```
|
||||||
|
|
||||||
|
To source only the `docker` endpoint configuration from an existing context
|
||||||
|
use the `--docker from=<context-name>` option. The example below creates a
|
||||||
|
new context named `my-context` using the docker endpoint configuration from
|
||||||
|
the existing context `existing-context` and a kubernetes configuration sourced
|
||||||
|
from the file `/home/me/my-kube-config`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context create my-context \
|
||||||
|
--docker from=existing-context \
|
||||||
|
--kubernetes config-file=/home/me/my-kube-config
|
||||||
|
```
|
||||||
|
|
||||||
|
To source only the `kubernetes` configuration from an existing context use the
|
||||||
|
`--kubernetes from=<context-name>` option. The example below creates a new
|
||||||
|
context named `my-context` using the kuberentes configuration from the existing
|
||||||
|
context `existing-context` and a docker endpoint of `/var/run/docker.sock`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context create my-context \
|
||||||
|
--docker host=/var/run/docker.sock \
|
||||||
|
--kubernetes from=existing-context
|
||||||
|
```
|
||||||
|
|
||||||
|
Docker and Kubernetes endpoints configurations, as well as default stack
|
||||||
|
orchestrator and description can be modified with `docker context update`
|
||||||
|
usage: docker context create [OPTIONS] CONTEXT
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: default-stack-orchestrator
|
||||||
|
value_type: string
|
||||||
|
description: |
|
||||||
|
Default orchestrator for stack operations to use with this context (swarm|kubernetes|all)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: description
|
||||||
|
value_type: string
|
||||||
|
description: Description of the context
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: docker
|
||||||
|
value_type: stringToString
|
||||||
|
default_value: '[]'
|
||||||
|
description: set the docker endpoint
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: from
|
||||||
|
value_type: string
|
||||||
|
description: create context from a named context
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: kubernetes
|
||||||
|
value_type: stringToString
|
||||||
|
default_value: '[]'
|
||||||
|
description: set the kubernetes endpoint
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
command: docker context export
|
||||||
|
short: Export a context to a tar or kubeconfig file
|
||||||
|
long: |-
|
||||||
|
Exports a context in a file that can then be used with `docker context import` (or with `kubectl` if `--kubeconfig` is set).
|
||||||
|
Default output filename is `<CONTEXT>.dockercontext`, or `<CONTEXT>.kubeconfig` if `--kubeconfig` is set.
|
||||||
|
To export to `STDOUT`, you can run `docker context export my-context -`.
|
||||||
|
usage: docker context export [OPTIONS] CONTEXT [FILE|-]
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: kubeconfig
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Export as a kubeconfig file
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
command: docker context import
|
||||||
|
short: Import a context from a tar or zip file
|
||||||
|
long: Imports a context previously exported with `docker context export`. To import
|
||||||
|
from stdin, use a hyphen (`-`) as filename.
|
||||||
|
usage: docker context import CONTEXT FILE|-
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,60 @@
|
||||||
|
command: docker context inspect
|
||||||
|
short: Display detailed information on one or more contexts
|
||||||
|
long: Inspects one or more contexts.
|
||||||
|
usage: docker context inspect [OPTIONS] [CONTEXT] [CONTEXT...]
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: format
|
||||||
|
shorthand: f
|
||||||
|
value_type: string
|
||||||
|
description: Format the output using the given Go template
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
examples: |-
|
||||||
|
### Inspect a context by name
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker context inspect "local+aks"
|
||||||
|
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"Name": "local+aks",
|
||||||
|
"Metadata": {
|
||||||
|
"Description": "Local Docker Engine + Azure AKS endpoint",
|
||||||
|
"StackOrchestrator": "kubernetes"
|
||||||
|
},
|
||||||
|
"Endpoints": {
|
||||||
|
"docker": {
|
||||||
|
"Host": "npipe:////./pipe/docker_engine",
|
||||||
|
"SkipTLSVerify": false
|
||||||
|
},
|
||||||
|
"kubernetes": {
|
||||||
|
"Host": "https://simon-aks-***.hcp.uksouth.azmk8s.io:443",
|
||||||
|
"SkipTLSVerify": false,
|
||||||
|
"DefaultNamespace": "default"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"TLSMaterial": {
|
||||||
|
"kubernetes": [
|
||||||
|
"ca.pem",
|
||||||
|
"cert.pem",
|
||||||
|
"key.pem"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Storage": {
|
||||||
|
"MetadataPath": "C:\\Users\\simon\\.docker\\contexts\\meta\\cb6d08c0a1bfa5fe6f012e61a442788c00bed93f509141daff05f620fc54ddee",
|
||||||
|
"TLSPath": "C:\\Users\\simon\\.docker\\contexts\\tls\\cb6d08c0a1bfa5fe6f012e61a442788c00bed93f509141daff05f620fc54ddee"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
command: docker context ls
|
||||||
|
aliases: list
|
||||||
|
short: List contexts
|
||||||
|
long: List contexts
|
||||||
|
usage: docker context ls [OPTIONS]
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: format
|
||||||
|
value_type: string
|
||||||
|
description: Pretty-print contexts 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 show context names
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
command: docker context rm
|
||||||
|
aliases: remove
|
||||||
|
short: Remove one or more contexts
|
||||||
|
long: Remove one or more contexts
|
||||||
|
usage: docker context rm CONTEXT [CONTEXT...]
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: force
|
||||||
|
shorthand: f
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Force the removal of a context in use
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
command: docker context update
|
||||||
|
short: Update a context
|
||||||
|
long: |-
|
||||||
|
Updates an existing `context`.
|
||||||
|
See [context create](context_create.md)
|
||||||
|
usage: docker context update [OPTIONS] CONTEXT
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
options:
|
||||||
|
- option: default-stack-orchestrator
|
||||||
|
value_type: string
|
||||||
|
description: |
|
||||||
|
Default orchestrator for stack operations to use with this context (swarm|kubernetes|all)
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: description
|
||||||
|
value_type: string
|
||||||
|
description: Description of the context
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: docker
|
||||||
|
value_type: stringToString
|
||||||
|
default_value: '[]'
|
||||||
|
description: set the docker endpoint
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: kubernetes
|
||||||
|
value_type: stringToString
|
||||||
|
default_value: '[]'
|
||||||
|
description: set the kubernetes endpoint
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
command: docker context use
|
||||||
|
short: Set the current docker context
|
||||||
|
long: |-
|
||||||
|
Set the default context to use, when `DOCKER_HOST`, `DOCKER_CONTEXT` environment variables and `--host`, `--context` global options are not set.
|
||||||
|
To disable usage of contexts, you can use the special `default` context.
|
||||||
|
usage: docker context use CONTEXT
|
||||||
|
pname: docker context
|
||||||
|
plink: docker_context.yaml
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
|
||||||
|
|
@ -270,6 +270,14 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: domainname
|
||||||
|
value_type: string
|
||||||
|
description: Container NIS domain name
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: entrypoint
|
- option: entrypoint
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Overwrite the default ENTRYPOINT of the image
|
description: Overwrite the default ENTRYPOINT of the image
|
||||||
|
|
@ -303,6 +311,15 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: gpus
|
||||||
|
value_type: gpu-request
|
||||||
|
description: GPU devices to add to the container ('all' to pass all GPUs)
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: group-add
|
- option: group-add
|
||||||
value_type: list
|
value_type: list
|
||||||
description: Add additional groups to join
|
description: Add additional groups to join
|
||||||
|
|
@ -571,8 +588,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: net
|
- option: net
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
@ -588,8 +604,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: network
|
- option: network
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
|
||||||
|
|
@ -182,6 +182,17 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: output
|
||||||
|
shorthand: o
|
||||||
|
value_type: stringArray
|
||||||
|
default_value: '[]'
|
||||||
|
description: 'Output destination (format: type=local,dest=path)'
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: platform
|
- option: platform
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Set platform if server is multi-platform capable
|
description: Set platform if server is multi-platform capable
|
||||||
|
|
|
||||||
|
|
@ -33,6 +33,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: quiet
|
||||||
|
shorthand: q
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Suppress verbose output
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
|
|
|
||||||
|
|
@ -307,6 +307,16 @@ examples: |-
|
||||||
busybox glibc 21c16b6787c6 5 weeks ago 4.19 MB
|
busybox glibc 21c16b6787c6 5 weeks ago 4.19 MB
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Filtering with multiple `reference` would give, either match A or B:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker images --filter=reference='busy*:uclibc' --filter=reference='busy*:glibc'
|
||||||
|
|
||||||
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
||||||
|
busybox uclibc e02e811dd08f 5 weeks ago 1.09 MB
|
||||||
|
busybox glibc 21c16b6787c6 5 weeks ago 4.19 MB
|
||||||
|
```
|
||||||
|
|
||||||
### Format the output
|
### Format the output
|
||||||
|
|
||||||
The formatting option (`--format`) will pretty print container output
|
The formatting option (`--format`) will pretty print container output
|
||||||
|
|
|
||||||
|
|
@ -31,203 +31,66 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
examples: |-
|
examples: "### Show output\n\nThe example below shows the output for a daemon running
|
||||||
### Show output
|
on Red Hat Enterprise Linux,\nusing the `devicemapper` storage driver. As can be
|
||||||
|
seen in the output, additional\ninformation about the `devicemapper` storage driver
|
||||||
The example below shows the output for a daemon running on Red Hat Enterprise Linux,
|
is shown:\n\n```bash\n$ docker info\nClient:\n Debug Mode: false\n\nServer:\n Containers:
|
||||||
using the `devicemapper` storage driver. As can be seen in the output, additional
|
14\n Running: 3\n Paused: 1\n Stopped: 10\n Images: 52\n Server Version: 1.10.3\n
|
||||||
information about the `devicemapper` storage driver is shown:
|
Storage Driver: devicemapper\n Pool Name: docker-202:2-25583803-pool\n Pool Blocksize:
|
||||||
|
65.54 kB\n Base Device Size: 10.74 GB\n Backing Filesystem: xfs\n Data file:
|
||||||
```bash
|
/dev/loop0\n Metadata file: /dev/loop1\n Data Space Used: 1.68 GB\n Data Space
|
||||||
$ docker info
|
Total: 107.4 GB\n Data Space Available: 7.548 GB\n Metadata Space Used: 2.322
|
||||||
|
MB\n Metadata Space Total: 2.147 GB\n Metadata Space Available: 2.145 GB\n Udev
|
||||||
Containers: 14
|
Sync Supported: true\n Deferred Removal Enabled: false\n Deferred Deletion Enabled:
|
||||||
Running: 3
|
false\n Deferred Deleted Device Count: 0\n Data loop file: /var/lib/docker/devicemapper/devicemapper/data\n
|
||||||
Paused: 1
|
\ Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata\n Library
|
||||||
Stopped: 10
|
Version: 1.02.107-RHEL7 (2015-12-01)\n Execution Driver: native-0.2\n Logging Driver:
|
||||||
Images: 52
|
json-file\n Plugins:\n Volume: local\n Network: null host bridge\n Kernel Version:
|
||||||
Server Version: 1.10.3
|
3.10.0-327.el7.x86_64\n Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)\n
|
||||||
Storage Driver: devicemapper
|
OSType: linux\n Architecture: x86_64\n CPUs: 1\n Total Memory: 991.7 MiB\n Name:
|
||||||
Pool Name: docker-202:2-25583803-pool
|
ip-172-30-0-91.ec2.internal\n ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S\n
|
||||||
Pool Blocksize: 65.54 kB
|
Docker Root Dir: /var/lib/docker\n Debug Mode: false\n Username: gordontheturtle\n
|
||||||
Base Device Size: 10.74 GB
|
Registry: https://index.docker.io/v1/\n Insecure registries:\n myinsecurehost:5000\n
|
||||||
Backing Filesystem: xfs
|
\ 127.0.0.0/8\n```\n \n### Show debugging output\n\nHere is a sample output for
|
||||||
Data file: /dev/loop0
|
a daemon running on Ubuntu, using the overlay2\nstorage driver and a node that is
|
||||||
Metadata file: /dev/loop1
|
part of a 2-node swarm:\n\n```bash\n$ docker -D info\nClient:\n Debug Mode: true\n\nServer:\n
|
||||||
Data Space Used: 1.68 GB
|
Containers: 14\n Running: 3\n Paused: 1\n Stopped: 10\n Images: 52\n Server Version:
|
||||||
Data Space Total: 107.4 GB
|
1.13.0\n Storage Driver: overlay2\n Backing Filesystem: extfs\n Supports d_type:
|
||||||
Data Space Available: 7.548 GB
|
true\n Native Overlay Diff: false\n Logging Driver: json-file\n Cgroup Driver:
|
||||||
Metadata Space Used: 2.322 MB
|
cgroupfs\n Plugins:\n Volume: local\n Network: bridge host macvlan null overlay\n
|
||||||
Metadata Space Total: 2.147 GB
|
Swarm: active\n NodeID: rdjq45w1op418waxlairloqbm\n Is Manager: true\n ClusterID:
|
||||||
Metadata Space Available: 2.145 GB
|
te8kdyw33n36fqiz74bfjeixd\n Managers: 1\n Nodes: 2\n Orchestration:\n Task
|
||||||
Udev Sync Supported: true
|
History Retention Limit: 5\n Raft:\n Snapshot Interval: 10000\n Number of Old
|
||||||
Deferred Removal Enabled: false
|
Snapshots to Retain: 0\n Heartbeat Tick: 1\n Election Tick: 3\n Dispatcher:\n
|
||||||
Deferred Deletion Enabled: false
|
\ Heartbeat Period: 5 seconds\n CA Configuration:\n Expiry Duration: 3 months\n
|
||||||
Deferred Deleted Device Count: 0
|
\ Root Rotation In Progress: false\n Node Address: 172.16.66.128 172.16.66.129\n
|
||||||
Data loop file: /var/lib/docker/devicemapper/devicemapper/data
|
\ Manager Addresses:\n 172.16.66.128:2477\n Runtimes: runc\n Default Runtime:
|
||||||
Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
|
runc\n Init Binary: docker-init\n containerd version: 8517738ba4b82aff5662c97ca4627e7e4d03b531\n
|
||||||
Library Version: 1.02.107-RHEL7 (2015-12-01)
|
runc version: ac031b5bf1cc92239461125f4c1ffb760522bbf2\n init version: N/A (expected:
|
||||||
Execution Driver: native-0.2
|
v0.13.0)\n Security Options:\n apparmor\n seccomp\n Profile: default\n Kernel
|
||||||
Logging Driver: json-file
|
Version: 4.4.0-31-generic\n Operating System: Ubuntu 16.04.1 LTS\n OSType: linux\n
|
||||||
Plugins:
|
Architecture: x86_64\n CPUs: 2\n Total Memory: 1.937 GiB\n Name: ubuntu\n ID: H52R:7ZR6:EIIA:76JG:ORIY:BVKF:GSFU:HNPG:B5MK:APSC:SZ3Q:N326\n
|
||||||
Volume: local
|
Docker Root Dir: /var/lib/docker\n Debug Mode: true\n File Descriptors: 30\n Goroutines:
|
||||||
Network: null host bridge
|
123\n System Time: 2016-11-12T17:24:37.955404361-08:00\n EventsListeners: 0\n
|
||||||
Kernel Version: 3.10.0-327.el7.x86_64
|
Http Proxy: http://test:test@proxy.example.com:8080\n Https Proxy: https://test:test@proxy.example.com:8080\n
|
||||||
Operating System: Red Hat Enterprise Linux Server 7.2 (Maipo)
|
No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com\n Registry: https://index.docker.io/v1/\n
|
||||||
OSType: linux
|
WARNING: No swap limit support\n Labels:\n storage=ssd\n staging=true\n Experimental:
|
||||||
Architecture: x86_64
|
false\n Insecure Registries:\n 127.0.0.0/8\n Registry Mirrors:\n http://192.168.1.2/\n
|
||||||
CPUs: 1
|
\ http://registry-mirror.example.com:5000/\n Live Restore Enabled: false\n```\n\nThe
|
||||||
Total Memory: 991.7 MiB
|
global `-D` option causes all `docker` commands to output debug information.\n\n###
|
||||||
Name: ip-172-30-0-91.ec2.internal
|
Format the output\n\nYou can also specify the output format:\n\n```bash\n$ docker
|
||||||
ID: I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S
|
info --format '{{json .}}'\n\n{\"ID\":\"I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S\",\"Containers\":14,
|
||||||
Docker Root Dir: /var/lib/docker
|
...}\n```\n\n### Run `docker info` on Windows\n\nHere is a sample output for a daemon
|
||||||
Debug mode (client): false
|
running on Windows Server 2016:\n\n```none\nE:\\docker>docker info\nClient:\n Debug
|
||||||
Debug mode (server): false
|
Mode: false\n\nServer:\n Containers: 1\n Running: 0\n Paused: 0\n Stopped: 1\n
|
||||||
Username: gordontheturtle
|
Images: 17\n Server Version: 1.13.0\n Storage Driver: windowsfilter\n Windows:\n
|
||||||
Registry: https://index.docker.io/v1/
|
Logging Driver: json-file\n Plugins:\n Volume: local\n Network: nat null overlay\n
|
||||||
Insecure registries:
|
Swarm: inactive\n Default Isolation: process\n Kernel Version: 10.0 14393 (14393.206.amd64fre.rs1_release.160912-1937)\n
|
||||||
myinsecurehost:5000
|
Operating System: Windows Server 2016 Datacenter\n OSType: windows\n Architecture:
|
||||||
127.0.0.0/8
|
x86_64\n CPUs: 8\n Total Memory: 3.999 GiB\n Name: WIN-V0V70C0LU5P\n ID: NYMS:B5VK:UMSL:FVDZ:EWB5:FKVK:LPFL:FJMQ:H6FT:BZJ6:L2TD:XH62\n
|
||||||
```
|
Docker Root Dir: C:\\control\n Debug Mode: false\n Registry: https://index.docker.io/v1/\n
|
||||||
|
Insecure Registries:\n 127.0.0.0/8\n Registry Mirrors:\n http://192.168.1.2/\n
|
||||||
### Show debugging output
|
\ http://registry-mirror.example.com:5000/\n Live Restore Enabled: false\n```"
|
||||||
|
|
||||||
Here is a sample output for a daemon running on Ubuntu, using the overlay2
|
|
||||||
storage driver and a node that is part of a 2-node swarm:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ docker -D info
|
|
||||||
|
|
||||||
Containers: 14
|
|
||||||
Running: 3
|
|
||||||
Paused: 1
|
|
||||||
Stopped: 10
|
|
||||||
Images: 52
|
|
||||||
Server Version: 1.13.0
|
|
||||||
Storage Driver: overlay2
|
|
||||||
Backing Filesystem: extfs
|
|
||||||
Supports d_type: true
|
|
||||||
Native Overlay Diff: false
|
|
||||||
Logging Driver: json-file
|
|
||||||
Cgroup Driver: cgroupfs
|
|
||||||
Plugins:
|
|
||||||
Volume: local
|
|
||||||
Network: bridge host macvlan null overlay
|
|
||||||
Swarm: active
|
|
||||||
NodeID: rdjq45w1op418waxlairloqbm
|
|
||||||
Is Manager: true
|
|
||||||
ClusterID: te8kdyw33n36fqiz74bfjeixd
|
|
||||||
Managers: 1
|
|
||||||
Nodes: 2
|
|
||||||
Orchestration:
|
|
||||||
Task History Retention Limit: 5
|
|
||||||
Raft:
|
|
||||||
Snapshot Interval: 10000
|
|
||||||
Number of Old Snapshots to Retain: 0
|
|
||||||
Heartbeat Tick: 1
|
|
||||||
Election Tick: 3
|
|
||||||
Dispatcher:
|
|
||||||
Heartbeat Period: 5 seconds
|
|
||||||
CA Configuration:
|
|
||||||
Expiry Duration: 3 months
|
|
||||||
Root Rotation In Progress: false
|
|
||||||
Node Address: 172.16.66.128 172.16.66.129
|
|
||||||
Manager Addresses:
|
|
||||||
172.16.66.128:2477
|
|
||||||
Runtimes: runc
|
|
||||||
Default Runtime: runc
|
|
||||||
Init Binary: docker-init
|
|
||||||
containerd version: 8517738ba4b82aff5662c97ca4627e7e4d03b531
|
|
||||||
runc version: ac031b5bf1cc92239461125f4c1ffb760522bbf2
|
|
||||||
init version: N/A (expected: v0.13.0)
|
|
||||||
Security Options:
|
|
||||||
apparmor
|
|
||||||
seccomp
|
|
||||||
Profile: default
|
|
||||||
Kernel Version: 4.4.0-31-generic
|
|
||||||
Operating System: Ubuntu 16.04.1 LTS
|
|
||||||
OSType: linux
|
|
||||||
Architecture: x86_64
|
|
||||||
CPUs: 2
|
|
||||||
Total Memory: 1.937 GiB
|
|
||||||
Name: ubuntu
|
|
||||||
ID: H52R:7ZR6:EIIA:76JG:ORIY:BVKF:GSFU:HNPG:B5MK:APSC:SZ3Q:N326
|
|
||||||
Docker Root Dir: /var/lib/docker
|
|
||||||
Debug Mode (client): true
|
|
||||||
Debug Mode (server): true
|
|
||||||
File Descriptors: 30
|
|
||||||
Goroutines: 123
|
|
||||||
System Time: 2016-11-12T17:24:37.955404361-08:00
|
|
||||||
EventsListeners: 0
|
|
||||||
Http Proxy: http://test:test@proxy.example.com:8080
|
|
||||||
Https Proxy: https://test:test@proxy.example.com:8080
|
|
||||||
No Proxy: localhost,127.0.0.1,docker-registry.somecorporation.com
|
|
||||||
Registry: https://index.docker.io/v1/
|
|
||||||
WARNING: No swap limit support
|
|
||||||
Labels:
|
|
||||||
storage=ssd
|
|
||||||
staging=true
|
|
||||||
Experimental: false
|
|
||||||
Insecure Registries:
|
|
||||||
127.0.0.0/8
|
|
||||||
Registry Mirrors:
|
|
||||||
http://192.168.1.2/
|
|
||||||
http://registry-mirror.example.com:5000/
|
|
||||||
Live Restore Enabled: false
|
|
||||||
```
|
|
||||||
|
|
||||||
The global `-D` option causes all `docker` commands to output debug information.
|
|
||||||
|
|
||||||
### Format the output
|
|
||||||
|
|
||||||
You can also specify the output format:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ docker info --format '{{json .}}'
|
|
||||||
|
|
||||||
{"ID":"I54V:OLXT:HVMM:TPKO:JPHQ:CQCD:JNLC:O3BZ:4ZVJ:43XJ:PFHZ:6N2S","Containers":14, ...}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run `docker info` on Windows
|
|
||||||
|
|
||||||
Here is a sample output for a daemon running on Windows Server 2016:
|
|
||||||
|
|
||||||
```none
|
|
||||||
E:\docker>docker info
|
|
||||||
|
|
||||||
Containers: 1
|
|
||||||
Running: 0
|
|
||||||
Paused: 0
|
|
||||||
Stopped: 1
|
|
||||||
Images: 17
|
|
||||||
Server Version: 1.13.0
|
|
||||||
Storage Driver: windowsfilter
|
|
||||||
Windows:
|
|
||||||
Logging Driver: json-file
|
|
||||||
Plugins:
|
|
||||||
Volume: local
|
|
||||||
Network: nat null overlay
|
|
||||||
Swarm: inactive
|
|
||||||
Default Isolation: process
|
|
||||||
Kernel Version: 10.0 14393 (14393.206.amd64fre.rs1_release.160912-1937)
|
|
||||||
Operating System: Windows Server 2016 Datacenter
|
|
||||||
OSType: windows
|
|
||||||
Architecture: x86_64
|
|
||||||
CPUs: 8
|
|
||||||
Total Memory: 3.999 GiB
|
|
||||||
Name: WIN-V0V70C0LU5P
|
|
||||||
ID: NYMS:B5VK:UMSL:FVDZ:EWB5:FKVK:LPFL:FJMQ:H6FT:BZJ6:L2TD:XH62
|
|
||||||
Docker Root Dir: C:\control
|
|
||||||
Debug Mode (client): false
|
|
||||||
Debug Mode (server): false
|
|
||||||
Registry: https://index.docker.io/v1/
|
|
||||||
Insecure Registries:
|
|
||||||
127.0.0.0/8
|
|
||||||
Registry Mirrors:
|
|
||||||
http://192.168.1.2/
|
|
||||||
http://registry-mirror.example.com:5000/
|
|
||||||
Live Restore Enabled: false
|
|
||||||
```
|
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
|
|
|
||||||
|
|
@ -83,7 +83,7 @@ examples: "### Inspect an image's manifest object\n \n```bash\n$ docker manifest
|
||||||
IP and port.\nThis is similar to tagging an image and pushing it to a foreign registry.\n\nAfter
|
IP and port.\nThis is similar to tagging an image and pushing it to a foreign registry.\n\nAfter
|
||||||
you have created your local copy of the manifest list, you may optionally\n`annotate`
|
you have created your local copy of the manifest list, you may optionally\n`annotate`
|
||||||
it. Annotations allowed are the architecture and operating system (overriding the
|
it. Annotations allowed are the architecture and operating system (overriding the
|
||||||
image's current values),\nos features, and an archictecure variant. \n\nFinally,
|
image's current values),\nos features, and an architecture variant. \n\nFinally,
|
||||||
you need to `push` your manifest list to the desired registry. Below are descriptions
|
you need to `push` your manifest list to the desired registry. Below are descriptions
|
||||||
of these three commands,\nand an example putting them all together.\n\n```bash\n$
|
of these three commands,\nand an example putting them all together.\n\n```bash\n$
|
||||||
docker manifest create 45.55.81.106:5000/coolapp:v1 \\\n 45.55.81.106:5000/coolapp-ppc64le-linux:v1
|
docker manifest create 45.55.81.106:5000/coolapp:v1 \\\n 45.55.81.106:5000/coolapp-ppc64le-linux:v1
|
||||||
|
|
@ -122,7 +122,7 @@ examples: "### Inspect an image's manifest object\n \n```bash\n$ docker manifest
|
||||||
docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag\n```\n\nNote
|
docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag\n```\n\nNote
|
||||||
that the `--insecure` flag is not required to annotate a manifest list, since annotations
|
that the `--insecure` flag is not required to annotate a manifest list, since annotations
|
||||||
are to a locally-stored copy of a manifest list. You may also skip the `--insecure`
|
are to a locally-stored copy of a manifest list. You may also skip the `--insecure`
|
||||||
flag if you are performaing a `docker manifest inspect` on a locally-stored manifest
|
flag if you are performing a `docker manifest inspect` on a locally-stored manifest
|
||||||
list. Be sure to keep in mind that locally-stored manifest lists are never used
|
list. Be sure to keep in mind that locally-stored manifest lists are never used
|
||||||
by the engine on a `docker pull`."
|
by the engine on a `docker pull`."
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,7 @@ clink:
|
||||||
- docker_network_prune.yaml
|
- docker_network_prune.yaml
|
||||||
- docker_network_rm.yaml
|
- docker_network_rm.yaml
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,15 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: driver-opt
|
||||||
|
value_type: stringSlice
|
||||||
|
default_value: '[]'
|
||||||
|
description: driver options for the network
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: ip
|
- option: ip
|
||||||
value_type: string
|
value_type: string
|
||||||
description: IPv4 address (e.g., 172.30.100.104)
|
description: IPv4 address (e.g., 172.30.100.104)
|
||||||
|
|
@ -119,6 +128,7 @@ examples: |-
|
||||||
|
|
||||||
You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks.
|
You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks.
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -336,6 +336,7 @@ examples: |-
|
||||||
my-ingress-network
|
my-ingress-network
|
||||||
```
|
```
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@ examples: |-
|
||||||
$ docker network disconnect multi-host-network container1
|
$ docker network disconnect multi-host-network container1
|
||||||
```
|
```
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -125,6 +125,7 @@ examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK I
|
||||||
by a colon for all networks:\n\n```bash\n$ docker network ls --format \"{{.ID}}:
|
by a colon for all networks:\n\n```bash\n$ docker network ls --format \"{{.ID}}:
|
||||||
{{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```"
|
{{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```"
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -31,6 +31,7 @@ examples: |-
|
||||||
list and tries to delete that. The command reports success or failure for each
|
list and tries to delete that. The command reports success or failure for each
|
||||||
deletion.
|
deletion.
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
min_api_version: "1.21"
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,6 @@
|
||||||
command: docker node promote
|
command: docker node promote
|
||||||
short: Promote one or more nodes to manager in the swarm
|
short: Promote one or more nodes to manager in the swarm
|
||||||
long: |-
|
long: Promotes a node to manager. This command can only be executed on a manager node.
|
||||||
Promotes a node to manager. This command targets a docker engine that is a
|
|
||||||
manager in the swarm.
|
|
||||||
usage: docker node promote NODE [NODE...]
|
usage: docker node promote NODE [NODE...]
|
||||||
pname: docker node
|
pname: docker node
|
||||||
plink: docker_node.yaml
|
plink: docker_node.yaml
|
||||||
|
|
|
||||||
|
|
@ -133,6 +133,7 @@ examples: |-
|
||||||
|
|
||||||
Placeholder | Description
|
Placeholder | Description
|
||||||
----------------|------------------------------------------------------------------------------------------
|
----------------|------------------------------------------------------------------------------------------
|
||||||
|
`.ID` | Task ID
|
||||||
`.Name` | Task name
|
`.Name` | Task name
|
||||||
`.Image` | Task image
|
`.Image` | Task image
|
||||||
`.Node` | Node ID
|
`.Node` | Node ID
|
||||||
|
|
|
||||||
|
|
@ -57,6 +57,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: quiet
|
||||||
|
shorthand: q
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Suppress verbose output
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
examples: |-
|
examples: |-
|
||||||
### Pull an image from Docker Hub
|
### Pull an image from Docker Hub
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,14 @@
|
||||||
command: docker rmi
|
command: docker rmi
|
||||||
short: Remove one or more images
|
short: Remove one or more images
|
||||||
long: Remove one or more images
|
long: |-
|
||||||
|
Removes (and un-tags) one or more images from the host node. If an image has
|
||||||
|
multiple tags, using this command with the tag as a parameter only removes the
|
||||||
|
tag. If the tag is the only one for the image, both the image and the tag are
|
||||||
|
removed.
|
||||||
|
|
||||||
|
This does not remove images from a registry. You cannot remove an image of a
|
||||||
|
running container unless you use the `-f` option. To see all images on a host
|
||||||
|
use the [`docker image ls`](images.md) command.
|
||||||
usage: docker rmi [OPTIONS] IMAGE [IMAGE...]
|
usage: docker rmi [OPTIONS] IMAGE [IMAGE...]
|
||||||
pname: docker
|
pname: docker
|
||||||
plink: docker.yaml
|
plink: docker.yaml
|
||||||
|
|
|
||||||
|
|
@ -288,6 +288,14 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: domainname
|
||||||
|
value_type: string
|
||||||
|
description: Container NIS domain name
|
||||||
|
deprecated: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: entrypoint
|
- option: entrypoint
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Overwrite the default ENTRYPOINT of the image
|
description: Overwrite the default ENTRYPOINT of the image
|
||||||
|
|
@ -321,6 +329,15 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: gpus
|
||||||
|
value_type: gpu-request
|
||||||
|
description: GPU devices to add to the container ('all' to pass all GPUs)
|
||||||
|
deprecated: false
|
||||||
|
min_api_version: "1.40"
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
- option: group-add
|
- option: group-add
|
||||||
value_type: list
|
value_type: list
|
||||||
description: Add additional groups to join
|
description: Add additional groups to join
|
||||||
|
|
@ -589,8 +606,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: net
|
- option: net
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
@ -606,8 +622,7 @@ options:
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: network
|
- option: network
|
||||||
value_type: string
|
value_type: network
|
||||||
default_value: default
|
|
||||||
description: Connect a container to a network
|
description: Connect a container to a network
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
|
|
@ -1306,6 +1321,55 @@ examples: |-
|
||||||
> that may be removed should not be added to untrusted containers with
|
> that may be removed should not be added to untrusted containers with
|
||||||
> `--device`.
|
> `--device`.
|
||||||
|
|
||||||
|
For Windows, the format of the string passed to the `--device` option is in
|
||||||
|
the form of `--device=<IdType>/<Id>`. Beginning with Windows Server 2019
|
||||||
|
and Windows 10 October 2018 Update, Windows only supports an IdType of
|
||||||
|
`class` and the Id as a [device interface class
|
||||||
|
GUID](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/overview-of-device-interface-classes).
|
||||||
|
Refer to the table defined in the [Windows container
|
||||||
|
docs](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/hardware-devices-in-containers)
|
||||||
|
for a list of container-supported device interface class GUIDs.
|
||||||
|
|
||||||
|
If this option is specified for a process-isolated Windows container, _all_
|
||||||
|
devices that implement the requested device interface class GUID are made
|
||||||
|
available in the container. For example, the command below makes all COM
|
||||||
|
ports on the host visible in the container.
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
PS C:\> docker run --device=class/86E0D1E0-8089-11D0-9CE4-08003E301F73 mcr.microsoft.com/windows/servercore:ltsc2019
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note**: the `--device` option is only supported on process-isolated
|
||||||
|
> Windows containers. This option fails if the container isolation is `hyperv`
|
||||||
|
> or when running Linux Containers on Windows (LCOW).
|
||||||
|
|
||||||
|
### Access an NVIDIA GPU
|
||||||
|
|
||||||
|
The `--gpus` flag allows you to access NVIDIA GPU resources. First you need to
|
||||||
|
install [nvidia-container-runtime](https://nvidia.github.io/nvidia-container-runtime/).
|
||||||
|
Visit [Specify a container's resources](https://docs.docker.com/config/containers/resource_constraints/)
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
To use `--gpus`, specify which GPUs (or all) to use. If no value is provied, all
|
||||||
|
available GPUs are used. The example below exposes all available GPUs.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run -it --rm --gpus all ubuntu nvidia-smi
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the `device` option to specify GPUs. The example below exposes a specific
|
||||||
|
GPU.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run -it --rm --gpus device=GPU-3a23c669-1f69-c64e-cf85-44e9b07e7a2a ubuntu nvidia-smi
|
||||||
|
```
|
||||||
|
|
||||||
|
The example below exposes the first and third GPUs.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run -it --rm --gpus device=0,2 nvidia-smi
|
||||||
|
```
|
||||||
|
|
||||||
### Restart policies (--restart)
|
### Restart policies (--restart)
|
||||||
|
|
||||||
Use Docker's `--restart` to specify a container's *restart policy*. A restart
|
Use Docker's `--restart` to specify a container's *restart policy*. A restart
|
||||||
|
|
@ -1442,14 +1506,14 @@ examples: |-
|
||||||
|
|
||||||
|
|
||||||
| Value | Description |
|
| Value | Description |
|
||||||
|:----------|:-------------------------------------------------------------------------------------------|
|
|:----------|:------------------------------------------------------------------------------------------------------------------|
|
||||||
| `default` | Use the value specified by the Docker daemon's `--exec-opt` or system default (see below). |
|
| `default` | Use the value specified by the Docker daemon's `--exec-opt` or system default (see below). |
|
||||||
| `process` | Shared-kernel namespace isolation (not supported on Windows client operating systems). |
|
| `process` | Shared-kernel namespace isolation (not supported on Windows client operating systems older than Windows 10 1809). |
|
||||||
| `hyperv` | Hyper-V hypervisor partition-based isolation. |
|
| `hyperv` | Hyper-V hypervisor partition-based isolation. |
|
||||||
|
|
||||||
The default isolation on Windows server operating systems is `process`. The default (and only supported)
|
The default isolation on Windows server operating systems is `process`. The default
|
||||||
isolation on Windows client operating systems is `hyperv`. An attempt to start a container on a client
|
isolation on Windows client operating systems is `hyperv`. An attempt to start a container on a client
|
||||||
operating system with `--isolation process` will fail.
|
operating system older than Windows 10 1809 with `--isolation process` will fail.
|
||||||
|
|
||||||
On Windows server, assuming the default configuration, these commands are equivalent
|
On Windows server, assuming the default configuration, these commands are equivalent
|
||||||
and result in `process` isolation:
|
and result in `process` isolation:
|
||||||
|
|
@ -1543,4 +1607,3 @@ experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue