diff --git a/Makefile b/Makefile index 4a856962bb..f19fa8df77 100644 --- a/Makefile +++ b/Makefile @@ -90,6 +90,10 @@ authors: ## generate AUTHORS file from git history manpages: ## generate man pages from go source and markdown scripts/docs/generate-man.sh +.PHONY: mddocs +mddocs: ## generate markdown files from go source + scripts/docs/generate-md.sh + .PHONY: yamldocs yamldocs: ## generate documentation YAML files consumed by docs repo scripts/docs/generate-yaml.sh diff --git a/docker.Makefile b/docker.Makefile index 8a821a92c8..bddd91a2a5 100644 --- a/docker.Makefile +++ b/docker.Makefile @@ -103,6 +103,10 @@ authors: ## generate AUTHORS file from git history manpages: build_docker_image ## generate man pages from go source and markdown $(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make manpages +.PHONY: mddocs +mddocs: build_docker_image ## generate markdown files from go source + $(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make mddocs + .PHONY: yamldocs yamldocs: build_docker_image ## generate documentation YAML files consumed by docs repo $(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make yamldocs diff --git a/docs/generate.go b/docs/generate.go index 62e1b829aa..c9187c2c0d 100644 --- a/docs/generate.go +++ b/docs/generate.go @@ -10,8 +10,10 @@ import ( "os" clidocstool "github.com/docker/cli-docs-tool" + "github.com/docker/cli/cli" "github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command/commands" + "github.com/pkg/errors" "github.com/spf13/cobra" "github.com/spf13/pflag" ) @@ -19,8 +21,9 @@ import ( const defaultSourcePath = "docs/reference/commandline/" type options struct { - source string - target string + source string + target string + formats []string } func gen(opts *options) error { @@ -34,6 +37,10 @@ func gen(opts *options) error { Use: "docker [OPTIONS] COMMAND [ARG...]", Short: "The base command for the Docker CLI.", } + clientOpts, _, _ := cli.SetupRootCommand(cmd) + if err := dockerCLI.Initialize(clientOpts); err != nil { + return err + } commands.AddCommands(cmd, dockerCLI) c, err := clidocstool.New(clidocstool.Options{ @@ -46,7 +53,22 @@ func gen(opts *options) error { return err } - return c.GenYamlTree(cmd) + for _, format := range opts.formats { + switch format { + case "md": + if err = c.GenMarkdownTree(cmd); err != nil { + return err + } + case "yaml": + if err = c.GenYamlTree(cmd); err != nil { + return err + } + default: + return errors.Errorf("unknown format %q", format) + } + } + + return nil } func run() error { @@ -54,9 +76,13 @@ func run() error { flags := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError) flags.StringVar(&opts.source, "source", defaultSourcePath, "Docs source folder") flags.StringVar(&opts.target, "target", defaultSourcePath, "Docs target folder") + flags.StringSliceVar(&opts.formats, "formats", []string{}, "Format (md, yaml)") if err := flags.Parse(os.Args[1:]); err != nil { return err } + if len(opts.formats) == 0 { + return errors.New("Docs format required") + } return gen(opts) } diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md index 0952fe6599..370cc7d86f 100644 --- a/docs/reference/commandline/attach.md +++ b/docs/reference/commandline/attach.md @@ -1,25 +1,22 @@ ---- -title: "attach" -description: "The attach command description and usage" -keywords: "attach, running, container" ---- - # attach -```markdown -Usage: docker attach [OPTIONS] CONTAINER - + Attach local standard input, output, and error streams to a running container -Aliases: - docker container attach, docker attach +### Aliases -Options: - --detach-keys string Override the key sequence for detaching a container - --help Print usage - --no-stdin Do not attach STDIN - --sig-proxy Proxy all received signals to the process (default true) -``` +`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 diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index d45b368bc9..d476ac1f29 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -1,64 +1,49 @@ ---- -title: "build" -description: "The build command description and usage" -keywords: "build, docker, image" ---- - # build -```markdown -Usage: docker build [OPTIONS] PATH | URL | - - + Build an image from a Dockerfile -Aliases: - docker image build, docker build, docker buildx build, docker builder build +### Aliases -Options: - --add-host value Add a custom host-to-IP mapping (host:ip) (default []) - --build-arg value Set build-time variables (default []) - --cache-from value Images to consider as cache sources (default []) - --cgroup-parent string Optional parent cgroup for the container - --compress Compress the build context using gzip - --cpu-period int Limit the CPU CFS (Completely Fair Scheduler) period - --cpu-quota int Limit the CPU CFS (Completely Fair Scheduler) quota - -c, --cpu-shares int 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 (default true) - -f, --file string Name of the Dockerfile (Default is 'PATH/Dockerfile') - --force-rm Always remove intermediate containers - --help Print usage - --iidfile string Write the image ID to the file - --isolation string Container isolation technology - --label value Set metadata for an image (default []) - -m, --memory string Memory limit - --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap - --network string Set the networking mode for the RUN instructions during build - 'bridge': use default Docker bridge - 'none': no networking - 'container:': reuse another container's network stack - 'host': use the Docker host network stack - '|': connect to a user-defined network - --no-cache Do not use cache when building the image - -o, --output Output destination (format: type=local,dest=path) - --pull Always attempt to pull a newer version of the image - --progress Set type of progress output (only if BuildKit enabled) (auto, plain, tty). - Use plain to show container output - -q, --quiet Suppress the build output and print image ID on success - --rm Remove intermediate containers after a successful build (default true) - --secret Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret" - --security-opt value Security Options (default []) - --shm-size bytes Size of /dev/shm - The format is ``. `number` must be greater than `0`. - Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), - or `g` (gigabytes). If you omit the unit, the system uses bytes. - --squash Squash newly built layers into a single new layer (**Experimental Only**) - --ssh SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|[=|[,]]) - -t, --tag value Name and optionally a tag in the 'name:tag' format (default []) - --target string Set the target build stage to build. - --ulimit value Ulimit options (default []) -``` +`docker image build`, `docker build`, `docker buildx build`, `docker builder build` + +### Options + +| Name | Type | Default | Description | +|:------------------------------------|:--------------|:----------|:------------------------------------------------------------------| +| [`--add-host`](#add-host) | `list` | | Add a custom host-to-IP mapping (`host:ip`) | +| [`--build-arg`](#build-arg) | `list` | | Set build-time variables | +| [`--cache-from`](#cache-from) | `stringSlice` | | Images to consider as cache sources | +| [`--cgroup-parent`](#cgroup-parent) | `string` | | Optional parent cgroup for the container | +| `--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), [`--file`](#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`](#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`](#security-opt) | `stringSlice` | | Security options | +| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | +| [`--squash`](#squash) | | | Squash newly built layers into a single new layer | +| [`-t`](#tag), [`--tag`](#tag) | `list` | | Name and optionally a tag in the `name:tag` format | +| [`--target`](#target) | `string` | | Set the target build stage to build. | +| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | + + + ## Description diff --git a/docs/reference/commandline/builder.md b/docs/reference/commandline/builder.md new file mode 100644 index 0000000000..993b627bb7 --- /dev/null +++ b/docs/reference/commandline/builder.md @@ -0,0 +1,16 @@ +# builder + + +Manage builds + +### Subcommands + +| Name | Description | +|:----------------------------|:---------------------------------| +| [`build`](builder_build.md) | Build an image from a Dockerfile | +| [`prune`](builder_prune.md) | Remove build cache | + + + + + diff --git a/docs/reference/commandline/builder_build.md b/docs/reference/commandline/builder_build.md new file mode 100644 index 0000000000..0272728b98 --- /dev/null +++ b/docs/reference/commandline/builder_build.md @@ -0,0 +1,50 @@ +# builder 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` | | Optional parent cgroup for the container | +| `--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/builder_prune.md b/docs/reference/commandline/builder_prune.md new file mode 100644 index 0000000000..a90d58d39a --- /dev/null +++ b/docs/reference/commandline/builder_prune.md @@ -0,0 +1,16 @@ +# builder prune + + +Remove build cache + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:------------------------------------------------------| +| `-a`, `--all` | | | Remove all unused build cache, not just dangling ones | +| `--filter` | `filter` | | Provide filter values (e.g. `until=24h`) | +| `-f`, `--force` | | | Do not prompt for confirmation | +| `--keep-storage` | `bytes` | `0` | Amount of disk space to keep for cache | + + + diff --git a/docs/reference/commandline/checkpoint.md b/docs/reference/commandline/checkpoint.md index 56b0a5978b..93444d023d 100644 --- a/docs/reference/commandline/checkpoint.md +++ b/docs/reference/commandline/checkpoint.md @@ -1,9 +1,19 @@ ---- -title: docker checkpoint -description: "The checkpoint command description and usage" -keywords: experimental, checkpoint, restore, criu -experimental: true ---- +# checkpoint + + +Manage checkpoints + +### Subcommands + +| Name | Description | +|:---------------------------------|:---------------------------------------------| +| [`create`](checkpoint_create.md) | Create a checkpoint from a running container | +| [`ls`](checkpoint_ls.md) | List checkpoints for a container | +| [`rm`](checkpoint_rm.md) | Remove a checkpoint | + + + + ## Description diff --git a/docs/reference/commandline/checkpoint_create.md b/docs/reference/commandline/checkpoint_create.md new file mode 100644 index 0000000000..f59e259527 --- /dev/null +++ b/docs/reference/commandline/checkpoint_create.md @@ -0,0 +1,15 @@ +# checkpoint create + + +Create a checkpoint from a running container + +### Options + +| Name | Type | Default | Description | +|:-------------------|:---------|:--------|:---------------------------------------------| +| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | +| `--leave-running` | | | Leave the container running after checkpoint | + + + + diff --git a/docs/reference/commandline/checkpoint_ls.md b/docs/reference/commandline/checkpoint_ls.md new file mode 100644 index 0000000000..39d2802262 --- /dev/null +++ b/docs/reference/commandline/checkpoint_ls.md @@ -0,0 +1,18 @@ +# checkpoint ls + + +List checkpoints for a container + +### Aliases + +`docker checkpoint ls`, `docker checkpoint list` + +### Options + +| Name | Type | Default | Description | +|:-------------------|:---------|:--------|:------------------------------------------| +| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | + + + + diff --git a/docs/reference/commandline/checkpoint_rm.md b/docs/reference/commandline/checkpoint_rm.md new file mode 100644 index 0000000000..faeb67ccf2 --- /dev/null +++ b/docs/reference/commandline/checkpoint_rm.md @@ -0,0 +1,18 @@ +# checkpoint rm + + +Remove a checkpoint + +### Aliases + +`docker checkpoint rm`, `docker checkpoint remove` + +### Options + +| Name | Type | Default | Description | +|:-------------------|:---------|:--------|:------------------------------------------| +| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | + + + + diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index 9fa1cd3a11..9180906af0 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -24,31 +24,89 @@ redirect_from: To list available commands, either run `docker` with no parameters or execute `docker help`: -```console -$ docker -Usage: docker [OPTIONS] COMMAND [ARG...] - docker [ --help | -v | --version ] + +The base command for the Docker CLI. -A self-sufficient runtime for containers. +### Subcommands -Options: - --config string Location of client config files (default "/root/.docker") - -c, --context string Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with "docker context use") - -D, --debug Enable debug mode - --help Print usage - -H, --host value Daemon socket(s) to connect to (default []) - -l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") - --tls Use TLS; implied by --tlsverify - --tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem") - --tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem") - --tlskey string Path to TLS key file (default "/root/.docker/key.pem") - --tlsverify Use TLS and verify the remote - -v, --version Print version information and quit +| Name | Description | +|:------------------------------|:------------------------------------------------------------------------------| +| [`attach`](attach.md) | Attach local standard input, output, and error streams to a running container | +| [`build`](build.md) | Build an image from a Dockerfile | +| [`builder`](builder.md) | Manage builds | +| [`checkpoint`](checkpoint.md) | Manage checkpoints | +| [`commit`](commit.md) | Create a new image from a container's changes | +| [`config`](config.md) | Manage Swarm configs | +| [`container`](container.md) | Manage containers | +| [`context`](context.md) | Manage contexts | +| [`cp`](cp.md) | Copy files/folders between a container and the local filesystem | +| [`create`](create.md) | Create a new container | +| [`diff`](diff.md) | Inspect changes to files or directories 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 | +| [`history`](history.md) | Show the history of an image | +| [`image`](image.md) | Manage images | +| [`images`](images.md) | List images | +| [`import`](import.md) | Import the contents from a tarball to create a filesystem image | +| [`info`](info.md) | Display system-wide information | +| [`inspect`](inspect.md) | Return low-level information on Docker objects | +| [`kill`](kill.md) | Kill one or more running containers | +| [`load`](load.md) | Load an image from a tar archive or STDIN | +| [`login`](login.md) | Log in to a registry | +| [`logout`](logout.md) | Log out from a registry | +| [`logs`](logs.md) | Fetch the logs of a container | +| [`manifest`](manifest.md) | Manage Docker image manifests and manifest lists | +| [`network`](network.md) | Manage networks | +| [`node`](node.md) | Manage Swarm nodes | +| [`pause`](pause.md) | Pause all processes within one or more containers | +| [`plugin`](plugin.md) | Manage plugins | +| [`port`](port.md) | List port mappings or a specific mapping for the container | +| [`ps`](ps.md) | List containers | +| [`pull`](pull.md) | Download an image from a registry | +| [`push`](push.md) | Upload an image to a registry | +| [`rename`](rename.md) | Rename a container | +| [`restart`](restart.md) | Restart one or more containers | +| [`rm`](rm.md) | Remove one or more containers | +| [`rmi`](rmi.md) | Remove one or more images | +| [`run`](run.md) | Create and run a new container from an image | +| [`save`](save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) | +| [`search`](search.md) | Search Docker Hub for images | +| [`secret`](secret.md) | Manage Swarm secrets | +| [`service`](service.md) | Manage Swarm services | +| [`stack`](stack.md) | Manage Swarm stacks | +| [`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 one or more running containers | +| [`swarm`](swarm.md) | Manage Swarm | +| [`system`](system.md) | Manage Docker | +| [`tag`](tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE | +| [`top`](top.md) | Display the running processes of a container | +| [`trust`](trust.md) | Manage trust on Docker images | +| [`unpause`](unpause.md) | Unpause all processes within one or more containers | +| [`update`](update.md) | Update configuration of one or more containers | +| [`version`](version.md) | Show the Docker version information | +| [`volume`](volume.md) | Manage volumes | +| [`wait`](wait.md) | Block until one or more containers stop, then print their exit codes | -Commands: - attach Attach to a running container - # […] -``` + +### Options + +| Name | Type | Default | Description | +|:--------------------|:---------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------| +| `--config` | `string` | `/root/.docker` | Location of client config files | +| `-c`, `--context` | `string` | | Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with `docker context use`) | +| `-D`, `--debug` | | | Enable debug mode | +| `-H`, `--host` | `list` | | Daemon socket(s) to connect to | +| `-l`, `--log-level` | `string` | `info` | Set the logging level (`debug`, `info`, `warn`, `error`, `fatal`) | +| `--tls` | | | Use TLS; implied by --tlsverify | +| `--tlscacert` | `string` | `/root/.docker/ca.pem` | Trust certs signed only by this CA | +| `--tlscert` | `string` | `/root/.docker/cert.pem` | Path to TLS certificate file | +| `--tlskey` | `string` | `/root/.docker/key.pem` | Path to TLS key file | +| `--tlsverify` | | | Use TLS and verify the remote | + + + ## Description diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md index 480a2ee9b3..353da72e4a 100644 --- a/docs/reference/commandline/commit.md +++ b/docs/reference/commandline/commit.md @@ -1,26 +1,23 @@ ---- -title: "commit" -description: "The commit command description and usage" -keywords: "commit, file, changes" ---- - # commit -```markdown -Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]] - + Create a new image from a container's changes -Aliases: - docker container commit, docker commit +### Aliases -Options: - -a, --author string Author (e.g., "John Hannibal Smith ") - -c, --change value Apply Dockerfile instruction to the created image (default []) - --help Print usage - -m, --message string Commit message - -p, --pause Pause container during commit (default true) -``` +`docker container commit`, `docker commit` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-----------------------------------------------------------| +| `-a`, `--author` | `string` | | Author (e.g., `John Hannibal Smith `) | +| [`-c`](#change), [`--change`](#change) | `list` | | Apply Dockerfile instruction to the created image | +| `-m`, `--message` | `string` | | Commit message | +| `-p`, `--pause` | | | Pause container during commit | + + + ## Description diff --git a/docs/reference/commandline/config.md b/docs/reference/commandline/config.md index 80ea03dfac..36c04c80b2 100644 --- a/docs/reference/commandline/config.md +++ b/docs/reference/commandline/config.md @@ -1,27 +1,20 @@ ---- -title: "config" -description: "The config command description and usage" -keywords: "config" ---- - # config -```markdown -Usage: docker config COMMAND - + Manage Swarm configs -Options: - --help Print usage +### Subcommands -Commands: - create Create a config from a file or STDIN - inspect Display detailed information on one or more configs - ls List configs - rm Remove one or more configs +| Name | Description | +|:-------------------------------|:----------------------------------------------------| +| [`create`](config_create.md) | Create a config from a file or STDIN | +| [`inspect`](config_inspect.md) | Display detailed information on one or more configs | +| [`ls`](config_ls.md) | List configs | +| [`rm`](config_rm.md) | Remove one or more configs | -Run 'docker config COMMAND --help' for more information on a command. -``` + + + ## Description diff --git a/docs/reference/commandline/config_create.md b/docs/reference/commandline/config_create.md index a132053175..c7465dbb1d 100644 --- a/docs/reference/commandline/config_create.md +++ b/docs/reference/commandline/config_create.md @@ -1,20 +1,17 @@ ---- -title: "config create" -description: "The config create command description and usage" -keywords: ["config, create"] ---- - # config create -```Markdown -Usage: docker config create [OPTIONS] CONFIG [file|-] + +Create a config from a file or STDIN -Create a config from a file or STDIN as content +### Options -Options: - -l, --label list Config labels - --template-driver string Template driver -``` +| Name | Type | Default | Description | +|:------------------------------------|:---------|:--------|:----------------| +| [`-l`](#label), [`--label`](#label) | `list` | | Config labels | +| `--template-driver` | `string` | | Template driver | + + + ## Description diff --git a/docs/reference/commandline/config_inspect.md b/docs/reference/commandline/config_inspect.md index 5733d65adb..e112a3c95d 100644 --- a/docs/reference/commandline/config_inspect.md +++ b/docs/reference/commandline/config_inspect.md @@ -1,24 +1,17 @@ ---- -title: "config inspect" -description: "The config inspect command description and usage" -keywords: ["config, inspect"] ---- - # config inspect -```Markdown -Usage: docker config inspect [OPTIONS] CONFIG [CONFIG...] - + Display detailed information on one or more configs -Options: - -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 - --pretty Print the information in a human friendly format - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | +| `--pretty` | | | Print the information in a human friendly format | + + + ## Description diff --git a/docs/reference/commandline/config_ls.md b/docs/reference/commandline/config_ls.md index cc25ad4afd..68c36404ad 100644 --- a/docs/reference/commandline/config_ls.md +++ b/docs/reference/commandline/config_ls.md @@ -1,25 +1,22 @@ ---- -title: "config ls" -description: "The config ls command description and usage" -keywords: ["config, ls"] ---- - # config ls -```Markdown -Usage: docker config ls [OPTIONS] - + List configs -Aliases: - ls, list +### Aliases -Options: - -f, --filter filter Filter output based on conditions provided - --format string Pretty-print configs using a Go template - --help Print usage - -q, --quiet Only display IDs -``` +`docker config ls`, `docker config list` + +### 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:
'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 | +| `-q`, `--quiet` | | | Only display IDs | + + + ## Description diff --git a/docs/reference/commandline/config_rm.md b/docs/reference/commandline/config_rm.md index 03b7413ce1..d5b7380c88 100644 --- a/docs/reference/commandline/config_rm.md +++ b/docs/reference/commandline/config_rm.md @@ -1,22 +1,14 @@ ---- -title: "config rm" -description: "The config rm command description and usage" -keywords: ["config, rm"] ---- - # config rm -```Markdown -Usage: docker config rm CONFIG [CONFIG...] - + Remove one or more configs -Aliases: - rm, remove +### Aliases -Options: - --help Print usage -``` +`docker config rm`, `docker config remove` + + + ## Description diff --git a/docs/reference/commandline/container.md b/docs/reference/commandline/container.md index ec5166a2bc..776892eeb1 100644 --- a/docs/reference/commandline/container.md +++ b/docs/reference/commandline/container.md @@ -1,50 +1,42 @@ ---- -title: "container" -description: "The container command description and usage" -keywords: "container" ---- - # container -```markdown -Usage: docker container COMMAND - + Manage containers -Options: - --help Print usage +### Subcommands -Commands: - attach Attach to a running container - commit Create a new image from a container's changes - cp Copy files/folders between a container and the local filesystem - create Create a new container - diff Inspect changes to files or directories on a container's filesystem - exec Execute a command in a running container - export Export a container's filesystem as a tar archive - inspect Display detailed information on one or more containers - kill Kill one or more running containers - logs Fetch the logs of a container - ls List containers - pause Pause all processes within one or more containers - port List port mappings or a specific mapping for the container - prune Remove all stopped containers - rename Rename a container - restart Restart one or more containers - rm Remove one or more containers - run Create and run a new container from an image - start Start one or more stopped containers - stats Display a live stream of container(s) resource usage statistics - stop Stop one or more running containers - top Display the running processes of a container - unpause Unpause all processes within one or more containers - update Update configuration of one or more containers - wait Block until one or more containers stop, then print their exit codes +| Name | Description | +|:----------------------------------|:------------------------------------------------------------------------------| +| [`attach`](container_attach.md) | Attach local standard input, output, and error streams to a running container | +| [`commit`](container_commit.md) | Create a new image from a container's changes | +| [`cp`](container_cp.md) | Copy files/folders between a container and the local filesystem | +| [`create`](container_create.md) | Create a new container | +| [`diff`](container_diff.md) | Inspect changes to files or directories on a container's filesystem | +| [`exec`](container_exec.md) | Execute a command in a running container | +| [`export`](container_export.md) | Export a container's filesystem as a tar archive | +| [`inspect`](container_inspect.md) | Display detailed information on one or more containers | +| [`kill`](container_kill.md) | Kill one or more running containers | +| [`logs`](container_logs.md) | Fetch the logs of a container | +| [`ls`](container_ls.md) | List containers | +| [`pause`](container_pause.md) | Pause all processes within one or more containers | +| [`port`](container_port.md) | List port mappings or a specific mapping for the container | +| [`prune`](container_prune.md) | Remove all stopped containers | +| [`rename`](container_rename.md) | Rename a container | +| [`restart`](container_restart.md) | Restart one or more containers | +| [`rm`](container_rm.md) | Remove one or more containers | +| [`run`](container_run.md) | Create and run a new container from an image | +| [`start`](container_start.md) | Start one or more stopped containers | +| [`stats`](container_stats.md) | Display a live stream of container(s) resource usage statistics | +| [`stop`](container_stop.md) | Stop one or more running containers | +| [`top`](container_top.md) | Display the running processes of a container | +| [`unpause`](container_unpause.md) | Unpause all processes within one or more containers | +| [`update`](container_update.md) | Update configuration of one or more containers | +| [`wait`](container_wait.md) | Block until one or more containers stop, then print their exit codes | -Run 'docker container COMMAND --help' for more information on a command. -``` + + ## Description diff --git a/docs/reference/commandline/container_attach.md b/docs/reference/commandline/container_attach.md new file mode 100644 index 0000000000..10ce5539a2 --- /dev/null +++ b/docs/reference/commandline/container_attach.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..7a4e63b986 --- /dev/null +++ b/docs/reference/commandline/container_commit.md @@ -0,0 +1,24 @@ +# 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 new file mode 100644 index 0000000000..4c91817bd3 --- /dev/null +++ b/docs/reference/commandline/container_cp.md @@ -0,0 +1,28 @@ +# 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 new file mode 100644 index 0000000000..ddd74b15cc --- /dev/null +++ b/docs/reference/commandline/container_create.md @@ -0,0 +1,118 @@ +# 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) | +| `-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-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 new file mode 100644 index 0000000000..03e537c5ee --- /dev/null +++ b/docs/reference/commandline/container_diff.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..1f7d4aa4fa --- /dev/null +++ b/docs/reference/commandline/container_exec.md @@ -0,0 +1,29 @@ +# 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 new file mode 100644 index 0000000000..c0f1220587 --- /dev/null +++ b/docs/reference/commandline/container_export.md @@ -0,0 +1,21 @@ +# 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_inspect.md b/docs/reference/commandline/container_inspect.md new file mode 100644 index 0000000000..8ebd2157ae --- /dev/null +++ b/docs/reference/commandline/container_inspect.md @@ -0,0 +1,14 @@ +# container inspect + + +Display detailed information on one or more containers + +### 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 | +| `-s`, `--size` | | | Display total file sizes | + + + diff --git a/docs/reference/commandline/container_kill.md b/docs/reference/commandline/container_kill.md new file mode 100644 index 0000000000..a7febea02e --- /dev/null +++ b/docs/reference/commandline/container_kill.md @@ -0,0 +1,21 @@ +# 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 new file mode 100644 index 0000000000..f35a96d2b9 --- /dev/null +++ b/docs/reference/commandline/container_logs.md @@ -0,0 +1,26 @@ +# 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 new file mode 100644 index 0000000000..76fb07c75e --- /dev/null +++ b/docs/reference/commandline/container_ls.md @@ -0,0 +1,28 @@ +# 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 new file mode 100644 index 0000000000..bdd0ec7bc9 --- /dev/null +++ b/docs/reference/commandline/container_pause.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..bf27663ee7 --- /dev/null +++ b/docs/reference/commandline/container_port.md @@ -0,0 +1,15 @@ +# 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_prune.md b/docs/reference/commandline/container_prune.md index a1cc3388dd..179a4e23d2 100644 --- a/docs/reference/commandline/container_prune.md +++ b/docs/reference/commandline/container_prune.md @@ -1,22 +1,17 @@ ---- -title: "container prune" -description: "Remove all stopped containers" -keywords: container, prune, delete, remove ---- - # container prune -```markdown -Usage: docker container prune [OPTIONS] - + Remove all stopped containers -Options: -Options: - --filter filter Provide filter values (e.g. 'until=') - -f, --force Do not prompt for confirmation - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------| +| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | +| `-f`, `--force` | | | Do not prompt for confirmation | + + + ## Description diff --git a/docs/reference/commandline/container_rename.md b/docs/reference/commandline/container_rename.md new file mode 100644 index 0000000000..ecb5c786d5 --- /dev/null +++ b/docs/reference/commandline/container_rename.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..2a6d411667 --- /dev/null +++ b/docs/reference/commandline/container_restart.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..b3fd688877 --- /dev/null +++ b/docs/reference/commandline/container_rm.md @@ -0,0 +1,23 @@ +# container rm + + +Remove one or more containers + +### Aliases + +`docker container rm`, `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 new file mode 100644 index 0000000000..63ec20b88d --- /dev/null +++ b/docs/reference/commandline/container_run.md @@ -0,0 +1,121 @@ +# 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) | +| `-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-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 new file mode 100644 index 0000000000..9ad73bcc34 --- /dev/null +++ b/docs/reference/commandline/container_start.md @@ -0,0 +1,25 @@ +# 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 new file mode 100644 index 0000000000..6c42550f83 --- /dev/null +++ b/docs/reference/commandline/container_stats.md @@ -0,0 +1,24 @@ +# 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 new file mode 100644 index 0000000000..e61890b071 --- /dev/null +++ b/docs/reference/commandline/container_stop.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..f314f2a401 --- /dev/null +++ b/docs/reference/commandline/container_top.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..bd5e34761c --- /dev/null +++ b/docs/reference/commandline/container_unpause.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 0000000000..9095e298e9 --- /dev/null +++ b/docs/reference/commandline/container_update.md @@ -0,0 +1,34 @@ +# 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 new file mode 100644 index 0000000000..013ea92c1c --- /dev/null +++ b/docs/reference/commandline/container_wait.md @@ -0,0 +1,15 @@ +# 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/context.md b/docs/reference/commandline/context.md index 6d3420de7d..f9267aca38 100644 --- a/docs/reference/commandline/context.md +++ b/docs/reference/commandline/context.md @@ -1,33 +1,25 @@ ---- -title: "context" -description: "The context command description and usage" -keywords: "context" ---- - # config -```markdown + Manage contexts -Usage: -docker context [command] +### Subcommands -Available Commands: -create Create new context -export Export a context to a tar or kubeconfig file -import Import a context from a tar or zip file -inspect Display detailed information on one or more contexts -list List available contexts -rm Remove one or more contexts -show Print the current context -update Update a context -use Set the default context +| Name | Description | +|:--------------------------------|:------------------------------------------------------------------| +| [`create`](context_create.md) | Create a context | +| [`export`](context_export.md) | Export a context to a tar archive FILE or a tar stream on STDOUT. | +| [`import`](context_import.md) | Import a context from a tar or zip file | +| [`inspect`](context_inspect.md) | Display detailed information on one or more contexts | +| [`ls`](context_ls.md) | List contexts | +| [`rm`](context_rm.md) | Remove one or more contexts | +| [`show`](context_show.md) | Print the name of the current context | +| [`update`](context_update.md) | Update a context | +| [`use`](context_use.md) | Set the current docker context | -Flags: --h, --help Help for context -Use "docker context [command] --help" for more information about a command. -``` + + ## Description diff --git a/docs/reference/commandline/context_create.md b/docs/reference/commandline/context_create.md index 0b779d3a53..ae35fad844 100644 --- a/docs/reference/commandline/context_create.md +++ b/docs/reference/commandline/context_create.md @@ -1,20 +1,12 @@ ---- -title: "context create" -description: "The context create command description and usage" -keywords: "context, create" ---- - # context create -```markdown -Usage: docker context create [OPTIONS] CONTEXT - + Create a context Docker endpoint config: NAME DESCRIPTION -from Copy Docker endpoint configuration from an existing context +from Copy named context's Docker endpoint configuration host Docker endpoint on which to connect ca Trust certs signed only by this CA cert Path to TLS certificate file @@ -23,16 +15,19 @@ skip-tls-verify Skip TLS certificate validation Example: -$ docker context create my-context \ - --description "some description" \ - --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file" +$ docker context create my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file" -Options: - --description string Description of the context - --docker stringToString set the docker endpoint - (default []) - --from string Create the context from an existing context -``` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:-----------------|:--------|:------------------------------------| +| `--description` | `string` | | Description of the context | +| [`--docker`](#docker) | `stringToString` | | set the docker endpoint | +| [`--from`](#from) | `string` | | create context from a named context | + + + ## Description diff --git a/docs/reference/commandline/context_export.md b/docs/reference/commandline/context_export.md index 1e8c581f8d..efa64090ac 100644 --- a/docs/reference/commandline/context_export.md +++ b/docs/reference/commandline/context_export.md @@ -1,16 +1,10 @@ ---- -title: "context export" -description: "The context export command description and usage" -keywords: "context, export" ---- - # context export -```markdown -Usage: docker context export [OPTIONS] CONTEXT [FILE|-] - + Export a context to a tar archive FILE or a tar stream on STDOUT. -``` + + + ## Description diff --git a/docs/reference/commandline/context_import.md b/docs/reference/commandline/context_import.md index 70de069c1d..741b610b18 100644 --- a/docs/reference/commandline/context_import.md +++ b/docs/reference/commandline/context_import.md @@ -1,16 +1,10 @@ ---- -title: "context import" -description: "The context import command description and usage" -keywords: "context, import" ---- - # context import -```markdown -Usage: docker context import [OPTIONS] CONTEXT FILE|- + +Import a context from a tar or zip file -Import a context from a tar file -``` + + ## Description diff --git a/docs/reference/commandline/context_inspect.md b/docs/reference/commandline/context_inspect.md index 7125ec3ac8..db04950288 100644 --- a/docs/reference/commandline/context_inspect.md +++ b/docs/reference/commandline/context_inspect.md @@ -1,22 +1,16 @@ ---- -title: "context inspect" -description: "The context inspect command description and usage" -keywords: "context, inspect" ---- - # context inspect -```markdown -Usage: docker context inspect [OPTIONS] [CONTEXT] [CONTEXT...] - + Display detailed information on one or more contexts -Options: - -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 -``` +### 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 | + + + ## Description diff --git a/docs/reference/commandline/context_ls.md b/docs/reference/commandline/context_ls.md index 89f2b80638..e7d9b0ea15 100644 --- a/docs/reference/commandline/context_ls.md +++ b/docs/reference/commandline/context_ls.md @@ -1,28 +1,21 @@ ---- -title: "context ls" -description: "The context ls command description and usage" -keywords: "context, ls" ---- - # context ls -```markdown -Usage: docker context ls [OPTIONS] - + List contexts -Aliases: - ls, list +### Aliases -Options: - --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 - -q, --quiet Only show context names -``` +`docker context ls`, `docker context list` + +### 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 | +| `-q`, `--quiet` | | | Only show context names | + + + ## Examples diff --git a/docs/reference/commandline/context_rm.md b/docs/reference/commandline/context_rm.md index fdf5521cb6..933941580a 100644 --- a/docs/reference/commandline/context_rm.md +++ b/docs/reference/commandline/context_rm.md @@ -1,19 +1,17 @@ ---- -title: "context rm" -description: "The context rm command description and usage" -keywords: "context, rm" ---- - # context rm -```markdown -Usage: docker context rm CONTEXT [CONTEXT...] - + Remove one or more contexts -Aliases: - rm, remove +### Aliases -Options: - -f, --force Force the removal of a context in use -``` +`docker context rm`, `docker context remove` + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:--------------------------------------| +| `-f`, `--force` | | | Force the removal of a context in use | + + + diff --git a/docs/reference/commandline/context_show.md b/docs/reference/commandline/context_show.md index ba08fa73a0..a2a9b4120f 100644 --- a/docs/reference/commandline/context_show.md +++ b/docs/reference/commandline/context_show.md @@ -1,16 +1,10 @@ ---- -title: "context show" -description: "The context show command description and usage" -keywords: "context, show" ---- - # context show -```markdown -Usage: docker context show - + Print the name of the current context -``` + + + ## Description diff --git a/docs/reference/commandline/context_update.md b/docs/reference/commandline/context_update.md index c132952abf..9b580bfa80 100644 --- a/docs/reference/commandline/context_update.md +++ b/docs/reference/commandline/context_update.md @@ -1,20 +1,12 @@ ---- -title: "context update" -description: "The context update command description and usage" -keywords: "context, update" ---- - # context update -```markdown -Usage: docker context update [OPTIONS] CONTEXT - + Update a context Docker endpoint config: NAME DESCRIPTION -from Copy Docker endpoint configuration from an existing context +from Copy named context's Docker endpoint configuration host Docker endpoint on which to connect ca Trust certs signed only by this CA cert Path to TLS certificate file @@ -25,11 +17,16 @@ Example: $ docker context update my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file" -Options: - --description string Description of the context - --docker stringToString set the docker endpoint - (default []) -``` + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----------------|:--------|:---------------------------| +| `--description` | `string` | | Description of the context | +| `--docker` | `stringToString` | | set the docker endpoint | + + + ## Description diff --git a/docs/reference/commandline/context_use.md b/docs/reference/commandline/context_use.md index 7e8d68a511..32b33628d3 100644 --- a/docs/reference/commandline/context_use.md +++ b/docs/reference/commandline/context_use.md @@ -1,16 +1,10 @@ ---- -title: "context use" -description: "The context use command description and usage" -keywords: "context, use" ---- - # context use -```markdown -Usage: docker context use CONTEXT - + Set the current docker context -``` + + + ## Description diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md index d9dd41f774..37697de169 100644 --- a/docs/reference/commandline/cp.md +++ b/docs/reference/commandline/cp.md @@ -1,15 +1,6 @@ ---- -title: "cp" -description: "The cp command description and usage" -keywords: "copy, container, files, folders" ---- - # cp -```markdown -Usage: docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|- - docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH - + Copy files/folders between a container and the local filesystem Use '-' as the source to read a tar archive from stdin @@ -17,14 +8,20 @@ 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 +### Aliases -Options: - -L, --follow-link Always follow symbol link in SRC_PATH - -a, --archive Archive mode (copy all uid/gid information) - --help Print usage -``` +`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 diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index e96255d67c..c85786328b 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -1,141 +1,117 @@ ---- -title: "create" -description: "The create command description and usage" -keywords: "docker, create, container" ---- - # create -Creates a new container. - -```markdown -Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...] - + Create a new container -Aliases: - docker container create, docker create +### Aliases -Options: - --add-host value Add a custom host-to-IP mapping (host:ip) (default []) - -a, --attach value Attach to STDIN, STDOUT or STDERR (default []) - --blkio-weight value Block IO (relative weight), between 10 and 1000 - --blkio-weight-device value Block IO weight (relative device weight) (default []) - --cap-add value Add Linux capabilities (default []) - --cap-drop value Drop Linux capabilities (default []) - --cgroupns string Cgroup namespace to use - 'host': Run the container in the Docker host's cgroup namespace - 'private': Run the container in its own private cgroup namespace - '': Use the default Docker daemon cgroup namespace specified by the `--default-cgroupns-mode` option - --cgroup-parent string Optional parent cgroup for the container - --cidfile string Write the container ID to the file - --cpu-count int The number of CPUs available for execution by the container. - Windows daemon only. On Windows Server containers, this is - approximated as a percentage of total CPU usage. - --cpu-percent int CPU percent (Windows only) - --cpu-period int Limit CPU CFS (Completely Fair Scheduler) period - --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota - -c, --cpu-shares int CPU shares (relative weight) - --cpus NanoCPUs Number of CPUs (default 0.000) - --cpu-rt-period int Limit the CPU real-time period in microseconds - --cpu-rt-runtime int Limit the CPU real-time runtime in microseconds - --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 value Add a host device to the container (default []) - --device-cgroup-rule value Add a rule to the cgroup allowed devices list - --device-read-bps value Limit read rate (bytes per second) from a device (default []) - --device-read-iops value Limit read rate (IO per second) from a device (default []) - --device-write-bps value Limit write rate (bytes per second) to a device (default []) - --device-write-iops value Limit write rate (IO per second) to a device (default []) - --disable-content-trust Skip image verification (default true) - --dns value Set custom DNS servers (default []) - --dns-option value Set DNS options (default []) - --dns-search value Set custom DNS search domains (default []) - --domainname string Container NIS domain name - --entrypoint string Overwrite the default ENTRYPOINT of the image - -e, --env value Set environment variables (default []) - --env-file value Read in a file of environment variables (default []) - --expose value Expose a port or a range of ports (default []) - --group-add value Add additional groups to join (default []) - --health-cmd string Command to run to check health - --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) - --health-retries int Consecutive failures needed to report unhealthy - --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) - --health-start-period duration Start period for the container to initialize before counting retries towards unstable (ns|us|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 string Maximum IO bandwidth limit for the system drive (Windows only) - --io-maxiops uint 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 namespace to use - --isolation string Container isolation technology - --kernel-memory string Kernel memory limit - -l, --label value Set meta data on a container (default []) - --label-file value Read in a line delimited file of labels (default []) - --link value Add link to another container (default []) - --link-local-ip value Container IPv4/IPv6 link-local addresses (default []) - --log-driver string Logging driver for the container - --log-opt value Log driver options (default []) - --mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33) - -m, --memory string Memory limit - --memory-reservation string Memory soft limit - --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap - --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) - --mount value Attach a filesystem mount to the container (default []) - --name string Assign a name to the container - --network-alias value Add network-scoped alias for the container (default []) - --network string Connect a container to a network (default "default") - 'bridge': create a network stack on the default Docker bridge - 'none': no networking - 'container:': reuse another container's network stack - 'host': use the Docker host network stack - '|': connect to a user-defined network - --no-healthcheck Disable any container-specified HEALTHCHECK - --oom-kill-disable Disable OOM Killer - --oom-score-adj int Tune host's OOM preferences (-1000 to 1000) - --pid string PID namespace to use - --pids-limit int Tune container pids limit (set -1 for unlimited), kernel >= 4.3 - --privileged Give extended privileges to this container - -p, --publish value Publish a container's port(s) to the host (default []) - -P, --publish-all Publish all exposed ports to random ports - --pull string Pull image before creating ("always"|"missing"|"never") (default "missing") - -q, --quiet Suppress the pull output - --read-only Mount the container's root filesystem as read only - --restart string Restart policy to apply when a container exits (default "no") - Possible values are: no, on-failure[:max-retry], always, unless-stopped - --rm Automatically remove the container when it exits - --runtime string Runtime to use for this container - --security-opt value Security Options (default []) - --shm-size bytes Size of /dev/shm - The format is ``. `number` must be greater than `0`. - Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), - or `g` (gigabytes). If you omit the unit, the system uses bytes. - --stop-signal string Signal to stop the container - --stop-timeout int Timeout (in seconds) to stop a container - --storage-opt value Storage driver options for the container (default []) - --sysctl value Sysctl options (default map[]) - --tmpfs value Mount a tmpfs directory (default []) - -t, --tty Allocate a pseudo-TTY - --ulimit value Ulimit options (default []) - -u, --user string Username or UID (format: [:]) - --userns string User namespace to use - 'host': Use the Docker host user namespace - '': Use the Docker daemon user namespace specified by `--userns-remap` option. - --uts string UTS namespace to use - -v, --volume value Bind mount a volume (default []). The format - is `[host-src:]container-dest[:]`. - The comma-delimited `options` are [rw|ro], - [z|Z], [[r]shared|[r]slave|[r]private], - [delegated|cached|consistent], and - [nocopy]. The 'host-src' is an absolute path - or a name value. - --volume-driver string Optional volume driver for the container - --volumes-from value Mount volumes from the specified container(s) (default []) - -w, --workdir string Working directory inside the container -``` +`docker container create`, `docker create` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) | +| `-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-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 diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md index e2aea5059c..05f2990dbc 100644 --- a/docs/reference/commandline/diff.md +++ b/docs/reference/commandline/diff.md @@ -1,22 +1,14 @@ ---- -title: "diff" -description: "The diff command description and usage" -keywords: "list, changed, files, container" ---- - # diff -```markdown -Usage: docker diff CONTAINER - + Inspect changes to files or directories on a container's filesystem -Aliases: - docker container diff, docker diff +### Aliases -Options: - --help Print usage -``` +`docker container diff`, `docker diff` + + + ## Description diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index e058093219..906fd5b71a 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -1,26 +1,23 @@ ---- -title: "events" -description: "The events command description and usage" -keywords: "events, container, report" ---- - # events -```markdown -Usage: docker events [OPTIONS] - + Get real time events from the server -Aliases: - docker system events, docker events +### Aliases -Options: - -f, --filter value Filter output based on conditions provided (default []) - --format string Format the output using the given Go template - --help Print usage - --since string Show all events created since timestamp - --until string Stream events until this timestamp -``` +`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 the output using the given Go template | +| [`--since`](#since) | `string` | | Show all events created since timestamp | +| `--until` | `string` | | Stream events until this timestamp | + + + ## Description diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index e7e6b5662a..fc94bbecce 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -1,31 +1,28 @@ ---- -title: "exec" -description: "The exec command description and usage" -keywords: "command, container, run, execute" ---- - # exec -```markdown -Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...] - + Execute a command in a running container -Aliases: - docker container exec, docker exec +### Aliases -Options: - -d, --detach Detached mode: run command in the background - --detach-keys Override the key sequence for detaching a container - -e, --env=[] Set environment variables - --env-file Read in a file of environment variables - --help Print usage - -i, --interactive Keep STDIN open even if not attached - --privileged Give extended privileges to the command - -t, --tty Allocate a pseudo-TTY - -u, --user Username or UID (format: [:]) - -w, --workdir Working directory inside the container -``` +`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), [`--env`](#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), [`--workdir`](#workdir) | `string` | | Working directory inside the container | + + + ## Description diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md index 3c62af7c27..f2d84f1414 100644 --- a/docs/reference/commandline/export.md +++ b/docs/reference/commandline/export.md @@ -1,23 +1,20 @@ ---- -title: "export" -description: "The export command description and usage" -keywords: "export, file, system, container" ---- - # export -```markdown -Usage: docker export [OPTIONS] CONTAINER - + Export a container's filesystem as a tar archive -Aliases: - docker container export, docker export +### Aliases -Options: - --help Print usage - -o, --output string Write to a file, instead of STDOUT -``` +`docker container export`, `docker export` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-----------------------------------| +| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | + + + ## Description diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index 8b104c12c9..0756b1b646 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -1,27 +1,23 @@ ---- -title: "history" -description: "The history command description and usage" -keywords: "docker, image, history" ---- - # history -```markdown -Usage: docker history [OPTIONS] IMAGE - + Show the history of an image -Aliases: - docker image history, docker history +### Aliases -Options: - --format string Pretty-print images using a Go template - --help Print usage - -H, --human Print sizes and dates in human readable format (default true) - --no-trunc Don't truncate output - -q, --quiet Only show image IDs -``` +`docker image history`, `docker history` +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`--format`](#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 | + + + ## Examples diff --git a/docs/reference/commandline/image.md b/docs/reference/commandline/image.md index 4fbb782163..3aa0843c24 100644 --- a/docs/reference/commandline/image.md +++ b/docs/reference/commandline/image.md @@ -1,37 +1,28 @@ - ---- -title: "image" -description: "The image command description and usage" -keywords: "image" ---- - # image -```markdown -Usage: docker image COMMAND - + Manage images -Options: - --help Print usage +### Subcommands -Commands: - build Build an image from a Dockerfile - history Show the history of an image - import Import the contents from a tarball to create a filesystem image - inspect Display detailed information on one or more images - load Load an image from a tar archive or STDIN - ls List images - prune Remove unused images - pull Download an image from a registry - push Upload an image to a registry - rm Remove one or more images - save Save one or more images to a tar archive (streamed to STDOUT by default) - tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE +| Name | Description | +|:------------------------------|:-------------------------------------------------------------------------| +| [`build`](image_build.md) | Build an image from a Dockerfile | +| [`history`](image_history.md) | Show the history of an image | +| [`import`](image_import.md) | Import the contents from a tarball to create a filesystem image | +| [`inspect`](image_inspect.md) | Display detailed information on one or more images | +| [`load`](image_load.md) | Load an image from a tar archive or STDIN | +| [`ls`](image_ls.md) | List images | +| [`prune`](image_prune.md) | Remove unused images | +| [`pull`](image_pull.md) | Download an image from a registry | +| [`push`](image_push.md) | Upload an image to a registry | +| [`rm`](image_rm.md) | Remove one or more images | +| [`save`](image_save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) | +| [`tag`](image_tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE | -Run 'docker image COMMAND --help' for more information on a command. -``` + + ## Description diff --git a/docs/reference/commandline/image_build.md b/docs/reference/commandline/image_build.md new file mode 100644 index 0000000000..b60e61312a --- /dev/null +++ b/docs/reference/commandline/image_build.md @@ -0,0 +1,50 @@ +# 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` | | Optional parent cgroup for the container | +| `--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 new file mode 100644 index 0000000000..97f437cfb0 --- /dev/null +++ b/docs/reference/commandline/image_history.md @@ -0,0 +1,24 @@ +# 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 new file mode 100644 index 0000000000..0399a919c5 --- /dev/null +++ b/docs/reference/commandline/image_import.md @@ -0,0 +1,23 @@ +# 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_inspect.md b/docs/reference/commandline/image_inspect.md new file mode 100644 index 0000000000..1f59b0014d --- /dev/null +++ b/docs/reference/commandline/image_inspect.md @@ -0,0 +1,13 @@ +# image inspect + + +Display detailed information on one or more images + +### 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/image_load.md b/docs/reference/commandline/image_load.md new file mode 100644 index 0000000000..b78855c361 --- /dev/null +++ b/docs/reference/commandline/image_load.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..7cabd920f0 --- /dev/null +++ b/docs/reference/commandline/image_ls.md @@ -0,0 +1,26 @@ +# 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_prune.md b/docs/reference/commandline/image_prune.md index 56a1153ddd..d643583dae 100644 --- a/docs/reference/commandline/image_prune.md +++ b/docs/reference/commandline/image_prune.md @@ -1,22 +1,18 @@ ---- -title: "image prune" -description: "Remove all stopped images" -keywords: "image, prune, delete, remove" ---- - # image prune -```markdown -Usage: docker image prune [OPTIONS] - + Remove unused images -Options: - -a, --all Remove all unused images, not just dangling ones - --filter filter Provide filter values (e.g. 'until=') - -f, --force Do not prompt for confirmation - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------| +| `-a`, `--all` | | | Remove all unused images, not just dangling ones | +| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | +| `-f`, `--force` | | | Do not prompt for confirmation | + + + ## Description diff --git a/docs/reference/commandline/image_pull.md b/docs/reference/commandline/image_pull.md new file mode 100644 index 0000000000..d9f298eecb --- /dev/null +++ b/docs/reference/commandline/image_pull.md @@ -0,0 +1,24 @@ +# 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 new file mode 100644 index 0000000000..964b61aec1 --- /dev/null +++ b/docs/reference/commandline/image_push.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000000..4bd4e3f9e2 --- /dev/null +++ b/docs/reference/commandline/image_rm.md @@ -0,0 +1,22 @@ +# 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 new file mode 100644 index 0000000000..77aa3cdf8f --- /dev/null +++ b/docs/reference/commandline/image_save.md @@ -0,0 +1,21 @@ +# 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 new file mode 100644 index 0000000000..55dcdf7209 --- /dev/null +++ b/docs/reference/commandline/image_tag.md @@ -0,0 +1,15 @@ +# 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/images.md b/docs/reference/commandline/images.md index 63041949ff..fd99ab6c33 100644 --- a/docs/reference/commandline/images.md +++ b/docs/reference/commandline/images.md @@ -1,38 +1,25 @@ ---- -title: "images" -description: "The images command description and usage" -keywords: "list, docker, images" ---- - # images -```markdown -Usage: docker images [OPTIONS] [REPOSITORY[:TAG]] - + List images -Aliases: - docker image ls, docker image list, docker images +### Aliases -Options: - -a, --all Show all images (default hides intermediate images) - --digests Show digests - -f, --filter value Filter output based on conditions provided (default []) - - dangling=(true|false) - - label= or label== - - before=([:tag]||) - - since=([:tag]||) - - reference=(pattern of an image reference) - --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 - --help Print usage - --no-trunc Don't truncate output - -q, --quiet Only show image IDs -``` +`docker image ls`, `docker image list`, `docker images` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all images (default hides intermediate images) | +| [`--digests`](#digests) | | | Show digests | +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | +| [`--format`](#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`](#no-trunc) | | | Don't truncate output | +| `-q`, `--quiet` | | | Only show image IDs | + + + ## Description diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md index 17ca9723ce..5e38332821 100644 --- a/docs/reference/commandline/import.md +++ b/docs/reference/commandline/import.md @@ -1,25 +1,22 @@ ---- -title: "import" -description: "The import command description and usage" -keywords: "import, file, system, container" ---- - # import -```markdown -Usage: docker import [OPTIONS] file|URL|- [REPOSITORY[:TAG]] - + Import the contents from a tarball to create a filesystem image -Aliases: - docker image import, docker import +### Aliases -Options: - -c, --change value Apply Dockerfile instruction to the created image (default []) - --help Print usage - -m, --message string Set commit message for imported image - --platform string Set platform if server is multi-platform capable -``` +`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 diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md index a039097dc2..41235357ee 100644 --- a/docs/reference/commandline/info.md +++ b/docs/reference/commandline/info.md @@ -1,23 +1,20 @@ ---- -title: "info" -description: "The info command description and usage" -keywords: "display, docker, information" ---- - # info -```markdown -Usage: docker info [OPTIONS] - + Display system-wide information -Aliases: - docker system info, docker info +### Aliases -Options: - -f, --format string Format the output using the given Go template - --help Print usage -``` +`docker system info`, `docker info` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:----------------------------------------------| +| [`-f`](#format), [`--format`](#format) | `string` | | Format the output using the given Go template | + + + ## Description diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 85a71aa4fd..c7a2ee1a8f 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -1,23 +1,18 @@ ---- -title: "inspect" -description: "The inspect command description and usage" -keywords: "inspect, container, json" ---- - # inspect -```markdown -Usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] + +Return low-level information on Docker objects -Return low-level information on Docker object(s) (e.g. container, image, volume, -network, node, service, or task) identified by name or ID +### Options -Options: - -f, --format Format the output using the given Go template - --help Print usage - -s, --size Display total file sizes if the type is container - --type Return JSON for specified type -``` +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | +| [`-s`](#size), [`--size`](#size) | | | Display total file sizes if the type is container | +| [`--type`](#type) | `string` | | Return JSON for specified type | + + + ## Description diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md index fdd9eee4ed..2d12d6eb4d 100644 --- a/docs/reference/commandline/kill.md +++ b/docs/reference/commandline/kill.md @@ -1,23 +1,20 @@ ---- -title: "kill" -description: "The kill command description and usage" -keywords: "container, kill, signal" ---- - # kill -```markdown -Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...] - + Kill one or more running containers -Aliases: - docker container kill, docker kill +### Aliases -Options: - --help Print usage - -s, --signal string Signal to send to the container -``` +`docker container kill`, `docker kill` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:--------------------------------| +| [`-s`](#signal), [`--signal`](#signal) | `string` | | Signal to send to the container | + + + ## Description diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index a51355235c..c7e9316b1c 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -1,26 +1,21 @@ ---- -title: "load" -description: "The load command description and usage" -keywords: "stdin, tarred, repository" ---- - # load -```markdown -Usage: docker load [OPTIONS] + +Load an image from a tar archive or STDIN -Load an image or repository from a tar archive (even if compressed with gzip, -bzip2, or xz) from a file or STDIN. +### Aliases -Aliases: - docker image load, docker load +`docker image load`, `docker load` -Options: - --help Print usage - -i, --input string Read from tar archive file, instead of STDIN. - The tarball may be compressed with gzip, bzip, or xz - -q, --quiet Suppress the load output but still outputs the imported images -``` +### Options + +| Name | Type | Default | Description | +|:------------------------------------|:---------|:--------|:---------------------------------------------| +| [`-i`](#input), [`--input`](#input) | `string` | | Read from tar archive file, instead of STDIN | +| `-q`, `--quiet` | | | Suppress the load output | + + + ## Description diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 9c3504fb18..e41134f8a7 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -1,23 +1,19 @@ ---- -title: "login" -description: "The login command description and usage" -keywords: "registry, login, image" ---- - # login -```markdown -Usage: docker login [OPTIONS] [SERVER] - + Log in to a registry. If no server is specified, the default is defined by the daemon. -Options: - --help Print usage - -p, --password string Password - --password-stdin Read password from stdin - -u, --username string Username -``` +### Options + +| Name | Type | Default | Description | +|:--------------------------------------|:---------|:--------|:-----------------------------| +| `-p`, `--password` | `string` | | Password | +| [`--password-stdin`](#password-stdin) | | | Take the password from stdin | +| `-u`, `--username` | `string` | | Username | + + + ## Description diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index 393103a308..f9d6455595 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -1,20 +1,11 @@ ---- -title: "logout" -description: "The logout command description and usage" -keywords: "logout, docker, registry" ---- - # logout -```markdown -Usage: docker logout [SERVER] - + Log out from a registry. If no server is specified, the default is defined by the daemon. -Options: - --help Print usage -``` + + ## Examples diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 8545778d15..2c98415ae2 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -1,28 +1,25 @@ ---- -title: "logs" -description: "The logs command description and usage" -keywords: "logs, retrieve, docker" ---- - # logs -```markdown -Usage: docker logs [OPTIONS] CONTAINER - + Fetch the logs of a container -Aliases: - docker container logs, docker logs +### Aliases -Options: - --details Show extra details provided to logs - -f, --follow Follow log output - --help Print usage - --since string Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) - --until string Show logs before timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) - -n, --tail string Number of lines to show from the end of the logs (default "all") - -t, --timestamps Show timestamps -``` +`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`](#until) | `string` | | Show logs before a timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | + + + ## Description diff --git a/docs/reference/commandline/manifest.md b/docs/reference/commandline/manifest.md index 057fd18120..001f78a8f5 100644 --- a/docs/reference/commandline/manifest.md +++ b/docs/reference/commandline/manifest.md @@ -1,24 +1,32 @@ ---- -title: "manifest" -description: "The manifest command description and usage" -keywords: "docker, manifest" ---- +# manifest -```markdown -Usage: docker manifest COMMAND + -Manage Docker image manifests and manifest lists +The **docker manifest** command has subcommands for managing image manifests and +manifest lists. A manifest list allows you to use one name to refer to the same image +built for multiple architectures. -Options: - --help Print usage +To see help for a subcommand, use: -Commands: - annotate Add additional information to a local image manifest - create Create a local manifest list for annotating and pushing to a registry - inspect Display an image manifest, or manifest list - push Push a manifest list to a repository + docker manifest CMD --help -``` +For full details on using docker manifest lists, see the registry v2 specification. + + + +### Subcommands + +| Name | Description | +|:-----------------------------------|:----------------------------------------------------------------------| +| [`annotate`](manifest_annotate.md) | Add additional information to a local image manifest | +| [`create`](manifest_create.md) | Create a local manifest list for annotating and pushing to a registry | +| [`inspect`](manifest_inspect.md) | Display an image manifest, or manifest list | +| [`push`](manifest_push.md) | Push a manifest list to a repository | +| [`rm`](manifest_rm.md) | Delete one or more manifest lists from local storage | + + + + ## Description diff --git a/docs/reference/commandline/manifest_annotate.md b/docs/reference/commandline/manifest_annotate.md new file mode 100644 index 0000000000..e45566dc73 --- /dev/null +++ b/docs/reference/commandline/manifest_annotate.md @@ -0,0 +1,18 @@ +# manifest annotate + + +Add additional information to a local image manifest + +### Options + +| Name | Type | Default | Description | +|:----------------|:--------------|:--------|:-----------------------------| +| `--arch` | `string` | | Set architecture | +| `--os` | `string` | | Set operating system | +| `--os-features` | `stringSlice` | | Set operating system feature | +| `--os-version` | `string` | | Set operating system version | +| `--variant` | `string` | | Set architecture variant | + + + + diff --git a/docs/reference/commandline/manifest_create.md b/docs/reference/commandline/manifest_create.md new file mode 100644 index 0000000000..2879fae6f7 --- /dev/null +++ b/docs/reference/commandline/manifest_create.md @@ -0,0 +1,15 @@ +# manifest create + + +Create a local manifest list for annotating and pushing to a registry + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:----------------------------------------------| +| `-a`, `--amend` | | | Amend an existing manifest list | +| `--insecure` | | | Allow communication with an insecure registry | + + + + diff --git a/docs/reference/commandline/manifest_inspect.md b/docs/reference/commandline/manifest_inspect.md new file mode 100644 index 0000000000..79c062193c --- /dev/null +++ b/docs/reference/commandline/manifest_inspect.md @@ -0,0 +1,15 @@ +# manifest inspect + + +Display an image manifest, or manifest list + +### Options + +| Name | Type | Default | Description | +|:------------------|:-----|:--------|:-----------------------------------------------------| +| `--insecure` | | | Allow communication with an insecure registry | +| `-v`, `--verbose` | | | Output additional info including layers and platform | + + + + diff --git a/docs/reference/commandline/manifest_push.md b/docs/reference/commandline/manifest_push.md new file mode 100644 index 0000000000..67a7d18a4f --- /dev/null +++ b/docs/reference/commandline/manifest_push.md @@ -0,0 +1,15 @@ +# manifest push + + +Push a manifest list to a repository + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:------------------------------------------| +| `--insecure` | | | Allow push to an insecure registry | +| `-p`, `--purge` | | | Remove the local manifest list after push | + + + + diff --git a/docs/reference/commandline/manifest_rm.md b/docs/reference/commandline/manifest_rm.md new file mode 100644 index 0000000000..e3bd5f8c89 --- /dev/null +++ b/docs/reference/commandline/manifest_rm.md @@ -0,0 +1,8 @@ +# manifest rm + + +Delete one or more manifest lists from local storage + + + + diff --git a/docs/reference/commandline/network.md b/docs/reference/commandline/network.md index bf5e19b701..4fc743b839 100644 --- a/docs/reference/commandline/network.md +++ b/docs/reference/commandline/network.md @@ -1,42 +1,25 @@ ---- -title: "network" -description: "The network command description and usage" -keywords: "network" ---- - # network -```markdown -Usage: docker network COMMAND - + Manage networks -Options: - --help Print usage +### Subcommands -Commands: - connect Connect a container to a network - create Create a network - disconnect Disconnect a container from a network - inspect Display detailed information on one or more networks - ls List networks - prune Remove all unused networks - rm Remove one or more networks +| Name | Description | +|:--------------------------------------|:-----------------------------------------------------| +| [`connect`](network_connect.md) | Connect a container to a network | +| [`create`](network_create.md) | Create a network | +| [`disconnect`](network_disconnect.md) | Disconnect a container from a network | +| [`inspect`](network_inspect.md) | Display detailed information on one or more networks | +| [`ls`](network_ls.md) | List networks | +| [`prune`](network_prune.md) | Remove all unused networks | +| [`rm`](network_rm.md) | Remove one or more networks | -Run 'docker network COMMAND --help' for more information on a command. -``` + + + ## Description Manage networks. You can use subcommands to create, inspect, list, remove, prune, connect, and disconnect networks. - -## Related commands - -* [network create](network_create.md) -* [network inspect](network_inspect.md) -* [network list](network_ls.md) -* [network rm](network_rm.md) -* [network prune](network_prune.md) -* [network connect](network_connect.md) -* [network disconnect](network_disconnect.md) diff --git a/docs/reference/commandline/network_connect.md b/docs/reference/commandline/network_connect.md index 5afca53588..3f4e69cabb 100644 --- a/docs/reference/commandline/network_connect.md +++ b/docs/reference/commandline/network_connect.md @@ -1,24 +1,21 @@ ---- -title: "network connect" -description: "The network connect command description and usage" -keywords: "network, connect, user-defined" ---- - # network connect -```markdown -Usage: docker network connect [OPTIONS] NETWORK CONTAINER - + Connect a container to a network -Options: - --alias value Add network-scoped alias for the container (default []) - --help Print usage - --ip string IPv4 address (e.g., 172.30.100.104) - --ip6 string IPv6 address (e.g., 2001:db8::33) - --link value Add link to another container (default []) - --link-local-ip value Add a link-local address for the container (default []) -``` +### Options + +| Name | Type | Default | Description | +|:--------------------|:--------------|:--------|:-------------------------------------------| +| [`--alias`](#alias) | `stringSlice` | | Add network-scoped alias for the container | +| `--driver-opt` | `stringSlice` | | driver options for the network | +| [`--ip`](#ip) | `string` | | IPv4 address (e.g., `172.30.100.104`) | +| `--ip6` | `string` | | IPv6 address (e.g., `2001:db8::33`) | +| [`--link`](#link) | `list` | | Add link to another container | +| `--link-local-ip` | `stringSlice` | | Add a link-local address for the container | + + + ## Description diff --git a/docs/reference/commandline/network_create.md b/docs/reference/commandline/network_create.md index bfd006a5f0..e46170dcae 100644 --- a/docs/reference/commandline/network_create.md +++ b/docs/reference/commandline/network_create.md @@ -1,37 +1,31 @@ ---- -title: "network create" -description: "The network create command description and usage" -keywords: "network, create" ---- - # network create -```markdown -Usage: docker network create [OPTIONS] NETWORK - + Create a network -Options: - --attachable Enable manual container attachment - --ingress Specify the network provides the routing-mesh - --aux-address value Auxiliary IPv4 or IPv6 addresses used by Network - driver (default map[]) - -d, --driver string Driver to manage the Network (default "bridge") - --gateway value IPv4 or IPv6 Gateway for the master subnet (default []) - --help Print usage - --internal Restrict external access to the network - --ip-range value Allocate container ip from a sub-range (default []) - --ipam-driver string IP Address Management Driver (default "default") - --ipam-opt value Set IPAM driver specific options (default map[]) - --ipv6 Enable IPv6 networking - --label value Set metadata on a network (default []) - -o, --opt value Set driver specific options (default map[]) - --subnet value Subnet in CIDR format that represents a - network segment (default []) - --scope value Promote a network to swarm scope (value = [ local | swarm ]) - --config-only Creates a configuration only network - --config-from The name of the network from which to copy the configuration -``` +### Options + +| Name | Type | Default | Description | +|:--------------------------|:--------------|:----------|:--------------------------------------------------------| +| `--attachable` | | | Enable manual container attachment | +| `--aux-address` | `map` | `map[]` | Auxiliary IPv4 or IPv6 addresses used by Network driver | +| `--config-from` | `string` | | The network from which to copy the configuration | +| `--config-only` | | | Create a configuration only network | +| `-d`, `--driver` | `string` | `bridge` | Driver to manage the Network | +| `--gateway` | `stringSlice` | | IPv4 or IPv6 Gateway for the master subnet | +| [`--ingress`](#ingress) | | | Create swarm routing-mesh network | +| [`--internal`](#internal) | | | Restrict external access to the network | +| `--ip-range` | `stringSlice` | | Allocate container ip from a sub-range | +| `--ipam-driver` | `string` | `default` | IP Address Management Driver | +| `--ipam-opt` | `map` | `map[]` | Set IPAM driver specific options | +| `--ipv6` | | | Enable IPv6 networking | +| `--label` | `list` | | Set metadata on a network | +| `-o`, `--opt` | `map` | `map[]` | Set driver specific options | +| `--scope` | `string` | | Control the network's scope | +| `--subnet` | `stringSlice` | | Subnet in CIDR format that represents a network segment | + + + ## Description diff --git a/docs/reference/commandline/network_disconnect.md b/docs/reference/commandline/network_disconnect.md index 59ff61578b..8ab6b97035 100644 --- a/docs/reference/commandline/network_disconnect.md +++ b/docs/reference/commandline/network_disconnect.md @@ -1,20 +1,16 @@ ---- -title: "network disconnect" -description: "The network disconnect command description and usage" -keywords: "network, disconnect, user-defined" ---- - # network disconnect -```markdown -Usage: docker network disconnect [OPTIONS] NETWORK CONTAINER - + Disconnect a container from a network -Options: - -f, --force Force the container to disconnect from a network - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:-------------------------------------------------| +| `-f`, `--force` | | | Force the container to disconnect from a network | + + + ## Description diff --git a/docs/reference/commandline/network_inspect.md b/docs/reference/commandline/network_inspect.md index cae82a11e2..d0129d0fe1 100644 --- a/docs/reference/commandline/network_inspect.md +++ b/docs/reference/commandline/network_inspect.md @@ -1,24 +1,17 @@ ---- -title: "network inspect" -description: "The network inspect command description and usage" -keywords: "network, inspect, user-defined" ---- - # network inspect -```markdown -Usage: docker network inspect [OPTIONS] NETWORK [NETWORK...] - + Display detailed information on one or more networks -Options: - -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 - -v, --verbose Verbose output for diagnostics - --help Print usage -``` +### 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 | +| [`-v`](#verbose), [`--verbose`](#verbose) | | | Verbose output for diagnostics | + + + ## Description diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index b1d3aa001f..bce120c2ae 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -1,31 +1,23 @@ ---- -title: "network ls" -description: "The network ls command description and usage" -keywords: "network, list, user-defined" ---- - -# docker network ls - -```markdown -Usage: docker network ls [OPTIONS] +# network ls + List networks -Aliases: - ls, list +### Aliases -Options: - -f, --filter filter Provide filter values (e.g. 'driver=bridge') - --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 - --help Print usage - --no-trunc Do not truncate the output - -q, --quiet Only display network IDs -``` +`docker network ls`, `docker network list` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) | +| [`--format`](#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` | | | Do not truncate the output | +| `-q`, `--quiet` | | | Only display network IDs | + + + ## Description diff --git a/docs/reference/commandline/network_prune.md b/docs/reference/commandline/network_prune.md index f2a0db809b..f1ef35ec98 100644 --- a/docs/reference/commandline/network_prune.md +++ b/docs/reference/commandline/network_prune.md @@ -1,21 +1,17 @@ ---- -title: "network prune" -description: "Remove unused networks" -keywords: "network, prune, delete" ---- - # network prune -```markdown -Usage: docker network prune [OPTIONS] - + Remove all unused networks -Options: - --filter filter Provide filter values (e.g. 'until=') - -f, --force Do not prompt for confirmation - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------| +| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | +| `-f`, `--force` | | | Do not prompt for confirmation | + + + ## Description diff --git a/docs/reference/commandline/network_rm.md b/docs/reference/commandline/network_rm.md index 79869db5d7..755d2126fd 100644 --- a/docs/reference/commandline/network_rm.md +++ b/docs/reference/commandline/network_rm.md @@ -1,22 +1,20 @@ ---- -title: "network rm" -description: "the network rm command description and usage" -keywords: "network, rm, user-defined" ---- - # network rm -```markdown -Usage: docker network rm NETWORK [NETWORK...] - + Remove one or more networks -Aliases: - rm, remove +### Aliases -Options: - -f, --force Do not error if the network does not exist -``` +`docker network rm`, `docker network remove` + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:-------------------------------------------| +| `-f`, `--force` | | | Do not error if the network does not exist | + + + ## Description diff --git a/docs/reference/commandline/node.md b/docs/reference/commandline/node.md index 17f099a0fb..03b04102d1 100644 --- a/docs/reference/commandline/node.md +++ b/docs/reference/commandline/node.md @@ -1,31 +1,24 @@ ---- -title: "node" -description: "The node command description and usage" -keywords: "node" ---- - # node -```markdown -Usage: docker node COMMAND - + Manage Swarm nodes -Options: - --help Print usage +### Subcommands -Commands: - demote Demote one or more nodes from manager in the swarm - inspect Display detailed information on one or more nodes - ls List nodes in the swarm - promote Promote one or more nodes to manager in the swarm - ps List tasks running on one or more nodes, defaults to current node - rm Remove one or more nodes from the swarm - update Update a node +| Name | Description | +|:-----------------------------|:------------------------------------------------------------------| +| [`demote`](node_demote.md) | Demote one or more nodes from manager in the swarm | +| [`inspect`](node_inspect.md) | Display detailed information on one or more nodes | +| [`ls`](node_ls.md) | List nodes in the swarm | +| [`promote`](node_promote.md) | Promote one or more nodes to manager in the swarm | +| [`ps`](node_ps.md) | List tasks running on one or more nodes, defaults to current node | +| [`rm`](node_rm.md) | Remove one or more nodes from the swarm | +| [`update`](node_update.md) | Update a node | -Run 'docker node COMMAND --help' for more information on a command. -``` + + + ## Description diff --git a/docs/reference/commandline/node_demote.md b/docs/reference/commandline/node_demote.md index 7bb5b59bda..c48355490a 100644 --- a/docs/reference/commandline/node_demote.md +++ b/docs/reference/commandline/node_demote.md @@ -1,20 +1,10 @@ ---- -title: "node demote" -description: "The node demote command description and usage" -keywords: "node, demote" ---- - # node demote -```markdown -Usage: docker node demote NODE [NODE...] - + Demote one or more nodes from manager in the swarm -Options: - --help Print usage -``` + ## Description diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index 6e56212e37..056a1c8c36 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -1,24 +1,17 @@ ---- -title: "node inspect" -description: "The node inspect command description and usage" -keywords: "node, inspect" ---- - # node inspect -```markdown -Usage: docker node inspect [OPTIONS] self|NODE [NODE...] - + Display detailed information on one or more nodes -Options: - -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 - --pretty Print the information in a human friendly format - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | +| `--pretty` | | | Print the information in a human friendly format | + + + ## Description diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index bac7310374..1f49595fd0 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -1,30 +1,22 @@ ---- -title: "node ls" -description: "The node ls command description and usage" -keywords: "node, list" ---- - # node ls -```markdown -Usage: docker node ls [OPTIONS] - + List nodes in the swarm -Aliases: - ls, list +### Aliases -Options: - -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 - --help Print usage - -q, --quiet Only display IDs -``` +`docker node ls`, `docker node list` + +### 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:
'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 | +| `-q`, `--quiet` | | | Only display IDs | + + + ## Description diff --git a/docs/reference/commandline/node_promote.md b/docs/reference/commandline/node_promote.md index 665dd9486a..bfb110da97 100644 --- a/docs/reference/commandline/node_promote.md +++ b/docs/reference/commandline/node_promote.md @@ -1,19 +1,10 @@ ---- -title: "node promote" -description: "The node promote command description and usage" -keywords: "node, promote" ---- - # node promote -```markdown -Usage: docker node promote NODE [NODE...] - + Promote one or more nodes to manager in the swarm -Options: - --help Print usage -``` + + ## Description diff --git a/docs/reference/commandline/node_ps.md b/docs/reference/commandline/node_ps.md index b639c3835f..79b73cbc16 100644 --- a/docs/reference/commandline/node_ps.md +++ b/docs/reference/commandline/node_ps.md @@ -1,25 +1,20 @@ ---- -title: "node ps" -description: "The node ps command description and usage" -keywords: node, tasks, ps -aliases: ["/engine/reference/commandline/node_tasks/"] ---- - # node ps -```markdown -Usage: docker node ps [OPTIONS] [NODE...] + +List tasks running on one or more nodes, defaults to current node -List tasks running on one or more nodes, defaults to current node. +### Options -Options: - -f, --filter filter Filter output based on conditions provided - --format string Pretty-print tasks using a Go template - --help Print usage - --no-resolve Do not map IDs to Names - --no-trunc Do not truncate output - -q, --quiet Only display task IDs -``` +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------| +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | +| [`--format`](#format) | `string` | | Pretty-print tasks using a Go template | +| `--no-resolve` | | | Do not map IDs to Names | +| `--no-trunc` | | | Do not truncate output | +| `-q`, `--quiet` | | | Only display task IDs | + + + ## Description diff --git a/docs/reference/commandline/node_rm.md b/docs/reference/commandline/node_rm.md index 466128c7fe..83c1e3949d 100644 --- a/docs/reference/commandline/node_rm.md +++ b/docs/reference/commandline/node_rm.md @@ -1,23 +1,20 @@ ---- -title: "node rm" -description: "The node rm command description and usage" -keywords: "node, remove" ---- - # node rm -```markdown -Usage: docker node rm [OPTIONS] NODE [NODE...] - + Remove one or more nodes from the swarm -Aliases: - rm, remove +### Aliases -Options: - -f, --force Force remove a node from the swarm - --help Print usage -``` +`docker node rm`, `docker node remove` + +### Options + +| Name | Type | Default | Description | +|:------------------------------------|:-----|:--------|:-----------------------------------| +| [`-f`](#force), [`--force`](#force) | | | Force remove a node from the swarm | + + + ## Description diff --git a/docs/reference/commandline/node_update.md b/docs/reference/commandline/node_update.md index 93a4166655..14d051fc38 100644 --- a/docs/reference/commandline/node_update.md +++ b/docs/reference/commandline/node_update.md @@ -1,23 +1,19 @@ ---- -title: "node update" -description: "The node update command description and usage" -keywords: "resources, update, dynamically" ---- - # update -```markdown -Usage: docker node update [OPTIONS] NODE - + Update a node -Options: - --availability string Availability of the node ("active"|"pause"|"drain") - --help Print usage - --label-add value Add or update a node label (key=value) (default []) - --label-rm value Remove a node label if exists (default []) - --role string Role of the node ("worker"|"manager") -``` +### Options + +| Name | Type | Default | Description | +|:----------------------------|:---------|:--------|:------------------------------------------------------| +| `--availability` | `string` | | Availability of the node (`active`, `pause`, `drain`) | +| [`--label-add`](#label-add) | `list` | | Add or update a node label (`key=value`) | +| `--label-rm` | `list` | | Remove a node label if exists | +| `--role` | `string` | | Role of the node (`worker`, `manager`) | + + + ## Description diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md index ebb22e80e7..bf22b75442 100644 --- a/docs/reference/commandline/pause.md +++ b/docs/reference/commandline/pause.md @@ -1,22 +1,14 @@ ---- -title: "pause" -description: "The pause command description and usage" -keywords: "cgroups, container, suspend, SIGSTOP" ---- - # pause -```markdown -Usage: docker pause CONTAINER [CONTAINER...] - + Pause all processes within one or more containers -Aliases: - docker container pause, docker pause +### Aliases -Options: - --help Print usage -``` +`docker container pause`, `docker pause` + + + ## Description diff --git a/docs/reference/commandline/plugin.md b/docs/reference/commandline/plugin.md index 33beda292d..5db68473c8 100644 --- a/docs/reference/commandline/plugin.md +++ b/docs/reference/commandline/plugin.md @@ -1,34 +1,26 @@ ---- -title: "plugin" -description: "The plugin command description and usage" -keywords: "plugin" ---- - # plugin -```markdown -Usage: docker plugin COMMAND - + Manage plugins -Options: - --help Print usage +### Subcommands -Commands: - create Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory. - disable Disable a plugin - enable Enable a plugin - inspect Display detailed information on one or more plugins - install Install a plugin - ls List plugins - push Push a plugin to a registry - rm Remove one or more plugins - set Change settings for a plugin - upgrade Upgrade an existing plugin +| Name | Description | +|:-------------------------------|:----------------------------------------------------------------------------------------------------------------------| +| [`create`](plugin_create.md) | Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory. | +| [`disable`](plugin_disable.md) | Disable a plugin | +| [`enable`](plugin_enable.md) | Enable a plugin | +| [`inspect`](plugin_inspect.md) | Display detailed information on one or more plugins | +| [`install`](plugin_install.md) | Install a plugin | +| [`ls`](plugin_ls.md) | List plugins | +| [`push`](plugin_push.md) | Push a plugin to a registry | +| [`rm`](plugin_rm.md) | Remove one or more plugins | +| [`set`](plugin_set.md) | Change settings for a plugin | +| [`upgrade`](plugin_upgrade.md) | Upgrade an existing plugin | -Run 'docker plugin COMMAND --help' for more information on a command. -``` + + ## Description diff --git a/docs/reference/commandline/plugin_create.md b/docs/reference/commandline/plugin_create.md index 78cd78e874..1367bea15e 100644 --- a/docs/reference/commandline/plugin_create.md +++ b/docs/reference/commandline/plugin_create.md @@ -1,20 +1,16 @@ ---- -title: "plugin create" -description: "the plugin create command description and usage" -keywords: "plugin, create" ---- - # plugin create -```markdown -Usage: docker plugin create [OPTIONS] PLUGIN PLUGIN-DATA-DIR - + Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory. -Options: - --compress Compress the context using gzip - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:-------------|:-----|:--------|:--------------------------------| +| `--compress` | | | Compress the context using gzip | + + + ## Description diff --git a/docs/reference/commandline/plugin_disable.md b/docs/reference/commandline/plugin_disable.md index 12a7c9368c..ec1791155d 100644 --- a/docs/reference/commandline/plugin_disable.md +++ b/docs/reference/commandline/plugin_disable.md @@ -1,20 +1,16 @@ ---- -title: "plugin disable" -description: "the plugin disable command description and usage" -keywords: "plugin, disable" ---- - # plugin disable -```markdown -Usage: docker plugin disable [OPTIONS] PLUGIN - + Disable a plugin -Options: - -f, --force Force the disable of an active plugin - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:--------------------------------------| +| `-f`, `--force` | | | Force the disable of an active plugin | + + + ## Description diff --git a/docs/reference/commandline/plugin_enable.md b/docs/reference/commandline/plugin_enable.md index 11a0b09a68..2d69ab8e65 100644 --- a/docs/reference/commandline/plugin_enable.md +++ b/docs/reference/commandline/plugin_enable.md @@ -1,20 +1,16 @@ ---- -title: "plugin enable" -description: "the plugin enable command description and usage" -keywords: "plugin, enable" ---- - # plugin enable -```markdown -Usage: docker plugin enable [OPTIONS] PLUGIN - + Enable a plugin -Options: - --help Print usage - --timeout int HTTP client timeout (in seconds) -``` +### Options + +| Name | Type | Default | Description | +|:------------|:------|:--------|:---------------------------------| +| `--timeout` | `int` | `30` | HTTP client timeout (in seconds) | + + + ## Description diff --git a/docs/reference/commandline/plugin_inspect.md b/docs/reference/commandline/plugin_inspect.md index f16e9849b6..73906ed638 100644 --- a/docs/reference/commandline/plugin_inspect.md +++ b/docs/reference/commandline/plugin_inspect.md @@ -1,23 +1,16 @@ ---- -title: "plugin inspect" -description: "The plugin inspect command description and usage" -keywords: "plugin, inspect" ---- - # plugin inspect -```markdown -Usage: docker plugin inspect [OPTIONS] PLUGIN [PLUGIN...] - + Display detailed information on one or more plugins -Options: - -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 - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | + + + ## Description diff --git a/docs/reference/commandline/plugin_install.md b/docs/reference/commandline/plugin_install.md index 784edad465..f3a201e3e1 100644 --- a/docs/reference/commandline/plugin_install.md +++ b/docs/reference/commandline/plugin_install.md @@ -1,23 +1,19 @@ ---- -title: "plugin install" -description: "the plugin install command description and usage" -keywords: "plugin, install" ---- - # plugin install -```markdown -Usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...] - + Install a plugin -Options: - --alias string Local name for plugin - --disable Do not enable the plugin on install - --disable-content-trust Skip image verification (default true) - --grant-all-permissions Grant all permissions necessary to run the plugin - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:--------------------------------------------------| +| `--alias` | `string` | | Local name for plugin | +| `--disable` | | | Do not enable the plugin on install | +| `--disable-content-trust` | | | Skip image verification | +| `--grant-all-permissions` | | | Grant all permissions necessary to run the plugin | + + + ## Description diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md index 1b716f1ccf..52b7cb9be4 100644 --- a/docs/reference/commandline/plugin_ls.md +++ b/docs/reference/commandline/plugin_ls.md @@ -1,31 +1,23 @@ ---- -title: "plugin ls" -description: "The plugin ls command description and usage" -keywords: "plugin, list" ---- - # plugin ls -```markdown -Usage: docker plugin ls [OPTIONS] - + List plugins -Aliases: - ls, list +### Aliases -Options: - -f, --filter filter Provide filter values (e.g. 'enabled=true') - --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 - --help Print usage - --no-trunc Don't truncate output - -q, --quiet Only display plugin IDs -``` +`docker plugin ls`, `docker plugin list` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-f`, `--filter` | `filter` | | Provide filter values (e.g. `enabled=true`) | +| [`--format`](#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 display plugin IDs | + + + ## Description diff --git a/docs/reference/commandline/plugin_push.md b/docs/reference/commandline/plugin_push.md index f00d2f56d3..4ad1dbf6c0 100644 --- a/docs/reference/commandline/plugin_push.md +++ b/docs/reference/commandline/plugin_push.md @@ -1,18 +1,16 @@ ---- -title: "plugin push" -description: "the plugin push command description and usage" -keywords: "plugin, push" ---- - -```markdown -Usage: docker plugin push [OPTIONS] PLUGIN[:TAG] +# plugin push + Push a plugin to a registry -Options: - --disable-content-trust Skip image signing (default true) - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:--------------------------|:-----|:--------|:-------------------| +| `--disable-content-trust` | | | Skip image signing | + + + ## Description diff --git a/docs/reference/commandline/plugin_rm.md b/docs/reference/commandline/plugin_rm.md index 8dec068a40..4002e28a3f 100644 --- a/docs/reference/commandline/plugin_rm.md +++ b/docs/reference/commandline/plugin_rm.md @@ -1,23 +1,20 @@ ---- -title: "plugin rm" -description: "the plugin rm command description and usage" -keywords: "plugin, rm" ---- - # plugin rm -```markdown -Usage: docker plugin rm [OPTIONS] PLUGIN [PLUGIN...] - + Remove one or more plugins -Aliases: - rm, remove +### Aliases -Options: - -f, --force Force the removal of an active plugin - --help Print usage -``` +`docker plugin rm`, `docker plugin remove` + +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:--------------------------------------| +| `-f`, `--force` | | | Force the removal of an active plugin | + + + ## Description diff --git a/docs/reference/commandline/plugin_set.md b/docs/reference/commandline/plugin_set.md index 20a4ed2442..488932050f 100644 --- a/docs/reference/commandline/plugin_set.md +++ b/docs/reference/commandline/plugin_set.md @@ -1,19 +1,10 @@ ---- -title: "plugin set" -description: "the plugin set command description and usage" -keywords: "plugin, set" ---- - # plugin set -```markdown -Usage: docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...] - + Change settings for a plugin -Options: - --help Print usage -``` + + ## Description diff --git a/docs/reference/commandline/plugin_upgrade.md b/docs/reference/commandline/plugin_upgrade.md index fc70732fdc..dfa8b22d46 100644 --- a/docs/reference/commandline/plugin_upgrade.md +++ b/docs/reference/commandline/plugin_upgrade.md @@ -1,22 +1,18 @@ ---- -title: "plugin upgrade" -description: "the plugin upgrade command description and usage" -keywords: "plugin, upgrade" ---- - # plugin upgrade -```markdown -Usage: docker plugin upgrade [OPTIONS] PLUGIN [REMOTE] + +Upgrade an existing plugin -Upgrade a plugin +### Options -Options: - --disable-content-trust Skip image verification (default true) - --grant-all-permissions Grant all permissions necessary to run the plugin - --help Print usage - --skip-remote-check Do not check if specified remote plugin matches existing plugin image -``` +| Name | Type | Default | Description | +|:--------------------------|:-----|:--------|:----------------------------------------------------------------------| +| `--disable-content-trust` | | | Skip image verification | +| `--grant-all-permissions` | | | Grant all permissions necessary to run the plugin | +| `--skip-remote-check` | | | Do not check if specified remote plugin matches existing plugin image | + + + ## Description diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md index 95dde22661..d36212c9c2 100644 --- a/docs/reference/commandline/port.md +++ b/docs/reference/commandline/port.md @@ -1,22 +1,14 @@ ---- -title: "port" -description: "The port command description and usage" -keywords: "port, mapping, container" ---- - # port -```markdown -Usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]] - + List port mappings or a specific mapping for the container -Aliases: - docker container port, docker port +### Aliases -Options: - --help Print usage -``` +`docker container port`, `docker port` + + + ## Examples diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index e67bad8b4f..de5fd3efb5 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -1,51 +1,27 @@ ---- -title: "ps" -description: "The ps command description and usage" -keywords: "container, running, list" ---- - # ps -```markdown -Usage: docker ps [OPTIONS] - + List containers -Aliases: - docker container ls, docker container list, docker container ps, docker ps +### Aliases -Options: - -a, --all Show all containers (default shows just running) - -f, --filter value Filter output based on conditions provided (default []) - - ancestor=([:tag]||) - containers created from an image or a descendant. - - before=(|) - - expose=([/]|/[]) - - exited= an exit code of - - health=(starting|healthy|unhealthy|none) - - id= a container's ID - - isolation=(`default`|`process`|`hyperv`) (Windows daemon only) - - is-task=(true|false) - - label= or label== - - name= a container's name - - network=(|) - - publish=([/]|/[]) - - since=(|) - - status=(created|restarting|removing|running|paused|exited) - - volume=(|) - --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 - --help Print usage - -n, --last int Show n last created containers (includes all states) (default -1) - -l, --latest Show the latest created container (includes all states) - --no-trunc Don't truncate output - -q, --quiet Only display numeric IDs - -s, --size Display total file sizes -``` +`docker container ls`, `docker container list`, `docker container ps`, `docker ps` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-a`](#all), [`--all`](#all) | | | Show all containers (default shows just running) | +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | +| [`--format`](#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`](#no-trunc) | | | Don't truncate output | +| `-q`, `--quiet` | | | Only display container IDs | +| [`-s`](#size), [`--size`](#size) | | | Display total file sizes | + + + ## Examples diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index 4b74a6df20..443f12af04 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -1,25 +1,23 @@ ---- -title: "pull" -description: "The pull command description and usage" -keywords: "pull, image, hub, docker" ---- - # pull -```markdown -Usage: docker pull [OPTIONS] NAME[:TAG|@DIGEST] - + Download an image from a registry -Aliases: - docker image pull, docker pull +### Aliases -Options: - -a, --all-tags Download all tagged images in the repository - --disable-content-trust Skip image verification (default true) - --help Print usage - -q, --quiet Suppress verbose output -``` +`docker image pull`, `docker pull` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------------|:---------|:--------|:-------------------------------------------------| +| [`-a`](#all-tags), [`--all-tags`](#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 diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index 2346588d44..a2c83dbe10 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -1,25 +1,22 @@ ---- -title: "push" -description: "The push command description and usage" -keywords: "share, push, image" ---- - # push -```markdown -Usage: docker push [OPTIONS] NAME[:TAG] - + Upload an image to a registry -Aliases: - docker image push, docker push +### Aliases -Options: - -a, --all-tags Push all tags of an image to the repository - --disable-content-trust Skip image signing (default true) - --help Print usage - -q, --quiet Suppress verbose output -``` +`docker image push`, `docker push` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------------|:-----|:--------|:--------------------------------------------| +| [`-a`](#all-tags), [`--all-tags`](#all-tags) | | | Push all tags of an image to the repository | +| `--disable-content-trust` | | | Skip image signing | +| `-q`, `--quiet` | | | Suppress verbose output | + + + ## Description diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md index dc19c75c17..b445a74ede 100644 --- a/docs/reference/commandline/rename.md +++ b/docs/reference/commandline/rename.md @@ -1,22 +1,14 @@ ---- -title: "rename" -description: "The rename command description and usage" -keywords: "rename, docker, container" ---- - # rename -```markdown -Usage: docker rename CONTAINER NEW_NAME - + Rename a container -Aliases: - docker container rename, docker rename +### Aliases -Options: - --help Print usage -``` +`docker container rename`, `docker rename` + + + ## Description diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md index 0a154a693d..7eb5b033dc 100644 --- a/docs/reference/commandline/restart.md +++ b/docs/reference/commandline/restart.md @@ -1,23 +1,21 @@ ---- -title: "restart" -description: "The restart command description and usage" -keywords: "restart, container, Docker" ---- - # restart -```markdown -Usage: docker restart [OPTIONS] CONTAINER [CONTAINER...] - + Restart one or more containers -Aliases: - docker container restart, docker restart +### Aliases -Options: - -s, --signal string Signal to send to the container - -t, --time int Seconds to wait before killing the container -``` +`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 | + + + ## Examples diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md index aab72e1bfd..0e82ba358c 100644 --- a/docs/reference/commandline/rm.md +++ b/docs/reference/commandline/rm.md @@ -1,25 +1,22 @@ ---- -title: "rm" -description: "The rm command description and usage" -keywords: "remove, Docker, container" ---- - # rm -```markdown -Usage: docker rm [OPTIONS] CONTAINER [CONTAINER...] - + Remove one or more containers -Aliases: - docker container rm, docker rm +### Aliases -Options: - -f, --force Force the removal of a running container (uses SIGKILL) - --help Print usage - -l, --link Remove the specified link - -v, --volumes Remove anonymous volumes associated with the container -``` +`docker container rm`, `docker rm` + +### Options + +| Name | Type | Default | Description | +|:------------------------------------------|:-----|:--------|:--------------------------------------------------------| +| [`-f`](#force), [`--force`](#force) | | | Force the removal of a running container (uses SIGKILL) | +| [`-l`](#link), [`--link`](#link) | | | Remove the specified link | +| [`-v`](#volumes), [`--volumes`](#volumes) | | | Remove anonymous volumes associated with the container | + + + ## Examples diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index e7786c86e2..5fd35e9931 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -1,24 +1,21 @@ ---- -title: "rmi" -description: "The rmi command description and usage" -keywords: "remove, image, Docker" ---- - # rmi -```markdown -Usage: docker rmi [OPTIONS] IMAGE [IMAGE...] - + Remove one or more images -Aliases: - docker image rm, docker rmi +### Aliases -Options: - -f, --force Force removal of the image - --help Print usage - --no-prune Do not delete untagged parents -``` +`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 diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index f26f1cc57b..49a7497e2d 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -1,121 +1,120 @@ ---- -title: "run" -description: "The run command description and usage" -keywords: "run, command, container" ---- - # run -```markdown -Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] - + Create and run a new container from an image -Aliases: - docker container run, docker run +### Aliases -Options: - --add-host list Add a custom host-to-IP mapping (host:ip) - -a, --attach list Attach to STDIN, STDOUT or STDERR - --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - --blkio-weight-device list Block IO weight (relative device weight) (default []) - --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-period int Limit CPU CFS (Completely Fair Scheduler) period - --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota - --cpu-rt-period int Limit CPU real-time period in microseconds - --cpu-rt-runtime int Limit CPU real-time runtime in microseconds - -c, --cpu-shares int 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 (default []) - --device-read-iops list Limit read rate (IO per second) from a device (default []) - --device-write-bps list Limit write rate (bytes per second) to a device (default []) - --device-write-iops list Limit write rate (IO per second) to a device (default []) - --disable-content-trust Skip image verification (default true) - --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 Time between running the check (ms|s|m|h) (default 0s) - --health-retries int Consecutive failures needed to report unhealthy - --health-start-period duration Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) - --health-timeout duration 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 - --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 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 Memory limit - --memory-reservation bytes Memory soft limit - --memory-swap bytes Swap limit equal to memory plus swap: '-1' to enable unlimited swap - --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) - --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 Tune host's OOM preferences (-1000 to 1000) - --pid string PID namespace to use - --pids-limit int 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 Pull image before running ("always"|"missing"|"never") (default "missing") - --read-only Mount the container's root filesystem as read only - --restart string Restart policy to apply when a container exits (default "no") - --rm Automatically remove the container when it exits - --runtime string Runtime to use for this container - --security-opt list Security Options - --shm-size bytes Size of /dev/shm - --sig-proxy Proxy received signals to the process (default true) - --stop-signal string Signal to stop a container (default "SIGTERM") - --stop-timeout int Timeout (in seconds) to stop a container - --storage-opt list Storage driver options for the container - --sysctl map Sysctl options (default map[]) - --tmpfs list Mount a tmpfs directory - -t, --tty Allocate a pseudo-TTY - --ulimit ulimit Ulimit options (default []) - -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 -``` +`docker container run`, `docker run` + +### Options + +| Name | Type | Default | Description | +|:----------------------------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`--add-host`](#add-host) | `list` | | Add a custom host-to-IP mapping (host:ip) | +| [`-a`](#attach), [`--attach`](#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`](#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`](#device) | `list` | | Add a host device to the container | +| [`--device-cgroup-rule`](#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), [`--env`](#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`](#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-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`](#isolation) | `string` | | Container isolation technology | +| `--kernel-memory` | `bytes` | `0` | Kernel memory limit | +| [`-l`](#label), [`--label`](#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), [`--memory`](#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) | `mount` | | Attach a filesystem mount to the container | +| [`--name`](#name) | `string` | | Assign a name to the container | +| [`--network`](#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`](#privileged) | | | Give extended privileges to this container | +| [`-p`](#publish), [`--publish`](#publish) | `list` | | Publish a container's port(s) to the host | +| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| [`--pull`](#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`](#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`](#security-opt) | `list` | | Security Options | +| `--shm-size` | `bytes` | `0` | Size of /dev/shm | +| `--sig-proxy` | | | Proxy received signals to the process | +| [`--stop-signal`](#stop-signal) | `string` | | Signal to stop the container | +| [`--stop-timeout`](#stop-timeout) | `int` | `0` | Timeout (in seconds) to stop a container | +| [`--storage-opt`](#storage-opt) | `list` | | Storage driver options for the container | +| [`--sysctl`](#sysctl) | `map` | `map[]` | Sysctl options | +| [`--tmpfs`](#tmpfs) | `list` | | Mount a tmpfs directory | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| [`--ulimit`](#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), [`--volume`](#volume) | `list` | | Bind mount a volume | +| `--volume-driver` | `string` | | Optional volume driver for the container | +| [`--volumes-from`](#volumes-from) | `list` | | Mount volumes from the specified container(s) | +| [`-w`](#workdir), [`--workdir`](#workdir) | `string` | | Working directory inside the container | + + + ## Description diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md index 7b21b4e014..d6df5574c1 100644 --- a/docs/reference/commandline/save.md +++ b/docs/reference/commandline/save.md @@ -1,23 +1,20 @@ ---- -title: "save" -description: "The save command description and usage" -keywords: "tarred, repository, backup" ---- - # save -```markdown -Usage: docker save [OPTIONS] IMAGE [IMAGE...] - + Save one or more images to a tar archive (streamed to STDOUT by default) -Aliases: - docker image save, docker save +### Aliases -Options: - --help Print usage - -o, --output string Write to a file, instead of STDOUT -``` +`docker image save`, `docker save` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-----------------------------------| +| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT | + + + ## Description diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index ba0f642990..db073e6135 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -1,26 +1,19 @@ ---- -title: "search" -description: "The search command description and usage" -keywords: "search, hub, images" ---- - # search -```markdown -Usage: docker search [OPTIONS] TERM - + Search Docker Hub for images -Options: - -f, --filter value Filter output based on conditions provided (default []) - - is-automated=(true|false) - - is-official=(true|false) - - stars= - image has at least 'number' stars - --format string Pretty-print images using a Go template - --help Print usage - --limit int Max number of search results - --no-trunc Don't truncate output -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------| +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | +| [`--format`](#format) | `string` | | Pretty-print search using a Go template | +| [`--limit`](#limit) | `int` | `0` | Max number of search results | +| [`--no-trunc`](#no-trunc) | | | Don't truncate output | + + + ## Description diff --git a/docs/reference/commandline/secret.md b/docs/reference/commandline/secret.md index 206c9b58bd..010525cf4d 100644 --- a/docs/reference/commandline/secret.md +++ b/docs/reference/commandline/secret.md @@ -1,36 +1,21 @@ ---- -title: "secret" -description: "The secret command description and usage" -keywords: "secret" ---- - # secret -```markdown -Usage: docker secret COMMAND - + Manage Swarm secrets -Options: - --help Print usage +### Subcommands -Commands: - create Create a secret from a file or STDIN as content - inspect Display detailed information on one or more secrets - ls List secrets - rm Remove one or more secrets +| Name | Description | +|:-------------------------------|:----------------------------------------------------| +| [`create`](secret_create.md) | Create a secret from a file or STDIN as content | +| [`inspect`](secret_inspect.md) | Display detailed information on one or more secrets | +| [`ls`](secret_ls.md) | List secrets | +| [`rm`](secret_rm.md) | Remove one or more secrets | -Run 'docker secret COMMAND --help' for more information on a command. -``` + + ## Description Manage secrets. - -## Related commands - -* [secret create](secret_create.md) -* [secret inspect](secret_inspect.md) -* [secret list](secret_ls.md) -* [secret rm](secret_rm.md) diff --git a/docs/reference/commandline/secret_create.md b/docs/reference/commandline/secret_create.md index 794ee189e4..4a508faea1 100644 --- a/docs/reference/commandline/secret_create.md +++ b/docs/reference/commandline/secret_create.md @@ -1,20 +1,18 @@ ---- -title: "secret create" -description: "The secret create command description and usage" -keywords: ["secret, create"] ---- - # secret create -```Markdown -Usage: docker secret create [OPTIONS] SECRET [file|-] - + Create a secret from a file or STDIN as content -Options: - -l, --label list Secret labels - --template-driver string Template driver -``` +### Options + +| Name | Type | Default | Description | +|:------------------------------------|:---------|:--------|:----------------| +| `-d`, `--driver` | `string` | | Secret driver | +| [`-l`](#label), [`--label`](#label) | `list` | | Secret labels | +| `--template-driver` | `string` | | Template driver | + + + ## Description diff --git a/docs/reference/commandline/secret_inspect.md b/docs/reference/commandline/secret_inspect.md index b8c18c1bbc..1540d5bb35 100644 --- a/docs/reference/commandline/secret_inspect.md +++ b/docs/reference/commandline/secret_inspect.md @@ -1,24 +1,17 @@ ---- -title: "secret inspect" -description: "The secret inspect command description and usage" -keywords: ["secret, inspect"] ---- - # secret inspect -```Markdown -Usage: docker secret inspect [OPTIONS] SECRET [SECRET...] - + Display detailed information on one or more secrets -Options: - -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 - --pretty Print the information in a human friendly format - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | +| `--pretty` | | | Print the information in a human friendly format | + + + ## Description diff --git a/docs/reference/commandline/secret_ls.md b/docs/reference/commandline/secret_ls.md index 38c4216c56..dd4b825273 100644 --- a/docs/reference/commandline/secret_ls.md +++ b/docs/reference/commandline/secret_ls.md @@ -1,31 +1,22 @@ ---- -title: "secret ls" -description: "The secret ls command description and usage" -keywords: ["secret, ls"] ---- - # secret ls -```Markdown -Usage: docker secret ls [OPTIONS] - + List secrets -Aliases: - ls, list +### Aliases -Options: - -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 +`docker secret ls`, `docker secret list` - --help Print usage - -q, --quiet Only display IDs -``` +### 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:
'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 | +| `-q`, `--quiet` | | | Only display IDs | + + + ## Description diff --git a/docs/reference/commandline/secret_rm.md b/docs/reference/commandline/secret_rm.md index df99f958ca..7d707d37cf 100644 --- a/docs/reference/commandline/secret_rm.md +++ b/docs/reference/commandline/secret_rm.md @@ -1,22 +1,14 @@ ---- -title: "secret rm" -description: "The secret rm command description and usage" -keywords: ["secret, rm"] ---- - # secret rm -```Markdown -Usage: docker secret rm SECRET [SECRET...] - + Remove one or more secrets -Aliases: - rm, remove +### Aliases -Options: - --help Print usage -``` +`docker secret rm`, `docker secret remove` + + + ## Description diff --git a/docs/reference/commandline/service.md b/docs/reference/commandline/service.md index 8d834dcd90..6c8ff4d6be 100644 --- a/docs/reference/commandline/service.md +++ b/docs/reference/commandline/service.md @@ -1,31 +1,25 @@ ---- -title: "service" -description: "The service command description and usage" -keywords: "service" ---- - # service -```markdown -Usage: docker service COMMAND - + Manage Swarm services -Options: - --help Print usage +### Subcommands -Commands: - create Create a new service - inspect Display detailed information on one or more services - logs Fetch the logs of a service or task - ls List services - ps List the tasks of one or more services - rm Remove one or more services - scale Scale one or multiple replicated services - update Update a service +| Name | Description | +|:----------------------------------|:-----------------------------------------------------| +| [`create`](service_create.md) | Create a new service | +| [`inspect`](service_inspect.md) | Display detailed information on one or more services | +| [`logs`](service_logs.md) | Fetch the logs of a service or task | +| [`ls`](service_ls.md) | List services | +| [`ps`](service_ps.md) | List the tasks of one or more services | +| [`rm`](service_rm.md) | Remove one or more services | +| [`rollback`](service_rollback.md) | Revert changes to a service's configuration | +| [`scale`](service_scale.md) | Scale one or multiple replicated services | +| [`update`](service_update.md) | Update a service | -Run 'docker service COMMAND --help' for more information on a command. -``` + + + ## Description diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index a7583f1304..ee9981687a 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -1,90 +1,86 @@ ---- -title: "service create" -description: "The service create command description and usage" -keywords: "service, create" ---- - # service create -```Markdown -Usage: docker service create [OPTIONS] IMAGE [COMMAND] [ARG...] - + Create a new service -Options: - --cap-add list Add Linux capabilities - --cap-drop list Drop Linux capabilities - --config config Specify configurations to expose to the service - --constraint list Placement constraints - --container-label list Container labels - --credential-spec credential-spec Credential spec for managed service account (Windows only) - -d, --detach Exit immediately instead of waiting for the service to converge (default true) - --dns list Set custom DNS servers - --dns-option list Set DNS options - --dns-search list Set custom DNS search domains - --endpoint-mode string Endpoint mode (vip or dnsrr) (default "vip") - --entrypoint command Overwrite the default ENTRYPOINT of the image - -e, --env list Set environment variables - --env-file list Read in a file of environment variables - --generic-resource list User defined resources request - --group list Set one or more supplementary user groups for the container - --health-cmd string Command to run to check health - --health-interval duration Time between running the check (ms|s|m|h) - --health-retries int Consecutive failures needed to report unhealthy - --health-start-period duration Start period for the container to initialize before counting retries towards unstable (ms|s|m|h) - --health-timeout duration Maximum time to allow one check to run (ms|s|m|h) - --help Print usage - --host list Set one or more custom host-to-IP mappings (host:ip) - --hostname string Container hostname - --init bool Use an init inside each service container to forward signals and reap processes - --isolation string Service container isolation mode - -l, --label list Service labels - --limit-cpu decimal Limit CPUs - --limit-memory bytes Limit Memory - --limit-pids int Limit maximum number of processes (default 0 = unlimited) - --log-driver string Logging driver for service - --log-opt list Logging driver options - --max-concurrent Number of job tasks to run at once (default equal to --replicas) - --mode string Service mode (replicated, global, replicated-job, or global-job) (default "replicated") - --mount mount Attach a filesystem mount to the service - --name string Service name - --network network Network attachments - --no-healthcheck Disable any container-specified HEALTHCHECK - --no-resolve-image Do not query the registry to resolve image digest and supported platforms - --placement-pref pref Add a placement preference - -p, --publish port Publish a port as a node port - -q, --quiet Suppress progress output - --read-only Mount the container's root filesystem as read only - --replicas uint Number of tasks - --replicas-max-per-node uint Maximum number of tasks per node (default 0 = unlimited) - --reserve-cpu decimal Reserve CPUs - --reserve-memory bytes Reserve Memory - --restart-condition string Restart when condition is met ("none"|"on-failure"|"any") (default "any") - --restart-delay duration Delay between restart attempts (ns|us|ms|s|m|h) (default 5s) - --restart-max-attempts uint Maximum number of restarts before giving up - --restart-window duration Window used to evaluate the restart policy (ns|us|ms|s|m|h) - --rollback-delay duration Delay between task rollbacks (ns|us|ms|s|m|h) (default 0s) - --rollback-failure-action string Action on rollback failure ("pause"|"continue") (default "pause") - --rollback-max-failure-ratio float Failure rate to tolerate during a rollback (default 0) - --rollback-monitor duration Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h) (default 5s) - --rollback-order string Rollback order ("start-first"|"stop-first") (default "stop-first") - --rollback-parallelism uint Maximum number of tasks rolled back simultaneously (0 to roll back all at once) (default 1) - --secret secret Specify secrets to expose to the service - --stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h) (default 10s) - --stop-signal string Signal to stop the container - --sysctl list Sysctl options - -t, --tty Allocate a pseudo-TTY - --ulimit ulimit Ulimit options (default []) - --update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s) - --update-failure-action string Action on update failure ("pause"|"continue"|"rollback") (default "pause") - --update-max-failure-ratio float Failure rate to tolerate during an update (default 0) - --update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 5s) - --update-order string Update order ("start-first"|"stop-first") (default "stop-first") - --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1) - -u, --user string Username or UID (format: [:]) - --with-registry-auth Send registry authentication details to swarm agents - -w, --workdir string Working directory inside the container -``` +### Options + +| Name | Type | Default | Description | +|:----------------------------------------------------|:------------------|:-------------|:----------------------------------------------------------------------------------------------------| +| `--cap-add` | `list` | | Add Linux capabilities | +| `--cap-drop` | `list` | | Drop Linux capabilities | +| [`--config`](#config) | `config` | | Specify configurations to expose to the service | +| [`--constraint`](#constraint) | `list` | | Placement constraints | +| `--container-label` | `list` | | Container labels | +| `--credential-spec` | `credential-spec` | | Credential spec for managed service account (Windows only) | +| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| `--dns` | `list` | | Set custom DNS servers | +| `--dns-option` | `list` | | Set DNS options | +| `--dns-search` | `list` | | Set custom DNS search domains | +| `--endpoint-mode` | `string` | `vip` | Endpoint mode (vip or dnsrr) | +| `--entrypoint` | `command` | | Overwrite the default ENTRYPOINT of the image | +| [`-e`](#env), [`--env`](#env) | `list` | | Set environment variables | +| `--env-file` | `list` | | Read in a file of environment variables | +| `--generic-resource` | `list` | | User defined resources | +| `--group` | `list` | | Set one or more supplementary user groups for the container | +| `--health-cmd` | `string` | | Command to run to check health | +| `--health-interval` | `duration` | | Time between running the check (ms\|s\|m\|h) | +| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | +| `--health-start-period` | `duration` | | Start period for the container to initialize before counting retries towards unstable (ms\|s\|m\|h) | +| `--health-timeout` | `duration` | | Maximum time to allow one check to run (ms\|s\|m\|h) | +| `--host` | `list` | | Set one or more custom host-to-IP mappings (host:ip) | +| [`--hostname`](#hostname) | `string` | | Container hostname | +| `--init` | | | Use an init inside each service container to forward signals and reap processes | +| [`--isolation`](#isolation) | `string` | | Service container isolation mode | +| [`-l`](#label), [`--label`](#label) | `list` | | Service labels | +| `--limit-cpu` | `decimal` | | Limit CPUs | +| `--limit-memory` | `bytes` | `0` | Limit Memory | +| `--limit-pids` | `int64` | `0` | Limit maximum number of processes (default 0 = unlimited) | +| `--log-driver` | `string` | | Logging driver for service | +| `--log-opt` | `list` | | Logging driver options | +| `--max-concurrent` | `uint` | | Number of job tasks to run concurrently (default equal to --replicas) | +| `--mode` | `string` | `replicated` | Service mode (`replicated`, `global`, `replicated-job`, `global-job`) | +| [`--mount`](#mount) | `mount` | | Attach a filesystem mount to the service | +| `--name` | `string` | | Service name | +| [`--network`](#network) | `network` | | Network attachments | +| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | +| `--no-resolve-image` | | | Do not query the registry to resolve image digest and supported platforms | +| [`--placement-pref`](#placement-pref) | `pref` | | Add a placement preference | +| [`-p`](#publish), [`--publish`](#publish) | `port` | | Publish a port as a node port | +| `-q`, `--quiet` | | | Suppress progress output | +| `--read-only` | | | Mount the container's root filesystem as read only | +| [`--replicas`](#replicas) | `uint` | | Number of tasks | +| [`--replicas-max-per-node`](#replicas-max-per-node) | `uint64` | `0` | Maximum number of tasks per node (default 0 = unlimited) | +| `--reserve-cpu` | `decimal` | | Reserve CPUs | +| [`--reserve-memory`](#reserve-memory) | `bytes` | `0` | Reserve Memory | +| `--restart-condition` | `string` | | Restart when condition is met (`none`, `on-failure`, `any`) (default `any`) | +| `--restart-delay` | `duration` | | Delay between restart attempts (ns\|us\|ms\|s\|m\|h) (default 5s) | +| `--restart-max-attempts` | `uint` | | Maximum number of restarts before giving up | +| `--restart-window` | `duration` | | Window used to evaluate the restart policy (ns\|us\|ms\|s\|m\|h) | +| `--rollback-delay` | `duration` | `0s` | Delay between task rollbacks (ns\|us\|ms\|s\|m\|h) (default 0s) | +| `--rollback-failure-action` | `string` | | Action on rollback failure (`pause`, `continue`) (default `pause`) | +| `--rollback-max-failure-ratio` | `float` | `0` | Failure rate to tolerate during a rollback (default 0) | +| `--rollback-monitor` | `duration` | `0s` | Duration after each task rollback to monitor for failure (ns\|us\|ms\|s\|m\|h) (default 5s) | +| `--rollback-order` | `string` | | Rollback order (`start-first`, `stop-first`) (default `stop-first`) | +| `--rollback-parallelism` | `uint64` | `1` | Maximum number of tasks rolled back simultaneously (0 to roll back all at once) | +| [`--secret`](#secret) | `secret` | | Specify secrets to expose to the service | +| `--stop-grace-period` | `duration` | | Time to wait before force killing a container (ns\|us\|ms\|s\|m\|h) (default 10s) | +| `--stop-signal` | `string` | | Signal to stop the container | +| `--sysctl` | `list` | | Sysctl options | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `--ulimit` | `ulimit` | | Ulimit options | +| [`--update-delay`](#update-delay) | `duration` | `0s` | Delay between updates (ns\|us\|ms\|s\|m\|h) (default 0s) | +| `--update-failure-action` | `string` | | Action on update failure (`pause`, `continue`, `rollback`) (default `pause`) | +| `--update-max-failure-ratio` | `float` | `0` | Failure rate to tolerate during an update (default 0) | +| `--update-monitor` | `duration` | `0s` | Duration after each task update to monitor for failure (ns\|us\|ms\|s\|m\|h) (default 5s) | +| `--update-order` | `string` | | Update order (`start-first`, `stop-first`) (default `stop-first`) | +| `--update-parallelism` | `uint64` | `1` | Maximum number of tasks updated simultaneously (0 to update all at once) | +| `-u`, `--user` | `string` | | Username or UID (format: [:]) | +| [`--with-registry-auth`](#with-registry-auth) | | | Send registry authentication details to swarm agents | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + ## Description diff --git a/docs/reference/commandline/service_inspect.md b/docs/reference/commandline/service_inspect.md index a3e42ee626..583b02fe55 100644 --- a/docs/reference/commandline/service_inspect.md +++ b/docs/reference/commandline/service_inspect.md @@ -1,24 +1,17 @@ ---- -title: "service inspect" -description: "The service inspect command description and usage" -keywords: "service, inspect" ---- - # service inspect -```Markdown -Usage: docker service inspect [OPTIONS] SERVICE [SERVICE...] - + Display detailed information on one or more services -Options: - -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 - --pretty Print the information in a human friendly format - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | +| [`--pretty`](#pretty) | | | Print the information in a human friendly format | + + + ## Description diff --git a/docs/reference/commandline/service_logs.md b/docs/reference/commandline/service_logs.md index 590981e92f..b5808f591d 100644 --- a/docs/reference/commandline/service_logs.md +++ b/docs/reference/commandline/service_logs.md @@ -1,26 +1,24 @@ ---- -title: "service logs" -description: "The service logs command description and usage" -keywords: "service, task, logs" ---- - # service logs -```Markdown -Usage: docker service logs [OPTIONS] SERVICE|TASK - + Fetch the logs of a service or task -Options: - -f, --follow Follow log output - --help Print usage - --no-resolve Do not map IDs to Names in output - --no-task-ids Do not include task IDs in output - --no-trunc Do not truncate output - --since string Show logs since timestamp - -n, --tail string Number of lines to show from the end of the logs (default "all") - -t, --timestamps Show timestamps -``` +### Options + +| Name | Type | Default | Description | +|:---------------------|:---------|:--------|:------------------------------------------------------------------------------------------------| +| `--details` | | | Show extra details provided to logs | +| `-f`, `--follow` | | | Follow log output | +| `--no-resolve` | | | Do not map IDs to Names in output | +| `--no-task-ids` | | | Do not include task IDs in output | +| `--no-trunc` | | | Do not truncate output | +| `--raw` | | | Do not neatly format logs | +| `--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 | + + + ## Description diff --git a/docs/reference/commandline/service_ls.md b/docs/reference/commandline/service_ls.md index 430a3e957f..264694a4dd 100644 --- a/docs/reference/commandline/service_ls.md +++ b/docs/reference/commandline/service_ls.md @@ -1,30 +1,22 @@ ---- -title: "service ls" -description: "The service ls command description and usage" -keywords: "service, ls" ---- - # service ls -```Markdown -Usage: docker service ls [OPTIONS] - + List services -Aliases: - ls, list +### Aliases -Options: - -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 - --help Print usage - -q, --quiet Only display IDs -``` +`docker service ls`, `docker service list` + +### 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:
'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 | +| `-q`, `--quiet` | | | Only display IDs | + + + ## Description diff --git a/docs/reference/commandline/service_ps.md b/docs/reference/commandline/service_ps.md index 0746c89e01..85fab2ed65 100644 --- a/docs/reference/commandline/service_ps.md +++ b/docs/reference/commandline/service_ps.md @@ -1,25 +1,20 @@ ---- -title: "service ps" -description: "The service ps command description and usage" -keywords: "service, tasks, ps" -aliases: ["/engine/reference/commandline/service_tasks/"] ---- - # service ps -```Markdown -Usage: docker service ps [OPTIONS] SERVICE [SERVICE...] - + List the tasks of one or more services -Options: - -f, --filter filter Filter output based on conditions provided - --format string Pretty-print tasks using a Go template - --help Print usage - --no-resolve Do not map IDs to Names - --no-trunc Do not truncate output - -q, --quiet Only display task IDs -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------| +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | +| [`--format`](#format) | `string` | | Pretty-print tasks using a Go template | +| `--no-resolve` | | | Do not map IDs to Names | +| `--no-trunc` | | | Do not truncate output | +| `-q`, `--quiet` | | | Only display task IDs | + + + ## Description diff --git a/docs/reference/commandline/service_rm.md b/docs/reference/commandline/service_rm.md index 015d435076..e974bb90f4 100644 --- a/docs/reference/commandline/service_rm.md +++ b/docs/reference/commandline/service_rm.md @@ -1,22 +1,14 @@ ---- -title: "service rm" -description: "The service rm command description and usage" -keywords: "service, rm" ---- - # service rm -```Markdown -Usage: docker service rm SERVICE [SERVICE...] - + Remove one or more services -Aliases: - rm, remove +### Aliases -Options: - --help Print usage -``` +`docker service rm`, `docker service remove` + + + ## Description diff --git a/docs/reference/commandline/service_rollback.md b/docs/reference/commandline/service_rollback.md index 2cd276fe17..52aaf1ce39 100644 --- a/docs/reference/commandline/service_rollback.md +++ b/docs/reference/commandline/service_rollback.md @@ -1,21 +1,17 @@ ---- -title: "service rollback" -description: "The service rollback command description and usage" -keywords: "service, rollback" ---- - # service rollback -```markdown -Usage: docker service rollback SERVICE - + Revert changes to a service's configuration -Options: - -d, --detach Exit immediately instead of waiting for the service to converge (default true) - --help Print usage - -q, --quiet Suppress progress output -``` +### Options + +| Name | Type | Default | Description | +|:-----------------|:-----|:--------|:----------------------------------------------------------------| +| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| `-q`, `--quiet` | | | Suppress progress output | + + + ## Description diff --git a/docs/reference/commandline/service_scale.md b/docs/reference/commandline/service_scale.md index a61337d07b..594e6aea9b 100644 --- a/docs/reference/commandline/service_scale.md +++ b/docs/reference/commandline/service_scale.md @@ -1,20 +1,16 @@ ---- -title: "service scale" -description: "The service scale command description and usage" -keywords: "service, scale" ---- - # service scale -```markdown -Usage: docker service scale [OPTIONS] SERVICE=REPLICAS [SERVICE=REPLICAS...] - + Scale one or multiple replicated services -Options: - -d, --detach Exit immediately instead of waiting for the service to converge (default true) - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:-----------------|:-----|:--------|:----------------------------------------------------------------| +| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | + + + ## Description diff --git a/docs/reference/commandline/service_update.md b/docs/reference/commandline/service_update.md index 0c82c4d628..43180c6b65 100644 --- a/docs/reference/commandline/service_update.md +++ b/docs/reference/commandline/service_update.md @@ -1,108 +1,105 @@ ---- -title: "service update" -description: "The service update command description and usage" -keywords: "service, update" ---- - # service update -```Markdown -Usage: docker service update [OPTIONS] SERVICE - + Update a service -Options: - --args command Service command args - --cap-add list Add Linux capabilities - --cap-drop list Drop Linux capabilities - --config-add config Add or update a config file on a service - --config-rm list Remove a configuration file - --constraint-add list Add or update a placement constraint - --constraint-rm list Remove a constraint - --container-label-add list Add or update a container label - --container-label-rm list Remove a container label by its key - --credential-spec credential-spec Credential spec for managed service account (Windows only) - -d, --detach Exit immediately instead of waiting for the service to converge (default true) - --dns-add list Add or update a custom DNS server - --dns-option-add list Add or update a DNS option - --dns-option-rm list Remove a DNS option - --dns-rm list Remove a custom DNS server - --dns-search-add list Add or update a custom DNS search domain - --dns-search-rm list Remove a DNS search domain - --endpoint-mode string Endpoint mode (vip or dnsrr) - --entrypoint command Overwrite the default ENTRYPOINT of the image - --env-add list Add or update an environment variable - --env-rm list Remove an environment variable - --force Force update even if no changes require it - --generic-resource-add list Add an additional generic resource to the service's resources requirements - --generic-resource-rm list Remove a previously added generic resource to the service's resources requirements - --group-add list Add an additional supplementary user group to the container - --group-rm list Remove a previously added supplementary user group from the container - --health-cmd string Command to run to check health - --health-interval duration Time between running the check (ms|s|m|h) - --health-retries int Consecutive failures needed to report unhealthy - --health-start-period duration Start period for the container to initialize before counting retries towards unstable (ms|s|m|h) - --health-timeout duration Maximum time to allow one check to run (ms|s|m|h) - --help Print usage - --host-add list Add a custom host-to-IP mapping (host:ip) - --host-rm list Remove a custom host-to-IP mapping (host:ip) - --hostname string Container hostname - --init bool Use an init inside each service container to forward signals and reap processes - --image string Service image tag - --isolation string Service container isolation mode - --label-add list Add or update a service label - --label-rm list Remove a label by its key - --limit-cpu decimal Limit CPUs - --limit-memory bytes Limit Memory - --limit-pids int Limit maximum number of processes (default 0 = unlimited) - --log-driver string Logging driver for service - --log-opt list Logging driver options - --max-concurrent Number of job tasks to run at once (default equal to --replicas) - --mount-add mount Add or update a mount on a service - --mount-rm list Remove a mount by its target path - --network-add network Add a network - --network-rm list Remove a network - --no-healthcheck Disable any container-specified HEALTHCHECK - --no-resolve-image Do not query the registry to resolve image digest and supported platforms - --placement-pref-add pref Add a placement preference - --placement-pref-rm pref Remove a placement preference - --publish-add port Add or update a published port - --publish-rm port Remove a published port by its target port - -q, --quiet Suppress progress output - --read-only Mount the container's root filesystem as read only - --replicas uint Number of tasks - --reserve-cpu decimal Reserve CPUs - --reserve-memory bytes Reserve Memory - --restart-condition string Restart when condition is met ("none"|"on-failure"|"any") - --restart-delay duration Delay between restart attempts (ns|us|ms|s|m|h) - --restart-max-attempts uint Maximum number of restarts before giving up - --restart-window duration Window used to evaluate the restart policy (ns|us|ms|s|m|h) - --rollback Rollback to previous specification - --rollback-delay duration Delay between task rollbacks (ns|us|ms|s|m|h) - --rollback-failure-action string Action on rollback failure ("pause"|"continue") - --rollback-max-failure-ratio float Failure rate to tolerate during a rollback - --rollback-monitor duration Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h) - --rollback-order string Rollback order ("start-first"|"stop-first") - --rollback-parallelism uint Maximum number of tasks rolled back simultaneously (0 to roll back all at once) - --secret-add secret Add or update a secret on a service - --secret-rm list Remove a secret - --stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h) - --stop-signal string Signal to stop the container - --sysctl-add list Add or update a Sysctl option - --sysctl-rm list Remove a Sysctl option - -t, --tty Allocate a pseudo-TTY - --ulimit-add ulimit Add or update a ulimit option (default []) - --ulimit-rm list Remove a ulimit option - --update-delay duration Delay between updates (ns|us|ms|s|m|h) - --update-failure-action string Action on update failure ("pause"|"continue"|"rollback") - --update-max-failure-ratio float Failure rate to tolerate during an update - --update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) - --update-order string Update order ("start-first"|"stop-first") - --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) - -u, --user string Username or UID (format: [:]) - --with-registry-auth Send registry authentication details to swarm agents - -w, --workdir string Working directory inside the container -``` +### Options + +| Name | Type | Default | Description | +|:----------------------------------------------|:------------------|:--------|:----------------------------------------------------------------------------------------------------| +| `--args` | `command` | | Service command args | +| `--cap-add` | `list` | | Add Linux capabilities | +| `--cap-drop` | `list` | | Drop Linux capabilities | +| `--config-add` | `config` | | Add or update a config file on a service | +| `--config-rm` | `list` | | Remove a configuration file | +| `--constraint-add` | `list` | | Add or update a placement constraint | +| `--constraint-rm` | `list` | | Remove a constraint | +| `--container-label-add` | `list` | | Add or update a container label | +| `--container-label-rm` | `list` | | Remove a container label by its key | +| `--credential-spec` | `credential-spec` | | Credential spec for managed service account (Windows only) | +| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| `--dns-add` | `list` | | Add or update a custom DNS server | +| `--dns-option-add` | `list` | | Add or update a DNS option | +| `--dns-option-rm` | `list` | | Remove a DNS option | +| `--dns-rm` | `list` | | Remove a custom DNS server | +| `--dns-search-add` | `list` | | Add or update a custom DNS search domain | +| `--dns-search-rm` | `list` | | Remove a DNS search domain | +| `--endpoint-mode` | `string` | | Endpoint mode (vip or dnsrr) | +| `--entrypoint` | `command` | | Overwrite the default ENTRYPOINT of the image | +| `--env-add` | `list` | | Add or update an environment variable | +| `--env-rm` | `list` | | Remove an environment variable | +| `--force` | | | Force update even if no changes require it | +| `--generic-resource-add` | `list` | | Add a Generic resource | +| `--generic-resource-rm` | `list` | | Remove a Generic resource | +| `--group-add` | `list` | | Add an additional supplementary user group to the container | +| `--group-rm` | `list` | | Remove a previously added supplementary user group from the container | +| `--health-cmd` | `string` | | Command to run to check health | +| `--health-interval` | `duration` | | Time between running the check (ms\|s\|m\|h) | +| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy | +| `--health-start-period` | `duration` | | Start period for the container to initialize before counting retries towards unstable (ms\|s\|m\|h) | +| `--health-timeout` | `duration` | | Maximum time to allow one check to run (ms\|s\|m\|h) | +| `--host-add` | `list` | | Add a custom host-to-IP mapping (`host:ip`) | +| `--host-rm` | `list` | | Remove a custom host-to-IP mapping (`host:ip`) | +| `--hostname` | `string` | | Container hostname | +| `--image` | `string` | | Service image tag | +| `--init` | | | Use an init inside each service container to forward signals and reap processes | +| [`--isolation`](#isolation) | `string` | | Service container isolation mode | +| `--label-add` | `list` | | Add or update a service label | +| `--label-rm` | `list` | | Remove a label by its key | +| `--limit-cpu` | `decimal` | | Limit CPUs | +| `--limit-memory` | `bytes` | `0` | Limit Memory | +| `--limit-pids` | `int64` | `0` | Limit maximum number of processes (default 0 = unlimited) | +| `--log-driver` | `string` | | Logging driver for service | +| `--log-opt` | `list` | | Logging driver options | +| `--max-concurrent` | `uint` | | Number of job tasks to run concurrently (default equal to --replicas) | +| [`--mount-add`](#mount-add) | `mount` | | Add or update a mount on a service | +| `--mount-rm` | `list` | | Remove a mount by its target path | +| [`--network-add`](#network-add) | `network` | | Add a network | +| `--network-rm` | `list` | | Remove a network | +| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | +| `--no-resolve-image` | | | Do not query the registry to resolve image digest and supported platforms | +| `--placement-pref-add` | `pref` | | Add a placement preference | +| `--placement-pref-rm` | `pref` | | Remove a placement preference | +| [`--publish-add`](#publish-add) | `port` | | Add or update a published port | +| `--publish-rm` | `port` | | Remove a published port by its target port | +| `-q`, `--quiet` | | | Suppress progress output | +| `--read-only` | | | Mount the container's root filesystem as read only | +| `--replicas` | `uint` | | Number of tasks | +| `--replicas-max-per-node` | `uint64` | `0` | Maximum number of tasks per node (default 0 = unlimited) | +| `--reserve-cpu` | `decimal` | | Reserve CPUs | +| `--reserve-memory` | `bytes` | `0` | Reserve Memory | +| `--restart-condition` | `string` | | Restart when condition is met (`none`, `on-failure`, `any`) | +| `--restart-delay` | `duration` | | Delay between restart attempts (ns\|us\|ms\|s\|m\|h) | +| `--restart-max-attempts` | `uint` | | Maximum number of restarts before giving up | +| `--restart-window` | `duration` | | Window used to evaluate the restart policy (ns\|us\|ms\|s\|m\|h) | +| [`--rollback`](#rollback) | | | Rollback to previous specification | +| `--rollback-delay` | `duration` | `0s` | Delay between task rollbacks (ns\|us\|ms\|s\|m\|h) | +| `--rollback-failure-action` | `string` | | Action on rollback failure (`pause`, `continue`) | +| `--rollback-max-failure-ratio` | `float` | `0` | Failure rate to tolerate during a rollback | +| `--rollback-monitor` | `duration` | `0s` | Duration after each task rollback to monitor for failure (ns\|us\|ms\|s\|m\|h) | +| `--rollback-order` | `string` | | Rollback order (`start-first`, `stop-first`) | +| `--rollback-parallelism` | `uint64` | `0` | Maximum number of tasks rolled back simultaneously (0 to roll back all at once) | +| [`--secret-add`](#secret-add) | `secret` | | Add or update a secret on a service | +| `--secret-rm` | `list` | | Remove a secret | +| `--stop-grace-period` | `duration` | | Time to wait before force killing a container (ns\|us\|ms\|s\|m\|h) | +| `--stop-signal` | `string` | | Signal to stop the container | +| `--sysctl-add` | `list` | | Add or update a Sysctl option | +| `--sysctl-rm` | `list` | | Remove a Sysctl option | +| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `--ulimit-add` | `ulimit` | | Add or update a ulimit option | +| `--ulimit-rm` | `list` | | Remove a ulimit option | +| `--update-delay` | `duration` | `0s` | Delay between updates (ns\|us\|ms\|s\|m\|h) | +| `--update-failure-action` | `string` | | Action on update failure (`pause`, `continue`, `rollback`) | +| `--update-max-failure-ratio` | `float` | `0` | Failure rate to tolerate during an update | +| `--update-monitor` | `duration` | `0s` | Duration after each task update to monitor for failure (ns\|us\|ms\|s\|m\|h) | +| `--update-order` | `string` | | Update order (`start-first`, `stop-first`) | +| [`--update-parallelism`](#update-parallelism) | `uint64` | `0` | Maximum number of tasks updated simultaneously (0 to update all at once) | +| `-u`, `--user` | `string` | | Username or UID (format: [:]) | +| `--with-registry-auth` | | | Send registry authentication details to swarm agents | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + ## Description diff --git a/docs/reference/commandline/stack.md b/docs/reference/commandline/stack.md index 5003440429..9123aaef5b 100644 --- a/docs/reference/commandline/stack.md +++ b/docs/reference/commandline/stack.md @@ -1,30 +1,23 @@ ---- -title: "stack" -description: "The stack command description and usage" -keywords: "stack" ---- - # stack -```markdown -Usage: docker stack [OPTIONS] COMMAND - + Manage Swarm stacks -Options: - --help Print usage +### Subcommands -Commands: - deploy Deploy a new stack or update an existing stack - ls List stacks - ps List the tasks in the stack - rm Remove one or more stacks - services List the services in the stack +| Name | Description | +|:--------------------------------|:---------------------------------------------------------------------| +| [`config`](stack_config.md) | Outputs the final config file, after doing merges and interpolations | +| [`deploy`](stack_deploy.md) | Deploy a new stack or update an existing stack | +| [`ls`](stack_ls.md) | List stacks | +| [`ps`](stack_ps.md) | List the tasks in the stack | +| [`rm`](stack_rm.md) | Remove one or more stacks | +| [`services`](stack_services.md) | List the services in the stack | -Run 'docker stack COMMAND --help' for more information on a command. -``` + + + ## Description Manage stacks. - diff --git a/docs/reference/commandline/stack_config.md b/docs/reference/commandline/stack_config.md index 5836bf887c..1a3327c444 100644 --- a/docs/reference/commandline/stack_config.md +++ b/docs/reference/commandline/stack_config.md @@ -1,21 +1,17 @@ ---- -title: "stack config" -description: "The stack config command description and usage" -keywords: "stack, config" ---- - # stack config -```markdown -Usage: docker stack config [OPTIONS] - + Outputs the final config file, after doing merges and interpolations -Options: - -c, --compose-file strings Path to a Compose file, or "-" to read from stdin - --orchestrator string Orchestrator to use (swarm|kubernetes|all) - --skip-interpolation Skip interpolation and output only merged config -``` +### Options + +| Name | Type | Default | Description | +|:-----------------------|:--------------|:--------|:--------------------------------------------------| +| `-c`, `--compose-file` | `stringSlice` | | Path to a Compose file, or `-` to read from stdin | +| `--skip-interpolation` | | | Skip interpolation and output only merged config | + + + ## Description diff --git a/docs/reference/commandline/stack_deploy.md b/docs/reference/commandline/stack_deploy.md index efab0cfb8b..d36091e0a7 100644 --- a/docs/reference/commandline/stack_deploy.md +++ b/docs/reference/commandline/stack_deploy.md @@ -1,27 +1,23 @@ ---- -title: "stack deploy" -description: "The stack deploy command description and usage" -keywords: "stack, deploy, up" ---- - # stack deploy -```markdown -Usage: docker stack deploy [OPTIONS] STACK - + Deploy a new stack or update an existing stack -Aliases: - deploy, up +### Aliases -Options: - -c, --compose-file strings Path to a Compose file, or "-" to read from stdin - --help Print usage - --prune Prune services that are no longer referenced - --resolve-image string Query the registry to resolve image digest and supported platforms - ("always"|"changed"|"never") (default "always") - --with-registry-auth Send registry authentication details to Swarm agents -``` +`docker stack deploy`, `docker stack up` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------| +| [`-c`](#compose-file), [`--compose-file`](#compose-file) | `stringSlice` | | Path to a Compose file, or `-` to read from stdin | +| `--prune` | | | Prune services that are no longer referenced | +| `--resolve-image` | `string` | `always` | Query the registry to resolve image digest and supported platforms (`always`, `changed`, `never`) | +| `--with-registry-auth` | | | Send registry authentication details to Swarm agents | + + + ## Description diff --git a/docs/reference/commandline/stack_ls.md b/docs/reference/commandline/stack_ls.md index 06bb3d5d68..075662a674 100644 --- a/docs/reference/commandline/stack_ls.md +++ b/docs/reference/commandline/stack_ls.md @@ -1,28 +1,20 @@ ---- -title: "stack ls" -description: "The stack ls command description and usage" -keywords: "stack, ls" ---- - # stack ls -```markdown -Usage: docker stack ls [OPTIONS] - + List stacks -Aliases: - ls, list +### Aliases -Options: - --help Print usage - --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 -``` +`docker stack ls`, `docker stack list` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`--format`](#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 | + + + ## Description diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md index d974430589..640e7ac741 100644 --- a/docs/reference/commandline/stack_ps.md +++ b/docs/reference/commandline/stack_ps.md @@ -1,29 +1,20 @@ ---- -title: "stack ps" -description: "The stack ps command description and usage" -keywords: "stack, ps" ---- - # stack ps -```markdown -Usage: docker stack ps [OPTIONS] STACK - + List the tasks in the stack -Options: - -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 - --help Print usage - --no-resolve Do not map IDs to Names - --no-trunc Do not truncate output - -q, --quiet Only display task IDs -``` +### 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:
'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-resolve`](#no-resolve) | | | Do not map IDs to Names | +| [`--no-trunc`](#no-trunc) | | | Do not truncate output | +| [`-q`](#quiet), [`--quiet`](#quiet) | | | Only display task IDs | + + + ## Description diff --git a/docs/reference/commandline/stack_rm.md b/docs/reference/commandline/stack_rm.md index 9c90a08933..9549ea28f6 100644 --- a/docs/reference/commandline/stack_rm.md +++ b/docs/reference/commandline/stack_rm.md @@ -1,22 +1,14 @@ ---- -title: "stack rm" -description: "The stack rm command description and usage" -keywords: "stack, rm, remove, down" ---- - # stack rm -```markdown -Usage: docker stack rm [OPTIONS] STACK [STACK...] - + Remove one or more stacks -Aliases: - rm, remove, down +### Aliases -Options: - --help Print usage -``` +`docker stack rm`, `docker stack remove`, `docker stack down` + + + ## Description diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index b782e187a3..251a6ce336 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -1,27 +1,18 @@ ---- -title: "stack services" -description: "The stack services command description and usage" -keywords: "stack, services" ---- - # stack services -```markdown -Usage: docker stack services [OPTIONS] STACK - + List the services in the stack -Options: - -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 - --help Print usage - -q, --quiet Only display IDs -``` +### 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:
'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 | +| `-q`, `--quiet` | | | Only display IDs | + + + ## Description diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md index 1709212b28..866a24921a 100644 --- a/docs/reference/commandline/start.md +++ b/docs/reference/commandline/start.md @@ -1,25 +1,24 @@ ---- -title: "start" -description: "The start command description and usage" -keywords: "Start, container, stopped" ---- - # start -```markdown -Usage: docker start [OPTIONS] CONTAINER [CONTAINER...] - + Start one or more stopped containers -Aliases: - docker container start, docker start +### Aliases -Options: - -a, --attach Attach STDOUT/STDERR and forward signals - --detach-keys string Override the key sequence for detaching a container - --help Print usage - -i, --interactive Attach container's STDIN -``` +`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 | + + + ## Examples diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index e3b68029de..4046e4122f 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -1,26 +1,23 @@ ---- -title: "stats" -description: "The stats command description and usage" -keywords: "container, resource, statistics" ---- - # stats -```markdown -Usage: docker stats [OPTIONS] [CONTAINER...] - + Display a live stream of container(s) resource usage statistics -Aliases: - docker container stats, docker stats +### Aliases -Options: - -a, --all Show all containers (default shows just running) - --format string Pretty-print images using a Go template - --help Print usage - --no-stream Disable streaming stats and only pull the first result - --no-trunc Don't truncate output -``` +`docker container stats`, `docker stats` + +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all containers (default shows just running) | +| [`--format`](#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 diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md index dd508b4186..d46148356b 100644 --- a/docs/reference/commandline/stop.md +++ b/docs/reference/commandline/stop.md @@ -1,23 +1,21 @@ ---- -title: "stop" -description: "The stop command description and usage" -keywords: "stop, SIGKILL, SIGTERM" ---- - # stop -```markdown -Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] - + Stop one or more running containers -Aliases: - docker container stop, docker stop +### Aliases -Options: - -s, --signal string Signal to send to the container - -t, --time int Seconds to wait before killing the container -``` +`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 diff --git a/docs/reference/commandline/swarm.md b/docs/reference/commandline/swarm.md index 510bbc6d86..5187af0590 100644 --- a/docs/reference/commandline/swarm.md +++ b/docs/reference/commandline/swarm.md @@ -1,31 +1,24 @@ ---- -title: "swarm" -description: "The swarm command description and usage" -keywords: "swarm" ---- - # swarm -```markdown -Usage: docker swarm COMMAND - + Manage Swarm -Options: - --help Print usage +### Subcommands -Commands: - ca Manage root CA - init Initialize a swarm - join Join a swarm as a node and/or manager - join-token Manage join tokens - leave Leave the swarm - unlock Unlock swarm - unlock-key Manage the unlock key - update Update the swarm +| Name | Description | +|:------------------------------------|:--------------------------------------| +| [`ca`](swarm_ca.md) | Display and rotate the root CA | +| [`init`](swarm_init.md) | Initialize a swarm | +| [`join`](swarm_join.md) | Join a swarm as a node and/or manager | +| [`join-token`](swarm_join-token.md) | Manage join tokens | +| [`leave`](swarm_leave.md) | Leave the swarm | +| [`unlock`](swarm_unlock.md) | Unlock swarm | +| [`unlock-key`](swarm_unlock-key.md) | Manage the unlock key | +| [`update`](swarm_update.md) | Update the swarm | -Run 'docker swarm COMMAND --help' for more information on a command. -``` + + + ## Description diff --git a/docs/reference/commandline/swarm_ca.md b/docs/reference/commandline/swarm_ca.md index fd74a09cae..9e13917cad 100644 --- a/docs/reference/commandline/swarm_ca.md +++ b/docs/reference/commandline/swarm_ca.md @@ -1,26 +1,22 @@ ---- -title: "swarm ca" -description: "The swarm ca command description and usage" -keywords: "swarm, ca" ---- - # swarm ca -```markdown -Usage: docker swarm ca [OPTIONS] + +Display and rotate the root CA -Manage root CA +### Options -Options: - --ca-cert pem-file Path to the PEM-formatted root CA certificate to use for the new cluster - --ca-key pem-file Path to the PEM-formatted root CA key to use for the new cluster - --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) - -d, --detach Exit immediately instead of waiting for the root rotation to converge - --external-ca external-ca Specifications of one or more certificate signing endpoints - --help Print usage - -q, --quiet Suppress progress output - --rotate Rotate the swarm CA - if no certificate or key are provided, new ones will be generated -``` +| Name | Type | Default | Description | +|:---------------------------------------|:--------------|:------------|:----------------------------------------------------------------------------------------| +| `--ca-cert` | `pem-file` | | Path to the PEM-formatted root CA certificate to use for the new cluster | +| `--ca-key` | `pem-file` | | Path to the PEM-formatted root CA key to use for the new cluster | +| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | +| [`-d`](#detach), [`--detach`](#detach) | | | Exit immediately instead of waiting for the root rotation to converge | +| `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints | +| `-q`, `--quiet` | | | Suppress progress output | +| [`--rotate`](#rotate) | | | Rotate the swarm CA - if no certificate or key are provided, new ones will be generated | + + + ## Description diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md index 310b8341dc..113a25b07a 100644 --- a/docs/reference/commandline/swarm_init.md +++ b/docs/reference/commandline/swarm_init.md @@ -1,34 +1,30 @@ ---- -title: "swarm init" -description: "The swarm init command description and usage" -keywords: "swarm, init" ---- - # swarm init -```markdown -Usage: docker swarm init [OPTIONS] - + Initialize a swarm -Options: - --advertise-addr string Advertised address (format: [:port]) - --autolock Enable manager autolocking (requiring an unlock key to start a stopped manager) - --availability string Availability of the node ("active"|"pause"|"drain") (default "active") - --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) - --data-path-addr string Address or interface to use for data path traffic (format: ) - --data-path-port uint32 Port number to use for data path traffic (1024 - 49151). If no value is set or is set to 0, the default port (4789) is used. - --default-addr-pool IPnet List of default address pool (format: ) - --default-addr-pool-mask-length Subnet mask length for default address pool (default 24) - --dispatcher-heartbeat duration Dispatcher heartbeat period (ns|us|ms|s|m|h) (default 5s) - --external-ca external-ca Specifications of one or more certificate signing endpoints - --force-new-cluster Force create a new cluster from current state - --help Print usage - --listen-addr node-addr Listen address (format: [:port]) (default 0.0.0.0:2377) - --max-snapshots uint Number of additional Raft snapshots to retain - --snapshot-interval uint Number of log entries between Raft snapshots (default 10000) - --task-history-limit int Task history retention limit (default 5) -``` +### Options + +| Name | Type | Default | Description | +|:----------------------------------|:--------------|:---------------|:-----------------------------------------------------------------------------------------------------------------------------| +| `--advertise-addr` | `string` | | Advertised address (format: `[:port]`) | +| `--autolock` | | | Enable manager autolocking (requiring an unlock key to start a stopped manager) | +| `--availability` | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | +| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | +| `--data-path-addr` | `string` | | Address or interface to use for data path traffic (format: ``) | +| `--data-path-port` | `uint32` | `0` | Port number to use for data path traffic (1024 - 49151). If no value is set or is set to 0, the default port (4789) is used. | +| `--default-addr-pool` | `ipNetSlice` | | default address pool in CIDR format | +| `--default-addr-pool-mask-length` | `uint32` | `24` | default address pool subnet mask length | +| `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) | +| `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints | +| `--force-new-cluster` | | | Force create a new cluster from current state | +| `--listen-addr` | `node-addr` | `0.0.0.0:2377` | Listen address (format: `[:port]`) | +| `--max-snapshots` | `uint64` | `0` | Number of additional Raft snapshots to retain | +| `--snapshot-interval` | `uint64` | `10000` | Number of log entries between Raft snapshots | +| `--task-history-limit` | `int64` | `5` | Task history retention limit | + + + ## Description diff --git a/docs/reference/commandline/swarm_join-token.md b/docs/reference/commandline/swarm_join-token.md index eab393d9c8..405209f9e1 100644 --- a/docs/reference/commandline/swarm_join-token.md +++ b/docs/reference/commandline/swarm_join-token.md @@ -1,21 +1,17 @@ ---- -title: "swarm join-token" -description: "The swarm join-token command description and usage" -keywords: "swarm, join-token" ---- - # swarm join-token -```markdown -Usage: docker swarm join-token [OPTIONS] (worker|manager) - + Manage join tokens -Options: - --help Print usage - -q, --quiet Only display token - --rotate Rotate join token -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:-------------------| +| `-q`, `--quiet` | | | Only display token | +| `--rotate` | | | Rotate join token | + + + ## Description diff --git a/docs/reference/commandline/swarm_join.md b/docs/reference/commandline/swarm_join.md index 9c2aa0dcf1..bad97c7338 100644 --- a/docs/reference/commandline/swarm_join.md +++ b/docs/reference/commandline/swarm_join.md @@ -1,24 +1,20 @@ ---- -title: "swarm join" -description: "The swarm join command description and usage" -keywords: "swarm, join" ---- - # swarm join -```markdown -Usage: docker swarm join [OPTIONS] HOST:PORT - + Join a swarm as a node and/or manager -Options: - --advertise-addr string Advertised address (format: [:port]) - --availability string Availability of the node ("active"|"pause"|"drain") (default "active") - --data-path-addr string Address or interface to use for data path traffic (format: ) - --help Print usage - --listen-addr node-addr Listen address (format: [:port]) (default 0.0.0.0:2377) - --token string Token for entry into the swarm -``` +### Options + +| Name | Type | Default | Description | +|:-------------------|:------------|:---------------|:------------------------------------------------------------------------------| +| `--advertise-addr` | `string` | | Advertised address (format: `[:port]`) | +| `--availability` | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | +| `--data-path-addr` | `string` | | Address or interface to use for data path traffic (format: ``) | +| `--listen-addr` | `node-addr` | `0.0.0.0:2377` | Listen address (format: `[:port]`) | +| `--token` | `string` | | Token for entry into the swarm | + + + ## Description diff --git a/docs/reference/commandline/swarm_leave.md b/docs/reference/commandline/swarm_leave.md index 2ba2b758ee..459daa3a0f 100644 --- a/docs/reference/commandline/swarm_leave.md +++ b/docs/reference/commandline/swarm_leave.md @@ -1,20 +1,16 @@ ---- -title: "swarm leave" -description: "The swarm leave command description and usage" -keywords: "swarm, leave" ---- - # swarm leave -```markdown -Usage: docker swarm leave [OPTIONS] - + Leave the swarm -Options: - -f, --force Force this node to leave the swarm, ignoring warnings - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:------------------------------------------------------| +| `-f`, `--force` | | | Force this node to leave the swarm, ignoring warnings | + + + ## Description diff --git a/docs/reference/commandline/swarm_unlock-key.md b/docs/reference/commandline/swarm_unlock-key.md index 2f713bc193..2f78e0359e 100644 --- a/docs/reference/commandline/swarm_unlock-key.md +++ b/docs/reference/commandline/swarm_unlock-key.md @@ -1,21 +1,17 @@ ---- -title: "swarm unlock-key" -description: "The swarm unlock-keycommand description and usage" -keywords: "swarm, unlock-key" ---- - # swarm unlock-key -```markdown -Usage: docker swarm unlock-key [OPTIONS] - + Manage the unlock key -Options: - --help Print usage - -q, --quiet Only display token - --rotate Rotate unlock key -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:-------------------| +| `-q`, `--quiet` | | | Only display token | +| `--rotate` | | | Rotate unlock key | + + + ## Description diff --git a/docs/reference/commandline/swarm_unlock.md b/docs/reference/commandline/swarm_unlock.md index eb99300ab6..92743392c8 100644 --- a/docs/reference/commandline/swarm_unlock.md +++ b/docs/reference/commandline/swarm_unlock.md @@ -1,19 +1,10 @@ ---- -title: "swarm unlock" -description: "The swarm unlock command description and usage" -keywords: "swarm, unlock" ---- - # swarm unlock -```markdown -Usage: docker swarm unlock - + Unlock swarm -Options: - --help Print usage -``` + + ## Description diff --git a/docs/reference/commandline/swarm_update.md b/docs/reference/commandline/swarm_update.md index e4a7f90ecb..4879d2ee50 100644 --- a/docs/reference/commandline/swarm_update.md +++ b/docs/reference/commandline/swarm_update.md @@ -1,26 +1,22 @@ ---- -title: "swarm update" -description: "The swarm update command description and usage" -keywords: "swarm, update" ---- - # swarm update -```markdown -Usage: docker swarm update [OPTIONS] - + Update the swarm -Options: - --autolock Change manager autolocking setting (true|false) - --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) - --dispatcher-heartbeat duration Dispatcher heartbeat period (ns|us|ms|s|m|h) (default 5s) - --external-ca external-ca Specifications of one or more certificate signing endpoints - --help Print usage - --max-snapshots uint Number of additional Raft snapshots to retain - --snapshot-interval uint Number of log entries between Raft snapshots (default 10000) - --task-history-limit int Task history retention limit (default 5) -``` +### Options + +| Name | Type | Default | Description | +|:-------------------------|:--------------|:------------|:------------------------------------------------------------| +| `--autolock` | | | Change manager autolocking setting (true\|false) | +| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | +| `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) | +| `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints | +| `--max-snapshots` | `uint64` | `0` | Number of additional Raft snapshots to retain | +| `--snapshot-interval` | `uint64` | `10000` | Number of log entries between Raft snapshots | +| `--task-history-limit` | `int64` | `5` | Task history retention limit | + + + ## Description diff --git a/docs/reference/commandline/system.md b/docs/reference/commandline/system.md index 2090bbf12c..2e27b7a3dc 100644 --- a/docs/reference/commandline/system.md +++ b/docs/reference/commandline/system.md @@ -1,27 +1,21 @@ ---- -title: "system" -description: "The system command description and usage" -keywords: "system" ---- - # system -```markdown -Usage: docker system COMMAND - + Manage Docker -Options: - --help Print usage +### Subcommands -Commands: - df Show docker disk usage - events Get real time events from the server - info Display system-wide information - prune Remove unused data +| Name | Description | +|:-------------------------------------|:---------------------------------------------------------------------------------| +| [`df`](system_df.md) | Show docker disk usage | +| [`dial-stdio`](system_dial-stdio.md) | Proxy the stdio stream to the daemon connection. Should not be invoked manually. | +| [`events`](system_events.md) | Get real time events from the server | +| [`info`](system_info.md) | Display system-wide information | +| [`prune`](system_prune.md) | Remove unused data | -Run 'docker system COMMAND --help' for more information on a command. -``` + + + ## Description diff --git a/docs/reference/commandline/system_df.md b/docs/reference/commandline/system_df.md index ef0e45f93b..1c05ff4b3e 100644 --- a/docs/reference/commandline/system_df.md +++ b/docs/reference/commandline/system_df.md @@ -1,26 +1,17 @@ ---- -title: "system df" -description: "The system df command description and usage" -keywords: "system, data, usage, disk" ---- - # system df -```markdown -Usage: docker system df [OPTIONS] + +Show docker disk usage -Show docker filesystem usage +### Options -Options: - --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 - --help Print usage - -v, --verbose Show detailed information on space usage -``` +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`--format`](#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 | +| `-v`, `--verbose` | | | Show detailed information on space usage | + + + ## Description diff --git a/docs/reference/commandline/system_dial-stdio.md b/docs/reference/commandline/system_dial-stdio.md new file mode 100644 index 0000000000..fb59878aa3 --- /dev/null +++ b/docs/reference/commandline/system_dial-stdio.md @@ -0,0 +1,8 @@ +# system dial-stdio + + +Proxy the stdio stream to the daemon connection. Should not be invoked manually. + + + + diff --git a/docs/reference/commandline/system_events.md b/docs/reference/commandline/system_events.md index 9f0825e4c0..35788bcc39 100644 --- a/docs/reference/commandline/system_events.md +++ b/docs/reference/commandline/system_events.md @@ -1,23 +1,23 @@ ---- -title: "system events" -description: "The system events command description and usage" -keywords: "system, events, container, report" ---- - # system events -```markdown -Usage: docker system events [OPTIONS] - + Get real time events from the server -Options: - -f, --filter value Filter output based on conditions provided (default []) - --format string Format the output using the given Go template - --help Print usage - --since string Show all events created since timestamp - --until string Stream events until this timestamp -``` +### 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 the output using the given Go template | +| `--since` | `string` | | Show all events created since timestamp | +| `--until` | `string` | | Stream events until this timestamp | + + + ## Description diff --git a/docs/reference/commandline/system_info.md b/docs/reference/commandline/system_info.md new file mode 100644 index 0000000000..8ef2093a07 --- /dev/null +++ b/docs/reference/commandline/system_info.md @@ -0,0 +1,18 @@ +# system info + + +Display system-wide information + +### Aliases + +`docker system info`, `docker info` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:----------------------------------------------| +| `-f`, `--format` | `string` | | Format the output using the given Go template | + + + + diff --git a/docs/reference/commandline/system_prune.md b/docs/reference/commandline/system_prune.md index e14e42dd57..72b7d80f9f 100644 --- a/docs/reference/commandline/system_prune.md +++ b/docs/reference/commandline/system_prune.md @@ -1,23 +1,19 @@ ---- -title: "system prune" -description: "Remove unused data" -keywords: "system, prune, delete, remove" ---- - # system prune -```markdown -Usage: docker system prune [OPTIONS] - + Remove unused data -Options: - -a, --all Remove all unused images not just dangling ones - --filter filter Provide filter values (e.g. 'label==') - -f, --force Do not prompt for confirmation - --help Print usage - --volumes Prune volumes -``` +### Options + +| Name | Type | Default | Description | +|:----------------------|:---------|:--------|:---------------------------------------------------| +| `-a`, `--all` | | | Remove all unused images not just dangling ones | +| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label==`) | +| `-f`, `--force` | | | Do not prompt for confirmation | +| `--volumes` | | | Prune volumes | + + + ## Description diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index aac1a8d539..1274cd862a 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -1,22 +1,14 @@ ---- -title: "tag" -description: "The tag command description and usage" -keywords: "tag, name, image" ---- - # tag -```markdown -Usage: docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] - + Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE -Aliases: - docker image tag, docker tag +### Aliases -Options: - --help Print usage -``` +`docker image tag`, `docker tag` + + + ## Description diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md index 0764c7848f..7974577c69 100644 --- a/docs/reference/commandline/top.md +++ b/docs/reference/commandline/top.md @@ -1,19 +1,11 @@ ---- -title: "top" -description: "The top command description and usage" -keywords: "container, running, processes" ---- - # top -```markdown -Usage: docker top CONTAINER [ps OPTIONS] - + Display the running processes of a container -Aliases: - docker container top, docker top +### Aliases -Options: - --help Print usage -``` +`docker container top`, `docker top` + + + diff --git a/docs/reference/commandline/trust.md b/docs/reference/commandline/trust.md new file mode 100644 index 0000000000..bc1fa7206c --- /dev/null +++ b/docs/reference/commandline/trust.md @@ -0,0 +1,19 @@ +# trust + + +Manage trust on Docker images + +### Subcommands + +| Name | Description | +|:------------------------------|:-------------------------------------------------------| +| [`inspect`](trust_inspect.md) | Return low-level information about keys and signatures | +| [`key`](trust_key.md) | Manage keys for signing Docker images | +| [`revoke`](trust_revoke.md) | Remove trust for an image | +| [`sign`](trust_sign.md) | Sign an image | +| [`signer`](trust_signer.md) | Manage entities who can sign Docker images | + + + + + diff --git a/docs/reference/commandline/trust_inspect.md b/docs/reference/commandline/trust_inspect.md index 7be776be75..5cb0ac0394 100644 --- a/docs/reference/commandline/trust_inspect.md +++ b/docs/reference/commandline/trust_inspect.md @@ -1,20 +1,16 @@ ---- -title: "trust inspect" -description: "The inspect command description and usage" -keywords: "inspect, notary, trust" ---- - # trust inspect -```markdown -Usage: docker trust inspect IMAGE[:TAG] [IMAGE[:TAG]...] - + Return low-level information about keys and signatures -Options: - --help Print usage - --pretty Print the information in a human friendly format -``` +### Options + +| Name | Type | Default | Description | +|:-----------|:-----|:--------|:-------------------------------------------------| +| `--pretty` | | | Print the information in a human friendly format | + + + ## Description diff --git a/docs/reference/commandline/trust_key.md b/docs/reference/commandline/trust_key.md new file mode 100644 index 0000000000..eed149a3e8 --- /dev/null +++ b/docs/reference/commandline/trust_key.md @@ -0,0 +1,16 @@ +# trust key + + +Manage keys for signing Docker images + +### Subcommands + +| Name | Description | +|:------------------------------------|:-------------------------------------| +| [`generate`](trust_key_generate.md) | Generate and load a signing key-pair | +| [`load`](trust_key_load.md) | Load a private key file for signing | + + + + + diff --git a/docs/reference/commandline/trust_key_generate.md b/docs/reference/commandline/trust_key_generate.md index 71634b96ee..3afe2477f9 100644 --- a/docs/reference/commandline/trust_key_generate.md +++ b/docs/reference/commandline/trust_key_generate.md @@ -1,20 +1,16 @@ ---- -title: "key generate" -description: "The key generate command description and usage" -keywords: "key, notary, trust" ---- - # trust key generate -```markdown -Usage: docker trust key generate NAME - + Generate and load a signing key-pair -Options: - --dir string Directory to generate key in, defaults to current directory - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:--------|:---------|:--------|:------------------------------------------------------------| +| `--dir` | `string` | | Directory to generate key in, defaults to current directory | + + + ## Description diff --git a/docs/reference/commandline/trust_key_load.md b/docs/reference/commandline/trust_key_load.md index d0553af1dd..57fd480a9a 100644 --- a/docs/reference/commandline/trust_key_load.md +++ b/docs/reference/commandline/trust_key_load.md @@ -1,20 +1,16 @@ ---- -title: "key load" -description: "The key load command description and usage" -keywords: "key, notary, trust" ---- - # trust key load -```markdown -Usage: docker trust key load [OPTIONS] KEYFILE - + Load a private key file for signing -Options: - --help Print usage - --name string Name for the loaded key (default "signer") -``` +### Options + +| Name | Type | Default | Description | +|:---------|:---------|:---------|:------------------------| +| `--name` | `string` | `signer` | Name for the loaded key | + + + ## Description diff --git a/docs/reference/commandline/trust_revoke.md b/docs/reference/commandline/trust_revoke.md index e373b936cc..04a8a91330 100644 --- a/docs/reference/commandline/trust_revoke.md +++ b/docs/reference/commandline/trust_revoke.md @@ -1,20 +1,16 @@ ---- -title: "trust revoke" -description: "The revoke command description and usage" -keywords: "revoke, notary, trust" ---- - # trust revoke -```markdown -Usage: docker trust revoke [OPTIONS] IMAGE[:TAG] - + Remove trust for an image -Options: - --help Print usage - -y, --yes Do not prompt for confirmation -``` +### Options + +| Name | Type | Default | Description | +|:--------------|:-----|:--------|:-------------------------------| +| `-y`, `--yes` | | | Do not prompt for confirmation | + + + ## Description diff --git a/docs/reference/commandline/trust_sign.md b/docs/reference/commandline/trust_sign.md index 605887b6b4..567d0af6bd 100644 --- a/docs/reference/commandline/trust_sign.md +++ b/docs/reference/commandline/trust_sign.md @@ -1,21 +1,16 @@ ---- -title: "trust sign" -description: "The sign command description and usage" -keywords: "sign, notary, trust" ---- - # trust sign -```markdown -Usage: docker trust sign [OPTIONS] IMAGE:TAG - + Sign an image -Options: - --help print usage - --local force the signing of a local image +### Options -``` +| Name | Type | Default | Description | +|:----------|:-----|:--------|:----------------------------| +| `--local` | | | Sign a locally tagged image | + + + ## Description diff --git a/docs/reference/commandline/trust_signer.md b/docs/reference/commandline/trust_signer.md new file mode 100644 index 0000000000..52aeda273f --- /dev/null +++ b/docs/reference/commandline/trust_signer.md @@ -0,0 +1,16 @@ +# trust signer + + +Manage entities who can sign Docker images + +### Subcommands + +| Name | Description | +|:-----------------------------------|:----------------| +| [`add`](trust_signer_add.md) | Add a signer | +| [`remove`](trust_signer_remove.md) | Remove a signer | + + + + + diff --git a/docs/reference/commandline/trust_signer_add.md b/docs/reference/commandline/trust_signer_add.md index 4ae9a2f5fb..1ca68faa4c 100644 --- a/docs/reference/commandline/trust_signer_add.md +++ b/docs/reference/commandline/trust_signer_add.md @@ -1,20 +1,16 @@ ---- -title: "signer add" -description: "The signer add command description and usage" -keywords: "signer, notary, trust" ---- - # trust signer add -```markdown -Usage: docker trust signer add [OPTIONS] NAME REPOSITORY [REPOSITORY...] - + Add a signer -Options: - --help Print usage - -k, --key list Path to the signer's public key file -``` +### Options + +| Name | Type | Default | Description | +|:--------|:-------|:--------|:-------------------------------------| +| `--key` | `list` | | Path to the signer's public key file | + + + ## Description diff --git a/docs/reference/commandline/trust_signer_remove.md b/docs/reference/commandline/trust_signer_remove.md index 5882def689..a92fe5b929 100644 --- a/docs/reference/commandline/trust_signer_remove.md +++ b/docs/reference/commandline/trust_signer_remove.md @@ -1,20 +1,16 @@ ---- -title: "signer remove" -description: "The signer remove command description and usage" -keywords: "signer, notary, trust" ---- - # trust signer remove -```markdown -Usage: docker trust signer remove [OPTIONS] NAME REPOSITORY [REPOSITORY...] - + Remove a signer -Options: - -f, --force Do not prompt for confirmation before removing the most recent signer - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:----------------|:-----|:--------|:----------------------------------------------------------------------| +| `-f`, `--force` | | | Do not prompt for confirmation before removing the most recent signer | + + + ## Description diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md index 2923d09ce7..a5165812cc 100644 --- a/docs/reference/commandline/unpause.md +++ b/docs/reference/commandline/unpause.md @@ -1,22 +1,14 @@ ---- -title: "unpause" -description: "The unpause command description and usage" -keywords: "cgroups, suspend, container" ---- - # unpause -```markdown -Usage: docker unpause CONTAINER [CONTAINER...] - + Unpause all processes within one or more containers -Aliases: - docker container unpause, docker unpause +### Aliases -Options: - --help Print usage -``` +`docker container unpause`, `docker unpause` + + + ## Description diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/update.md index c2f84fdeac..b6dfe1ee7e 100644 --- a/docs/reference/commandline/update.md +++ b/docs/reference/commandline/update.md @@ -1,37 +1,33 @@ ---- -title: "update" -description: "The update command description and usage" -keywords: "resources, update, dynamically" ---- - ## update -```markdown -Usage: docker update [OPTIONS] CONTAINER [CONTAINER...] - + Update configuration of one or more containers -Aliases: - docker container update, docker update +### Aliases -Options: - --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) - --cpu-period int Limit CPU CFS (Completely Fair Scheduler) period - --cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota - --cpu-rt-period int Limit the CPU real-time period in microseconds - --cpu-rt-runtime int Limit the CPU real-time runtime in microseconds - -c, --cpu-shares int CPU shares (relative weight) - --cpus decimal Number of CPUs (default 0.000) - --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) - --help Print usage - --kernel-memory string Kernel memory limit - -m, --memory string Memory limit - --memory-reservation string Memory soft limit - --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap - --pids-limit int Tune container pids limit (set -1 for unlimited) - --restart string Restart policy to apply when a container exits -``` +`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), [`--cpu-shares`](#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), [`--memory`](#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`](#restart) | `string` | | Restart policy to apply when a container exits | + + + ## Description diff --git a/docs/reference/commandline/version.md b/docs/reference/commandline/version.md index 267a9f39e5..4dfadfafdc 100644 --- a/docs/reference/commandline/version.md +++ b/docs/reference/commandline/version.md @@ -1,20 +1,16 @@ ---- -title: "version" -description: "The version command description and usage" -keywords: "version, architecture, api" ---- - # version -```markdown -Usage: docker version [OPTIONS] - + Show the Docker version information -Options: - -f, --format string Format the output using the given Go template - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:----------------------------------------------| +| [`-f`](#format), [`--format`](#format) | `string` | | Format the output using the given Go template | + + + ## Description diff --git a/docs/reference/commandline/volume.md b/docs/reference/commandline/volume.md index 96ed528569..8f30002523 100644 --- a/docs/reference/commandline/volume.md +++ b/docs/reference/commandline/volume.md @@ -1,39 +1,24 @@ ---- -title: "volume" -description: "The volume command description and usage" -keywords: "volume" ---- - # volume -```markdown -Usage: docker volume COMMAND - + Manage volumes -Options: - --help Print usage +### Subcommands -Commands: - create Create a volume - inspect Display detailed information on one or more volumes - ls List volumes - prune Remove all unused local volumes - rm Remove one or more volumes +| Name | Description | +|:-------------------------------|:----------------------------------------------------| +| [`create`](volume_create.md) | Create a volume | +| [`inspect`](volume_inspect.md) | Display detailed information on one or more volumes | +| [`ls`](volume_ls.md) | List volumes | +| [`prune`](volume_prune.md) | Remove all unused local volumes | +| [`rm`](volume_rm.md) | Remove one or more volumes | +| [`update`](volume_update.md) | Update a volume (cluster volumes only) | -Run 'docker volume COMMAND --help' for more information on a command. -``` + + + ## Description Manage volumes. You can use subcommands to create, inspect, list, remove, or prune volumes. - -## Related commands - -* [volume create](volume_create.md) -* [volume inspect](volume_inspect.md) -* [volume list](volume_ls.md) -* [volume rm](volume_rm.md) -* [volume prune](volume_prune.md) -* [Understand Data Volumes](https://docs.docker.com/storage/volumes/) diff --git a/docs/reference/commandline/volume_create.md b/docs/reference/commandline/volume_create.md index 9f9f3141b0..e0129021ec 100644 --- a/docs/reference/commandline/volume_create.md +++ b/docs/reference/commandline/volume_create.md @@ -1,22 +1,28 @@ ---- -title: "volume create" -description: "The volume create command description and usage" -keywords: "volume, create" ---- - # volume create -```markdown -Usage: docker volume create [OPTIONS] [VOLUME] - + Create a volume -Options: - -d, --driver string Specify volume driver name (default "local") - --help Print usage - --label value Set metadata for a volume (default []) - -o, --opt value Set driver specific options (default map[]) -``` +### Options + +| Name | Type | Default | Description | +|:------------------------------|:---------|:---------|:-----------------------------------------------------------------------| +| `--availability` | `string` | `active` | Cluster Volume availability (`active`, `pause`, `drain`) | +| `-d`, `--driver` | `string` | `local` | Specify volume driver name | +| `--group` | `string` | | Cluster Volume group (cluster volumes) | +| `--label` | `list` | | Set metadata for a volume | +| `--limit-bytes` | `bytes` | `0` | Minimum size of the Cluster Volume in bytes | +| [`-o`](#opt), [`--opt`](#opt) | `map` | `map[]` | Set driver specific options | +| `--required-bytes` | `bytes` | `0` | Maximum size of the Cluster Volume in bytes | +| `--scope` | `string` | `single` | Cluster Volume access scope (`single`, `multi`) | +| `--secret` | `map` | `map[]` | Cluster Volume secrets | +| `--sharing` | `string` | `none` | Cluster Volume access sharing (`none`, `readonly`, `onewriter`, `all`) | +| `--topology-preferred` | `list` | | A topology that the Cluster Volume would be preferred in | +| `--topology-required` | `list` | | A topology that the Cluster Volume must be accessible from | +| `--type` | `string` | `block` | Cluster Volume access type (`mount`, `block`) | + + + ## Description diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 43a9a9e225..cfe36e8571 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -1,23 +1,16 @@ ---- -title: "volume inspect" -description: "The volume inspect command description and usage" -keywords: "volume, inspect" ---- - # volume inspect -```markdown -Usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...] - + Display detailed information on one or more volumes -Options: - -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 - --help Print usage -``` +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-f`](#format), [`--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 | + + + ## Description diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index 499a4be4c5..cd7f27c08c 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -1,34 +1,23 @@ ---- -title: "volume ls" -description: "The volume ls command description and usage" -keywords: "volume, list" ---- - # volume ls -```markdown -Usage: docker volume ls [OPTIONS] - + List volumes -Aliases: - ls, list +### Aliases -Options: - -f, --filter value Provide filter values (e.g. 'dangling=true') (default []) - - dangling= a volume if referenced or not - - driver= a volume's driver name - - label= or label== - - name= a volume's name - --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 - --help Print usage - -q, --quiet Only display volume names -``` +`docker volume ls`, `docker volume list` + +### Options + +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--cluster` | | | Display only cluster volumes, and use cluster volume list formatting | +| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `dangling=true`) | +| [`--format`](#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 | +| `-q`, `--quiet` | | | Only display volume names | + + + ## Description diff --git a/docs/reference/commandline/volume_prune.md b/docs/reference/commandline/volume_prune.md index 5d81967dab..ea5ffd1e3f 100644 --- a/docs/reference/commandline/volume_prune.md +++ b/docs/reference/commandline/volume_prune.md @@ -1,21 +1,17 @@ ---- -title: "volume prune" -description: "Remove unused local volumes" -keywords: "volume, prune, delete" ---- - # volume prune -```markdown -Usage: docker volume prune [OPTIONS] - + Remove all unused local volumes -Options: - --filter filter Provide filter values (e.g. 'label=