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 CLI refs

This commit is contained in:
Misty Stanley-Jones 2017-09-22 14:12:27 -07:00 committed by Misty Stanley-Jones
parent baf7c6089b
commit 500f1816b1
319 changed files with 7398 additions and 211 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -109,4 +109,6 @@ clink:
- docker_version.yaml
- docker_volume.yaml
- docker_wait.yaml
deprecated: false
experimental: false

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

@ -65,13 +65,22 @@ pname: docker
plink: docker.yaml
options:
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
- option: no-stdin
value_type: bool
default_value: "false"
description: Do not attach STDIN
deprecated: false
experimental: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy all received signals to the process
deprecated: false
experimental: false
examples: |-
### Attach to and detach from a running container
@ -140,4 +149,6 @@ examples: |-
275c44472aeb debian:7 "/bin/bash" 26 seconds ago Exited (13) 17 seconds ago test
```
deprecated: false
experimental: false

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

@ -16,7 +16,7 @@ long: |-
repository acts as the build context. The system recursively fetches the
repository and its submodules. The commit history is not preserved. A
repository is first pulled into a temporary directory on your local host. After
the that succeeds, the directory is sent to the Docker daemon as the context.
that succeeds, the directory is sent to the Docker daemon as the context.
Local copy gives you the ability to access private repositories using local
user credentials, VPN's, and so forth.
@ -108,91 +108,184 @@ pname: docker
plink: docker.yaml
options:
- option: add-host
value_type: list
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
- option: build-arg
value_type: list
description: Set build-time variables
deprecated: false
experimental: false
- option: cache-from
value_type: stringSlice
default_value: '[]'
description: Images to consider as cache sources
deprecated: false
experimental: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
- option: compress
value_type: bool
default_value: "false"
description: Compress the build context using gzip
deprecated: false
experimental: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
- option: cpu-shares
shorthand: c
value_type: int64
default_value: "0"
description: CPU shares (relative weight)
deprecated: false
experimental: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
- option: file
shorthand: f
value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false
experimental: false
- option: force-rm
value_type: bool
default_value: "false"
description: Always remove intermediate containers
deprecated: false
experimental: false
- option: iidfile
value_type: string
description: Write the image ID to the file
deprecated: false
experimental: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
- option: label
value_type: list
description: Set metadata for an image
deprecated: false
experimental: false
- option: memory
shorthand: m
value_type: bytes
default_value: "0"
description: Memory limit
deprecated: false
experimental: false
- option: memory-swap
value_type: bytes
default_value: "0"
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
- option: network
value_type: string
default_value: default
description: |
Set the networking mode for the RUN instructions during build
deprecated: false
min_api_version: "1.25"
experimental: false
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
deprecated: false
experimental: false
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Suppress the build output and print image ID on success
deprecated: false
experimental: false
- option: rm
value_type: bool
default_value: "true"
description: Remove intermediate containers after a successful build
deprecated: false
experimental: false
- option: security-opt
value_type: stringSlice
default_value: '[]'
description: Security options
deprecated: false
experimental: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
- option: squash
value_type: bool
default_value: "false"
description: Squash newly built layers into a single new layer
deprecated: false
min_api_version: "1.25"
experimental: true
- option: stream
value_type: bool
default_value: "false"
description: Stream attaches to server to negotiate build context
deprecated: false
min_api_version: "1.31"
experimental: true
- option: tag
shorthand: t
value_type: list
description: Name and optionally a tag in the 'name:tag' format
deprecated: false
experimental: false
- option: target
value_type: string
description: Set the target build stage to build.
deprecated: false
experimental: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context 10240
bytes\nStep 1/3 : FROM busybox\nPulling repository busybox\n ---> e9aa60c60128MB/2.284
MB (100%) endpoint: https://cdn-registry-1.docker.io/v1/\nStep 2/3 : RUN ls -lh
@ -358,4 +451,6 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
layer's name is `<missing>`, and there is a new layer with COMMENT `merge`.\n\nTest
the image, check for `/remove_me` being gone, make sure `hello\\nworld` is in `/hello`,
make sure the `HELLO` envvar's value is `world`."
deprecated: false
experimental: false

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

@ -12,4 +12,7 @@ clink:
- docker_checkpoint_create.yaml
- docker_checkpoint_ls.yaml
- docker_checkpoint_rm.yaml
deprecated: false
min_api_version: "1.25"
experimental: true

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

@ -6,8 +6,17 @@ pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
- option: leave-running
value_type: bool
default_value: "false"
description: Leave the container running after checkpoint
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.25"
experimental: true

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

@ -7,5 +7,11 @@ pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.25"
experimental: true

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

@ -7,5 +7,11 @@ pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.25"
experimental: true

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

@ -24,17 +24,29 @@ plink: docker.yaml
options:
- option: author
shorthand: a
value_type: string
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false
experimental: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
- option: pause
shorthand: p
value_type: bool
default_value: "true"
description: Pause container during commit
deprecated: false
experimental: false
examples: |-
### Commit a container
@ -101,4 +113,6 @@ examples: |-
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours desperate_dubinsky
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours focused_hamilton
```
deprecated: false
experimental: false

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

@ -14,4 +14,7 @@ clink:
- docker_config_inspect.yaml
- docker_config_ls.yaml
- docker_config_rm.yaml
deprecated: false
min_api_version: "1.30"
experimental: false

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

@ -7,5 +7,11 @@ plink: docker_config.yaml
options:
- option: label
shorthand: l
value_type: list
description: Config labels
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.30"
experimental: false

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

@ -7,8 +7,17 @@ plink: docker_config.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: pretty
value_type: bool
default_value: "false"
description: Print the information in a human friendly format
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.30"
experimental: false

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

@ -8,11 +8,23 @@ plink: docker_config.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print configs using a Go template
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display IDs
deprecated: false
experimental: false
deprecated: false
min_api_version: "1.30"
experimental: false

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

@ -5,4 +5,7 @@ long: Remove one or more configuration files
usage: docker config rm CONFIG [CONFIG...]
pname: docker config
plink: docker_config.yaml
deprecated: false
min_api_version: "1.30"
experimental: false

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

@ -56,4 +56,6 @@ clink:
- docker_container_unpause.yaml
- docker_container_update.yaml
- docker_container_wait.yaml
deprecated: false
experimental: false

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

@ -6,11 +6,22 @@ pname: docker container
plink: docker_container.yaml
options:
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
- option: no-stdin
value_type: bool
default_value: "false"
description: Do not attach STDIN
deprecated: false
experimental: false
- option: sig-proxy
value_type: bool
default_value: "true"
description: Proxy all received signals to the process
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,15 +7,29 @@ plink: docker_container.yaml
options:
- option: author
shorthand: a
value_type: string
description: Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
deprecated: false
experimental: false
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
- option: message
shorthand: m
value_type: string
description: Commit message
deprecated: false
experimental: false
- option: pause
shorthand: p
value_type: bool
default_value: "true"
description: Pause container during commit
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -14,10 +14,18 @@ plink: docker_container.yaml
options:
- option: archive
shorthand: a
value_type: bool
default_value: "false"
description: Archive mode (copy all uid/gid information)
deprecated: false
experimental: false
- option: follow-link
shorthand: L
value_type: bool
default_value: "false"
description: Always follow symbol link in SRC_PATH
deprecated: false
experimental: false
deprecated: false
experimental: false

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

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

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

@ -4,4 +4,6 @@ long: Inspect changes to files or directories on a container's filesystem
usage: docker container diff CONTAINER
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -7,25 +7,49 @@ plink: docker_container.yaml
options:
- option: detach
shorthand: d
value_type: bool
default_value: "false"
description: 'Detached mode: run command in the background'
deprecated: false
experimental: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
min_api_version: "1.25"
experimental: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the command
deprecated: false
experimental: false
- option: tty
shorthand: t
value_type: bool
default_value: "false"
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,5 +7,10 @@ plink: docker_container.yaml
options:
- option: output
shorthand: o
value_type: string
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,9 +7,17 @@ plink: docker_container.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,6 +7,11 @@ plink: docker_container.yaml
options:
- option: signal
shorthand: s
value_type: string
default_value: KILL
description: Signal to send to the container
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -6,20 +6,37 @@ pname: docker container
plink: docker_container.yaml
options:
- option: details
value_type: bool
default_value: "false"
description: Show extra details provided to logs
deprecated: false
experimental: false
- option: follow
shorthand: f
value_type: bool
default_value: "false"
description: Follow log output
deprecated: false
experimental: false
- option: since
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false
experimental: false
- option: tail
value_type: string
default_value: all
description: Number of lines to show from the end of the logs
deprecated: false
experimental: false
- option: timestamps
shorthand: t
value_type: bool
default_value: "false"
description: Show timestamps
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -8,30 +8,56 @@ plink: docker_container.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all containers (default shows just running)
deprecated: false
experimental: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print containers using a Go template
deprecated: false
experimental: false
- option: last
shorthand: "n"
value_type: int
default_value: "-1"
description: Show n last created containers (includes all states)
deprecated: false
experimental: false
- option: latest
shorthand: l
value_type: bool
default_value: "false"
description: Show the latest created container (includes all states)
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display numeric IDs
deprecated: false
experimental: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: Pause all processes within one or more containers
usage: docker container pause CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: List port mappings or a specific mapping for the container
usage: docker container port CONTAINER [PRIVATE_PORT[/PROTO]]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -6,11 +6,17 @@ pname: docker container
plink: docker_container.yaml
options:
- option: filter
value_type: filter
description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false
experimental: false
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Do not prompt for confirmation
deprecated: false
experimental: false
examples: |-
### Prune containers
@ -95,4 +101,7 @@ examples: |-
CONTAINER ID IMAGE COMMAND CREATED AT STATUS
53a9bc23a516 busybox "sh" 2017-01-04 13:11:59 -0800 PST Exited (0) 9 minutes ago
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -4,4 +4,6 @@ long: Rename a container
usage: docker container rename CONTAINER NEW_NAME
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -7,6 +7,11 @@ plink: docker_container.yaml
options:
- option: time
shorthand: t
value_type: int
default_value: "10"
description: Seconds to wait for stop before killing the container
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,14 +7,25 @@ plink: docker_container.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force the removal of a running container (uses SIGKILL)
deprecated: false
experimental: false
- option: link
shorthand: l
value_type: bool
default_value: "false"
description: Remove the specified link
deprecated: false
experimental: false
- option: volumes
shorthand: v
value_type: bool
default_value: "false"
description: Remove the volumes associated with the container
deprecated: false
experimental: false
deprecated: false
experimental: false

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

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

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

@ -7,16 +7,33 @@ plink: docker_container.yaml
options:
- option: attach
shorthand: a
value_type: bool
default_value: "false"
description: Attach STDOUT/STDERR and forward signals
deprecated: false
experimental: false
- option: checkpoint
value_type: string
description: Restore from this checkpoint
deprecated: false
experimental: true
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: true
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Attach container's STDIN
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,11 +7,22 @@ plink: docker_container.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all containers (default shows just running)
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
- option: no-stream
value_type: bool
default_value: "false"
description: Disable streaming stats and only pull the first result
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,6 +7,11 @@ plink: docker_container.yaml
options:
- option: time
shorthand: t
value_type: int
default_value: "10"
description: Seconds to wait for stop before killing it
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: Display the running processes of a container
usage: docker container top CONTAINER [ps OPTIONS]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: Unpause all processes within one or more containers
usage: docker container unpause CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -6,45 +6,92 @@ pname: docker container
plink: docker_container.yaml
options:
- option: blkio-weight
value_type: uint16
default_value: "0"
description: |
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
deprecated: false
experimental: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
- option: cpu-rt-period
value_type: int64
default_value: "0"
description: Limit the CPU real-time period in microseconds
deprecated: false
min_api_version: "1.25"
experimental: false
- option: cpu-rt-runtime
value_type: int64
default_value: "0"
description: Limit the CPU real-time runtime in microseconds
deprecated: false
min_api_version: "1.25"
experimental: false
- option: cpu-shares
shorthand: c
value_type: int64
default_value: "0"
description: CPU shares (relative weight)
deprecated: false
experimental: false
- option: cpus
value_type: decimal
description: Number of CPUs
deprecated: false
min_api_version: "1.29"
experimental: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
experimental: false
- option: memory
shorthand: m
value_type: bytes
default_value: "0"
description: Memory limit
deprecated: false
experimental: false
- option: memory-reservation
value_type: bytes
default_value: "0"
description: Memory soft limit
deprecated: false
experimental: false
- option: memory-swap
value_type: bytes
default_value: "0"
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
- option: restart
value_type: string
description: Restart policy to apply when a container exits
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: Block until one or more containers stop, then print their exit codes
usage: docker container wait CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
deprecated: false
experimental: false

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

@ -21,7 +21,9 @@ long: |-
the user and primary group at the destination. For example, files copied to a
container are created with `UID:GID` of the root user. Files copied to the local
machine are created with the `UID:GID` of the user which invoked the `docker cp`
command. If you specify the `-L` option, `docker cp` follows any symbolic link
command. However, if you specify the `-a` option, `docker cp` sets the ownership
to the user and primary group at the source.
If you specify the `-L` option, `docker cp` follows any symbolic link
in the `SRC_PATH`. `docker cp` does *not* create parent directories for
`DEST_PATH` if they do not exist.
@ -70,11 +72,11 @@ long: |-
in different ways (consider `SRC_PATH` and `DEST_PATH` are directories):
```bash
$ docker exec foo tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | tar Cxf DEST_PATH -
$ docker exec CONTAINER tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | tar Cxf DEST_PATH -
```
```bash
$ tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | docker exec -i foo tar Cxf DEST_PATH -
$ tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | docker exec -i CONTAINER tar Cxf DEST_PATH -
```
Using `-` as the `SRC_PATH` streams the contents of `STDIN` as a tar archive.
@ -88,10 +90,18 @@ plink: docker.yaml
options:
- option: archive
shorthand: a
value_type: bool
default_value: "false"
description: Archive mode (copy all uid/gid information)
deprecated: false
experimental: false
- option: follow-link
shorthand: L
value_type: bool
default_value: "false"
description: Always follow symbol link in SRC_PATH
deprecated: false
experimental: false
deprecated: false
experimental: false

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

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

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

@ -8,20 +8,38 @@ pname: docker
plink: docker.yaml
options:
- option: bundle-file
value_type: string
description: Path to a Distributed Application Bundle file
deprecated: false
experimental: true
- option: compose-file
shorthand: c
value_type: string
description: Path to a Compose file
deprecated: false
min_api_version: "1.25"
experimental: false
- option: prune
value_type: bool
default_value: "false"
description: Prune services that are no longer referenced
deprecated: false
min_api_version: "1.27"
experimental: false
- option: resolve-image
value_type: string
default_value: always
description: |
Query the registry to resolve image digest and supported platforms ("always"|"changed"|"never")
deprecated: false
min_api_version: "1.30"
experimental: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Send registry authentication details to Swarm agents
deprecated: false
experimental: false
examples: |-
### Compose file
@ -83,4 +101,7 @@ examples: |-
9gc5m4met4he vossibility_logstash replicated 1/1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
axqh55ipl40h vossibility_vossibility-collector replicated 1/1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
```
deprecated: false
min_api_version: "1.25"
experimental: true

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

@ -41,4 +41,6 @@ examples: |-
A /var/log/nginx/access.log
A /var/log/nginx/error.log
```
deprecated: false
experimental: false

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

@ -172,13 +172,25 @@ plink: docker.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: since
value_type: string
description: Show all events created since timestamp
deprecated: false
experimental: false
- option: until
value_type: string
description: Stream events until this timestamp
deprecated: false
experimental: false
examples: |-
### Basic example
@ -257,6 +269,12 @@ examples: |-
2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test)
2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge)
2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test)
$ docker events --since '2017-01-05T00:35:30' --until '2017-01-05T00:36:05'
2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local)
2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test)
2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge)
2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test)
```
### Filter events by criteria
@ -382,4 +400,6 @@ examples: |-
{"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42..
{"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..
```
deprecated: false
experimental: false

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

@ -20,27 +20,49 @@ plink: docker.yaml
options:
- option: detach
shorthand: d
value_type: bool
default_value: "false"
description: 'Detached mode: run command in the background'
deprecated: false
experimental: false
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
- option: env
shorthand: e
value_type: list
description: Set environment variables
deprecated: false
min_api_version: "1.25"
experimental: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Keep STDIN open even if not attached
deprecated: false
experimental: false
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the command
deprecated: false
experimental: false
- option: tty
shorthand: t
value_type: bool
default_value: "false"
description: Allocate a pseudo-TTY
deprecated: false
experimental: false
- option: user
shorthand: u
value_type: string
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
deprecated: false
experimental: false
examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$
docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a
container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command
@ -60,4 +82,6 @@ examples: "### Run `docker exec` on a running container\n\nFirst, start a contai
(Paused) test\n\n$ docker exec test ls\n\nFATA[0000] Error
response from daemon: Container test is paused, unpause the container before exec\n\n$
echo $?\n1\n```"
deprecated: false
experimental: false

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

@ -14,7 +14,10 @@ plink: docker.yaml
options:
- option: output
shorthand: o
value_type: string
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
examples: |-
ch of these commands has the same result.
@ -25,4 +28,6 @@ examples: |-
```bash
$ docker export --output="latest.tar" red_panda
```
deprecated: false
experimental: false

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

@ -6,18 +6,30 @@ pname: docker
plink: docker.yaml
options:
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
- option: human
shorthand: H
value_type: bool
default_value: "true"
description: Print sizes and dates in human readable format
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only show numeric IDs
deprecated: false
experimental: false
examples: |-
To see how the `docker:latest` image was built:
@ -79,4 +91,6 @@ examples: |-
<missing>: 3 weeks ago
<missing>: 3 weeks ago
```
deprecated: false
experimental: false

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

@ -30,4 +30,6 @@ clink:
- docker_image_rm.yaml
- docker_image_save.yaml
- docker_image_tag.yaml
deprecated: false
experimental: false

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

@ -6,89 +6,184 @@ pname: docker image
plink: docker_image.yaml
options:
- option: add-host
value_type: list
description: Add a custom host-to-IP mapping (host:ip)
deprecated: false
experimental: false
- option: build-arg
value_type: list
description: Set build-time variables
deprecated: false
experimental: false
- option: cache-from
value_type: stringSlice
default_value: '[]'
description: Images to consider as cache sources
deprecated: false
experimental: false
- option: cgroup-parent
value_type: string
description: Optional parent cgroup for the container
deprecated: false
experimental: false
- option: compress
value_type: bool
default_value: "false"
description: Compress the build context using gzip
deprecated: false
experimental: false
- option: cpu-period
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) period
deprecated: false
experimental: false
- option: cpu-quota
value_type: int64
default_value: "0"
description: Limit the CPU CFS (Completely Fair Scheduler) quota
deprecated: false
experimental: false
- option: cpu-shares
shorthand: c
value_type: int64
default_value: "0"
description: CPU shares (relative weight)
deprecated: false
experimental: false
- option: cpuset-cpus
value_type: string
description: CPUs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: cpuset-mems
value_type: string
description: MEMs in which to allow execution (0-3, 0,1)
deprecated: false
experimental: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
- option: file
shorthand: f
value_type: string
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
deprecated: false
experimental: false
- option: force-rm
value_type: bool
default_value: "false"
description: Always remove intermediate containers
deprecated: false
experimental: false
- option: iidfile
value_type: string
description: Write the image ID to the file
deprecated: false
experimental: false
- option: isolation
value_type: string
description: Container isolation technology
deprecated: false
experimental: false
- option: label
value_type: list
description: Set metadata for an image
deprecated: false
experimental: false
- option: memory
shorthand: m
value_type: bytes
default_value: "0"
description: Memory limit
deprecated: false
experimental: false
- option: memory-swap
value_type: bytes
default_value: "0"
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
deprecated: false
experimental: false
- option: network
value_type: string
default_value: default
description: |
Set the networking mode for the RUN instructions during build
deprecated: false
min_api_version: "1.25"
experimental: false
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
deprecated: false
experimental: false
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Suppress the build output and print image ID on success
deprecated: false
experimental: false
- option: rm
value_type: bool
default_value: "true"
description: Remove intermediate containers after a successful build
deprecated: false
experimental: false
- option: security-opt
value_type: stringSlice
default_value: '[]'
description: Security options
deprecated: false
experimental: false
- option: shm-size
value_type: bytes
default_value: "0"
description: Size of /dev/shm
deprecated: false
experimental: false
- option: squash
value_type: bool
default_value: "false"
description: Squash newly built layers into a single new layer
deprecated: false
min_api_version: "1.25"
experimental: true
- option: stream
value_type: bool
default_value: "false"
description: Stream attaches to server to negotiate build context
deprecated: false
min_api_version: "1.31"
experimental: true
- option: tag
shorthand: t
value_type: list
description: Name and optionally a tag in the 'name:tag' format
deprecated: false
experimental: false
- option: target
value_type: string
description: Set the target build stage to build.
deprecated: false
experimental: false
- option: ulimit
value_type: ulimit
default_value: '[]'
description: Ulimit options
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -6,16 +6,30 @@ pname: docker image
plink: docker_image.yaml
options:
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
- option: human
shorthand: H
value_type: bool
default_value: "true"
description: Print sizes and dates in human readable format
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only show numeric IDs
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,8 +7,16 @@ plink: docker_image.yaml
options:
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
- option: message
shorthand: m
value_type: string
description: Set commit message for imported image
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,5 +7,10 @@ plink: docker_image.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,9 +7,17 @@ plink: docker_image.yaml
options:
- option: input
shorthand: i
value_type: string
description: Read from tar archive file, instead of STDIN
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Suppress the load output
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -8,21 +8,41 @@ plink: docker_image.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all images (default hides intermediate images)
deprecated: false
experimental: false
- option: digests
value_type: bool
default_value: "false"
description: Show digests
deprecated: false
experimental: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only show numeric IDs
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -8,14 +8,23 @@ plink: docker_image.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Remove all unused images, not just dangling ones
deprecated: false
experimental: false
- option: filter
value_type: filter
description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false
experimental: false
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Do not prompt for confirmation
deprecated: false
experimental: false
examples: |2-
output:
@ -145,4 +154,7 @@ examples: |2-
alpine latest 88e169ea8f46 8 days ago 3.98 MB
busybox latest e02e811dd08f 2 months ago 1.09 MB
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -7,9 +7,17 @@ plink: docker_image.yaml
options:
- option: all-tags
shorthand: a
value_type: bool
default_value: "false"
description: Download all tagged images in the repository
deprecated: false
experimental: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -6,6 +6,11 @@ pname: docker image
plink: docker_image.yaml
options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image signing
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -8,9 +8,17 @@ plink: docker_image.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force removal of the image
deprecated: false
experimental: false
- option: no-prune
value_type: bool
default_value: "false"
description: Do not delete untagged parents
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -7,5 +7,10 @@ plink: docker_image.yaml
options:
- option: output
shorthand: o
value_type: string
description: Write to a file, instead of STDOUT
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -4,4 +4,6 @@ long: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
usage: docker image tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG]
pname: docker image
plink: docker_image.yaml
deprecated: false
experimental: false

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

@ -22,23 +22,41 @@ plink: docker.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all images (default hides intermediate images)
deprecated: false
experimental: false
- option: digests
value_type: bool
default_value: "false"
description: Show digests
deprecated: false
experimental: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print images using a Go template
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only show numeric IDs
deprecated: false
experimental: false
examples: |-
### List the most recently created images
@ -326,4 +344,6 @@ examples: |-
746b819f315e postgres 9.3.5
746b819f315e postgres latest
```
deprecated: false
experimental: false

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

@ -19,10 +19,16 @@ plink: docker.yaml
options:
- option: change
shorthand: c
value_type: list
description: Apply Dockerfile instruction to the created image
deprecated: false
experimental: false
- option: message
shorthand: m
value_type: string
description: Set commit message for imported image
deprecated: false
experimental: false
examples: |-
### Import from a remote location
@ -68,4 +74,6 @@ examples: |-
the ownership of the files (especially root ownership) during the
archiving with tar. If you are not root (or the sudo command) when you
tar, then the ownerships might not get preserved.
deprecated: false
experimental: false

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

@ -24,7 +24,10 @@ plink: docker.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
examples: |-
### Show output
@ -222,4 +225,6 @@ examples: |-
http://registry-mirror.example.com:5000/
Live Restore Enabled: false
```
deprecated: false
experimental: false

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

@ -10,13 +10,22 @@ plink: docker.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes if the type is container
deprecated: false
experimental: false
- option: type
value_type: string
description: Return JSON for specified type
deprecated: false
experimental: false
examples: |-
### Get an instance's IP address
@ -78,4 +87,6 @@ examples: |-
```bash
$ docker inspect --format='{{json .Config}}' $INSTANCE_ID
```
deprecated: false
experimental: false

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

@ -13,6 +13,11 @@ plink: docker.yaml
options:
- option: signal
shorthand: s
value_type: string
default_value: KILL
description: Signal to send to the container
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -9,11 +9,17 @@ plink: docker.yaml
options:
- option: input
shorthand: i
value_type: string
description: Read from tar archive file, instead of STDIN
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Suppress the load output
deprecated: false
experimental: false
examples: |-
```bash
$ docker images
@ -42,4 +48,6 @@ examples: |-
fedora heisenbug 58394af37342 7 weeks ago 385.5 MB
fedora latest 58394af37342 7 weeks ago 385.5 MB
```
deprecated: false
experimental: false

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

@ -2,11 +2,17 @@ command: docker login
short: Log in to a Docker registry
long: "Login to a registry.\n\n### Login to a self-hosted registry\n\nIf you want
to login to a self-hosted registry you can specify this by\nadding the server name.\n\n```bash\n$
docker login localhost:8080\n```\n\n### Privileged user requirement\n\n`docker login`
requires user to use `sudo` or be `root`, except when:\n\n1. connecting to a remote
daemon, such as a `docker-machine` provisioned `docker engine`.\n2. user is added
to the `docker` group. This will impact the security of your system; the `docker`
group is `root` equivalent. See [Docker Daemon Attack Surface](https://docs.docker.com/security/security/#docker-daemon-attack-surface)
docker login localhost:8080\n```\n\n### Provide a password using STDIN\n\nTo run
the `docker login` command non-interactively, you can set the\n`--password-stdin`
flag to provide a password through `STDIN`. Using\n`STDIN` prevents the password
from ending up in the shell's history,\nor log-files.\n\nThe following example reads
a password from a file, and passes it to the\n`docker login` command using `STDIN`:\n\n```bash\n$
cat ~/my_password.txt | docker login --username foo --password-stdin\n```\n\n###
Privileged user requirement\n\n`docker login` requires user to use `sudo` or be
`root`, except when:\n\n1. connecting to a remote daemon, such as a `docker-machine`
provisioned `docker engine`.\n2. user is added to the `docker` group. This will
impact the security of your system; the `docker` group is `root` equivalent. See
[Docker Daemon Attack Surface](https://docs.docker.com/security/security/#docker-daemon-attack-surface)
for details.\n\nYou can log into any public or private repository for which you
have\ncredentials. When you log in, the command stores encoded credentials in\n`$HOME/.docker/config.json`
on Linux or `%USERPROFILE%/.docker/config.json` on Windows.\n\n### Credentials store\n\nThe
@ -61,11 +67,22 @@ plink: docker.yaml
options:
- option: password
shorthand: p
value_type: string
description: Password
deprecated: false
experimental: false
- option: password-stdin
value_type: bool
default_value: "false"
description: Take the password from stdin
deprecated: false
experimental: false
- option: username
shorthand: u
value_type: string
description: Username
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -8,4 +8,6 @@ examples: |-
```bash
$ docker logout localhost:8080
```
deprecated: false
experimental: false

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

@ -41,20 +41,37 @@ pname: docker
plink: docker.yaml
options:
- option: details
value_type: bool
default_value: "false"
description: Show extra details provided to logs
deprecated: false
experimental: false
- option: follow
shorthand: f
value_type: bool
default_value: "false"
description: Follow log output
deprecated: false
experimental: false
- option: since
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
deprecated: false
experimental: false
- option: tail
value_type: string
default_value: all
description: Number of lines to show from the end of the logs
deprecated: false
experimental: false
- option: timestamps
shorthand: t
value_type: bool
default_value: "false"
description: Show timestamps
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -22,4 +22,6 @@ clink:
- docker_network_ls.yaml
- docker_network_prune.yaml
- docker_network_rm.yaml
deprecated: false
experimental: false

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

@ -9,17 +9,32 @@ pname: docker network
plink: docker_network.yaml
options:
- option: alias
value_type: stringSlice
default_value: '[]'
description: Add network-scoped alias for the container
deprecated: false
experimental: false
- option: ip
value_type: string
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
experimental: false
- option: ip6
value_type: string
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
experimental: false
- option: link
value_type: list
description: Add link to another container
deprecated: false
experimental: false
- option: link-local-ip
value_type: stringSlice
default_value: '[]'
description: Add a link-local address for the container
deprecated: false
experimental: false
examples: |-
### Connect a running container to a network
@ -88,4 +103,6 @@ examples: |-
network but launched from different Engines can also communicate in this way.
You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks.
deprecated: false
experimental: false

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

@ -53,52 +53,105 @@ pname: docker network
plink: docker_network.yaml
options:
- option: attachable
value_type: bool
default_value: "false"
description: Enable manual container attachment
deprecated: false
min_api_version: "1.25"
experimental: false
- option: aux-address
value_type: map
default_value: map[]
description: Auxiliary IPv4 or IPv6 addresses used by Network driver
deprecated: false
experimental: false
- option: config-from
value_type: string
description: The network from which copying the configuration
deprecated: false
min_api_version: "1.30"
experimental: false
- option: config-only
value_type: bool
default_value: "false"
description: Create a configuration only network
deprecated: false
min_api_version: "1.30"
experimental: false
- option: driver
shorthand: d
value_type: string
default_value: bridge
description: Driver to manage the Network
deprecated: false
experimental: false
- option: gateway
value_type: stringSlice
default_value: '[]'
description: IPv4 or IPv6 Gateway for the master subnet
deprecated: false
experimental: false
- option: ingress
value_type: bool
default_value: "false"
description: Create swarm routing-mesh network
deprecated: false
min_api_version: "1.29"
experimental: false
- option: internal
value_type: bool
default_value: "false"
description: Restrict external access to the network
deprecated: false
experimental: false
- option: ip-range
value_type: stringSlice
default_value: '[]'
description: Allocate container ip from a sub-range
deprecated: false
experimental: false
- option: ipam-driver
value_type: string
default_value: default
description: IP Address Management Driver
deprecated: false
experimental: false
- option: ipam-opt
value_type: map
default_value: map[]
description: Set IPAM driver specific options
deprecated: false
experimental: false
- option: ipv6
value_type: bool
default_value: "false"
description: Enable IPv6 networking
deprecated: false
experimental: false
- option: label
value_type: list
description: Set metadata on a network
deprecated: false
experimental: false
- option: opt
shorthand: o
value_type: map
default_value: map[]
description: Set driver specific options
deprecated: false
experimental: false
- option: scope
value_type: string
description: Control the network's scope
deprecated: false
min_api_version: "1.30"
experimental: false
- option: subnet
value_type: stringSlice
default_value: '[]'
description: Subnet in CIDR format that represents a network segment
deprecated: false
experimental: false
examples: |-
### Connect containers
@ -217,8 +270,10 @@ examples: |-
$ docker network create -d overlay \
--subnet=10.11.0.0/16 \
--ingress \
--opt com.docker.network.mtu=9216 \
--opt com.docker.network.driver.mtu=9216 \
--opt encrypted=true \
my-ingress-network
```
deprecated: false
experimental: false

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

@ -9,10 +9,15 @@ plink: docker_network.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force the container to disconnect from a network
deprecated: false
experimental: false
examples: |-
```bash
$ docker network disconnect multi-host-network container1
```
deprecated: false
experimental: false

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

@ -9,9 +9,17 @@ plink: docker_network.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: verbose
shorthand: v
value_type: bool
default_value: "false"
description: Verbose output for diagnostics
deprecated: false
experimental: false
deprecated: false
experimental: false

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

@ -10,16 +10,28 @@ plink: docker_network.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Provide filter values (e.g. 'driver=bridge')
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print networks using a Go template
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Do not truncate the output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display network IDs
deprecated: false
experimental: false
examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK ID
\ NAME DRIVER SCOPE\n7fca4eb8c647 bridge
\ bridge local\n9f904ee27bf5 none null
@ -100,4 +112,6 @@ examples: "### List all networks\n\n```bash\n$ sudo docker network ls\nNETWORK I
uses a template without headers and outputs the\n`ID` and `Driver` entries separated
by a colon for all networks:\n\n```bash\n$ docker network ls --format \"{{.ID}}:
{{.Driver}}\"\nafaaab448eb2: bridge\nd1584f8dc718: host\n391df270dc66: null\n```"
deprecated: false
experimental: false

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

@ -8,11 +8,17 @@ pname: docker network
plink: docker_network.yaml
options:
- option: filter
value_type: filter
description: Provide filter values (e.g. 'until=<timestamp>')
deprecated: false
experimental: false
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Do not prompt for confirmation
deprecated: false
experimental: false
examples: |-
```bash
$ docker network prune
@ -77,4 +83,7 @@ examples: |-
97b91972bc3b host host local
f949d337b1f5 none null local
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -30,4 +30,6 @@ examples: |-
If the deletion of one network fails, the command continues to the next on the
list and tries to delete that. The command reports success or failure for each
deletion.
deprecated: false
experimental: false

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

@ -20,4 +20,7 @@ clink:
- docker_node_ps.yaml
- docker_node_rm.yaml
- docker_node_update.yaml
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -10,4 +10,7 @@ examples: |-
```bash
$ docker node demote <node name>
```
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -12,10 +12,16 @@ plink: docker_node.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
- option: pretty
value_type: bool
default_value: "false"
description: Print the information in a human friendly format
deprecated: false
experimental: false
examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n
\ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\":
10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\":
@ -52,4 +58,7 @@ examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\
Version: 17.06.0-ce\nTLS Info:\n TrustRoot:\n-----BEGIN CERTIFICATE-----\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\n-----END
CERTIFICATE-----\n\n Issuer Public Key:\tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==\n
Issuer Subject:\tMBMxETAPBgNVBAMTCHN3YXJtLWNh\n```"
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -11,13 +11,22 @@ plink: docker_node.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print nodes using a Go template
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display IDs
deprecated: false
experimental: false
examples: "```bash\n$ docker node ls\n\nID HOSTNAME STATUS
\ AVAILABILITY MANAGER STATUS\n1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready
\ Active\n38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active\ne216jshn25ckzbvmwlnh5jr3g
@ -65,5 +74,8 @@ examples: "```bash\n$ docker node ls\n\nID HOSTNAME
headers and outputs the\n`ID`, `Hostname`, and `TLS Status` entries separated by
a colon for all nodes:\n\n```bash\n$ docker node ls --format \"{{.ID}}: {{.Hostname}}
{{.TLSStatus}}\"\ne216jshn25ckzbvmwlnh5jr3g: swarm-manager1 Ready\n35o6tiywb700jesrt3dmllaza:
swarm-worker1 Needs Rotation \n``"
swarm-worker1 Needs Rotation \n```"
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -10,4 +10,7 @@ examples: |-
```bash
$ docker node promote <node name>
```
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -9,19 +9,34 @@ plink: docker_node.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print tasks using a Go template
deprecated: false
experimental: false
- option: no-resolve
value_type: bool
default_value: "false"
description: Do not map IDs to Names
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Do not truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display task IDs
deprecated: false
experimental: false
examples: |-
```bash
$ docker node ps swarm-manager1
@ -124,4 +139,7 @@ examples: |-
top.2: busybox
top.3: busybox
```
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -8,8 +8,11 @@ plink: docker_node.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force remove a node from the swarm
deprecated: false
experimental: false
examples: |-
### Remove a stopped node from the swarm
@ -45,4 +48,7 @@ examples: |-
A manager node must be demoted to a worker node (using `docker node demote`)
before you can remove it from the swarm.
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -6,13 +6,25 @@ pname: docker node
plink: docker_node.yaml
options:
- option: availability
value_type: string
description: Availability of the node ("active"|"pause"|"drain")
deprecated: false
experimental: false
- option: label-add
value_type: list
description: Add or update a node label (key=value)
deprecated: false
experimental: false
- option: label-rm
value_type: list
description: Remove a node label if exists
deprecated: false
experimental: false
- option: role
value_type: string
description: Role of the node ("worker"|"manager")
deprecated: false
experimental: false
examples: |-
### Add label metadata to a node
@ -46,4 +58,7 @@ examples: |-
For more information about labels, refer to [apply custom
metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).
deprecated: false
min_api_version: "1.24"
experimental: false

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

@ -18,4 +18,6 @@ examples: |-
```bash
$ docker pause my_container
```
deprecated: false
experimental: false

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

@ -26,4 +26,7 @@ clink:
- docker_plugin_rm.yaml
- docker_plugin_set.yaml
- docker_plugin_upgrade.yaml
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -9,8 +9,11 @@ pname: docker plugin
plink: docker_plugin.yaml
options:
- option: compress
value_type: bool
default_value: "false"
description: Compress the context using gzip
deprecated: false
experimental: false
examples: |-
The following example shows how to create a sample `plugin`.
@ -32,4 +35,7 @@ examples: |-
```
The plugin can subsequently be enabled for local use or pushed to the public registry.
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -10,8 +10,11 @@ plink: docker_plugin.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force the disable of an active plugin
deprecated: false
experimental: false
examples: |-
The following example shows that the `sample-volume-plugin` plugin is installed
and enabled:
@ -35,4 +38,7 @@ examples: |-
ID NAME TAG DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -8,8 +8,11 @@ pname: docker plugin
plink: docker_plugin.yaml
options:
- option: timeout
value_type: int
default_value: "0"
description: HTTP client timeout (in seconds)
deprecated: false
experimental: false
examples: |-
The following example shows that the `sample-volume-plugin` plugin is installed,
but disabled:
@ -33,4 +36,7 @@ examples: |-
ID NAME TAG DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -9,7 +9,10 @@ plink: docker_plugin.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
examples: |-
```none
$ docker plugin inspect tiborvass/sample-volume-plugin:latest
@ -130,4 +133,7 @@ examples: |-
8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -10,16 +10,28 @@ pname: docker plugin
plink: docker_plugin.yaml
options:
- option: alias
value_type: string
description: Local name for plugin
deprecated: false
experimental: false
- option: disable
value_type: bool
default_value: "false"
description: Do not enable the plugin on install
deprecated: false
experimental: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
- option: grant-all-permissions
value_type: bool
default_value: "false"
description: Grant all permissions necessary to run the plugin
deprecated: false
experimental: false
examples: |-
The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its
`DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker
@ -45,4 +57,7 @@ examples: |-
ID NAME TAG DESCRIPTION ENABLED
69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -12,16 +12,28 @@ plink: docker_plugin.yaml
options:
- option: filter
shorthand: f
value_type: filter
description: Provide filter values (e.g. 'enabled=true')
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print plugins using a Go template
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display plugin IDs
deprecated: false
experimental: false
examples: |-
```bash
$ docker plugin ls
@ -51,9 +63,9 @@ examples: |-
`ipamdriver`, `logdriver`, `metricscollector`, and `authz` are supported capabilities.
```bash
$ docker plugin install --disable tiborvass/no-remove
$ docker plugin install --disable vieux/sshfs
tiborvass/no-remove
Installed plugin vieux/sshfs
$ docker plugin ls --filter enabled=true
@ -85,6 +97,9 @@ examples: |-
```bash
$ docker plugin ls --format "{{.ID}}: {{.Name}}"
4be01827a72e: tiborvass/no-remove
4be01827a72e: vieux/sshfs:latest
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -11,8 +11,11 @@ pname: docker plugin
plink: docker_plugin.yaml
options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image signing
deprecated: false
experimental: false
examples: |-
The following example shows how to push a sample `user/plugin`.
@ -24,4 +27,7 @@ examples: |-
$ docker plugin push user/plugin
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -12,8 +12,11 @@ plink: docker_plugin.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force the removal of an active plugin
deprecated: false
experimental: false
examples: |-
The following example disables and removes the `sample-volume-plugin:latest`
plugin:
@ -27,4 +30,7 @@ examples: |-
tiborvass/sample-volume-plugin
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -80,4 +80,7 @@ examples: |-
["foo", "bar", "baz"]
```
deprecated: false
min_api_version: "1.25"
experimental: false

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

@ -10,15 +10,24 @@ pname: docker plugin
plink: docker_plugin.yaml
options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
- option: grant-all-permissions
value_type: bool
default_value: "false"
description: Grant all permissions necessary to run the plugin
deprecated: false
experimental: false
- option: skip-remote-check
value_type: bool
default_value: "false"
description: |
Do not check if specified remote plugin matches existing plugin image
deprecated: false
experimental: false
examples: |-
The following example installs `vieus/sshfs` plugin, uses it to create and use
a volume, then upgrades the plugin.
@ -70,4 +79,7 @@ examples: |-
hello
```
deprecated: false
min_api_version: "1.26"
experimental: false

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

@ -24,4 +24,6 @@ examples: |-
$ docker port test 7890
0.0.0.0:4321
```
deprecated: false
experimental: false

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

@ -7,32 +7,56 @@ plink: docker.yaml
options:
- option: all
shorthand: a
value_type: bool
default_value: "false"
description: Show all containers (default shows just running)
deprecated: false
experimental: false
- option: filter
shorthand: f
value_type: filter
description: Filter output based on conditions provided
deprecated: false
experimental: false
- option: format
value_type: string
description: Pretty-print containers using a Go template
deprecated: false
experimental: false
- option: last
shorthand: "n"
value_type: int
default_value: "-1"
description: Show n last created containers (includes all states)
deprecated: false
experimental: false
- option: latest
shorthand: l
value_type: bool
default_value: "false"
description: Show the latest created container (includes all states)
deprecated: false
experimental: false
- option: no-trunc
value_type: bool
default_value: "false"
description: Don't truncate output
deprecated: false
experimental: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display numeric IDs
deprecated: false
experimental: false
- option: size
shorthand: s
value_type: bool
default_value: "false"
description: Display total file sizes
deprecated: false
experimental: false
examples: |-
### Prevent truncating output
@ -68,18 +92,19 @@ examples: |-
| Filter | Description |
|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------|
| `id` | container's ID |
| `name` | container's name |
| `label` | An arbitrary string representing either a key or a key-value pair |
| `id` | Container's ID |
| `name` | Container's name |
| `label` | An arbitrary string representing either a key or a key-value pair. Expressed as `<key>` or `<key>=<value>` |
| `exited` | An integer representing the container's exit code. Only useful with `--all`. |
| `status` | One of `created|restarting|running|removing|paused|exited|dead` |
| `status` | One of `created`, `restarting`, `running`, `removing`, `paused`, `exited`, or `dead` |
| `ancestor` | Filters containers which share a given image as an ancestor. Expressed as `<image-name>[:<tag>]`, `<image id>`, or `<image@digest>` |
| `before` or `since` | Filters containers created before or after a given container ID or name |
| `volume` | Filters running containers which have mounted a given volume or bind mount. |
| `network` | Filters running containers connected to a given network. |
| `publish` or `expose` | Filters containers which publish or expose a given port. |
| `health` | One of `starting|healthy|unhealthy|none`. Filters containers based on their healthcheck status. |
| `isolation` | Windows daemon only. One of `default|process|hyperv`. |
| `publish` or `expose` | Filters containers which publish or expose a given port. Expressed as `<port>[/<proto>]` or `<startport-endport>/[<proto>]` |
| `health` | Filters containers based on their healthcheck status. One of `starting`, `healthy`, `unhealthy` or `none`. |
| `isolation` | Windows daemon only. One of `default`, `process`, or `hyperv`. |
| `is-task` | Filters containers that are a "task" for a service. Boolean option (`true` or `false`) |
#### label
@ -192,11 +217,11 @@ examples: |-
The `ancestor` filter matches containers based on its image or a descendant of
it. The filter supports the following image representation:
- image
- image:tag
- image:tag@digest
- short-id
- full-id
- `image`
- `image:tag`
- `image:tag@digest`
- `short-id`
- `full-id`
If you don't specify a `tag`, the `latest` tag is used. For example, to filter
for containers that use the latest `ubuntu` image:
@ -415,4 +440,6 @@ examples: |-
c1d3b0166030 com.docker.swarm.node=debian,com.docker.swarm.cpu=6
41d50ecd2f57 com.docker.swarm.node=fedora,com.docker.swarm.cpu=3,com.docker.swarm.storage=ssd
```
deprecated: false
experimental: false

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

@ -31,11 +31,17 @@ plink: docker.yaml
options:
- option: all-tags
shorthand: a
value_type: bool
default_value: "false"
description: Download all tagged images in the repository
deprecated: false
experimental: false
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
experimental: false
examples: |-
### Pull an image from Docker Hub
@ -234,4 +240,6 @@ examples: |-
> connection between the Docker Engine daemon and the Docker Engine client
> initiating the pull is lost. If the connection with the Engine daemon is
> lost for other reasons than a manual interaction, the pull is also aborted.
deprecated: false
experimental: false

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