From cf9d3692a364fba0eb421cb1c1864ff20bec2ee0 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 15 Jan 2024 11:19:39 +0100 Subject: [PATCH 1/4] docs: remove empty cli reference stubs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .../reference/commandline/container_attach.md | 23 -- .../reference/commandline/container_commit.md | 24 -- docs/reference/commandline/container_cp.md | 28 -- .../reference/commandline/container_create.md | 120 ------- docs/reference/commandline/container_diff.md | 15 - docs/reference/commandline/container_exec.md | 29 -- .../reference/commandline/container_export.md | 21 -- docs/reference/commandline/container_kill.md | 21 -- docs/reference/commandline/container_logs.md | 26 -- docs/reference/commandline/container_ls.md | 28 -- docs/reference/commandline/container_pause.md | 15 - docs/reference/commandline/container_port.md | 15 - .../reference/commandline/container_rename.md | 15 - .../commandline/container_restart.md | 22 -- docs/reference/commandline/container_rm.md | 23 -- docs/reference/commandline/container_run.md | 123 ------- docs/reference/commandline/container_start.md | 25 -- docs/reference/commandline/container_stats.md | 24 -- docs/reference/commandline/container_stop.md | 22 -- docs/reference/commandline/container_top.md | 15 - .../commandline/container_unpause.md | 15 - .../reference/commandline/container_update.md | 34 -- docs/reference/commandline/container_wait.md | 15 - docs/reference/commandline/image_build.md | 50 --- docs/reference/commandline/image_history.md | 24 -- docs/reference/commandline/image_import.md | 23 -- docs/reference/commandline/image_load.md | 22 -- docs/reference/commandline/image_ls.md | 26 -- docs/reference/commandline/image_pull.md | 24 -- docs/reference/commandline/image_push.md | 23 -- docs/reference/commandline/image_rm.md | 22 -- docs/reference/commandline/image_save.md | 21 -- docs/reference/commandline/image_tag.md | 15 - docs/reference/commandline/system_events.md | 338 ------------------ docs/reference/commandline/system_info.md | 18 - 35 files changed, 1304 deletions(-) delete mode 100644 docs/reference/commandline/container_attach.md delete mode 100644 docs/reference/commandline/container_commit.md delete mode 100644 docs/reference/commandline/container_cp.md delete mode 100644 docs/reference/commandline/container_create.md delete mode 100644 docs/reference/commandline/container_diff.md delete mode 100644 docs/reference/commandline/container_exec.md delete mode 100644 docs/reference/commandline/container_export.md delete mode 100644 docs/reference/commandline/container_kill.md delete mode 100644 docs/reference/commandline/container_logs.md delete mode 100644 docs/reference/commandline/container_ls.md delete mode 100644 docs/reference/commandline/container_pause.md delete mode 100644 docs/reference/commandline/container_port.md delete mode 100644 docs/reference/commandline/container_rename.md delete mode 100644 docs/reference/commandline/container_restart.md delete mode 100644 docs/reference/commandline/container_rm.md delete mode 100644 docs/reference/commandline/container_run.md delete mode 100644 docs/reference/commandline/container_start.md delete mode 100644 docs/reference/commandline/container_stats.md delete mode 100644 docs/reference/commandline/container_stop.md delete mode 100644 docs/reference/commandline/container_top.md delete mode 100644 docs/reference/commandline/container_unpause.md delete mode 100644 docs/reference/commandline/container_update.md delete mode 100644 docs/reference/commandline/container_wait.md delete mode 100644 docs/reference/commandline/image_build.md delete mode 100644 docs/reference/commandline/image_history.md delete mode 100644 docs/reference/commandline/image_import.md delete mode 100644 docs/reference/commandline/image_load.md delete mode 100644 docs/reference/commandline/image_ls.md delete mode 100644 docs/reference/commandline/image_pull.md delete mode 100644 docs/reference/commandline/image_push.md delete mode 100644 docs/reference/commandline/image_rm.md delete mode 100644 docs/reference/commandline/image_save.md delete mode 100644 docs/reference/commandline/image_tag.md delete mode 100644 docs/reference/commandline/system_events.md delete mode 100644 docs/reference/commandline/system_info.md diff --git a/docs/reference/commandline/container_attach.md b/docs/reference/commandline/container_attach.md deleted file mode 100644 index 10ce5539a293..000000000000 --- a/docs/reference/commandline/container_attach.md +++ /dev/null @@ -1,23 +0,0 @@ -# container attach - - -Attach local standard input, output, and error streams to a running container - -### Aliases - -`docker container attach`, `docker attach` - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:----------------------------------------------------| -| `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `--no-stdin` | | | Do not attach STDIN | -| `--sig-proxy` | | | Proxy all received signals to the process | - - - - -## Description - -See [docker attach](attach.md) for more information. diff --git a/docs/reference/commandline/container_commit.md b/docs/reference/commandline/container_commit.md deleted file mode 100644 index 7a4e63b9862a..000000000000 --- a/docs/reference/commandline/container_commit.md +++ /dev/null @@ -1,24 +0,0 @@ -# container commit - - -Create a new image from a container's changes - -### Aliases - -`docker container commit`, `docker commit` - -### Options - -| Name | Type | Default | Description | -|:------------------|:---------|:--------|:-----------------------------------------------------------| -| `-a`, `--author` | `string` | | Author (e.g., `John Hannibal Smith `) | -| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | -| `-m`, `--message` | `string` | | Commit message | -| `-p`, `--pause` | | | Pause container during commit | - - - - -## Description - -See [docker commit](commit.md) for more information. diff --git a/docs/reference/commandline/container_cp.md b/docs/reference/commandline/container_cp.md deleted file mode 100644 index 4c91817bd333..000000000000 --- a/docs/reference/commandline/container_cp.md +++ /dev/null @@ -1,28 +0,0 @@ -# container cp - - -Copy files/folders between a container and the local filesystem - -Use '-' as the source to read a tar archive from stdin -and extract it to a directory destination in a container. -Use '-' as the destination to stream a tar archive of a -container source to stdout. - -### Aliases - -`docker container cp`, `docker cp` - -### Options - -| Name | Type | Default | Description | -|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------| -| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | -| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | - - - - -## Description - -See [docker cp](cp.md) for more information. diff --git a/docs/reference/commandline/container_create.md b/docs/reference/commandline/container_create.md deleted file mode 100644 index 06335a52d94e..000000000000 --- a/docs/reference/commandline/container_create.md +++ /dev/null @@ -1,120 +0,0 @@ -# container create - - -Create a new container - -### Aliases - -`docker container create`, `docker create` - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) | -| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | -| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR | -| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | -| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) | -| `--cap-add` | `list` | | Add Linux capabilities | -| `--cap-drop` | `list` | | Drop Linux capabilities | -| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | -| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
default-cgroupns-mode option on the daemon (default) | -| `--cidfile` | `string` | | Write the container ID to the file | -| `--cpu-count` | `int64` | `0` | CPU count (Windows only) | -| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) | -| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | -| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | -| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds | -| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds | -| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | -| `--cpus` | `decimal` | | Number of CPUs | -| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | -| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| `--device` | `list` | | Add a host device to the container | -| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list | -| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device | -| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device | -| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device | -| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device | -| `--disable-content-trust` | | | Skip image verification | -| `--dns` | `list` | | Set custom DNS servers | -| `--dns-option` | `list` | | Set DNS options | -| `--dns-search` | `list` | | Set custom DNS search domains | -| `--domainname` | `string` | | Container NIS domain name | -| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image | -| `-e`, `--env` | `list` | | Set environment variables | -| `--env-file` | `list` | | Read in a file of environment variables | -| `--expose` | `list` | | Expose a port or a range of ports | -| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) | -| `--group-add` | `list` | | Add additional groups to join | -| `--health-cmd` | `string` | | Command to run to check health | -| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) | -| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | -| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | -| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | -| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | -| `-h`, `--hostname` | `string` | | Container host name | -| `--init` | | | Run an init inside the container that forwards signals and reaps processes | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | -| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | -| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | -| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | -| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) | -| `--ipc` | `string` | | IPC mode to use | -| `--isolation` | `string` | | Container isolation technology | -| `--kernel-memory` | `bytes` | `0` | Kernel memory limit | -| `-l`, `--label` | `list` | | Set meta data on a container | -| `--label-file` | `list` | | Read in a line delimited file of labels | -| `--link` | `list` | | Add link to another container | -| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses | -| `--log-driver` | `string` | | Logging driver for the container | -| `--log-opt` | `list` | | Log driver options | -| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) | -| `-m`, `--memory` | `bytes` | `0` | Memory limit | -| `--memory-reservation` | `bytes` | `0` | Memory soft limit | -| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap | -| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) | -| `--mount` | `mount` | | Attach a filesystem mount to the container | -| `--name` | `string` | | Assign a name to the container | -| `--network` | `network` | | Connect a container to a network | -| `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | -| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | -| `--pid` | `string` | | PID namespace to use | -| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | -| `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--privileged` | | | Give extended privileges to this container | -| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | -| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | -| `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| `--read-only` | | | Mount the container's root filesystem as read only | -| `--restart` | `string` | `no` | Restart policy to apply when a container exits | -| `--rm` | | | Automatically remove the container when it exits | -| `--runtime` | `string` | | Runtime to use for this container | -| `--security-opt` | `list` | | Security Options | -| `--shm-size` | `bytes` | `0` | Size of /dev/shm | -| `--stop-signal` | `string` | | Signal to stop the container | -| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container | -| `--storage-opt` | `list` | | Storage driver options for the container | -| `--sysctl` | `map` | `map[]` | Sysctl options | -| `--tmpfs` | `list` | | Mount a tmpfs directory | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | -| `--ulimit` | `ulimit` | | Ulimit options | -| `-u`, `--user` | `string` | | Username or UID (format: [:]) | -| `--userns` | `string` | | User namespace to use | -| `--uts` | `string` | | UTS namespace to use | -| `-v`, `--volume` | `list` | | Bind mount a volume | -| `--volume-driver` | `string` | | Optional volume driver for the container | -| `--volumes-from` | `list` | | Mount volumes from the specified container(s) | -| `-w`, `--workdir` | `string` | | Working directory inside the container | - - - - -## Description - -See [docker create](create.md) for more information. diff --git a/docs/reference/commandline/container_diff.md b/docs/reference/commandline/container_diff.md deleted file mode 100644 index 03e537c5eee0..000000000000 --- a/docs/reference/commandline/container_diff.md +++ /dev/null @@ -1,15 +0,0 @@ -# container diff - - -Inspect changes to files or directories on a container's filesystem - -### Aliases - -`docker container diff`, `docker diff` - - - - -## Description - -See [docker diff](diff.md) for more information. diff --git a/docs/reference/commandline/container_exec.md b/docs/reference/commandline/container_exec.md deleted file mode 100644 index 1f7d4aa4faba..000000000000 --- a/docs/reference/commandline/container_exec.md +++ /dev/null @@ -1,29 +0,0 @@ -# container exec - - -Execute a command in a running container - -### Aliases - -`docker container exec`, `docker exec` - -### Options - -| Name | Type | Default | Description | -|:----------------------|:---------|:--------|:-------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: run command in the background | -| `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `-e`, `--env` | `list` | | Set environment variables | -| `--env-file` | `list` | | Read in a file of environment variables | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | -| `--privileged` | | | Give extended privileges to the command | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | -| `-u`, `--user` | `string` | | Username or UID (format: `[:]`) | -| `-w`, `--workdir` | `string` | | Working directory inside the container | - - - - -## Description - -See [docker exec](exec.md) for more information. diff --git a/docs/reference/commandline/container_export.md b/docs/reference/commandline/container_export.md deleted file mode 100644 index c0f12205874e..000000000000 --- a/docs/reference/commandline/container_export.md +++ /dev/null @@ -1,21 +0,0 @@ -# container export - - -Export a container's filesystem as a tar archive - -### Aliases - -`docker container export`, `docker export` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-----------------------------------| -| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | - - - - -## Description - -See [docker export](export.md) for more information. diff --git a/docs/reference/commandline/container_kill.md b/docs/reference/commandline/container_kill.md deleted file mode 100644 index a7febea02ee0..000000000000 --- a/docs/reference/commandline/container_kill.md +++ /dev/null @@ -1,21 +0,0 @@ -# container kill - - -Kill one or more running containers - -### Aliases - -`docker container kill`, `docker kill` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:--------------------------------| -| `-s`, `--signal` | `string` | | Signal to send to the container | - - - - -## Description - -See [docker kill](kill.md) for more information. diff --git a/docs/reference/commandline/container_logs.md b/docs/reference/commandline/container_logs.md deleted file mode 100644 index f35a96d2b902..000000000000 --- a/docs/reference/commandline/container_logs.md +++ /dev/null @@ -1,26 +0,0 @@ -# container logs - - -Fetch the logs of a container - -### Aliases - -`docker container logs`, `docker logs` - -### Options - -| Name | Type | Default | Description | -|:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------| -| `--details` | | | Show extra details provided to logs | -| `-f`, `--follow` | | | Follow log output | -| `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | -| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs | -| `-t`, `--timestamps` | | | Show timestamps | -| `--until` | `string` | | Show logs before a timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | - - - - -## Description - -See [docker logs](logs.md) for more information. diff --git a/docs/reference/commandline/container_ls.md b/docs/reference/commandline/container_ls.md deleted file mode 100644 index 76fb07c75ee3..000000000000 --- a/docs/reference/commandline/container_ls.md +++ /dev/null @@ -1,28 +0,0 @@ -# container ls - - -List containers - -### Aliases - -`docker container ls`, `docker container list`, `docker container ps`, `docker ps` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all containers (default shows just running) | -| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-n`, `--last` | `int` | `-1` | Show n last created containers (includes all states) | -| `-l`, `--latest` | | | Show the latest created container (includes all states) | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only display container IDs | -| `-s`, `--size` | | | Display total file sizes | - - - - -## Description - -See [docker ps](ps.md) for more information. diff --git a/docs/reference/commandline/container_pause.md b/docs/reference/commandline/container_pause.md deleted file mode 100644 index bdd0ec7bc90b..000000000000 --- a/docs/reference/commandline/container_pause.md +++ /dev/null @@ -1,15 +0,0 @@ -# container pause - - -Pause all processes within one or more containers - -### Aliases - -`docker container pause`, `docker pause` - - - - -## Description - -See [docker pause](pause.md) for more information. diff --git a/docs/reference/commandline/container_port.md b/docs/reference/commandline/container_port.md deleted file mode 100644 index bf27663ee7d6..000000000000 --- a/docs/reference/commandline/container_port.md +++ /dev/null @@ -1,15 +0,0 @@ -# container port - - -List port mappings or a specific mapping for the container - -### Aliases - -`docker container port`, `docker port` - - - - -## Description - -See [docker port](port.md) for more information. diff --git a/docs/reference/commandline/container_rename.md b/docs/reference/commandline/container_rename.md deleted file mode 100644 index ecb5c786d55f..000000000000 --- a/docs/reference/commandline/container_rename.md +++ /dev/null @@ -1,15 +0,0 @@ -# container rename - - -Rename a container - -### Aliases - -`docker container rename`, `docker rename` - - - - -## Description - -See [docker rename](rename.md) for more information. diff --git a/docs/reference/commandline/container_restart.md b/docs/reference/commandline/container_restart.md deleted file mode 100644 index 2a6d41166775..000000000000 --- a/docs/reference/commandline/container_restart.md +++ /dev/null @@ -1,22 +0,0 @@ -# container restart - - -Restart one or more containers - -### Aliases - -`docker container restart`, `docker restart` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:---------------------------------------------| -| `-s`, `--signal` | `string` | | Signal to send to the container | -| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container | - - - - -## Description - -See [docker restart](restart.md) for more information. diff --git a/docs/reference/commandline/container_rm.md b/docs/reference/commandline/container_rm.md deleted file mode 100644 index 58b0f0deda70..000000000000 --- a/docs/reference/commandline/container_rm.md +++ /dev/null @@ -1,23 +0,0 @@ -# container rm - - -Remove one or more containers - -### Aliases - -`docker container rm`, `docker container remove`, `docker rm` - -### Options - -| Name | Type | Default | Description | -|:------------------|:-----|:--------|:--------------------------------------------------------| -| `-f`, `--force` | | | Force the removal of a running container (uses SIGKILL) | -| `-l`, `--link` | | | Remove the specified link | -| `-v`, `--volumes` | | | Remove anonymous volumes associated with the container | - - - - -## Description - -See [docker rm](rm.md) for more information. diff --git a/docs/reference/commandline/container_run.md b/docs/reference/commandline/container_run.md deleted file mode 100644 index f5449e845695..000000000000 --- a/docs/reference/commandline/container_run.md +++ /dev/null @@ -1,123 +0,0 @@ -# container run - - -Create and run a new container from an image - -### Aliases - -`docker container run`, `docker run` - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) | -| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | -| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR | -| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | -| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) | -| `--cap-add` | `list` | | Add Linux capabilities | -| `--cap-drop` | `list` | | Drop Linux capabilities | -| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | -| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
default-cgroupns-mode option on the daemon (default) | -| `--cidfile` | `string` | | Write the container ID to the file | -| `--cpu-count` | `int64` | `0` | CPU count (Windows only) | -| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) | -| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | -| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | -| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds | -| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds | -| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | -| `--cpus` | `decimal` | | Number of CPUs | -| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | -| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| `-d`, `--detach` | | | Run container in background and print container ID | -| `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `--device` | `list` | | Add a host device to the container | -| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list | -| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device | -| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device | -| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device | -| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device | -| `--disable-content-trust` | | | Skip image verification | -| `--dns` | `list` | | Set custom DNS servers | -| `--dns-option` | `list` | | Set DNS options | -| `--dns-search` | `list` | | Set custom DNS search domains | -| `--domainname` | `string` | | Container NIS domain name | -| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image | -| `-e`, `--env` | `list` | | Set environment variables | -| `--env-file` | `list` | | Read in a file of environment variables | -| `--expose` | `list` | | Expose a port or a range of ports | -| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) | -| `--group-add` | `list` | | Add additional groups to join | -| `--health-cmd` | `string` | | Command to run to check health | -| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) | -| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | -| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | -| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | -| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | -| `-h`, `--hostname` | `string` | | Container host name | -| `--init` | | | Run an init inside the container that forwards signals and reaps processes | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | -| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | -| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | -| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | -| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) | -| `--ipc` | `string` | | IPC mode to use | -| `--isolation` | `string` | | Container isolation technology | -| `--kernel-memory` | `bytes` | `0` | Kernel memory limit | -| `-l`, `--label` | `list` | | Set meta data on a container | -| `--label-file` | `list` | | Read in a line delimited file of labels | -| `--link` | `list` | | Add link to another container | -| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses | -| `--log-driver` | `string` | | Logging driver for the container | -| `--log-opt` | `list` | | Log driver options | -| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) | -| `-m`, `--memory` | `bytes` | `0` | Memory limit | -| `--memory-reservation` | `bytes` | `0` | Memory soft limit | -| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap | -| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) | -| `--mount` | `mount` | | Attach a filesystem mount to the container | -| `--name` | `string` | | Assign a name to the container | -| `--network` | `network` | | Connect a container to a network | -| `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | -| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | -| `--pid` | `string` | | PID namespace to use | -| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | -| `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--privileged` | | | Give extended privileges to this container | -| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | -| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | -| `--pull` | `string` | `missing` | Pull image before running (`always`, `missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| `--read-only` | | | Mount the container's root filesystem as read only | -| `--restart` | `string` | `no` | Restart policy to apply when a container exits | -| `--rm` | | | Automatically remove the container when it exits | -| `--runtime` | `string` | | Runtime to use for this container | -| `--security-opt` | `list` | | Security Options | -| `--shm-size` | `bytes` | `0` | Size of /dev/shm | -| `--sig-proxy` | | | Proxy received signals to the process | -| `--stop-signal` | `string` | | Signal to stop the container | -| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container | -| `--storage-opt` | `list` | | Storage driver options for the container | -| `--sysctl` | `map` | `map[]` | Sysctl options | -| `--tmpfs` | `list` | | Mount a tmpfs directory | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | -| `--ulimit` | `ulimit` | | Ulimit options | -| `-u`, `--user` | `string` | | Username or UID (format: [:]) | -| `--userns` | `string` | | User namespace to use | -| `--uts` | `string` | | UTS namespace to use | -| `-v`, `--volume` | `list` | | Bind mount a volume | -| `--volume-driver` | `string` | | Optional volume driver for the container | -| `--volumes-from` | `list` | | Mount volumes from the specified container(s) | -| `-w`, `--workdir` | `string` | | Working directory inside the container | - - - - -## Description - -See [docker run](run.md) for more information. diff --git a/docs/reference/commandline/container_start.md b/docs/reference/commandline/container_start.md deleted file mode 100644 index 9ad73bcc341a..000000000000 --- a/docs/reference/commandline/container_start.md +++ /dev/null @@ -1,25 +0,0 @@ -# container start - - -Start one or more stopped containers - -### Aliases - -`docker container start`, `docker start` - -### Options - -| Name | Type | Default | Description | -|:----------------------|:---------|:--------|:----------------------------------------------------| -| `-a`, `--attach` | | | Attach STDOUT/STDERR and forward signals | -| `--checkpoint` | `string` | | Restore from this checkpoint | -| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | -| `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `-i`, `--interactive` | | | Attach container's STDIN | - - - - -## Description - -See [docker start](start.md) for more information. diff --git a/docs/reference/commandline/container_stats.md b/docs/reference/commandline/container_stats.md deleted file mode 100644 index 6c42550f83c4..000000000000 --- a/docs/reference/commandline/container_stats.md +++ /dev/null @@ -1,24 +0,0 @@ -# container stats - - -Display a live stream of container(s) resource usage statistics - -### Aliases - -`docker container stats`, `docker stats` - -### Options - -| Name | Type | Default | Description | -|:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all containers (default shows just running) | -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-stream` | | | Disable streaming stats and only pull the first result | -| `--no-trunc` | | | Do not truncate output | - - - - -## Description - -See [docker stats](stats.md) for more information. diff --git a/docs/reference/commandline/container_stop.md b/docs/reference/commandline/container_stop.md deleted file mode 100644 index e61890b07157..000000000000 --- a/docs/reference/commandline/container_stop.md +++ /dev/null @@ -1,22 +0,0 @@ -# container stop - - -Stop one or more running containers - -### Aliases - -`docker container stop`, `docker stop` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:---------------------------------------------| -| `-s`, `--signal` | `string` | | Signal to send to the container | -| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container | - - - - -## Description - -See [docker stop](stop.md) for more information. diff --git a/docs/reference/commandline/container_top.md b/docs/reference/commandline/container_top.md deleted file mode 100644 index f314f2a40196..000000000000 --- a/docs/reference/commandline/container_top.md +++ /dev/null @@ -1,15 +0,0 @@ -# container top - - -Display the running processes of a container - -### Aliases - -`docker container top`, `docker top` - - - - -## Description - -See [docker top](top.md) for more information. diff --git a/docs/reference/commandline/container_unpause.md b/docs/reference/commandline/container_unpause.md deleted file mode 100644 index bd5e34761c2c..000000000000 --- a/docs/reference/commandline/container_unpause.md +++ /dev/null @@ -1,15 +0,0 @@ -# container unpause - - -Unpause all processes within one or more containers - -### Aliases - -`docker container unpause`, `docker unpause` - - - - -## Description - -See [docker unpause](unpause.md) for more information. diff --git a/docs/reference/commandline/container_update.md b/docs/reference/commandline/container_update.md deleted file mode 100644 index 9095e298e9e9..000000000000 --- a/docs/reference/commandline/container_update.md +++ /dev/null @@ -1,34 +0,0 @@ -# container update - - -Update configuration of one or more containers - -### Aliases - -`docker container update`, `docker update` - -### Options - -| Name | Type | Default | Description | -|:-----------------------|:----------|:--------|:-----------------------------------------------------------------------------| -| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | -| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | -| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | -| `--cpu-rt-period` | `int64` | `0` | Limit the CPU real-time period in microseconds | -| `--cpu-rt-runtime` | `int64` | `0` | Limit the CPU real-time runtime in microseconds | -| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | -| `--cpus` | `decimal` | | Number of CPUs | -| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | -| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| `-m`, `--memory` | `bytes` | `0` | Memory limit | -| `--memory-reservation` | `bytes` | `0` | Memory soft limit | -| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | -| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | -| `--restart` | `string` | | Restart policy to apply when a container exits | - - - - -## Description - -See [docker update](update.md) for more information. diff --git a/docs/reference/commandline/container_wait.md b/docs/reference/commandline/container_wait.md deleted file mode 100644 index 013ea92c1c35..000000000000 --- a/docs/reference/commandline/container_wait.md +++ /dev/null @@ -1,15 +0,0 @@ -# container wait - - -Block until one or more containers stop, then print their exit codes - -### Aliases - -`docker container wait`, `docker wait` - - - - -## Description - -See [docker wait](wait.md) for more information. diff --git a/docs/reference/commandline/image_build.md b/docs/reference/commandline/image_build.md deleted file mode 100644 index e27c85964ec3..000000000000 --- a/docs/reference/commandline/image_build.md +++ /dev/null @@ -1,50 +0,0 @@ -# image build - - -Build an image from a Dockerfile - -### Aliases - -`docker image build`, `docker build`, `docker buildx build`, `docker builder build` - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:--------------|:----------|:------------------------------------------------------------------| -| `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) | -| `--build-arg` | `list` | | Set build-time variables | -| `--cache-from` | `stringSlice` | | Images to consider as cache sources | -| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--compress` | | | Compress the build context using gzip | -| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | -| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | -| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | -| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | -| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| `--disable-content-trust` | | | Skip image verification | -| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) | -| `--force-rm` | | | Always remove intermediate containers | -| `--iidfile` | `string` | | Write the image ID to the file | -| `--isolation` | `string` | | Container isolation technology | -| `--label` | `list` | | Set metadata for an image | -| `-m`, `--memory` | `bytes` | `0` | Memory limit | -| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | -| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build | -| `--no-cache` | | | Do not use cache when building the image | -| `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--pull` | | | Always attempt to pull a newer version of the image | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | -| `--rm` | | | Remove intermediate containers after a successful build | -| `--security-opt` | `stringSlice` | | Security options | -| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | -| `--squash` | | | Squash newly built layers into a single new layer | -| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format | -| `--target` | `string` | | Set the target build stage to build. | -| `--ulimit` | `ulimit` | | Ulimit options | - - - - -## Description - -See [docker build](build.md) for more information. diff --git a/docs/reference/commandline/image_history.md b/docs/reference/commandline/image_history.md deleted file mode 100644 index 97f437cfb025..000000000000 --- a/docs/reference/commandline/image_history.md +++ /dev/null @@ -1,24 +0,0 @@ -# image history - - -Show the history of an image - -### Aliases - -`docker image history`, `docker history` - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-H`, `--human` | | | Print sizes and dates in human readable format | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | - - - - -## Description - -See [docker history](history.md) for more information. diff --git a/docs/reference/commandline/image_import.md b/docs/reference/commandline/image_import.md deleted file mode 100644 index 0399a919c501..000000000000 --- a/docs/reference/commandline/image_import.md +++ /dev/null @@ -1,23 +0,0 @@ -# image import - - -Import the contents from a tarball to create a filesystem image - -### Aliases - -`docker image import`, `docker import` - -### Options - -| Name | Type | Default | Description | -|:------------------|:---------|:--------|:--------------------------------------------------| -| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | -| `-m`, `--message` | `string` | | Set commit message for imported image | -| `--platform` | `string` | | Set platform if server is multi-platform capable | - - - - -## Description - -See [docker import](import.md) for more information. diff --git a/docs/reference/commandline/image_load.md b/docs/reference/commandline/image_load.md deleted file mode 100644 index b78855c36184..000000000000 --- a/docs/reference/commandline/image_load.md +++ /dev/null @@ -1,22 +0,0 @@ -# image load - - -Load an image from a tar archive or STDIN - -### Aliases - -`docker image load`, `docker load` - -### Options - -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:---------------------------------------------| -| `-i`, `--input` | `string` | | Read from tar archive file, instead of STDIN | -| `-q`, `--quiet` | | | Suppress the load output | - - - - -## Description - -See [docker load](load.md) for more information. diff --git a/docs/reference/commandline/image_ls.md b/docs/reference/commandline/image_ls.md deleted file mode 100644 index 7cabd920f0e7..000000000000 --- a/docs/reference/commandline/image_ls.md +++ /dev/null @@ -1,26 +0,0 @@ -# image ls - - -List images - -### Aliases - -`docker image ls`, `docker image list`, `docker images` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all images (default hides intermediate images) | -| `--digests` | | | Show digests | -| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | - - - - -## Description - -See [docker images](images.md) for more information. diff --git a/docs/reference/commandline/image_pull.md b/docs/reference/commandline/image_pull.md deleted file mode 100644 index d9f298eecb0b..000000000000 --- a/docs/reference/commandline/image_pull.md +++ /dev/null @@ -1,24 +0,0 @@ -# image pull - - -Download an image from a registry - -### Aliases - -`docker image pull`, `docker pull` - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:-------------------------------------------------| -| `-a`, `--all-tags` | | | Download all tagged images in the repository | -| `--disable-content-trust` | | | Skip image verification | -| `--platform` | `string` | | Set platform if server is multi-platform capable | -| `-q`, `--quiet` | | | Suppress verbose output | - - - - -## Description - -See [docker pull](pull.md) for more information. diff --git a/docs/reference/commandline/image_push.md b/docs/reference/commandline/image_push.md deleted file mode 100644 index 964b61aec121..000000000000 --- a/docs/reference/commandline/image_push.md +++ /dev/null @@ -1,23 +0,0 @@ -# image push - - -Upload an image to a registry - -### Aliases - -`docker image push`, `docker push` - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:-----|:--------|:--------------------------------------------| -| `-a`, `--all-tags` | | | Push all tags of an image to the repository | -| `--disable-content-trust` | | | Skip image signing | -| `-q`, `--quiet` | | | Suppress verbose output | - - - - -## Description - -See [docker push](push.md) for more information. diff --git a/docs/reference/commandline/image_rm.md b/docs/reference/commandline/image_rm.md deleted file mode 100644 index 4bd4e3f9e2cc..000000000000 --- a/docs/reference/commandline/image_rm.md +++ /dev/null @@ -1,22 +0,0 @@ -# image rm - - -Remove one or more images - -### Aliases - -`docker image rm`, `docker image remove`, `docker rmi` - -### Options - -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------------------| -| `-f`, `--force` | | | Force removal of the image | -| `--no-prune` | | | Do not delete untagged parents | - - - - -## Description - -See [docker rmi](rmi.md) for more information. diff --git a/docs/reference/commandline/image_save.md b/docs/reference/commandline/image_save.md deleted file mode 100644 index 77aa3cdf8f5f..000000000000 --- a/docs/reference/commandline/image_save.md +++ /dev/null @@ -1,21 +0,0 @@ -# image save - - -Save one or more images to a tar archive (streamed to STDOUT by default) - -### Aliases - -`docker image save`, `docker save` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-----------------------------------| -| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | - - - - -## Description - -See [docker save](save.md) for more information. diff --git a/docs/reference/commandline/image_tag.md b/docs/reference/commandline/image_tag.md deleted file mode 100644 index 55dcdf72094e..000000000000 --- a/docs/reference/commandline/image_tag.md +++ /dev/null @@ -1,15 +0,0 @@ -# image tag - - -Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE - -### Aliases - -`docker image tag`, `docker tag` - - - - -## Description - -See [docker tag](tag.md) for more information. diff --git a/docs/reference/commandline/system_events.md b/docs/reference/commandline/system_events.md deleted file mode 100644 index ec5c83cf19ae..000000000000 --- a/docs/reference/commandline/system_events.md +++ /dev/null @@ -1,338 +0,0 @@ -# system events - - -Get real time events from the server - -### Aliases - -`docker system events`, `docker events` - -### Options - -| Name | Type | Default | Description | -|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | -| [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--since` | `string` | | Show all events created since timestamp | -| `--until` | `string` | | Stream events until this timestamp | - - - - -## Description - -Use `docker system events` to get real-time events from the server. These -events differ per Docker object type. - -### Object types - -#### Containers - -Docker containers report the following events: - -- `attach` -- `commit` -- `copy` -- `create` -- `destroy` -- `detach` -- `die` -- `exec_create` -- `exec_detach` -- `exec_die` -- `exec_start` -- `export` -- `health_status` -- `kill` -- `oom` -- `pause` -- `rename` -- `resize` -- `restart` -- `start` -- `stop` -- `top` -- `unpause` -- `update` - -#### Images - -Docker images report the following events: - -- `delete` -- `import` -- `load` -- `pull` -- `push` -- `save` -- `tag` -- `untag` - -#### Plugins - -Docker plugins report the following events: - -- `install` -- `enable` -- `disable` -- `remove` - -#### Volumes - -Docker volumes report the following events: - -- `create` -- `mount` -- `unmount` -- `destroy` - -#### Networks - -Docker networks report the following events: - -- `create` -- `connect` -- `disconnect` -- `destroy` - -#### Daemons - -Docker daemons report the following events: - -- `reload` - -### Limiting, filtering, and formatting the output - -#### Limit events by time - -The `--since` and `--until` parameters can be Unix timestamps, date formatted -timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed -relative to the client machine’s time. If you do not provide the `--since` option, -the command returns only new and/or live events. Supported formats for date -formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`, -`2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local -timezone on the client will be used if you do not provide either a `Z` or a -`+-00:00` timezone offset at the end of the timestamp. When providing Unix -timestamps enter seconds[.nanoseconds], where seconds is the number of seconds -that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap -seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a -fraction of a second no more than nine digits long. - -#### Filtering (--filter) - -The filtering flag (`-f` or `--filter`) format is of "key=value". If you would -like to use multiple filters, pass multiple flags (e.g., -`--filter "foo=bar" --filter "bif=baz"`) - -Using the same filter multiple times will be handled as a logical `OR`; for example, -`--filter container=588a23dac085 --filter container=a8f7720b8c22` displays -events for container `588a23dac085` or container `a8f7720b8c22`. - -Using multiple filters will be handled as a logical `AND`; for example, -`--filter container=588a23dac085 --filter event=start` displays events for -container `588a23dac085` and where the event type is `start`. - -The currently supported filters are: - -- container (`container=`) -- daemon (`daemon=`) -- event (`event=`) -- image (`image=`) -- label (`label=` or `label==`) -- network (`network=`) -- plugin (`plugin=`) -- type (`type=`) -- volume (`volume=`) - -## Examples - -### Basic example - -You'll need two shells for this example. - -**Shell 1: Listening for events:** - -```console -$ docker system events -``` - -**Shell 2: Start and Stop containers:** - -```console -$ docker create --name test alpine:latest top -$ docker start test -$ docker stop test -``` - -**Shell 1: (Again .. now showing events):** - -```console -2017-01-05T00:35:58.859401177+08:00 container create 0fdb48addc82871eb34eb23a847cfd033dedd1a0a37bef2e6d9eb3870fc7ff37 (image=alpine:latest, name=test) -2017-01-05T00:36:04.703631903+08:00 network connect e2e1f5ceda09d4300f3a846f0acfaa9a8bb0d89e775eb744c5acecd60e0529e2 (container=0fdb...ff37, name=bridge, type=bridge) -2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) -2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -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) -``` - -To exit the `docker system events` command, use `CTRL+C`. - -### Filter events by time - -You can filter the output by an absolute timestamp or relative time on the host -machine, using the following different time formats: - -```console -$ docker system events --since 1483283804 - -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) -2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -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 system events --since '2017-01-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) -2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -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 system events --since '2013-09-03T15:49:29' - -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) -2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -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 system events --since '10m' - -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) -2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -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) -``` - -### Filter events by criteria - -The following commands show several different ways to filter the `docker event` -output. - -```console -$ docker system events --filter 'event=stop' - -2017-01-05T00:40:22.880175420+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) -2017-01-05T00:41:17.888104182+08:00 container stop 2a8f...4e78 (image=alpine, name=kickass_brattain) - -$ docker system events --filter 'image=alpine' - -2017-01-05T00:41:55.784240236+08:00 container create d9cd...4d70 (image=alpine, name=happy_meitner) -2017-01-05T00:41:55.913156783+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) -2017-01-05T00:42:01.106875249+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=15) -2017-01-05T00:42:11.111934041+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=9) -2017-01-05T00:42:11.119578204+08:00 container die d9cd...4d70 (exitCode=137, image=alpine, name=happy_meitner) -2017-01-05T00:42:11.173276611+08:00 container stop d9cd...4d70 (image=alpine, name=happy_meitner) - -$ docker system events --filter 'container=test' - -2017-01-05T00:43:00.139719934+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) -2017-01-05T00:43:09.259951086+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) -2017-01-05T00:43:09.270102715+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) -2017-01-05T00:43:09.312556440+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) - -$ docker system events --filter 'container=test' --filter 'container=d9cdb1525ea8' - -2017-01-05T00:44:11.517071981+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) -2017-01-05T00:44:17.685870901+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) -2017-01-05T00:44:29.757658470+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=9) -2017-01-05T00:44:29.767718510+08:00 container die 0fdb...ff37 (exitCode=137, image=alpine:latest, name=test) -2017-01-05T00:44:29.815798344+08:00 container destroy 0fdb...ff37 (image=alpine:latest, name=test) - -$ docker system events --filter 'container=test' --filter 'event=stop' - -2017-01-05T00:46:13.664099505+08:00 container stop a9d1...e130 (image=alpine, name=test) - -$ docker system events --filter 'type=volume' - -2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) -2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562f...5025, destination=/foo, driver=local, propagation=rprivate) -2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562f...5025, driver=local) -2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - -$ docker system events --filter 'type=network' - -2015-12-23T21:38:24.705709133Z network create 8b11...2c5b (name=test-event-network-local, type=bridge) -2015-12-23T21:38:25.119625123Z network connect 8b11...2c5b (name=test-event-network-local, container=b4be...c54e, type=bridge) - -$ docker system events --filter 'container=container_1' --filter 'container=container_2' - -2014-09-03T15:49:29.999999999Z07:00 container die 4386fb97867d (image=ubuntu:22.04 ) -2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu:22.04 ) -2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (imager=redis:2.8) -2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8) - -$ docker system events --filter 'type=volume' - -2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) -2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, destination=/foo, driver=local, propagation=rprivate) -2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, driver=local) -2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) - -$ docker system events --filter 'type=network' - -2015-12-23T21:38:24.705709133Z network create 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, type=bridge) -2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge) - -$ docker system events --filter 'type=plugin' - -2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) -2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) -``` - -### Format the output (--format) - -If you specify a format (`--format`), the given template is executed -instead of the default format. Go's [text/template](https://pkg.go.dev/text/template) -package describes all the details of the format. - -```console -$ docker system events --filter 'type=container' --format 'Type={{.Type}} Status={{.Status}} ID={{.ID}}' - -Type=container Status=create ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -Type=container Status=attach ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -Type=container Status=start ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -Type=container Status=resize ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -Type=container Status=die ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 -``` - -#### Format as JSON - -If a format is set to `{{json .}}`, events are streamed in the JSON Lines format. -For information about JSON Lines, see . - -```console -$ docker system events --format '{{json .}}' - -{"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. -{"status":"attach","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. -{"Type":"network","Action":"connect","Actor":{"ID":"1b50a5bf755f6021dfa78e.. -{"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. -{"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. -``` diff --git a/docs/reference/commandline/system_info.md b/docs/reference/commandline/system_info.md deleted file mode 100644 index e85ace33824a..000000000000 --- a/docs/reference/commandline/system_info.md +++ /dev/null @@ -1,18 +0,0 @@ -# system info - - -Display system-wide information - -### Aliases - -`docker system info`, `docker info` - -### Options - -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-f`, `--format` | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | - - - - From a6774de6827624db258915a61246fec0808d8a40 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 15 Jan 2024 11:27:58 +0100 Subject: [PATCH 2/4] docs: rename cli reference aliases to canonical Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .../{attach.md => container_attach.md} | 0 .../{commit.md => container_commit.md} | 0 .../commandline/{cp.md => container_cp.md} | 0 .../{create.md => container_create.md} | 0 .../{diff.md => container_diff.md} | 0 .../{exec.md => container_exec.md} | 0 .../{export.md => container_export.md} | 0 .../{kill.md => container_kill.md} | 0 .../{logs.md => container_logs.md} | 0 .../commandline/{ps.md => container_ls.md} | 0 .../{pause.md => container_pause.md} | 0 .../{port.md => container_port.md} | 0 .../{rename.md => container_rename.md} | 0 .../{restart.md => container_restart.md} | 0 .../commandline/{rm.md => container_rm.md} | 0 .../commandline/{run.md => container_run.md} | 0 .../{start.md => container_start.md} | 0 .../{stats.md => container_stats.md} | 0 .../{stop.md => container_stop.md} | 0 .../commandline/{top.md => container_top.md} | 0 .../{unpause.md => container_unpause.md} | 0 .../{update.md => container_update.md} | 0 .../{wait.md => container_wait.md} | 0 .../commandline/{build.md => image_build.md} | 0 .../{history.md => image_history.md} | 0 .../{import.md => image_import.md} | 0 .../commandline/{load.md => image_load.md} | 0 .../commandline/{images.md => image_ls.md} | 0 .../commandline/{pull.md => image_pull.md} | 0 .../commandline/{push.md => image_push.md} | 0 .../commandline/{rmi.md => image_rm.md} | 0 .../commandline/{save.md => image_save.md} | 0 .../commandline/{tag.md => image_tag.md} | 0 docs/reference/commandline/index.md | 130 +++++++++--------- .../{events.md => system_events.md} | 0 .../commandline/{info.md => system_info.md} | 0 docs/reference/run.md | 12 +- 37 files changed, 70 insertions(+), 72 deletions(-) rename docs/reference/commandline/{attach.md => container_attach.md} (100%) rename docs/reference/commandline/{commit.md => container_commit.md} (100%) rename docs/reference/commandline/{cp.md => container_cp.md} (100%) rename docs/reference/commandline/{create.md => container_create.md} (100%) rename docs/reference/commandline/{diff.md => container_diff.md} (100%) rename docs/reference/commandline/{exec.md => container_exec.md} (100%) rename docs/reference/commandline/{export.md => container_export.md} (100%) rename docs/reference/commandline/{kill.md => container_kill.md} (100%) rename docs/reference/commandline/{logs.md => container_logs.md} (100%) rename docs/reference/commandline/{ps.md => container_ls.md} (100%) rename docs/reference/commandline/{pause.md => container_pause.md} (100%) rename docs/reference/commandline/{port.md => container_port.md} (100%) rename docs/reference/commandline/{rename.md => container_rename.md} (100%) rename docs/reference/commandline/{restart.md => container_restart.md} (100%) rename docs/reference/commandline/{rm.md => container_rm.md} (100%) rename docs/reference/commandline/{run.md => container_run.md} (100%) rename docs/reference/commandline/{start.md => container_start.md} (100%) rename docs/reference/commandline/{stats.md => container_stats.md} (100%) rename docs/reference/commandline/{stop.md => container_stop.md} (100%) rename docs/reference/commandline/{top.md => container_top.md} (100%) rename docs/reference/commandline/{unpause.md => container_unpause.md} (100%) rename docs/reference/commandline/{update.md => container_update.md} (100%) rename docs/reference/commandline/{wait.md => container_wait.md} (100%) rename docs/reference/commandline/{build.md => image_build.md} (100%) rename docs/reference/commandline/{history.md => image_history.md} (100%) rename docs/reference/commandline/{import.md => image_import.md} (100%) rename docs/reference/commandline/{load.md => image_load.md} (100%) rename docs/reference/commandline/{images.md => image_ls.md} (100%) rename docs/reference/commandline/{pull.md => image_pull.md} (100%) rename docs/reference/commandline/{push.md => image_push.md} (100%) rename docs/reference/commandline/{rmi.md => image_rm.md} (100%) rename docs/reference/commandline/{save.md => image_save.md} (100%) rename docs/reference/commandline/{tag.md => image_tag.md} (100%) rename docs/reference/commandline/{events.md => system_events.md} (100%) rename docs/reference/commandline/{info.md => system_info.md} (100%) diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/container_attach.md similarity index 100% rename from docs/reference/commandline/attach.md rename to docs/reference/commandline/container_attach.md diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/container_commit.md similarity index 100% rename from docs/reference/commandline/commit.md rename to docs/reference/commandline/container_commit.md diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/container_cp.md similarity index 100% rename from docs/reference/commandline/cp.md rename to docs/reference/commandline/container_cp.md diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/container_create.md similarity index 100% rename from docs/reference/commandline/create.md rename to docs/reference/commandline/container_create.md diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/container_diff.md similarity index 100% rename from docs/reference/commandline/diff.md rename to docs/reference/commandline/container_diff.md diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/container_exec.md similarity index 100% rename from docs/reference/commandline/exec.md rename to docs/reference/commandline/container_exec.md diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/container_export.md similarity index 100% rename from docs/reference/commandline/export.md rename to docs/reference/commandline/container_export.md diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/container_kill.md similarity index 100% rename from docs/reference/commandline/kill.md rename to docs/reference/commandline/container_kill.md diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/container_logs.md similarity index 100% rename from docs/reference/commandline/logs.md rename to docs/reference/commandline/container_logs.md diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/container_ls.md similarity index 100% rename from docs/reference/commandline/ps.md rename to docs/reference/commandline/container_ls.md diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/container_pause.md similarity index 100% rename from docs/reference/commandline/pause.md rename to docs/reference/commandline/container_pause.md diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/container_port.md similarity index 100% rename from docs/reference/commandline/port.md rename to docs/reference/commandline/container_port.md diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/container_rename.md similarity index 100% rename from docs/reference/commandline/rename.md rename to docs/reference/commandline/container_rename.md diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/container_restart.md similarity index 100% rename from docs/reference/commandline/restart.md rename to docs/reference/commandline/container_restart.md diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/container_rm.md similarity index 100% rename from docs/reference/commandline/rm.md rename to docs/reference/commandline/container_rm.md diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/container_run.md similarity index 100% rename from docs/reference/commandline/run.md rename to docs/reference/commandline/container_run.md diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/container_start.md similarity index 100% rename from docs/reference/commandline/start.md rename to docs/reference/commandline/container_start.md diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/container_stats.md similarity index 100% rename from docs/reference/commandline/stats.md rename to docs/reference/commandline/container_stats.md diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/container_stop.md similarity index 100% rename from docs/reference/commandline/stop.md rename to docs/reference/commandline/container_stop.md diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/container_top.md similarity index 100% rename from docs/reference/commandline/top.md rename to docs/reference/commandline/container_top.md diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/container_unpause.md similarity index 100% rename from docs/reference/commandline/unpause.md rename to docs/reference/commandline/container_unpause.md diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/container_update.md similarity index 100% rename from docs/reference/commandline/update.md rename to docs/reference/commandline/container_update.md diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/container_wait.md similarity index 100% rename from docs/reference/commandline/wait.md rename to docs/reference/commandline/container_wait.md diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/image_build.md similarity index 100% rename from docs/reference/commandline/build.md rename to docs/reference/commandline/image_build.md diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/image_history.md similarity index 100% rename from docs/reference/commandline/history.md rename to docs/reference/commandline/image_history.md diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/image_import.md similarity index 100% rename from docs/reference/commandline/import.md rename to docs/reference/commandline/image_import.md diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/image_load.md similarity index 100% rename from docs/reference/commandline/load.md rename to docs/reference/commandline/image_load.md diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/image_ls.md similarity index 100% rename from docs/reference/commandline/images.md rename to docs/reference/commandline/image_ls.md diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/image_pull.md similarity index 100% rename from docs/reference/commandline/pull.md rename to docs/reference/commandline/image_pull.md diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/image_push.md similarity index 100% rename from docs/reference/commandline/push.md rename to docs/reference/commandline/image_push.md diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/image_rm.md similarity index 100% rename from docs/reference/commandline/rmi.md rename to docs/reference/commandline/image_rm.md diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/image_save.md similarity index 100% rename from docs/reference/commandline/save.md rename to docs/reference/commandline/image_save.md diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/image_tag.md similarity index 100% rename from docs/reference/commandline/tag.md rename to docs/reference/commandline/image_tag.md diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 2dd4e7e4d0fd..2be6c2e16027 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -20,72 +20,71 @@ read the [`dockerd`](dockerd.md) reference page. ### Docker management commands -| Command | Description | -|:----------------------|:-----------------------------------------------------| -| [dockerd](dockerd.md) | Launch the Docker daemon | -| [info](info.md) | Display system-wide information | -| [inspect](inspect.md) | Return low-level information on a container or image | -| [version](version.md) | Show the Docker version information | - +| Command | Description | +| :-------------------------------- | :--------------------------------------------------- | +| [dockerd](dockerd.md) | Launch the Docker daemon | +| [inspect](inspect.md) | Return low-level information on a container or image | +| [system events](system_events.md) | Get real-time events from the server | +| [system info](system_info.md) | Display system-wide information | +| [version](version.md) | Show the Docker version information | ### Image commands -| Command | Description | -|:------------------------------|:----------------------------------------------------------------| -| [build](build.md) | Build an image from a Dockerfile | -| [commit](commit.md) | Create a new image from a container's changes | -| [history](history.md) | Show the history of an image | -| [images](images.md) | List images | -| [import](import.md) | Import the contents from a tarball to create a filesystem image | -| [load](load.md) | Load an image from a tar archive or STDIN | -| [image prune](image_prune.md) | Remove unused images | -| [rmi](rmi.md) | Remove one or more images | -| [save](save.md) | Save images to a tar archive | -| [tag](tag.md) | Tag an image into a repository | +| Command | Description | +| :-------------------------------- | :-------------------------------------------------------------- | +| [image build](image_build.md) | Build an image from a Dockerfile | +| [image commit](image_commit.md) | Create a new image from a container's changes | +| [image history](image_history.md) | Show the history of an image | +| [image import](image_import.md) | Import the contents from a tarball to create a filesystem image | +| [image load](image_load.md) | Load an image from a tar archive or STDIN | +| [image ls](image_ls.md) | List images | +| [image prune](image_prune.md) | Remove unused images | +| [image rm](image_rm.md) | Remove one or more images | +| [image save](image_save.md) | Save images to a tar archive | +| [image tag](image_tag.md) | Tag an image into a repository | ### Container commands -| Command | Description | -|:--------------------------------------|:-----------------------------------------------------------------| -| [attach](attach.md) | Attach to a running container | -| [container prune](container_prune.md) | Remove all stopped containers | -| [cp](cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT | -| [create](create.md) | Create a new container | -| [diff](diff.md) | Inspect changes on a container's filesystem | -| [events](events.md) | Get real time events from the server | -| [exec](exec.md) | Execute a command in a running container | -| [export](export.md) | Export a container's filesystem as a tar archive | -| [kill](kill.md) | Kill a running container | -| [logs](logs.md) | Fetch the logs of a container | -| [pause](pause.md) | Pause all processes within a container | -| [port](port.md) | List port mappings or a specific mapping for the container | -| [ps](ps.md) | List containers | -| [rename](rename.md) | Rename a container | -| [restart](restart.md) | Restart a running container | -| [rm](rm.md) | Remove one or more containers | -| [run](run.md) | Create and run a new container from an image | -| [start](start.md) | Start one or more stopped containers | -| [stats](stats.md) | Display a live stream of container(s) resource usage statistics | -| [stop](stop.md) | Stop a running container | -| [top](top.md) | Display the running processes of a container | -| [unpause](unpause.md) | Unpause all processes within a container | -| [update](update.md) | Update configuration of one or more containers | -| [wait](wait.md) | Block until a container stops, then print its exit code | +| Command | Description | +| :---------------------------------------- | :-------------------------------------------------------------- | +| [container attach](container_attach.md) | Attach to a running container | +| [container cp](container_cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT | +| [container create](container_create.md) | Create a new container | +| [container diff](container_diff.md) | Inspect changes on a container's filesystem | +| [container exec](container_exec.md) | Execute a command in a running container | +| [container export](container_export.md) | Export a container's filesystem as a tar archive | +| [container kill](container_kill.md) | Kill a running container | +| [container logs](container_logs.md) | Fetch the logs of a container | +| [container ls](container_ls.md) | List containers | +| [container pause](container_pause.md) | Pause all processes within a container | +| [container port](container_port.md) | List port mappings or a specific mapping for the container | +| [container prune](container_prune.md) | Remove all stopped containers | +| [container rename](container_rename.md) | Rename a container | +| [container restart](container_restart.md) | Restart a running container | +| [container rm](container_rm.md) | Remove one or more containers | +| [container run](container_run.md) | Create and run a new container from an image | +| [container start](container_start.md) | Start one or more stopped containers | +| [container stats](container_stats.md) | Display a live stream of container(s) resource usage statistics | +| [container stop](container_stop.md) | Stop a running container | +| [container top](container_top.md) | Display the running processes of a container | +| [container unpause](container_unpause.md) | Unpause all processes within a container | +| [container update](container_update.md) | Update configuration of one or more containers | +| [container wait](container_wait.md) | Block until a container stops, then print its exit code | ### Hub and registry commands -| Command | Description | -|:--------------------|:------------------------------------------------------------------------| -| [login](login.md) | Log in to a registry | -| [logout](logout.md) | Log out from a registry | -| [pull](pull.md) | Download an image from a registry | -| [push](push.md) | Upload an image to a registry | -| [search](search.md) | Search Docker Hub for images | +| Command | Description | +| :------------------ | :-------------------------------- | +| [login](login.md) | Log in to a registry | +| [logout](logout.md) | Log out from a registry | +| [pull](pull.md) | Download an image from a registry | +| [push](push.md) | Upload an image to a registry | +| [search](search.md) | Search Docker Hub for images | ### Network and connectivity commands | Command | Description | -|:--------------------------------------------|:-------------------------------------------------------| +| :------------------------------------------ | :----------------------------------------------------- | | [network connect](network_connect.md) | Connect a container to a network | | [network create](network_create.md) | Create a new network | | [network disconnect](network_disconnect.md) | Disconnect a container from a network | @@ -97,7 +96,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Shared data volume commands | Command | Description | -|:------------------------------------|:-----------------------------------------------------------------| +| :---------------------------------- | :--------------------------------------------------------------- | | [volume create](volume_create.md) | Creates a new volume where containers can consume and store data | | [volume inspect](volume_inspect.md) | Display information about a volume | | [volume ls](volume_ls.md) | Lists all the volumes Docker knows about | @@ -107,7 +106,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm node commands | Command | Description | -|:--------------------------------|:--------------------------------------------------------------| +| :------------------------------ | :------------------------------------------------------------ | | [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager | | [node inspect](node_inspect.md) | Inspect a node in the swarm | | [node ls](node_ls.md) | List nodes in the swarm | @@ -119,19 +118,19 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm management commands | Command | Description | -|:----------------------------------------|:----------------------------------------------| +| :-------------------------------------- | :-------------------------------------------- | | [swarm init](swarm_init.md) | Initialize a swarm | +| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens | | [swarm join](swarm_join.md) | Join a swarm as a manager node or worker node | | [swarm leave](swarm_leave.md) | Remove the current node from the swarm | -| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens | -| [swarm unlock](swarm_unlock.md) | Unlock swarm | | [swarm unlock-key](swarm_unlock-key.md) | Manage the unlock key | +| [swarm unlock](swarm_unlock.md) | Unlock swarm | | [swarm update](swarm_update.md) | Update attributes of a swarm | ### Swarm service commands | Command | Description | -|:--------------------------------------|:----------------------------------------------------------------| +| :------------------------------------ | :-------------------------------------------------------------- | | [service create](service_create.md) | Create a new service | | [service inspect](service_inspect.md) | Inspect a service | | [service logs](service_logs.md) | Fetch the logs of a service or task | @@ -144,7 +143,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm secret commands | Command | Description | -|:-------------------------------------|:------------------------------------------------| +| :----------------------------------- | :---------------------------------------------- | | [secret create](secret_create.md) | Create a secret from a file or STDIN as content | | [secret inspect](service_inspect.md) | Inspect the specified secret | | [secret ls](secret_ls.md) | List secrets in the swarm | @@ -153,18 +152,18 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm stack commands | Command | Description | -|:------------------------------------|:--------------------------------------------------------| +| :---------------------------------- | :------------------------------------------------------ | +| [stack config](stack_config.md) | Output the Compose file after merges and interpolations | | [stack deploy](stack_deploy.md) | Deploy a new stack or update an existing stack | | [stack ls](stack_ls.md) | List stacks in the swarm | | [stack ps](stack_ps.md) | List the tasks in the stack | | [stack rm](stack_rm.md) | Remove the stack from the swarm | | [stack services](stack_services.md) | List the services in the stack | -| [stack config](stack_config.md) | Output the Compose file after merges and interpolations | ### Plugin commands | Command | Description | -|:------------------------------------|:------------------------------------------------| +| :---------------------------------- | :---------------------------------------------- | | [plugin create](plugin_create.md) | Create a plugin from a rootfs and configuration | | [plugin disable](plugin_disable.md) | Disable a plugin | | [plugin enable](plugin_enable.md) | Enable a plugin | @@ -178,13 +177,12 @@ read the [`dockerd`](dockerd.md) reference page. ### Context commands | Command | Description | -|:--------------------------------------|:-------------------------------| +| :------------------------------------ | :----------------------------- | | [context create](context_create.md) | Create a context | | [context export](context_export.md) | Export a context | | [context import](context_import.md) | Import a context | +| [context inspect](context_inspect.md) | Inspect one or more contexts | | [context ls](context_ls.md) | List contexts | | [context rm](context_rm.md) | Remove one or more contexts | | [context update](context_update.md) | Update a context | | [context use](context_use.md) | Set the current docker context | -| [context inspect](context_inspect.md) | Inspect one or more contexts | - diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/system_events.md similarity index 100% rename from docs/reference/commandline/events.md rename to docs/reference/commandline/system_events.md diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/system_info.md similarity index 100% rename from docs/reference/commandline/info.md rename to docs/reference/commandline/system_info.md diff --git a/docs/reference/run.md b/docs/reference/run.md index 9f6151b8f753..41fd2c0dc2d8 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -114,13 +114,13 @@ $ docker attach 0246aa4d1448 For more information about `docker run` flags related to foreground and background modes, see: -- [`docker run --detach`](commandline/run.md#detach): run container in background -- [`docker run --attach`](commandline/run.md#attach): attach to `stdin`, `stdout`, and `stderr` -- [`docker run --tty`](commandline/run.md#tty): allocate a pseudo-tty -- [`docker run --interactive`](commandline/run.md#interactive): keep `stdin` open even if not attached +- [`docker run --detach`](commandline/container_run.md#detach): run container in background +- [`docker run --attach`](commandline/container_run.md#attach): attach to `stdin`, `stdout`, and `stderr` +- [`docker run --tty`](commandline/container_run.md#tty): allocate a pseudo-tty +- [`docker run --interactive`](commandline/container_run.md#interactive): keep `stdin` open even if not attached For more information about re-attaching to a background container, see -[`docker attach`](commandline/attach.md). +[`docker attach`](commandline/container_attach.md). ## Container identification @@ -135,7 +135,7 @@ You can identify a container in three ways: The UUID identifier is a random ID assigned to the container by the daemon. The daemon generates a random string name for containers automatically. You can -also defined a custom name using [the `--name` flag](./commandline/run.md#name). +also defined a custom name using [the `--name` flag](./commandline/container_run.md#name). Defining a `name` can be a handy way to add meaning to a container. If you specify a `name`, you can use it when referring to the container in a user-defined network. This works for both background and foreground Docker From b35361e8d22595936cc6110ccec4ae2d209f82a8 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 15 Jan 2024 13:49:53 +0100 Subject: [PATCH 3/4] docs: regenerate stubs for non-canonical commands Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/reference/commandline/attach.md | 20 +++++ docs/reference/commandline/build.md | 47 ++++++++++ docs/reference/commandline/commit.md | 21 +++++ docs/reference/commandline/cp.md | 25 ++++++ docs/reference/commandline/create.md | 117 +++++++++++++++++++++++++ docs/reference/commandline/diff.md | 12 +++ docs/reference/commandline/events.md | 21 +++++ docs/reference/commandline/exec.md | 26 ++++++ docs/reference/commandline/export.md | 18 ++++ docs/reference/commandline/history.md | 21 +++++ docs/reference/commandline/images.md | 23 +++++ docs/reference/commandline/import.md | 20 +++++ docs/reference/commandline/info.md | 18 ++++ docs/reference/commandline/kill.md | 18 ++++ docs/reference/commandline/load.md | 19 ++++ docs/reference/commandline/logs.md | 23 +++++ docs/reference/commandline/pause.md | 12 +++ docs/reference/commandline/port.md | 12 +++ docs/reference/commandline/ps.md | 25 ++++++ docs/reference/commandline/pull.md | 21 +++++ docs/reference/commandline/push.md | 20 +++++ docs/reference/commandline/rename.md | 12 +++ docs/reference/commandline/restart.md | 19 ++++ docs/reference/commandline/rm.md | 20 +++++ docs/reference/commandline/rmi.md | 19 ++++ docs/reference/commandline/run.md | 120 ++++++++++++++++++++++++++ docs/reference/commandline/save.md | 18 ++++ docs/reference/commandline/start.md | 22 +++++ docs/reference/commandline/stats.md | 21 +++++ docs/reference/commandline/stop.md | 19 ++++ docs/reference/commandline/tag.md | 12 +++ docs/reference/commandline/top.md | 12 +++ docs/reference/commandline/unpause.md | 12 +++ docs/reference/commandline/update.md | 31 +++++++ docs/reference/commandline/wait.md | 12 +++ 35 files changed, 888 insertions(+) create mode 100644 docs/reference/commandline/attach.md create mode 100644 docs/reference/commandline/build.md create mode 100644 docs/reference/commandline/commit.md create mode 100644 docs/reference/commandline/cp.md create mode 100644 docs/reference/commandline/create.md create mode 100644 docs/reference/commandline/diff.md create mode 100644 docs/reference/commandline/events.md create mode 100644 docs/reference/commandline/exec.md create mode 100644 docs/reference/commandline/export.md create mode 100644 docs/reference/commandline/history.md create mode 100644 docs/reference/commandline/images.md create mode 100644 docs/reference/commandline/import.md create mode 100644 docs/reference/commandline/info.md create mode 100644 docs/reference/commandline/kill.md create mode 100644 docs/reference/commandline/load.md create mode 100644 docs/reference/commandline/logs.md create mode 100644 docs/reference/commandline/pause.md create mode 100644 docs/reference/commandline/port.md create mode 100644 docs/reference/commandline/ps.md create mode 100644 docs/reference/commandline/pull.md create mode 100644 docs/reference/commandline/push.md create mode 100644 docs/reference/commandline/rename.md create mode 100644 docs/reference/commandline/restart.md create mode 100644 docs/reference/commandline/rm.md create mode 100644 docs/reference/commandline/rmi.md create mode 100644 docs/reference/commandline/run.md create mode 100644 docs/reference/commandline/save.md create mode 100644 docs/reference/commandline/start.md create mode 100644 docs/reference/commandline/stats.md create mode 100644 docs/reference/commandline/stop.md create mode 100644 docs/reference/commandline/tag.md create mode 100644 docs/reference/commandline/top.md create mode 100644 docs/reference/commandline/unpause.md create mode 100644 docs/reference/commandline/update.md create mode 100644 docs/reference/commandline/wait.md diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md new file mode 100644 index 000000000000..ffbf58a81d6d --- /dev/null +++ b/docs/reference/commandline/attach.md @@ -0,0 +1,20 @@ +# docker attach + + +Attach local standard input, output, and error streams to a running container + +### Aliases + +`docker container attach`, `docker attach` + +### Options + +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:----------------------------------------------------| +| `--detach-keys` | `string` | | Override the key sequence for detaching a container | +| `--no-stdin` | | | Do not attach STDIN | +| `--sig-proxy` | | | Proxy all received signals to the process | + + + + diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md new file mode 100644 index 000000000000..40983fb0e717 --- /dev/null +++ b/docs/reference/commandline/build.md @@ -0,0 +1,47 @@ +# docker build + + +Build an image from a Dockerfile + +### Aliases + +`docker image build`, `docker build`, `docker buildx build`, `docker builder build` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:--------------|:----------|:------------------------------------------------------------------| +| `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) | +| `--build-arg` | `list` | | Set build-time variables | +| `--cache-from` | `stringSlice` | | Images to consider as cache sources | +| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | +| `--compress` | | | Compress the build context using gzip | +| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | +| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | +| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | +| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | +| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | +| `--disable-content-trust` | | | Skip image verification | +| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) | +| `--force-rm` | | | Always remove intermediate containers | +| `--iidfile` | `string` | | Write the image ID to the file | +| `--isolation` | `string` | | Container isolation technology | +| `--label` | `list` | | Set metadata for an image | +| `-m`, `--memory` | `bytes` | `0` | Memory limit | +| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | +| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build | +| `--no-cache` | | | Do not use cache when building the image | +| `--platform` | `string` | | Set platform if server is multi-platform capable | +| `--pull` | | | Always attempt to pull a newer version of the image | +| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--rm` | | | Remove intermediate containers after a successful build | +| `--security-opt` | `stringSlice` | | Security options | +| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | +| `--squash` | | | Squash newly built layers into a single new layer | +| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format | +| `--target` | `string` | | Set the target build stage to build. | +| `--ulimit` | `ulimit` | | Ulimit options | + + + + diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md new file mode 100644 index 000000000000..281d96e488b5 --- /dev/null +++ b/docs/reference/commandline/commit.md @@ -0,0 +1,21 @@ +# docker commit + + +Create a new image from a container's changes + +### Aliases + +`docker container commit`, `docker commit` + +### Options + +| Name | Type | Default | Description | +|:------------------|:---------|:--------|:-----------------------------------------------------------| +| `-a`, `--author` | `string` | | Author (e.g., `John Hannibal Smith `) | +| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | +| `-m`, `--message` | `string` | | Commit message | +| `-p`, `--pause` | | | Pause container during commit | + + + + diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md new file mode 100644 index 000000000000..41c9529f9f0a --- /dev/null +++ b/docs/reference/commandline/cp.md @@ -0,0 +1,25 @@ +# docker cp + + +Copy files/folders between a container and the local filesystem + +Use '-' as the source to read a tar archive from stdin +and extract it to a directory destination in a container. +Use '-' as the destination to stream a tar archive of a +container source to stdout. + +### Aliases + +`docker container cp`, `docker cp` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------| +| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | +| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | +| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | + + + + diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md new file mode 100644 index 000000000000..ce34f5b12c97 --- /dev/null +++ b/docs/reference/commandline/create.md @@ -0,0 +1,117 @@ +# docker create + + +Create a new container + +### Aliases + +`docker container create`, `docker create` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) | +| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | +| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR | +| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | +| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) | +| `--cap-add` | `list` | | Add Linux capabilities | +| `--cap-drop` | `list` | | Drop Linux capabilities | +| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | +| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
default-cgroupns-mode option on the daemon (default) | +| `--cidfile` | `string` | | Write the container ID to the file | +| `--cpu-count` | `int64` | `0` | CPU count (Windows only) | +| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) | +| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | +| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | +| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds | +| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds | +| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | +| `--cpus` | `decimal` | | Number of CPUs | +| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | +| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | +| `--device` | `list` | | Add a host device to the container | +| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list | +| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device | +| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device | +| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device | +| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device | +| `--disable-content-trust` | | | Skip image verification | +| `--dns` | `list` | | Set custom DNS servers | +| `--dns-option` | `list` | | Set DNS options | +| `--dns-search` | `list` | | Set custom DNS search domains | +| `--domainname` | `string` | | Container NIS domain name | +| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image | +| `-e`, `--env` | `list` | | Set environment variables | +| `--env-file` | `list` | | Read in a file of environment variables | +| `--expose` | `list` | | Expose a port or a range of ports | +| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) | +| `--group-add` | `list` | | Add additional groups to join | +| `--health-cmd` | `string` | | Command to run to check health | +| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) | +| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | +| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | +| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | +| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | +| `--help` | | | Print usage | +| `-h`, `--hostname` | `string` | | Container host name | +| `--init` | | | Run an init inside the container that forwards signals and reaps processes | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | +| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | +| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | +| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) | +| `--ipc` | `string` | | IPC mode to use | +| `--isolation` | `string` | | Container isolation technology | +| `--kernel-memory` | `bytes` | `0` | Kernel memory limit | +| `-l`, `--label` | `list` | | Set meta data on a container | +| `--label-file` | `list` | | Read in a line delimited file of labels | +| `--link` | `list` | | Add link to another container | +| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses | +| `--log-driver` | `string` | | Logging driver for the container | +| `--log-opt` | `list` | | Log driver options | +| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) | +| `-m`, `--memory` | `bytes` | `0` | Memory limit | +| `--memory-reservation` | `bytes` | `0` | Memory soft limit | +| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap | +| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) | +| `--mount` | `mount` | | Attach a filesystem mount to the container | +| `--name` | `string` | | Assign a name to the container | +| `--network` | `network` | | Connect a container to a network | +| `--network-alias` | `list` | | Add network-scoped alias for the container | +| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | | | Disable OOM Killer | +| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | +| `--pid` | `string` | | PID namespace to use | +| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | +| `--platform` | `string` | | Set platform if server is multi-platform capable | +| `--privileged` | | | Give extended privileges to this container | +| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | +| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) | +| `-q`, `--quiet` | | | Suppress the pull output | +| `--read-only` | | | Mount the container's root filesystem as read only | +| `--restart` | `string` | `no` | Restart policy to apply when a container exits | +| `--rm` | | | Automatically remove the container when it exits | +| `--runtime` | `string` | | Runtime to use for this container | +| `--security-opt` | `list` | | Security Options | +| `--shm-size` | `bytes` | `0` | Size of /dev/shm | +| `--stop-signal` | `string` | | Signal to stop the container | +| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container | +| `--storage-opt` | `list` | | Storage driver options for the container | +| `--sysctl` | `map` | `map[]` | Sysctl options | +| `--tmpfs` | `list` | | Mount a tmpfs directory | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `--ulimit` | `ulimit` | | Ulimit options | +| `-u`, `--user` | `string` | | Username or UID (format: [:]) | +| `--userns` | `string` | | User namespace to use | +| `--uts` | `string` | | UTS namespace to use | +| `-v`, `--volume` | `list` | | Bind mount a volume | +| `--volume-driver` | `string` | | Optional volume driver for the container | +| `--volumes-from` | `list` | | Mount volumes from the specified container(s) | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + + diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md new file mode 100644 index 000000000000..36185898a6c7 --- /dev/null +++ b/docs/reference/commandline/diff.md @@ -0,0 +1,12 @@ +# docker diff + + +Inspect changes to files or directories on a container's filesystem + +### Aliases + +`docker container diff`, `docker diff` + + + + diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md new file mode 100644 index 000000000000..a5012cd6b7c3 --- /dev/null +++ b/docs/reference/commandline/events.md @@ -0,0 +1,21 @@ +# docker events + + +Get real time events from the server + +### Aliases + +`docker system events`, `docker events` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | +| `--format` | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | +| `--since` | `string` | | Show all events created since timestamp | +| `--until` | `string` | | Stream events until this timestamp | + + + + diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md new file mode 100644 index 000000000000..67bf20a1376f --- /dev/null +++ b/docs/reference/commandline/exec.md @@ -0,0 +1,26 @@ +# docker exec + + +Execute a command in a running container + +### Aliases + +`docker container exec`, `docker exec` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------| +| `-d`, `--detach` | | | Detached mode: run command in the background | +| `--detach-keys` | `string` | | Override the key sequence for detaching a container | +| `-e`, `--env` | `list` | | Set environment variables | +| `--env-file` | `list` | | Read in a file of environment variables | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--privileged` | | | Give extended privileges to the command | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-u`, `--user` | `string` | | Username or UID (format: `[:]`) | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + + diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md new file mode 100644 index 000000000000..558f2b87e9b8 --- /dev/null +++ b/docs/reference/commandline/export.md @@ -0,0 +1,18 @@ +# docker export + + +Export a container's filesystem as a tar archive + +### Aliases + +`docker container export`, `docker export` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-----------------------------------| +| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | + + + + diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md new file mode 100644 index 000000000000..7ffc95033523 --- /dev/null +++ b/docs/reference/commandline/history.md @@ -0,0 +1,21 @@ +# docker history + + +Show the history of an image + +### Aliases + +`docker image history`, `docker history` + +### Options + +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | +| `-H`, `--human` | | | Print sizes and dates in human readable format | +| `--no-trunc` | | | Don't truncate output | +| `-q`, `--quiet` | | | Only show image IDs | + + + + diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md new file mode 100644 index 000000000000..1fa9f6a319c5 --- /dev/null +++ b/docs/reference/commandline/images.md @@ -0,0 +1,23 @@ +# docker images + + +List images + +### Aliases + +`docker image ls`, `docker image list`, `docker images` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all images (default hides intermediate images) | +| `--digests` | | | Show digests | +| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | +| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | +| `--no-trunc` | | | Don't truncate output | +| `-q`, `--quiet` | | | Only show image IDs | + + + + diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md new file mode 100644 index 000000000000..1b3eec022448 --- /dev/null +++ b/docs/reference/commandline/import.md @@ -0,0 +1,20 @@ +# docker import + + +Import the contents from a tarball to create a filesystem image + +### Aliases + +`docker image import`, `docker import` + +### Options + +| Name | Type | Default | Description | +|:------------------|:---------|:--------|:--------------------------------------------------| +| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | +| `-m`, `--message` | `string` | | Set commit message for imported image | +| `--platform` | `string` | | Set platform if server is multi-platform capable | + + + + diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md new file mode 100644 index 000000000000..c155096a9191 --- /dev/null +++ b/docs/reference/commandline/info.md @@ -0,0 +1,18 @@ +# docker info + + +Display system-wide information + +### Aliases + +`docker system info`, `docker info` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-f`, `--format` | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | + + + + diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md new file mode 100644 index 000000000000..27f8974973ef --- /dev/null +++ b/docs/reference/commandline/kill.md @@ -0,0 +1,18 @@ +# docker kill + + +Kill one or more running containers + +### Aliases + +`docker container kill`, `docker kill` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:--------------------------------| +| `-s`, `--signal` | `string` | | Signal to send to the container | + + + + diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md new file mode 100644 index 000000000000..778d263077dd --- /dev/null +++ b/docs/reference/commandline/load.md @@ -0,0 +1,19 @@ +# docker load + + +Load an image from a tar archive or STDIN + +### Aliases + +`docker image load`, `docker load` + +### Options + +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:---------------------------------------------| +| `-i`, `--input` | `string` | | Read from tar archive file, instead of STDIN | +| `-q`, `--quiet` | | | Suppress the load output | + + + + diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md new file mode 100644 index 000000000000..840f0562a5c6 --- /dev/null +++ b/docs/reference/commandline/logs.md @@ -0,0 +1,23 @@ +# docker logs + + +Fetch the logs of a container + +### Aliases + +`docker container logs`, `docker logs` + +### Options + +| Name | Type | Default | Description | +|:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------| +| `--details` | | | Show extra details provided to logs | +| `-f`, `--follow` | | | Follow log output | +| `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | +| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs | +| `-t`, `--timestamps` | | | Show timestamps | +| `--until` | `string` | | Show logs before a timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | + + + + diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md new file mode 100644 index 000000000000..0840d7fb8183 --- /dev/null +++ b/docs/reference/commandline/pause.md @@ -0,0 +1,12 @@ +# docker pause + + +Pause all processes within one or more containers + +### Aliases + +`docker container pause`, `docker pause` + + + + diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md new file mode 100644 index 000000000000..4ac285e00df8 --- /dev/null +++ b/docs/reference/commandline/port.md @@ -0,0 +1,12 @@ +# docker port + + +List port mappings or a specific mapping for the container + +### Aliases + +`docker container port`, `docker port` + + + + diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md new file mode 100644 index 000000000000..57fcc6199ab2 --- /dev/null +++ b/docs/reference/commandline/ps.md @@ -0,0 +1,25 @@ +# docker ps + + +List containers + +### Aliases + +`docker container ls`, `docker container list`, `docker container ps`, `docker ps` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all containers (default shows just running) | +| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | +| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | +| `-n`, `--last` | `int` | `-1` | Show n last created containers (includes all states) | +| `-l`, `--latest` | | | Show the latest created container (includes all states) | +| `--no-trunc` | | | Don't truncate output | +| `-q`, `--quiet` | | | Only display container IDs | +| `-s`, `--size` | | | Display total file sizes | + + + + diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md new file mode 100644 index 000000000000..9ea408dbff21 --- /dev/null +++ b/docs/reference/commandline/pull.md @@ -0,0 +1,21 @@ +# docker pull + + +Download an image from a registry + +### Aliases + +`docker image pull`, `docker pull` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:-------------------------------------------------| +| `-a`, `--all-tags` | | | Download all tagged images in the repository | +| `--disable-content-trust` | | | Skip image verification | +| `--platform` | `string` | | Set platform if server is multi-platform capable | +| `-q`, `--quiet` | | | Suppress verbose output | + + + + diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md new file mode 100644 index 000000000000..16e9c1924629 --- /dev/null +++ b/docs/reference/commandline/push.md @@ -0,0 +1,20 @@ +# docker push + + +Upload an image to a registry + +### Aliases + +`docker image push`, `docker push` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:-----|:--------|:--------------------------------------------| +| `-a`, `--all-tags` | | | Push all tags of an image to the repository | +| `--disable-content-trust` | | | Skip image signing | +| `-q`, `--quiet` | | | Suppress verbose output | + + + + diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md new file mode 100644 index 000000000000..1e813055ee71 --- /dev/null +++ b/docs/reference/commandline/rename.md @@ -0,0 +1,12 @@ +# docker rename + + +Rename a container + +### Aliases + +`docker container rename`, `docker rename` + + + + diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md new file mode 100644 index 000000000000..2c6681cd2a6f --- /dev/null +++ b/docs/reference/commandline/restart.md @@ -0,0 +1,19 @@ +# docker restart + + +Restart one or more containers + +### Aliases + +`docker container restart`, `docker restart` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:---------------------------------------------| +| `-s`, `--signal` | `string` | | Signal to send to the container | +| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container | + + + + diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md new file mode 100644 index 000000000000..0c0bf058208e --- /dev/null +++ b/docs/reference/commandline/rm.md @@ -0,0 +1,20 @@ +# docker rm + + +Remove one or more containers + +### Aliases + +`docker container rm`, `docker container remove`, `docker rm` + +### Options + +| Name | Type | Default | Description | +|:------------------|:-----|:--------|:--------------------------------------------------------| +| `-f`, `--force` | | | Force the removal of a running container (uses SIGKILL) | +| `-l`, `--link` | | | Remove the specified link | +| `-v`, `--volumes` | | | Remove anonymous volumes associated with the container | + + + + diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md new file mode 100644 index 000000000000..574fa03114d7 --- /dev/null +++ b/docs/reference/commandline/rmi.md @@ -0,0 +1,19 @@ +# docker rmi + + +Remove one or more images + +### Aliases + +`docker image rm`, `docker image remove`, `docker rmi` + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:-------------------------------| +| `-f`, `--force` | | | Force removal of the image | +| `--no-prune` | | | Do not delete untagged parents | + + + + diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md new file mode 100644 index 000000000000..f4a72ba7bfee --- /dev/null +++ b/docs/reference/commandline/run.md @@ -0,0 +1,120 @@ +# docker run + + +Create and run a new container from an image + +### Aliases + +`docker container run`, `docker run` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) | +| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | +| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR | +| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | +| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) | +| `--cap-add` | `list` | | Add Linux capabilities | +| `--cap-drop` | `list` | | Drop Linux capabilities | +| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | +| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
default-cgroupns-mode option on the daemon (default) | +| `--cidfile` | `string` | | Write the container ID to the file | +| `--cpu-count` | `int64` | `0` | CPU count (Windows only) | +| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) | +| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | +| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | +| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds | +| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds | +| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | +| `--cpus` | `decimal` | | Number of CPUs | +| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | +| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | +| `-d`, `--detach` | | | Run container in background and print container ID | +| `--detach-keys` | `string` | | Override the key sequence for detaching a container | +| `--device` | `list` | | Add a host device to the container | +| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list | +| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device | +| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device | +| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device | +| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device | +| `--disable-content-trust` | | | Skip image verification | +| `--dns` | `list` | | Set custom DNS servers | +| `--dns-option` | `list` | | Set DNS options | +| `--dns-search` | `list` | | Set custom DNS search domains | +| `--domainname` | `string` | | Container NIS domain name | +| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image | +| `-e`, `--env` | `list` | | Set environment variables | +| `--env-file` | `list` | | Read in a file of environment variables | +| `--expose` | `list` | | Expose a port or a range of ports | +| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) | +| `--group-add` | `list` | | Add additional groups to join | +| `--health-cmd` | `string` | | Command to run to check health | +| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) | +| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | +| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | +| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | +| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | +| `--help` | | | Print usage | +| `-h`, `--hostname` | `string` | | Container host name | +| `--init` | | | Run an init inside the container that forwards signals and reaps processes | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | +| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | +| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | +| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) | +| `--ipc` | `string` | | IPC mode to use | +| `--isolation` | `string` | | Container isolation technology | +| `--kernel-memory` | `bytes` | `0` | Kernel memory limit | +| `-l`, `--label` | `list` | | Set meta data on a container | +| `--label-file` | `list` | | Read in a line delimited file of labels | +| `--link` | `list` | | Add link to another container | +| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses | +| `--log-driver` | `string` | | Logging driver for the container | +| `--log-opt` | `list` | | Log driver options | +| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) | +| `-m`, `--memory` | `bytes` | `0` | Memory limit | +| `--memory-reservation` | `bytes` | `0` | Memory soft limit | +| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap | +| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) | +| `--mount` | `mount` | | Attach a filesystem mount to the container | +| `--name` | `string` | | Assign a name to the container | +| `--network` | `network` | | Connect a container to a network | +| `--network-alias` | `list` | | Add network-scoped alias for the container | +| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | | | Disable OOM Killer | +| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | +| `--pid` | `string` | | PID namespace to use | +| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | +| `--platform` | `string` | | Set platform if server is multi-platform capable | +| `--privileged` | | | Give extended privileges to this container | +| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | +| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| `--pull` | `string` | `missing` | Pull image before running (`always`, `missing`, `never`) | +| `-q`, `--quiet` | | | Suppress the pull output | +| `--read-only` | | | Mount the container's root filesystem as read only | +| `--restart` | `string` | `no` | Restart policy to apply when a container exits | +| `--rm` | | | Automatically remove the container when it exits | +| `--runtime` | `string` | | Runtime to use for this container | +| `--security-opt` | `list` | | Security Options | +| `--shm-size` | `bytes` | `0` | Size of /dev/shm | +| `--sig-proxy` | | | Proxy received signals to the process | +| `--stop-signal` | `string` | | Signal to stop the container | +| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container | +| `--storage-opt` | `list` | | Storage driver options for the container | +| `--sysctl` | `map` | `map[]` | Sysctl options | +| `--tmpfs` | `list` | | Mount a tmpfs directory | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `--ulimit` | `ulimit` | | Ulimit options | +| `-u`, `--user` | `string` | | Username or UID (format: [:]) | +| `--userns` | `string` | | User namespace to use | +| `--uts` | `string` | | UTS namespace to use | +| `-v`, `--volume` | `list` | | Bind mount a volume | +| `--volume-driver` | `string` | | Optional volume driver for the container | +| `--volumes-from` | `list` | | Mount volumes from the specified container(s) | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + + diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md new file mode 100644 index 000000000000..1c9f9c53dbda --- /dev/null +++ b/docs/reference/commandline/save.md @@ -0,0 +1,18 @@ +# docker save + + +Save one or more images to a tar archive (streamed to STDOUT by default) + +### Aliases + +`docker image save`, `docker save` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-----------------------------------| +| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | + + + + diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md new file mode 100644 index 000000000000..d4ea72a7c112 --- /dev/null +++ b/docs/reference/commandline/start.md @@ -0,0 +1,22 @@ +# docker start + + +Start one or more stopped containers + +### Aliases + +`docker container start`, `docker start` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:----------------------------------------------------| +| `-a`, `--attach` | | | Attach STDOUT/STDERR and forward signals | +| `--checkpoint` | `string` | | Restore from this checkpoint | +| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | +| `--detach-keys` | `string` | | Override the key sequence for detaching a container | +| `-i`, `--interactive` | | | Attach container's STDIN | + + + + diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md new file mode 100644 index 000000000000..f1fec24e4941 --- /dev/null +++ b/docs/reference/commandline/stats.md @@ -0,0 +1,21 @@ +# docker stats + + +Display a live stream of container(s) resource usage statistics + +### Aliases + +`docker container stats`, `docker stats` + +### Options + +| Name | Type | Default | Description | +|:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all containers (default shows just running) | +| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | +| `--no-stream` | | | Disable streaming stats and only pull the first result | +| `--no-trunc` | | | Do not truncate output | + + + + diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md new file mode 100644 index 000000000000..16934813c505 --- /dev/null +++ b/docs/reference/commandline/stop.md @@ -0,0 +1,19 @@ +# docker stop + + +Stop one or more running containers + +### Aliases + +`docker container stop`, `docker stop` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:---------------------------------------------| +| `-s`, `--signal` | `string` | | Signal to send to the container | +| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container | + + + + diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md new file mode 100644 index 000000000000..4e980570a173 --- /dev/null +++ b/docs/reference/commandline/tag.md @@ -0,0 +1,12 @@ +# docker tag + + +Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE + +### Aliases + +`docker image tag`, `docker tag` + + + + diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md new file mode 100644 index 000000000000..b35f4920316f --- /dev/null +++ b/docs/reference/commandline/top.md @@ -0,0 +1,12 @@ +# docker top + + +Display the running processes of a container + +### Aliases + +`docker container top`, `docker top` + + + + diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md new file mode 100644 index 000000000000..f8d69ef879be --- /dev/null +++ b/docs/reference/commandline/unpause.md @@ -0,0 +1,12 @@ +# docker unpause + + +Unpause all processes within one or more containers + +### Aliases + +`docker container unpause`, `docker unpause` + + + + diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/update.md new file mode 100644 index 000000000000..60557bdbfb1a --- /dev/null +++ b/docs/reference/commandline/update.md @@ -0,0 +1,31 @@ +# docker update + + +Update configuration of one or more containers + +### Aliases + +`docker container update`, `docker update` + +### Options + +| Name | Type | Default | Description | +|:-----------------------|:----------|:--------|:-----------------------------------------------------------------------------| +| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | +| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period | +| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota | +| `--cpu-rt-period` | `int64` | `0` | Limit the CPU real-time period in microseconds | +| `--cpu-rt-runtime` | `int64` | `0` | Limit the CPU real-time runtime in microseconds | +| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | +| `--cpus` | `decimal` | | Number of CPUs | +| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | +| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | +| `-m`, `--memory` | `bytes` | `0` | Memory limit | +| `--memory-reservation` | `bytes` | `0` | Memory soft limit | +| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | +| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | +| `--restart` | `string` | | Restart policy to apply when a container exits | + + + + diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/wait.md new file mode 100644 index 000000000000..79dbf1507fa9 --- /dev/null +++ b/docs/reference/commandline/wait.md @@ -0,0 +1,12 @@ +# docker wait + + +Block until one or more containers stop, then print their exit codes + +### Aliases + +`docker container wait`, `docker wait` + + + + From 37f551566671f700945375f35b757881d7598441 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 15 Jan 2024 14:16:24 +0100 Subject: [PATCH 4/4] docs: fix broken link to tmpfs (missing anchor) Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/reference/commandline/container_run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/commandline/container_run.md b/docs/reference/commandline/container_run.md index 3f79db372473..de40a83f3354 100644 --- a/docs/reference/commandline/container_run.md +++ b/docs/reference/commandline/container_run.md @@ -391,7 +391,7 @@ container with the `rw`, `noexec`, `nosuid`, `size=65536k` options. $ docker run -d --tmpfs /run:rw,noexec,nosuid,size=65536k my_image ``` -For more information, see [tmpfs mounts](https://docs.docker.com/storage/tmpfs/#tmpfs-mounts). +For more information, see [tmpfs mounts](https://docs.docker.com/storage/tmpfs/). ### Mount volume (-v)