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

Update YAML files for 18.01

This commit is contained in:
Misty Stanley-Jones 2018-01-11 08:44:09 -08:00 committed by Misty Stanley-Jones
parent 6af480f2f2
commit 7c3d97ad11
169 changed files with 3526 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -113,4 +113,7 @@ clink:
- docker_wait.yaml - docker_wait.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -69,18 +69,27 @@ options:
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stdin - option: no-stdin
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not attach STDIN description: Do not attach STDIN
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy - option: sig-proxy
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Proxy all received signals to the process description: Proxy all received signals to the process
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Attach to and detach from a running container ### Attach to and detach from a running container
@ -151,4 +160,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -112,40 +112,61 @@ options:
description: Add a custom host-to-IP mapping (host:ip) description: Add a custom host-to-IP mapping (host:ip)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg - option: build-arg
value_type: list value_type: list
description: Set build-time variables description: Set build-time variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from - option: cache-from
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Images to consider as cache sources description: Images to consider as cache sources
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent - option: cgroup-parent
value_type: string value_type: string
description: Optional parent cgroup for the container description: Optional parent cgroup for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: compress - option: compress
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Compress the build context using gzip description: Compress the build context using gzip
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -153,49 +174,76 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file - option: file
shorthand: f shorthand: f
value_type: string value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile') description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm - option: force-rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always remove intermediate containers description: Always remove intermediate containers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: iidfile - option: iidfile
value_type: string value_type: string
description: Write the image ID to the file description: Write the image ID to the file
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation - option: isolation
value_type: string value_type: string
description: Container isolation technology description: Container isolation technology
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
value_type: list value_type: list
description: Set metadata for an image description: Set metadata for an image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -203,6 +251,9 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -210,6 +261,9 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network - option: network
value_type: string value_type: string
default_value: default default_value: default
@ -218,24 +272,36 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache - option: no-cache
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not use cache when building the image description: Do not use cache when building the image
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: pull - option: pull
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always attempt to pull a newer version of the image description: Always attempt to pull a newer version of the image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -243,24 +309,36 @@ options:
description: Suppress the build output and print image ID on success description: Suppress the build output and print image ID on success
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Remove intermediate containers after a successful build description: Remove intermediate containers after a successful build
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt - option: security-opt
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Security options description: Security options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size - option: shm-size
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Size of /dev/shm description: Size of /dev/shm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: squash - option: squash
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -268,6 +346,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: stream - option: stream
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -275,23 +356,35 @@ options:
deprecated: false deprecated: false
min_api_version: "1.31" min_api_version: "1.31"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: tag - option: tag
shorthand: t shorthand: t
value_type: list value_type: list
description: Name and optionally a tag in the 'name:tag' format description: Name and optionally a tag in the 'name:tag' format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target - option: target
value_type: string value_type: string
description: Set the target build stage to build. description: Set the target build stage to build.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit - option: ulimit
value_type: ulimit value_type: ulimit
default_value: '[]' default_value: '[]'
description: Ulimit options description: Ulimit options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240 examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240
bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284 bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284
MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh
@ -476,4 +569,7 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
make sure the `HELLO` envvar's value is `world`." make sure the `HELLO` envvar's value is `world`."
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -15,4 +15,7 @@ clink:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false

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

@ -10,13 +10,22 @@ options:
description: Use a custom checkpoint storage directory description: Use a custom checkpoint storage directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave-running - option: leave-running
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Leave the container running after checkpoint description: Leave the container running after checkpoint
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false

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

@ -11,7 +11,13 @@ options:
description: Use a custom checkpoint storage directory description: Use a custom checkpoint storage directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false

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

@ -11,7 +11,13 @@ options:
description: Use a custom checkpoint storage directory description: Use a custom checkpoint storage directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false

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

@ -28,18 +28,27 @@ options:
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>") description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change - option: change
shorthand: c shorthand: c
value_type: list value_type: list
description: Apply Dockerfile instruction to the created image description: Apply Dockerfile instruction to the created image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message - option: message
shorthand: m shorthand: m
value_type: string value_type: string
description: Commit message description: Commit message
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause - option: pause
shorthand: p shorthand: p
value_type: bool value_type: bool
@ -47,6 +56,9 @@ options:
description: Pause container during commit description: Pause container during commit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Commit a container ### Commit a container
@ -115,4 +127,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_config.yaml
View File

@ -17,4 +17,7 @@ clink:
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -11,7 +11,13 @@ options:
description: Config labels description: Config labels
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -11,13 +11,22 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pretty - option: pretty
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print the information in a human friendly format description: Print the information in a human friendly format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -12,11 +12,17 @@ options:
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print configs using a Go template description: Pretty-print configs using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -24,7 +30,13 @@ options:
description: Only display IDs description: Only display IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -8,4 +8,7 @@ plink: docker_config.yaml
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -58,4 +58,7 @@ clink:
- docker_container_wait.yaml - docker_container_wait.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -10,18 +10,30 @@ options:
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stdin - option: no-stdin
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not attach STDIN description: Do not attach STDIN
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy - option: sig-proxy
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Proxy all received signals to the process description: Proxy all received signals to the process
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -11,18 +11,27 @@ options:
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>") description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: change - option: change
shorthand: c shorthand: c
value_type: list value_type: list
description: Apply Dockerfile instruction to the created image description: Apply Dockerfile instruction to the created image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message - option: message
shorthand: m shorthand: m
value_type: string value_type: string
description: Commit message description: Commit message
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause - option: pause
shorthand: p shorthand: p
value_type: bool value_type: bool
@ -30,6 +39,12 @@ options:
description: Pause container during commit description: Pause container during commit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_container_cp.yaml
View File

@ -19,6 +19,9 @@ options:
description: Archive mode (copy all uid/gid information) description: Archive mode (copy all uid/gid information)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link - option: follow-link
shorthand: L shorthand: L
value_type: bool value_type: bool
@ -26,6 +29,12 @@ options:
description: Always follow symbol link in SRC_PATH description: Always follow symbol link in SRC_PATH
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -10,12 +10,18 @@ options:
description: Add a custom host-to-IP mapping (host:ip) description: Add a custom host-to-IP mapping (host:ip)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach - option: attach
shorthand: a shorthand: a
value_type: list value_type: list
description: Attach to STDIN, STDOUT or STDERR description: Attach to STDIN, STDOUT or STDERR
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight - option: blkio-weight
value_type: uint16 value_type: uint16
default_value: "0" default_value: "0"
@ -23,56 +29,86 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device - option: blkio-weight-device
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Block IO weight (relative device weight) description: Block IO weight (relative device weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add - option: cap-add
value_type: list value_type: list
description: Add Linux capabilities description: Add Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop - option: cap-drop
value_type: list value_type: list
description: Drop Linux capabilities description: Drop Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent - option: cgroup-parent
value_type: string value_type: string
description: Optional parent cgroup for the container description: Optional parent cgroup for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile - option: cidfile
value_type: string value_type: string
description: Write the container ID to the file description: Write the container ID to the file
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count - option: cpu-count
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU count (Windows only) description: CPU count (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent - option: cpu-percent
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU percent (Windows only) description: CPU percent (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period - option: cpu-rt-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -80,6 +116,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime - option: cpu-rt-runtime
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -87,6 +126,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -94,125 +136,194 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus - option: cpus
value_type: decimal value_type: decimal
description: Number of CPUs description: Number of CPUs
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device - option: device
value_type: list value_type: list
description: Add a host device to the container description: Add a host device to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule - option: device-cgroup-rule
value_type: list value_type: list
description: Add a rule to the cgroup allowed devices list description: Add a rule to the cgroup allowed devices list
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps - option: device-read-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (bytes per second) from a device description: Limit read rate (bytes per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops - option: device-read-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (IO per second) from a device description: Limit read rate (IO per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps - option: device-write-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (bytes per second) to a device description: Limit write rate (bytes per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops - option: device-write-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (IO per second) to a device description: Limit write rate (IO per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns - option: dns
value_type: list value_type: list
description: Set custom DNS servers description: Set custom DNS servers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt - option: dns-opt
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option - option: dns-option
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search - option: dns-search
value_type: list value_type: list
description: Set custom DNS search domains description: Set custom DNS search domains
deprecated: false deprecated: false
experimental: 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: list value_type: list
description: Set environment variables description: Set environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file - option: env-file
value_type: list value_type: list
description: Read in a file of environment variables description: Read in a file of environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose - option: expose
value_type: list value_type: list
description: Expose a port or a range of ports description: Expose a port or a range of ports
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd - option: health-cmd
value_type: string value_type: string
description: Command to run to check health description: Command to run to check health
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval - option: health-interval
value_type: duration value_type: duration
default_value: 0s default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s) description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries - option: health-retries
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Consecutive failures needed to report unhealthy description: Consecutive failures needed to report unhealthy
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period - option: health-start-period
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -221,6 +332,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.29" min_api_version: "1.29"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout - option: health-timeout
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -228,18 +342,27 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s) Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help - option: help
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print usage description: Print usage
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname - option: hostname
shorthand: h shorthand: h
value_type: string value_type: string
description: Container host name description: Container host name
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init - option: init
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -248,6 +371,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -255,6 +381,9 @@ options:
description: Keep STDIN open even if not attached description: Keep STDIN open even if not attached
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth - option: io-maxbandwidth
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -262,74 +391,116 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only) Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops - option: io-maxiops
value_type: uint64 value_type: uint64
default_value: "0" default_value: "0"
description: Maximum IOps limit for the system drive (Windows only) description: Maximum IOps limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: 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)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6 - option: ip6
value_type: string value_type: string
description: IPv6 address (e.g., 2001:db8::33) description: IPv6 address (e.g., 2001:db8::33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc - option: ipc
value_type: string value_type: string
description: IPC mode to use description: IPC mode to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation - option: isolation
value_type: string value_type: string
description: Container isolation technology description: Container isolation technology
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory - option: kernel-memory
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Kernel memory limit description: Kernel memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
shorthand: l shorthand: l
value_type: list value_type: list
description: Set meta data on a container description: Set meta data on a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file - option: label-file
value_type: list value_type: list
description: Read in a line delimited file of labels description: Read in a line delimited file of labels
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link - option: link
value_type: list value_type: list
description: Add link to another container description: Add link to another container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip - option: link-local-ip
value_type: list value_type: list
description: Container IPv4/IPv6 link-local addresses description: Container IPv4/IPv6 link-local addresses
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver - option: log-driver
value_type: string value_type: string
description: Logging driver for the container description: Logging driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt - option: log-opt
value_type: list value_type: list
description: Log driver options description: Log driver options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address - option: mac-address
value_type: string value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33) description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -337,12 +508,18 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation - option: memory-reservation
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Memory soft limit description: Memory soft limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -350,91 +527,139 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness - option: memory-swappiness
value_type: int64 value_type: int64
default_value: "-1" default_value: "-1"
description: Tune container memory swappiness (0 to 100) description: Tune container memory swappiness (0 to 100)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount - option: mount
value_type: mount value_type: mount
description: Attach a filesystem mount to the container description: Attach a filesystem mount to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name - option: name
value_type: string value_type: string
description: Assign a name to the container description: Assign a name to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net - option: net
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias - option: net-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network - option: network
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias - option: network-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck - option: no-healthcheck
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable any container-specified HEALTHCHECK description: Disable any container-specified HEALTHCHECK
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable - option: oom-kill-disable
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable OOM Killer description: Disable OOM Killer
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj - option: oom-score-adj
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000) description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid - option: pid
value_type: string value_type: string
description: PID namespace to use description: PID namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit - option: pids-limit
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Tune container pids limit (set -1 for unlimited) description: Tune container pids limit (set -1 for unlimited)
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged - option: privileged
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Give extended privileges to this container description: Give extended privileges to this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish - option: publish
shorthand: p shorthand: p
value_type: list value_type: list
description: Publish a container's port(s) to the host description: Publish a container's port(s) to the host
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all - option: publish-all
shorthand: P shorthand: P
value_type: bool value_type: bool
@ -442,46 +667,70 @@ options:
description: Publish all exposed ports to random ports description: Publish all exposed ports to random ports
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only - option: read-only
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Mount the container's root filesystem as read only description: Mount the container's root filesystem as read only
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart - option: restart
value_type: string value_type: string
default_value: "no" default_value: "no"
description: Restart policy to apply when a container exits description: Restart policy to apply when a container exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Automatically remove the container when it exits description: Automatically remove the container when it exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime - option: runtime
value_type: string value_type: string
description: Runtime to use for this container description: Runtime to use for this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt - option: security-opt
value_type: list value_type: list
description: Security Options description: Security Options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size - option: shm-size
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Size of /dev/shm description: Size of /dev/shm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal - option: stop-signal
value_type: string value_type: string
default_value: SIGTERM default_value: SIGTERM
description: Signal to stop a container description: Signal to stop a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout - option: stop-timeout
value_type: int value_type: int
default_value: "0" default_value: "0"
@ -489,22 +738,34 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt - option: storage-opt
value_type: list value_type: list
description: Storage driver options for the container description: Storage driver options for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl - option: sysctl
value_type: map value_type: map
default_value: map[] default_value: map[]
description: Sysctl options description: Sysctl options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs - option: tmpfs
value_type: list value_type: list
description: Mount a tmpfs directory description: Mount a tmpfs directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty - option: tty
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -512,50 +773,80 @@ options:
description: Allocate a pseudo-TTY description: Allocate a pseudo-TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit - option: ulimit
value_type: ulimit value_type: ulimit
default_value: '[]' default_value: '[]'
description: Ulimit options description: Ulimit options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])' description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns - option: userns
value_type: string value_type: string
description: User namespace to use description: User namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts - option: uts
value_type: string value_type: string
description: UTS namespace to use description: UTS namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume - option: volume
shorthand: v shorthand: v
value_type: list value_type: list
description: Bind mount a volume description: Bind mount a volume
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver - option: volume-driver
value_type: string value_type: string
description: Optional volume driver for the container description: Optional volume driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from - option: volumes-from
value_type: list value_type: list
description: Mount volumes from the specified container(s) description: Mount volumes from the specified container(s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
description: Working directory inside the container description: Working directory inside the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_container_diff.yaml
View File

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -12,11 +12,17 @@ options:
description: 'Detached mode: run command in the background' description: 'Detached mode: run command in the background'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys - option: detach-keys
value_type: string value_type: string
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: list value_type: list
@ -24,6 +30,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -31,12 +40,18 @@ options:
description: Keep STDIN open even if not attached description: Keep STDIN open even if not attached
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged - option: privileged
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Give extended privileges to the command description: Give extended privileges to the command
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty - option: tty
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -44,12 +59,18 @@ options:
description: Allocate a pseudo-TTY description: Allocate a pseudo-TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])' description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
@ -57,6 +78,12 @@ options:
deprecated: false deprecated: false
min_api_version: "1.35" min_api_version: "1.35"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_container_export.yaml
View File

@ -11,6 +11,12 @@ options:
description: Write to a file, instead of STDOUT description: Write to a file, instead of STDOUT
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -11,6 +11,9 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size - option: size
shorthand: s shorthand: s
value_type: bool value_type: bool
@ -18,6 +21,12 @@ options:
description: Display total file sizes description: Display total file sizes
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -12,6 +12,12 @@ options:
description: Signal to send to the container description: Signal to send to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -11,6 +11,9 @@ options:
description: Show extra details provided to logs description: Show extra details provided to logs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow - option: follow
shorthand: f shorthand: f
value_type: bool value_type: bool
@ -18,18 +21,27 @@ options:
description: Follow log output description: Follow log output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since - option: since
value_type: string value_type: string
description: | description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tail - option: tail
value_type: string value_type: string
default_value: all default_value: all
description: Number of lines to show from the end of the logs description: Number of lines to show from the end of the logs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps - option: timestamps
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -37,6 +49,9 @@ options:
description: Show timestamps description: Show timestamps
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until - option: until
value_type: string value_type: string
description: | description: |
@ -44,6 +59,12 @@ options:
deprecated: false deprecated: false
min_api_version: "1.35" min_api_version: "1.35"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -13,17 +13,26 @@ options:
description: Show all containers (default shows just running) description: Show all containers (default shows just running)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter - option: filter
shorthand: f shorthand: f
value_type: filter value_type: filter
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print containers using a Go template description: Pretty-print containers using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: last - option: last
shorthand: "n" shorthand: "n"
value_type: int value_type: int
@ -31,6 +40,9 @@ options:
description: Show n last created containers (includes all states) description: Show n last created containers (includes all states)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: latest - option: latest
shorthand: l shorthand: l
value_type: bool value_type: bool
@ -38,12 +50,18 @@ options:
description: Show the latest created container (includes all states) description: Show the latest created container (includes all states)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -51,6 +69,9 @@ options:
description: Only display numeric IDs description: Only display numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size - option: size
shorthand: s shorthand: s
value_type: bool value_type: bool
@ -58,6 +79,12 @@ options:
description: Display total file sizes description: Display total file sizes
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

11
_data/engine-cli-edge/docker_container_prune.yaml
View File

@ -10,6 +10,9 @@ options:
description: Provide filter values (e.g. 'until=<timestamp>') description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
@ -17,6 +20,9 @@ options:
description: Do not prompt for confirmation description: Do not prompt for confirmation
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Prune containers ### Prune containers
@ -33,7 +39,7 @@ examples: |-
### Filtering ### Filtering
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more The filtering flag (`--filter`) format is of "key=value". If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are: The currently supported filters are:
@ -104,4 +110,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_container_rename.yaml
View File

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_container_restart.yaml
View File

@ -12,6 +12,12 @@ options:
description: Seconds to wait for stop before killing the container description: Seconds to wait for stop before killing the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -12,6 +12,9 @@ options:
description: Force the removal of a running container (uses SIGKILL) description: Force the removal of a running container (uses SIGKILL)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link - option: link
shorthand: l shorthand: l
value_type: bool value_type: bool
@ -19,6 +22,9 @@ options:
description: Remove the specified link description: Remove the specified link
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes - option: volumes
shorthand: v shorthand: v
value_type: bool value_type: bool
@ -26,6 +32,12 @@ options:
description: Remove the volumes associated with the container description: Remove the volumes associated with the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

300
_data/engine-cli-edge/docker_container_run.yaml
View File

@ -10,12 +10,18 @@ options:
description: Add a custom host-to-IP mapping (host:ip) description: Add a custom host-to-IP mapping (host:ip)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach - option: attach
shorthand: a shorthand: a
value_type: list value_type: list
description: Attach to STDIN, STDOUT or STDERR description: Attach to STDIN, STDOUT or STDERR
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight - option: blkio-weight
value_type: uint16 value_type: uint16
default_value: "0" default_value: "0"
@ -23,56 +29,86 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device - option: blkio-weight-device
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Block IO weight (relative device weight) description: Block IO weight (relative device weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add - option: cap-add
value_type: list value_type: list
description: Add Linux capabilities description: Add Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop - option: cap-drop
value_type: list value_type: list
description: Drop Linux capabilities description: Drop Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent - option: cgroup-parent
value_type: string value_type: string
description: Optional parent cgroup for the container description: Optional parent cgroup for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile - option: cidfile
value_type: string value_type: string
description: Write the container ID to the file description: Write the container ID to the file
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count - option: cpu-count
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU count (Windows only) description: CPU count (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent - option: cpu-percent
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU percent (Windows only) description: CPU percent (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period - option: cpu-rt-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -80,6 +116,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime - option: cpu-rt-runtime
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -87,6 +126,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -94,22 +136,34 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus - option: cpus
value_type: decimal value_type: decimal
description: Number of CPUs description: Number of CPUs
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach - option: detach
shorthand: d shorthand: d
value_type: bool value_type: bool
@ -117,114 +171,177 @@ options:
description: Run container in background and print container ID description: Run container in background and print container ID
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys - option: detach-keys
value_type: string value_type: string
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device - option: device
value_type: list value_type: list
description: Add a host device to the container description: Add a host device to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule - option: device-cgroup-rule
value_type: list value_type: list
description: Add a rule to the cgroup allowed devices list description: Add a rule to the cgroup allowed devices list
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps - option: device-read-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (bytes per second) from a device description: Limit read rate (bytes per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops - option: device-read-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (IO per second) from a device description: Limit read rate (IO per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps - option: device-write-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (bytes per second) to a device description: Limit write rate (bytes per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops - option: device-write-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (IO per second) to a device description: Limit write rate (IO per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns - option: dns
value_type: list value_type: list
description: Set custom DNS servers description: Set custom DNS servers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt - option: dns-opt
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option - option: dns-option
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search - option: dns-search
value_type: list value_type: list
description: Set custom DNS search domains description: Set custom DNS search domains
deprecated: false deprecated: false
experimental: 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: list value_type: list
description: Set environment variables description: Set environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file - option: env-file
value_type: list value_type: list
description: Read in a file of environment variables description: Read in a file of environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose - option: expose
value_type: list value_type: list
description: Expose a port or a range of ports description: Expose a port or a range of ports
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd - option: health-cmd
value_type: string value_type: string
description: Command to run to check health description: Command to run to check health
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval - option: health-interval
value_type: duration value_type: duration
default_value: 0s default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s) description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries - option: health-retries
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Consecutive failures needed to report unhealthy description: Consecutive failures needed to report unhealthy
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period - option: health-start-period
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -233,6 +350,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.29" min_api_version: "1.29"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout - option: health-timeout
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -240,18 +360,27 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s) Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help - option: help
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print usage description: Print usage
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname - option: hostname
shorthand: h shorthand: h
value_type: string value_type: string
description: Container host name description: Container host name
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init - option: init
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -260,6 +389,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -267,6 +399,9 @@ options:
description: Keep STDIN open even if not attached description: Keep STDIN open even if not attached
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth - option: io-maxbandwidth
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -274,74 +409,116 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only) Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops - option: io-maxiops
value_type: uint64 value_type: uint64
default_value: "0" default_value: "0"
description: Maximum IOps limit for the system drive (Windows only) description: Maximum IOps limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: 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)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6 - option: ip6
value_type: string value_type: string
description: IPv6 address (e.g., 2001:db8::33) description: IPv6 address (e.g., 2001:db8::33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc - option: ipc
value_type: string value_type: string
description: IPC mode to use description: IPC mode to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation - option: isolation
value_type: string value_type: string
description: Container isolation technology description: Container isolation technology
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory - option: kernel-memory
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Kernel memory limit description: Kernel memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
shorthand: l shorthand: l
value_type: list value_type: list
description: Set meta data on a container description: Set meta data on a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file - option: label-file
value_type: list value_type: list
description: Read in a line delimited file of labels description: Read in a line delimited file of labels
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link - option: link
value_type: list value_type: list
description: Add link to another container description: Add link to another container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip - option: link-local-ip
value_type: list value_type: list
description: Container IPv4/IPv6 link-local addresses description: Container IPv4/IPv6 link-local addresses
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver - option: log-driver
value_type: string value_type: string
description: Logging driver for the container description: Logging driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt - option: log-opt
value_type: list value_type: list
description: Log driver options description: Log driver options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address - option: mac-address
value_type: string value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33) description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -349,12 +526,18 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation - option: memory-reservation
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Memory soft limit description: Memory soft limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -362,91 +545,139 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness - option: memory-swappiness
value_type: int64 value_type: int64
default_value: "-1" default_value: "-1"
description: Tune container memory swappiness (0 to 100) description: Tune container memory swappiness (0 to 100)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount - option: mount
value_type: mount value_type: mount
description: Attach a filesystem mount to the container description: Attach a filesystem mount to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name - option: name
value_type: string value_type: string
description: Assign a name to the container description: Assign a name to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net - option: net
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias - option: net-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network - option: network
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias - option: network-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck - option: no-healthcheck
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable any container-specified HEALTHCHECK description: Disable any container-specified HEALTHCHECK
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable - option: oom-kill-disable
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable OOM Killer description: Disable OOM Killer
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj - option: oom-score-adj
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000) description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid - option: pid
value_type: string value_type: string
description: PID namespace to use description: PID namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit - option: pids-limit
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Tune container pids limit (set -1 for unlimited) description: Tune container pids limit (set -1 for unlimited)
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged - option: privileged
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Give extended privileges to this container description: Give extended privileges to this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish - option: publish
shorthand: p shorthand: p
value_type: list value_type: list
description: Publish a container's port(s) to the host description: Publish a container's port(s) to the host
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all - option: publish-all
shorthand: P shorthand: P
value_type: bool value_type: bool
@ -454,52 +685,79 @@ options:
description: Publish all exposed ports to random ports description: Publish all exposed ports to random ports
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only - option: read-only
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Mount the container's root filesystem as read only description: Mount the container's root filesystem as read only
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart - option: restart
value_type: string value_type: string
default_value: "no" default_value: "no"
description: Restart policy to apply when a container exits description: Restart policy to apply when a container exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Automatically remove the container when it exits description: Automatically remove the container when it exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime - option: runtime
value_type: string value_type: string
description: Runtime to use for this container description: Runtime to use for this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt - option: security-opt
value_type: list value_type: list
description: Security Options description: Security Options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size - option: shm-size
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Size of /dev/shm description: Size of /dev/shm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sig-proxy - option: sig-proxy
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Proxy received signals to the process description: Proxy received signals to the process
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal - option: stop-signal
value_type: string value_type: string
default_value: SIGTERM default_value: SIGTERM
description: Signal to stop a container description: Signal to stop a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout - option: stop-timeout
value_type: int value_type: int
default_value: "0" default_value: "0"
@ -507,22 +765,34 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt - option: storage-opt
value_type: list value_type: list
description: Storage driver options for the container description: Storage driver options for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl - option: sysctl
value_type: map value_type: map
default_value: map[] default_value: map[]
description: Sysctl options description: Sysctl options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs - option: tmpfs
value_type: list value_type: list
description: Mount a tmpfs directory description: Mount a tmpfs directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty - option: tty
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -530,50 +800,80 @@ options:
description: Allocate a pseudo-TTY description: Allocate a pseudo-TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit - option: ulimit
value_type: ulimit value_type: ulimit
default_value: '[]' default_value: '[]'
description: Ulimit options description: Ulimit options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])' description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns - option: userns
value_type: string value_type: string
description: User namespace to use description: User namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts - option: uts
value_type: string value_type: string
description: UTS namespace to use description: UTS namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume - option: volume
shorthand: v shorthand: v
value_type: list value_type: list
description: Bind mount a volume description: Bind mount a volume
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver - option: volume-driver
value_type: string value_type: string
description: Optional volume driver for the container description: Optional volume driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from - option: volumes-from
value_type: list value_type: list
description: Mount volumes from the specified container(s) description: Mount volumes from the specified container(s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
description: Working directory inside the container description: Working directory inside the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

18
_data/engine-cli-edge/docker_container_start.yaml
View File

@ -12,21 +12,33 @@ options:
description: Attach STDOUT/STDERR and forward signals description: Attach STDOUT/STDERR and forward signals
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint - option: checkpoint
value_type: string value_type: string
description: Restore from this checkpoint description: Restore from this checkpoint
deprecated: false deprecated: false
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint-dir - option: checkpoint-dir
value_type: string value_type: string
description: Use a custom checkpoint storage directory description: Use a custom checkpoint storage directory
deprecated: false deprecated: false
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys - option: detach-keys
value_type: string value_type: string
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -34,6 +46,12 @@ options:
description: Attach container's STDIN description: Attach container's STDIN
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_container_stats.yaml
View File

@ -12,23 +12,38 @@ options:
description: Show all containers (default shows just running) description: Show all containers (default shows just running)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print images using a Go template description: Pretty-print images using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-stream - option: no-stream
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable streaming stats and only pull the first result description: Disable streaming stats and only pull the first result
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not truncate output description: Do not truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_container_stop.yaml
View File

@ -12,6 +12,12 @@ options:
description: Seconds to wait for stop before killing it description: Seconds to wait for stop before killing it
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_container_top.yaml
View File

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_container_unpause.yaml
View File

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

45
_data/engine-cli-edge/docker_container_update.yaml
View File

@ -12,18 +12,27 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period - option: cpu-rt-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -31,6 +40,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime - option: cpu-rt-runtime
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -38,6 +50,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -45,28 +60,43 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus - option: cpus
value_type: decimal value_type: decimal
description: Number of CPUs description: Number of CPUs
deprecated: false deprecated: false
min_api_version: "1.29" min_api_version: "1.29"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory - option: kernel-memory
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Kernel memory limit description: Kernel memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -74,12 +104,18 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation - option: memory-reservation
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Memory soft limit description: Memory soft limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -87,11 +123,20 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_container_wait.yaml
View File

@ -6,4 +6,7 @@ pname: docker container
plink: docker_container.yaml plink: docker_container.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_cp.yaml
View File

@ -95,6 +95,9 @@ options:
description: Archive mode (copy all uid/gid information) description: Archive mode (copy all uid/gid information)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link - option: follow-link
shorthand: L shorthand: L
value_type: bool value_type: bool
@ -102,6 +105,12 @@ options:
description: Always follow symbol link in SRC_PATH description: Always follow symbol link in SRC_PATH
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

291
_data/engine-cli-edge/docker_create.yaml
View File

@ -21,12 +21,18 @@ options:
description: Add a custom host-to-IP mapping (host:ip) description: Add a custom host-to-IP mapping (host:ip)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: attach - option: attach
shorthand: a shorthand: a
value_type: list value_type: list
description: Attach to STDIN, STDOUT or STDERR description: Attach to STDIN, STDOUT or STDERR
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight - option: blkio-weight
value_type: uint16 value_type: uint16
default_value: "0" default_value: "0"
@ -34,56 +40,86 @@ options:
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: blkio-weight-device - option: blkio-weight-device
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Block IO weight (relative device weight) description: Block IO weight (relative device weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-add - option: cap-add
value_type: list value_type: list
description: Add Linux capabilities description: Add Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cap-drop - option: cap-drop
value_type: list value_type: list
description: Drop Linux capabilities description: Drop Linux capabilities
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent - option: cgroup-parent
value_type: string value_type: string
description: Optional parent cgroup for the container description: Optional parent cgroup for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cidfile - option: cidfile
value_type: string value_type: string
description: Write the container ID to the file description: Write the container ID to the file
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-count - option: cpu-count
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU count (Windows only) description: CPU count (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-percent - option: cpu-percent
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: CPU percent (Windows only) description: CPU percent (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-period - option: cpu-rt-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -91,6 +127,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-rt-runtime - option: cpu-rt-runtime
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
@ -98,6 +137,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -105,125 +147,194 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpus - option: cpus
value_type: decimal value_type: decimal
description: Number of CPUs description: Number of CPUs
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device - option: device
value_type: list value_type: list
description: Add a host device to the container description: Add a host device to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-cgroup-rule - option: device-cgroup-rule
value_type: list value_type: list
description: Add a rule to the cgroup allowed devices list description: Add a rule to the cgroup allowed devices list
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-bps - option: device-read-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (bytes per second) from a device description: Limit read rate (bytes per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-read-iops - option: device-read-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit read rate (IO per second) from a device description: Limit read rate (IO per second) from a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-bps - option: device-write-bps
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (bytes per second) to a device description: Limit write rate (bytes per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: device-write-iops - option: device-write-iops
value_type: list value_type: list
default_value: '[]' default_value: '[]'
description: Limit write rate (IO per second) to a device description: Limit write rate (IO per second) to a device
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns - option: dns
value_type: list value_type: list
description: Set custom DNS servers description: Set custom DNS servers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-opt - option: dns-opt
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-option - option: dns-option
value_type: list value_type: list
description: Set DNS options description: Set DNS options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: dns-search - option: dns-search
value_type: list value_type: list
description: Set custom DNS search domains description: Set custom DNS search domains
deprecated: false deprecated: false
experimental: 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: list value_type: list
description: Set environment variables description: Set environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file - option: env-file
value_type: list value_type: list
description: Read in a file of environment variables description: Read in a file of environment variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: expose - option: expose
value_type: list value_type: list
description: Expose a port or a range of ports description: Expose a port or a range of ports
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-cmd - option: health-cmd
value_type: string value_type: string
description: Command to run to check health description: Command to run to check health
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-interval - option: health-interval
value_type: duration value_type: duration
default_value: 0s default_value: 0s
description: Time between running the check (ms|s|m|h) (default 0s) description: Time between running the check (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-retries - option: health-retries
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Consecutive failures needed to report unhealthy description: Consecutive failures needed to report unhealthy
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-start-period - option: health-start-period
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -232,6 +343,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.29" min_api_version: "1.29"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: health-timeout - option: health-timeout
value_type: duration value_type: duration
default_value: 0s default_value: 0s
@ -239,18 +353,27 @@ options:
Maximum time to allow one check to run (ms|s|m|h) (default 0s) Maximum time to allow one check to run (ms|s|m|h) (default 0s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: help - option: help
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print usage description: Print usage
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: hostname - option: hostname
shorthand: h shorthand: h
value_type: string value_type: string
description: Container host name description: Container host name
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: init - option: init
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -259,6 +382,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -266,6 +392,9 @@ options:
description: Keep STDIN open even if not attached description: Keep STDIN open even if not attached
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxbandwidth - option: io-maxbandwidth
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -273,74 +402,116 @@ options:
Maximum IO bandwidth limit for the system drive (Windows only) Maximum IO bandwidth limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: io-maxiops - option: io-maxiops
value_type: uint64 value_type: uint64
default_value: "0" default_value: "0"
description: Maximum IOps limit for the system drive (Windows only) description: Maximum IOps limit for the system drive (Windows only)
deprecated: false deprecated: false
experimental: 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)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6 - option: ip6
value_type: string value_type: string
description: IPv6 address (e.g., 2001:db8::33) description: IPv6 address (e.g., 2001:db8::33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipc - option: ipc
value_type: string value_type: string
description: IPC mode to use description: IPC mode to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation - option: isolation
value_type: string value_type: string
description: Container isolation technology description: Container isolation technology
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kernel-memory - option: kernel-memory
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Kernel memory limit description: Kernel memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
shorthand: l shorthand: l
value_type: list value_type: list
description: Set meta data on a container description: Set meta data on a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-file - option: label-file
value_type: list value_type: list
description: Read in a line delimited file of labels description: Read in a line delimited file of labels
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link - option: link
value_type: list value_type: list
description: Add link to another container description: Add link to another container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip - option: link-local-ip
value_type: list value_type: list
description: Container IPv4/IPv6 link-local addresses description: Container IPv4/IPv6 link-local addresses
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-driver - option: log-driver
value_type: string value_type: string
description: Logging driver for the container description: Logging driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: log-opt - option: log-opt
value_type: list value_type: list
description: Log driver options description: Log driver options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mac-address - option: mac-address
value_type: string value_type: string
description: Container MAC address (e.g., 92:d0:c6:0a:29:33) description: Container MAC address (e.g., 92:d0:c6:0a:29:33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -348,12 +519,18 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-reservation - option: memory-reservation
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Memory soft limit description: Memory soft limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -361,91 +538,139 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swappiness - option: memory-swappiness
value_type: int64 value_type: int64
default_value: "-1" default_value: "-1"
description: Tune container memory swappiness (0 to 100) description: Tune container memory swappiness (0 to 100)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: mount - option: mount
value_type: mount value_type: mount
description: Attach a filesystem mount to the container description: Attach a filesystem mount to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name - option: name
value_type: string value_type: string
description: Assign a name to the container description: Assign a name to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: net - option: net
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: net-alias - option: net-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network - option: network
value_type: string value_type: string
default_value: default 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
experimentalcli: false
kubernetes: false
swarm: false
- option: network-alias - option: network-alias
value_type: list value_type: list
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-healthcheck - option: no-healthcheck
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable any container-specified HEALTHCHECK description: Disable any container-specified HEALTHCHECK
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-kill-disable - option: oom-kill-disable
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Disable OOM Killer description: Disable OOM Killer
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: oom-score-adj - option: oom-score-adj
value_type: int value_type: int
default_value: "0" default_value: "0"
description: Tune host's OOM preferences (-1000 to 1000) description: Tune host's OOM preferences (-1000 to 1000)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pid - option: pid
value_type: string value_type: string
description: PID namespace to use description: PID namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pids-limit - option: pids-limit
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Tune container pids limit (set -1 for unlimited) description: Tune container pids limit (set -1 for unlimited)
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged - option: privileged
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Give extended privileges to this container description: Give extended privileges to this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish - option: publish
shorthand: p shorthand: p
value_type: list value_type: list
description: Publish a container's port(s) to the host description: Publish a container's port(s) to the host
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: publish-all - option: publish-all
shorthand: P shorthand: P
value_type: bool value_type: bool
@ -453,46 +678,70 @@ options:
description: Publish all exposed ports to random ports description: Publish all exposed ports to random ports
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: read-only - option: read-only
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Mount the container's root filesystem as read only description: Mount the container's root filesystem as read only
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: restart - option: restart
value_type: string value_type: string
default_value: "no" default_value: "no"
description: Restart policy to apply when a container exits description: Restart policy to apply when a container exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Automatically remove the container when it exits description: Automatically remove the container when it exits
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: runtime - option: runtime
value_type: string value_type: string
description: Runtime to use for this container description: Runtime to use for this container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt - option: security-opt
value_type: list value_type: list
description: Security Options description: Security Options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size - option: shm-size
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Size of /dev/shm description: Size of /dev/shm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-signal - option: stop-signal
value_type: string value_type: string
default_value: SIGTERM default_value: SIGTERM
description: Signal to stop a container description: Signal to stop a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stop-timeout - option: stop-timeout
value_type: int value_type: int
default_value: "0" default_value: "0"
@ -500,22 +749,34 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: storage-opt - option: storage-opt
value_type: list value_type: list
description: Storage driver options for the container description: Storage driver options for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: sysctl - option: sysctl
value_type: map value_type: map
default_value: map[] default_value: map[]
description: Sysctl options description: Sysctl options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tmpfs - option: tmpfs
value_type: list value_type: list
description: Mount a tmpfs directory description: Mount a tmpfs directory
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty - option: tty
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -523,50 +784,77 @@ options:
description: Allocate a pseudo-TTY description: Allocate a pseudo-TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit - option: ulimit
value_type: ulimit value_type: ulimit
default_value: '[]' default_value: '[]'
description: Ulimit options description: Ulimit options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])' description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: userns - option: userns
value_type: string value_type: string
description: User namespace to use description: User namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: uts - option: uts
value_type: string value_type: string
description: UTS namespace to use description: UTS namespace to use
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume - option: volume
shorthand: v shorthand: v
value_type: list value_type: list
description: Bind mount a volume description: Bind mount a volume
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volume-driver - option: volume-driver
value_type: string value_type: string
description: Optional volume driver for the container description: Optional volume driver for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes-from - option: volumes-from
value_type: list value_type: list
description: Mount volumes from the specified container(s) description: Mount volumes from the specified container(s)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
description: Working directory inside the container description: Working directory inside the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Create and start a container ### Create and start a container
@ -677,4 +965,7 @@ examples: |-
the create/run command the create/run command
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

18
_data/engine-cli-edge/docker_deploy.yaml
View File

@ -12,6 +12,9 @@ options:
description: Path to a Distributed Application Bundle file description: Path to a Distributed Application Bundle file
deprecated: false deprecated: false
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: true
- option: compose-file - option: compose-file
shorthand: c shorthand: c
value_type: string value_type: string
@ -19,6 +22,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: prune - option: prune
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -26,6 +32,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.27" min_api_version: "1.27"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true
- option: resolve-image - option: resolve-image
value_type: string value_type: string
default_value: always default_value: always
@ -34,12 +43,18 @@ options:
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true
- option: with-registry-auth - option: with-registry-auth
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Send registry authentication details to Swarm agents description: Send registry authentication details to Swarm agents
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true
examples: |- examples: |-
### Compose file ### Compose file
@ -104,4 +119,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_diff.yaml
View File

@ -43,4 +43,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_events.yaml
View File

@ -180,21 +180,33 @@ options:
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since - option: since
value_type: string value_type: string
description: Show all events created since timestamp description: Show all events created since timestamp
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until - option: until
value_type: string value_type: string
description: Stream events until this timestamp description: Stream events until this timestamp
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Basic example ### Basic example
@ -406,4 +418,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

27
_data/engine-cli-edge/docker_exec.yaml
View File

@ -25,11 +25,17 @@ options:
description: 'Detached mode: run command in the background' description: 'Detached mode: run command in the background'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: detach-keys - option: detach-keys
value_type: string value_type: string
description: Override the key sequence for detaching a container description: Override the key sequence for detaching a container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: env - option: env
shorthand: e shorthand: e
value_type: list value_type: list
@ -37,6 +43,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive - option: interactive
shorthand: i shorthand: i
value_type: bool value_type: bool
@ -44,12 +53,18 @@ options:
description: Keep STDIN open even if not attached description: Keep STDIN open even if not attached
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged - option: privileged
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Give extended privileges to the command description: Give extended privileges to the command
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tty - option: tty
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -57,12 +72,18 @@ options:
description: Allocate a pseudo-TTY description: Allocate a pseudo-TTY
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: user - option: user
shorthand: u shorthand: u
value_type: string value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])' description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir - option: workdir
shorthand: w shorthand: w
value_type: string value_type: string
@ -70,6 +91,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.35" min_api_version: "1.35"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$ examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$
docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a
container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command
@ -94,4 +118,7 @@ examples: "### Run `docker exec` on a running container\n\nFirst, start a contai
paused, unpause the container before exec\n\n$ echo $?\n1\n```" paused, unpause the container before exec\n\n$ echo $?\n1\n```"
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_export.yaml
View File

@ -18,6 +18,9 @@ options:
description: Write to a file, instead of STDOUT description: Write to a file, instead of STDOUT
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
ch of these commands has the same result. ch of these commands has the same result.
@ -30,4 +33,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_history.yaml
View File

@ -10,6 +10,9 @@ options:
description: Pretty-print images using a Go template description: Pretty-print images using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: human - option: human
shorthand: H shorthand: H
value_type: bool value_type: bool
@ -17,12 +20,18 @@ options:
description: Print sizes and dates in human readable format description: Print sizes and dates in human readable format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -30,6 +39,9 @@ options:
description: Only show numeric IDs description: Only show numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
To see how the `docker:latest` image was built: To see how the `docker:latest` image was built:
@ -93,4 +105,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_image.yaml
View File

@ -32,4 +32,7 @@ clink:
- docker_image_tag.yaml - docker_image_tag.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

96
_data/engine-cli-edge/docker_image_build.yaml
View File

@ -10,40 +10,61 @@ options:
description: Add a custom host-to-IP mapping (host:ip) description: Add a custom host-to-IP mapping (host:ip)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: build-arg - option: build-arg
value_type: list value_type: list
description: Set build-time variables description: Set build-time variables
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-from - option: cache-from
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Images to consider as cache sources description: Images to consider as cache sources
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cgroup-parent - option: cgroup-parent
value_type: string value_type: string
description: Optional parent cgroup for the container description: Optional parent cgroup for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: compress - option: compress
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Compress the build context using gzip description: Compress the build context using gzip
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-period - option: cpu-period
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-quota - option: cpu-quota
value_type: int64 value_type: int64
default_value: "0" default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpu-shares - option: cpu-shares
shorthand: c shorthand: c
value_type: int64 value_type: int64
@ -51,49 +72,76 @@ options:
description: CPU shares (relative weight) description: CPU shares (relative weight)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-cpus - option: cpuset-cpus
value_type: string value_type: string
description: CPUs in which to allow execution (0-3, 0,1) description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cpuset-mems - option: cpuset-mems
value_type: string value_type: string
description: MEMs in which to allow execution (0-3, 0,1) description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: file - option: file
shorthand: f shorthand: f
value_type: string value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile') description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm - option: force-rm
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always remove intermediate containers description: Always remove intermediate containers
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: iidfile - option: iidfile
value_type: string value_type: string
description: Write the image ID to the file description: Write the image ID to the file
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: isolation - option: isolation
value_type: string value_type: string
description: Container isolation technology description: Container isolation technology
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
value_type: list value_type: list
description: Set metadata for an image description: Set metadata for an image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory - option: memory
shorthand: m shorthand: m
value_type: bytes value_type: bytes
@ -101,6 +149,9 @@ options:
description: Memory limit description: Memory limit
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: memory-swap - option: memory-swap
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
@ -108,6 +159,9 @@ options:
Swap limit equal to memory plus swap: '-1' to enable unlimited swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: network - option: network
value_type: string value_type: string
default_value: default default_value: default
@ -116,24 +170,36 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache - option: no-cache
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not use cache when building the image description: Do not use cache when building the image
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: pull - option: pull
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Always attempt to pull a newer version of the image description: Always attempt to pull a newer version of the image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -141,24 +207,36 @@ options:
description: Suppress the build output and print image ID on success description: Suppress the build output and print image ID on success
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: rm - option: rm
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Remove intermediate containers after a successful build description: Remove intermediate containers after a successful build
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: security-opt - option: security-opt
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Security options description: Security options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: shm-size - option: shm-size
value_type: bytes value_type: bytes
default_value: "0" default_value: "0"
description: Size of /dev/shm description: Size of /dev/shm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: squash - option: squash
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -166,6 +244,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: stream - option: stream
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -173,23 +254,38 @@ options:
deprecated: false deprecated: false
min_api_version: "1.31" min_api_version: "1.31"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
- option: tag - option: tag
shorthand: t shorthand: t
value_type: list value_type: list
description: Name and optionally a tag in the 'name:tag' format description: Name and optionally a tag in the 'name:tag' format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target - option: target
value_type: string value_type: string
description: Set the target build stage to build. description: Set the target build stage to build.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ulimit - option: ulimit
value_type: ulimit value_type: ulimit
default_value: '[]' default_value: '[]'
description: Ulimit options description: Ulimit options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_image_history.yaml
View File

@ -10,6 +10,9 @@ options:
description: Pretty-print images using a Go template description: Pretty-print images using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: human - option: human
shorthand: H shorthand: H
value_type: bool value_type: bool
@ -17,12 +20,18 @@ options:
description: Print sizes and dates in human readable format description: Print sizes and dates in human readable format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -30,6 +39,12 @@ options:
description: Only show numeric IDs description: Only show numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_image_import.yaml
View File

@ -11,12 +11,21 @@ options:
description: Apply Dockerfile instruction to the created image description: Apply Dockerfile instruction to the created image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message - option: message
shorthand: m shorthand: m
value_type: string value_type: string
description: Set commit message for imported image description: Set commit message for imported image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_image_inspect.yaml
View File

@ -11,6 +11,12 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_image_load.yaml
View File

@ -11,6 +11,9 @@ options:
description: Read from tar archive file, instead of STDIN description: Read from tar archive file, instead of STDIN
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -18,6 +21,12 @@ options:
description: Suppress the load output description: Suppress the load output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -13,29 +13,44 @@ options:
description: Show all images (default hides intermediate images) description: Show all images (default hides intermediate images)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: digests - option: digests
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Show digests description: Show digests
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter - option: filter
shorthand: f shorthand: f
value_type: filter value_type: filter
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print images using a Go template description: Pretty-print images using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -43,6 +58,12 @@ options:
description: Only show numeric IDs description: Only show numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -13,11 +13,17 @@ options:
description: Remove all unused images, not just dangling ones description: Remove all unused images, not just dangling ones
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter - option: filter
value_type: filter value_type: filter
description: Provide filter values (e.g. 'until=<timestamp>') description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
@ -25,6 +31,9 @@ options:
description: Do not prompt for confirmation description: Do not prompt for confirmation
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |2- examples: |2-
output: output:
@ -63,7 +72,7 @@ examples: |2-
### Filtering ### Filtering
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more The filtering flag (`--filter`) format is of "key=value". If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are: The currently supported filters are:
@ -157,4 +166,7 @@ examples: |2-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -12,18 +12,30 @@ options:
description: Download all tagged images in the repository description: Download all tagged images in the repository
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_image_push.yaml
View File

@ -11,6 +11,12 @@ options:
description: Skip image signing description: Skip image signing
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_image_rm.yaml
View File

@ -13,12 +13,21 @@ options:
description: Force removal of the image description: Force removal of the image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-prune - option: no-prune
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not delete untagged parents description: Do not delete untagged parents
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_image_save.yaml
View File

@ -11,6 +11,12 @@ options:
description: Write to a file, instead of STDOUT description: Write to a file, instead of STDOUT
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_image_tag.yaml
View File

@ -6,4 +6,7 @@ pname: docker image
plink: docker_image.yaml plink: docker_image.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -27,29 +27,44 @@ options:
description: Show all images (default hides intermediate images) description: Show all images (default hides intermediate images)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: digests - option: digests
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Show digests description: Show digests
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter - option: filter
shorthand: f shorthand: f
value_type: filter value_type: filter
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print images using a Go template description: Pretty-print images using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -57,6 +72,9 @@ options:
description: Only show numeric IDs description: Only show numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### List the most recently created images ### List the most recently created images
@ -346,4 +364,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_import.yaml
View File

@ -23,12 +23,18 @@ options:
description: Apply Dockerfile instruction to the created image description: Apply Dockerfile instruction to the created image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: message - option: message
shorthand: m shorthand: m
value_type: string value_type: string
description: Set commit message for imported image description: Set commit message for imported image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Import from a remote location ### Import from a remote location
@ -76,4 +82,7 @@ examples: |-
tar, then the ownerships might not get preserved. tar, then the ownerships might not get preserved.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_info.yaml
View File

@ -28,6 +28,9 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Show output ### Show output
@ -227,4 +230,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -14,6 +14,9 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size - option: size
shorthand: s shorthand: s
value_type: bool value_type: bool
@ -21,11 +24,17 @@ options:
description: Display total file sizes if the type is container description: Display total file sizes if the type is container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: type - option: type
value_type: string value_type: string
description: Return JSON for specified type description: Return JSON for specified type
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Get an instance's IP address ### Get an instance's IP address
@ -89,4 +98,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_kill.yaml
View File

@ -18,6 +18,12 @@ options:
description: Signal to send to the container description: Signal to send to the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_load.yaml
View File

@ -13,6 +13,9 @@ options:
description: Read from tar archive file, instead of STDIN description: Read from tar archive file, instead of STDIN
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -20,6 +23,9 @@ options:
description: Suppress the load output description: Suppress the load output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```bash ```bash
$ docker images $ docker images
@ -50,4 +56,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -12,7 +12,7 @@ long: "Login to a registry.\n\n### Login to a self-hosted registry\n\nIf you wan
`root`, except when:\n\n1. connecting to a remote daemon, such as a `docker-machine` `root`, except when:\n\n1. connecting to a remote daemon, such as a `docker-machine`
provisioned `docker engine`.\n2. user is added to the `docker` group. This will provisioned `docker engine`.\n2. user is added to the `docker` group. This will
impact the security of your system; the `docker` group is `root` equivalent. See impact the security of your system; the `docker` group is `root` equivalent. See
[Docker Daemon Attack Surface](https://docs.docker.com/security/security/#docker-daemon-attack-surface) [Docker Daemon Attack Surface](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface)
for details.\n\nYou can log into any public or private repository for which you for details.\n\nYou can log into any public or private repository for which you
have\ncredentials. When you log in, the command stores credentials in\n`$HOME/.docker/config.json` have\ncredentials. When you log in, the command stores credentials in\n`$HOME/.docker/config.json`
on Linux or `%USERPROFILE%/.docker/config.json` on\nWindows, via the procedure described on Linux or `%USERPROFILE%/.docker/config.json` on\nWindows, via the procedure described
@ -78,18 +78,30 @@ options:
description: Password description: Password
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: password-stdin - option: password-stdin
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Take the password from stdin description: Take the password from stdin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: username - option: username
shorthand: u shorthand: u
value_type: string value_type: string
description: Username description: Username
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_logout.yaml
View File

@ -10,4 +10,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -46,6 +46,9 @@ options:
description: Show extra details provided to logs description: Show extra details provided to logs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: follow - option: follow
shorthand: f shorthand: f
value_type: bool value_type: bool
@ -53,18 +56,27 @@ options:
description: Follow log output description: Follow log output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since - option: since
value_type: string value_type: string
description: | description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tail - option: tail
value_type: string value_type: string
default_value: all default_value: all
description: Number of lines to show from the end of the logs description: Number of lines to show from the end of the logs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps - option: timestamps
shorthand: t shorthand: t
value_type: bool value_type: bool
@ -72,6 +84,9 @@ options:
description: Show timestamps description: Show timestamps
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until - option: until
value_type: string value_type: string
description: | description: |
@ -79,6 +94,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.35" min_api_version: "1.35"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Retrieve logs until a specific point in time ### Retrieve logs until a specific point in time
@ -95,4 +113,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_network.yaml
View File

@ -24,4 +24,7 @@ clink:
- docker_network_rm.yaml - docker_network_rm.yaml
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

18
_data/engine-cli-edge/docker_network_connect.yaml
View File

@ -14,27 +14,42 @@ options:
description: Add network-scoped alias for the container description: Add network-scoped alias for the container
deprecated: false deprecated: false
experimental: 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)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip6 - option: ip6
value_type: string value_type: string
description: IPv6 address (e.g., 2001:db8::33) description: IPv6 address (e.g., 2001:db8::33)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link - option: link
value_type: list value_type: list
description: Add link to another container description: Add link to another container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: link-local-ip - option: link-local-ip
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Add a link-local address for the container description: Add a link-local address for the container
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Connect a running container to a network ### Connect a running container to a network
@ -105,4 +120,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
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

51
_data/engine-cli-edge/docker_network_create.yaml
View File

@ -59,18 +59,27 @@ options:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: aux-address - option: aux-address
value_type: map value_type: map
default_value: map[] default_value: map[]
description: Auxiliary IPv4 or IPv6 addresses used by Network driver description: Auxiliary IPv4 or IPv6 addresses used by Network driver
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: config-from - option: config-from
value_type: string value_type: string
description: The network from which copying the configuration description: The network from which copying the configuration
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: config-only - option: config-only
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -78,6 +87,9 @@ options:
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: driver - option: driver
shorthand: d shorthand: d
value_type: string value_type: string
@ -85,12 +97,18 @@ options:
description: Driver to manage the Network description: Driver to manage the Network
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: gateway - option: gateway
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: IPv4 or IPv6 Gateway for the master subnet description: IPv4 or IPv6 Gateway for the master subnet
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ingress - option: ingress
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -98,41 +116,62 @@ options:
deprecated: false deprecated: false
min_api_version: "1.29" min_api_version: "1.29"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: internal - option: internal
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Restrict external access to the network description: Restrict external access to the network
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ip-range - option: ip-range
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Allocate container ip from a sub-range description: Allocate container ip from a sub-range
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipam-driver - option: ipam-driver
value_type: string value_type: string
default_value: default default_value: default
description: IP Address Management Driver description: IP Address Management Driver
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipam-opt - option: ipam-opt
value_type: map value_type: map
default_value: map[] default_value: map[]
description: Set IPAM driver specific options description: Set IPAM driver specific options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: ipv6 - option: ipv6
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Enable IPv6 networking description: Enable IPv6 networking
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label - option: label
value_type: list value_type: list
description: Set metadata on a network description: Set metadata on a network
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: opt - option: opt
shorthand: o shorthand: o
value_type: map value_type: map
@ -140,18 +179,27 @@ options:
description: Set driver specific options description: Set driver specific options
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: scope - option: scope
value_type: string value_type: string
description: Control the network's scope description: Control the network's scope
deprecated: false deprecated: false
min_api_version: "1.30" min_api_version: "1.30"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: subnet - option: subnet
value_type: stringSlice value_type: stringSlice
default_value: '[]' default_value: '[]'
description: Subnet in CIDR format that represents a network segment description: Subnet in CIDR format that represents a network segment
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Connect containers ### Connect containers
@ -276,4 +324,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_network_disconnect.yaml
View File

@ -14,10 +14,16 @@ options:
description: Force the container to disconnect from a network description: Force the container to disconnect from a network
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```bash ```bash
$ docker network disconnect multi-host-network container1 $ docker network disconnect multi-host-network container1
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

9
_data/engine-cli-edge/docker_network_inspect.yaml
View File

@ -13,6 +13,9 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose - option: verbose
shorthand: v shorthand: v
value_type: bool value_type: bool
@ -20,6 +23,12 @@ options:
description: Verbose output for diagnostics description: Verbose output for diagnostics
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_network_ls.yaml
View File

@ -14,17 +14,26 @@ options:
description: Provide filter values (e.g. 'driver=bridge') description: Provide filter values (e.g. 'driver=bridge')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print networks using a Go template description: Pretty-print networks using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not truncate the output description: Do not truncate the output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -32,6 +41,9 @@ options:
description: Only display network IDs description: Only display network IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK ID examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK ID
\ NAME DRIVER SCOPE\n7fca4eb8c647 bridge \ NAME DRIVER SCOPE\n7fca4eb8c647 bridge
\ bridge local\n9f904ee27bf5 none null \ bridge local\n9f904ee27bf5 none null
@ -114,4 +126,7 @@ examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK I
{{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```" {{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```"
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

11
_data/engine-cli-edge/docker_network_prune.yaml
View File

@ -12,6 +12,9 @@ options:
description: Provide filter values (e.g. 'until=<timestamp>') description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force - option: force
shorthand: f shorthand: f
value_type: bool value_type: bool
@ -19,6 +22,9 @@ options:
description: Do not prompt for confirmation description: Do not prompt for confirmation
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```bash ```bash
$ docker network prune $ docker network prune
@ -32,7 +38,7 @@ examples: |-
### Filtering ### Filtering
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more The filtering flag (`--filter`) format is of "key=value". If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`) than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are: The currently supported filters are:
@ -86,4 +92,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_network_rm.yaml
View File

@ -32,4 +32,7 @@ examples: |-
deletion. deletion.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_node.yaml
View File

@ -23,4 +23,7 @@ clink:
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

3
_data/engine-cli-edge/docker_node_demote.yaml
View File

@ -13,4 +13,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

9
_data/engine-cli-edge/docker_node_inspect.yaml
View File

@ -16,12 +16,18 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pretty - option: pretty
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Print the information in a human friendly format description: Print the information in a human friendly format
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n
\ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\": \ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\":
10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\": 10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\":
@ -61,4 +67,7 @@ examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

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

@ -15,11 +15,17 @@ options:
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print nodes using a Go template description: Pretty-print nodes using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -27,6 +33,9 @@ options:
description: Only display IDs description: Only display IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: "```bash\n$ docker node ls\n\nID HOSTNAME STATUS examples: "```bash\n$ docker node ls\n\nID HOSTNAME STATUS
\ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready \ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready
\ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\ne216jshn25ckzbvmwlnh5jr3g \ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\ne216jshn25ckzbvmwlnh5jr3g
@ -78,4 +87,7 @@ examples: "```bash\n$ docker node ls\n\nID HOSTNAME
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

3
_data/engine-cli-edge/docker_node_promote.yaml
View File

@ -13,4 +13,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

18
_data/engine-cli-edge/docker_node_ps.yaml
View File

@ -13,23 +13,35 @@ options:
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print tasks using a Go template description: Pretty-print tasks using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-resolve - option: no-resolve
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not map IDs to Names description: Do not map IDs to Names
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not truncate output description: Do not truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -37,6 +49,9 @@ options:
description: Only display task IDs description: Only display task IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```bash ```bash
$ docker node ps swarm-manager1 $ docker node ps swarm-manager1
@ -142,4 +157,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

6
_data/engine-cli-edge/docker_node_rm.yaml
View File

@ -13,6 +13,9 @@ options:
description: Force remove a node from the swarm description: Force remove a node from the swarm
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Remove a stopped node from the swarm ### Remove a stopped node from the swarm
@ -51,4 +54,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

15
_data/engine-cli-edge/docker_node_update.yaml
View File

@ -10,21 +10,33 @@ options:
description: Availability of the node ("active"|"pause"|"drain") description: Availability of the node ("active"|"pause"|"drain")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-add - option: label-add
value_type: list value_type: list
description: Add or update a node label (key=value) description: Add or update a node label (key=value)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label-rm - option: label-rm
value_type: list value_type: list
description: Remove a node label if exists description: Remove a node label if exists
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: role - option: role
value_type: string value_type: string
description: Role of the node ("worker"|"manager") description: Role of the node ("worker"|"manager")
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Add label metadata to a node ### Add label metadata to a node
@ -61,4 +73,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.24" min_api_version: "1.24"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: true

3
_data/engine-cli-edge/docker_pause.yaml
View File

@ -20,4 +20,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_plugin.yaml
View File

@ -29,4 +29,7 @@ clink:
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_create.yaml
View File

@ -14,6 +14,9 @@ options:
description: Compress the context using gzip description: Compress the context using gzip
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example shows how to create a sample `plugin`. The following example shows how to create a sample `plugin`.
@ -38,4 +41,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_disable.yaml
View File

@ -15,6 +15,9 @@ options:
description: Force the disable of an active plugin description: Force the disable of an active plugin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example shows that the `sample-volume-plugin` plugin is installed The following example shows that the `sample-volume-plugin` plugin is installed
and enabled: and enabled:
@ -41,4 +44,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_enable.yaml
View File

@ -13,6 +13,9 @@ options:
description: HTTP client timeout (in seconds) description: HTTP client timeout (in seconds)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example shows that the `sample-volume-plugin` plugin is installed, The following example shows that the `sample-volume-plugin` plugin is installed,
but disabled: but disabled:
@ -39,4 +42,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_inspect.yaml
View File

@ -13,6 +13,9 @@ options:
description: Format the output using the given Go template description: Format the output using the given Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```none ```none
$ docker plugin inspect tiborvass/sample-volume-plugin:latest $ docker plugin inspect tiborvass/sample-volume-plugin:latest
@ -136,4 +139,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_plugin_install.yaml
View File

@ -14,24 +14,36 @@ options:
description: Local name for plugin description: Local name for plugin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable - option: disable
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Do not enable the plugin on install description: Do not enable the plugin on install
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: grant-all-permissions - option: grant-all-permissions
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Grant all permissions necessary to run the plugin description: Grant all permissions necessary to run the plugin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its
`DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker `DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker
@ -60,4 +72,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

15
_data/engine-cli-edge/docker_plugin_ls.yaml
View File

@ -16,17 +16,26 @@ options:
description: Provide filter values (e.g. 'enabled=true') description: Provide filter values (e.g. 'enabled=true')
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print plugins using a Go template description: Pretty-print plugins using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -34,6 +43,9 @@ options:
description: Only display plugin IDs description: Only display plugin IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
```bash ```bash
$ docker plugin ls $ docker plugin ls
@ -102,4 +114,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_push.yaml
View File

@ -16,6 +16,9 @@ options:
description: Skip image signing description: Skip image signing
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example shows how to push a sample `user/plugin`. The following example shows how to push a sample `user/plugin`.
@ -30,4 +33,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

6
_data/engine-cli-edge/docker_plugin_rm.yaml
View File

@ -17,6 +17,9 @@ options:
description: Force the removal of an active plugin description: Force the removal of an active plugin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example disables and removes the `sample-volume-plugin:latest` The following example disables and removes the `sample-volume-plugin:latest`
plugin: plugin:
@ -33,4 +36,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_plugin_set.yaml
View File

@ -83,4 +83,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.25" min_api_version: "1.25"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -15,12 +15,18 @@ options:
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: grant-all-permissions - option: grant-all-permissions
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Grant all permissions necessary to run the plugin description: Grant all permissions necessary to run the plugin
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: skip-remote-check - option: skip-remote-check
value_type: bool value_type: bool
default_value: "false" default_value: "false"
@ -28,6 +34,9 @@ options:
Do not check if specified remote plugin matches existing plugin image Do not check if specified remote plugin matches existing plugin image
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
The following example installs `vieus/sshfs` plugin, uses it to create and use The following example installs `vieus/sshfs` plugin, uses it to create and use
a volume, then upgrades the plugin. a volume, then upgrades the plugin.
@ -82,4 +91,7 @@ examples: |-
deprecated: false deprecated: false
min_api_version: "1.26" min_api_version: "1.26"
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

3
_data/engine-cli-edge/docker_port.yaml
View File

@ -26,4 +26,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

27
_data/engine-cli-edge/docker_ps.yaml
View File

@ -12,17 +12,26 @@ options:
description: Show all containers (default shows just running) description: Show all containers (default shows just running)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: filter - option: filter
shorthand: f shorthand: f
value_type: filter value_type: filter
description: Filter output based on conditions provided description: Filter output based on conditions provided
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: format - option: format
value_type: string value_type: string
description: Pretty-print containers using a Go template description: Pretty-print containers using a Go template
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: last - option: last
shorthand: "n" shorthand: "n"
value_type: int value_type: int
@ -30,6 +39,9 @@ options:
description: Show n last created containers (includes all states) description: Show n last created containers (includes all states)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: latest - option: latest
shorthand: l shorthand: l
value_type: bool value_type: bool
@ -37,12 +49,18 @@ options:
description: Show the latest created container (includes all states) description: Show the latest created container (includes all states)
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: no-trunc - option: no-trunc
value_type: bool value_type: bool
default_value: "false" default_value: "false"
description: Don't truncate output description: Don't truncate output
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet - option: quiet
shorthand: q shorthand: q
value_type: bool value_type: bool
@ -50,6 +68,9 @@ options:
description: Only display numeric IDs description: Only display numeric IDs
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: size - option: size
shorthand: s shorthand: s
value_type: bool value_type: bool
@ -57,6 +78,9 @@ options:
description: Display total file sizes description: Display total file sizes
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Prevent truncating output ### Prevent truncating output
@ -442,4 +466,7 @@ examples: |-
``` ```
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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

@ -36,18 +36,27 @@ options:
description: Download all tagged images in the repository description: Download all tagged images in the repository
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: disable-content-trust - option: disable-content-trust
value_type: bool value_type: bool
default_value: "true" default_value: "true"
description: Skip image verification description: Skip image verification
deprecated: false deprecated: false
experimental: false 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
deprecated: false deprecated: false
min_api_version: "1.32" min_api_version: "1.32"
experimental: true experimental: true
experimentalcli: false
kubernetes: false
swarm: false
examples: |- examples: |-
### Pull an image from Docker Hub ### Pull an image from Docker Hub
@ -248,4 +257,7 @@ examples: |-
> lost for other reasons than a manual interaction, the pull is also aborted. > lost for other reasons than a manual interaction, the pull is also aborted.
deprecated: false deprecated: false
experimental: false experimental: false
experimentalcli: false
kubernetes: false
swarm: false

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