diff --git a/data/engine-cli/docker.yaml b/data/engine-cli/docker.yaml index 328d49de8362..fe0954e2dc6f 100644 --- a/data/engine-cli/docker.yaml +++ b/data/engine-cli/docker.yaml @@ -37,8 +37,6 @@ long: |- | `DOCKER_API_VERSION` | Override the negotiated API version to use for debugging (e.g. `1.19`) | | `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the `docker` CLI and the [`dockerd` daemon](/reference/cli/dockerd/) | | `DOCKER_CONFIG` | The location of your client configuration files. | - | `DOCKER_CONTENT_TRUST_SERVER` | The URL of the Notary server to use. Defaults to the same URL as the registry. | - | `DOCKER_CONTENT_TRUST` | When set Docker uses notary to sign and verify images. Equates to `--disable-content-trust=false` for build, create, pull, push, run. | | `DOCKER_CONTEXT` | Name of the `docker context` to use (overrides `DOCKER_HOST` env var and default context set with `docker context use`) | | `DOCKER_CUSTOM_HEADERS` | (Experimental) Configure [custom HTTP headers](#custom-http-headers) to be sent by the client. Headers must be provided as a comma-separated list of `name=value` pairs. This is the equivalent to the `HttpHeaders` field in the configuration file. | | `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. | @@ -47,6 +45,8 @@ long: |- | `DOCKER_TLS` | Enable TLS for connections made by the `docker` CLI (equivalent of the `--tls` command-line option). Set to a non-empty value to enable TLS. Note that TLS is enabled automatically if any of the other TLS options are set. | | `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](/reference/cli/dockerd/) | | `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`) when [building](/reference/cli/docker/image/build/) with [BuildKit backend](/build/buildkit/). Use plain to show container output (default `auto`). | + | `NO_COLOR` | Disable any ANSI escape codes in the output in accordance with https://no-color.org/ + | Because Docker is developed using Go, you can also use any environment variables used by the Go runtime. In particular, you may find these useful: @@ -234,8 +234,8 @@ long: |- These settings are used to configure proxy settings for containers only, and not used as proxy settings for the `docker` CLI or the `dockerd` daemon. Refer to the - [environment variables](#environment-variables) and [HTTP/HTTPS proxy](/engine/daemon/proxy/#httphttps-proxy) - sections for configuring proxy settings for the CLI and daemon. + [environment variables](#environment-variables) section and the [Daemon proxy configuration](/engine/daemon/proxy/) + guide for configuring proxy settings for the CLI and daemon. > [!WARNING] > Proxy settings may contain sensitive information (for example, if the proxy @@ -390,7 +390,6 @@ cname: - docker system - docker tag - docker top - - docker trust - docker unpause - docker update - docker version @@ -449,7 +448,6 @@ clink: - docker_system.yaml - docker_tag.yaml - docker_top.yaml - - docker_trust.yaml - docker_unpause.yaml - docker_update.yaml - docker_version.yaml @@ -500,7 +498,7 @@ options: swarm: false - option: host shorthand: H - value_type: list + value_type: string description: Daemon socket to connect to details_url: '#host' deprecated: false diff --git a/data/engine-cli/docker_build.yaml b/data/engine-cli/docker_build.yaml index 6cc13ead6f70..fc9886436827 100644 --- a/data/engine-cli/docker_build.yaml +++ b/data/engine-cli/docker_build.yaml @@ -108,9 +108,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_builder_build.yaml b/data/engine-cli/docker_builder_build.yaml index 1a8075d93d2c..c1a67392e7e6 100644 --- a/data/engine-cli/docker_builder_build.yaml +++ b/data/engine-cli/docker_builder_build.yaml @@ -109,9 +109,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_commit.yaml b/data/engine-cli/docker_commit.yaml index c86e3d2deef8..c5490e67b06a 100644 --- a/data/engine-cli/docker_commit.yaml +++ b/data/engine-cli/docker_commit.yaml @@ -36,13 +36,23 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: no-pause + value_type: bool + default_value: "false" + description: Disable pausing container during commit + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: pause shorthand: p value_type: bool default_value: "true" - description: Pause container during commit - deprecated: false - hidden: false + description: 'Pause container during commit (deprecated: use --no-pause instead)' + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_container_commit.yaml b/data/engine-cli/docker_container_commit.yaml index 0f9397187798..523e7d9e4e0f 100644 --- a/data/engine-cli/docker_container_commit.yaml +++ b/data/engine-cli/docker_container_commit.yaml @@ -51,13 +51,23 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: no-pause + value_type: bool + default_value: "false" + description: Disable pausing container during commit + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: pause shorthand: p value_type: bool default_value: "true" - description: Pause container during commit - deprecated: false - hidden: false + description: 'Pause container during commit (deprecated: use --no-pause instead)' + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_container_create.yaml b/data/engine-cli/docker_container_create.yaml index eb25769b16cc..722645fbb1b4 100644 --- a/data/engine-cli/docker_container_create.yaml +++ b/data/engine-cli/docker_container_create.yaml @@ -290,9 +290,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -527,7 +527,8 @@ options: swarm: false os_type: windows - option: ip - value_type: string + value_type: ip + default_value: description: IPv4 address (e.g., 172.30.100.104) deprecated: false hidden: false @@ -536,7 +537,8 @@ options: kubernetes: false swarm: false - option: ip6 - value_type: string + value_type: ip + default_value: description: IPv6 address (e.g., 2001:db8::33) deprecated: false hidden: false @@ -565,9 +567,9 @@ options: - option: kernel-memory value_type: bytes default_value: "0" - description: Kernel memory limit - deprecated: false - hidden: false + description: Kernel memory limit (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_container_run.yaml b/data/engine-cli/docker_container_run.yaml index bb92fa9d091a..f49e12e13bb7 100644 --- a/data/engine-cli/docker_container_run.yaml +++ b/data/engine-cli/docker_container_run.yaml @@ -305,9 +305,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -546,7 +546,8 @@ options: swarm: false os_type: windows - option: ip - value_type: string + value_type: ip + default_value: description: IPv4 address (e.g., 172.30.100.104) deprecated: false hidden: false @@ -555,7 +556,8 @@ options: kubernetes: false swarm: false - option: ip6 - value_type: string + value_type: ip + default_value: description: IPv6 address (e.g., 2001:db8::33) deprecated: false hidden: false @@ -586,9 +588,9 @@ options: - option: kernel-memory value_type: bytes default_value: "0" - description: Kernel memory limit - deprecated: false - hidden: false + description: Kernel memory limit (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -2262,7 +2264,9 @@ examples: |- It's conventional to use `host.docker.internal` as the hostname referring to `host-gateway`. Docker Desktop automatically resolves this hostname, see - [Explore networking features](/desktop/features/networking/networking-how-tos/#connect-a-container-to-a-service-on-the-host). + [Explore networking how-tos on Docker Desktop](/desktop/features/networking/networking-how-tos/#connect-a-container-to-a-service-on-the-host) + and + [Configure host gateway IP](/reference/cli/dockerd/#configure-host-gateway-ip). The following example shows how the special `host-gateway` value works. The example runs an HTTP server that serves a file from host to container over the diff --git a/data/engine-cli/docker_create.yaml b/data/engine-cli/docker_create.yaml index 4266c3d11c4f..432c3c7ddc23 100644 --- a/data/engine-cli/docker_create.yaml +++ b/data/engine-cli/docker_create.yaml @@ -273,9 +273,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -510,7 +510,8 @@ options: swarm: false os_type: windows - option: ip - value_type: string + value_type: ip + default_value: description: IPv4 address (e.g., 172.30.100.104) deprecated: false hidden: false @@ -519,7 +520,8 @@ options: kubernetes: false swarm: false - option: ip6 - value_type: string + value_type: ip + default_value: description: IPv6 address (e.g., 2001:db8::33) deprecated: false hidden: false @@ -548,9 +550,9 @@ options: - option: kernel-memory value_type: bytes default_value: "0" - description: Kernel memory limit - deprecated: false - hidden: false + description: Kernel memory limit (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_image_build.yaml b/data/engine-cli/docker_image_build.yaml index 2c7c1f28d455..e5de1684603d 100644 --- a/data/engine-cli/docker_image_build.yaml +++ b/data/engine-cli/docker_image_build.yaml @@ -177,9 +177,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -470,22 +470,22 @@ examples: |- ```console Client: Docker Engine - Community - Version: 23.0.3 - API version: 1.42 - Go version: go1.19.7 - Git commit: 3e7cbfd - Built: Tue Apr 4 22:05:41 2023 - OS/Arch: darwin/amd64 - Context: default + Version: 28.5.1 + API version: 1.51 + Go version: go1.24.8 + Git commit: e180ab8 + Built: Wed Oct 8 12:16:17 2025 + OS/Arch: darwin/arm64 + Context: desktop-linux Server: Docker Engine - Community Engine: - Version: 23.0.3 - API version: 1.42 (minimum version 1.12) - Go version: go1.19.7 - Git commit: 59118bf - Built: Tue Apr 4 22:05:41 2023 - OS/Arch: linux/amd64 + Version: 28.5.1 + API version: 1.51 (minimum version 1.24) + Go version: go1.24.8 + Git commit: f8215cc + Built: Wed Oct 8 12:18:25 2025 + OS/Arch: linux/arm64 Experimental: true [...] ``` diff --git a/data/engine-cli/docker_image_load.yaml b/data/engine-cli/docker_image_load.yaml index c4b82bb93c52..d6312cf270b1 100644 --- a/data/engine-cli/docker_image_load.yaml +++ b/data/engine-cli/docker_image_load.yaml @@ -20,9 +20,10 @@ options: kubernetes: false swarm: false - option: platform - value_type: string + value_type: stringSlice + default_value: '[]' description: | - Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) + Load only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`). details_url: '#platform' deprecated: false hidden: false diff --git a/data/engine-cli/docker_image_ls.yaml b/data/engine-cli/docker_image_ls.yaml index bdad55e3a5a3..b870d29ac127 100644 --- a/data/engine-cli/docker_image_ls.yaml +++ b/data/engine-cli/docker_image_ls.yaml @@ -10,6 +10,9 @@ long: |- allowing each step to be cached. These intermediate layers are not shown by default. + Untagged (dangling) images are also hidden by default. Use the `-a` (`--all`) + flag to show intermediate layers and dangling images. + The `SIZE` is the cumulative space taken up by the image and all its parent images. This is also the disk space used by the contents of the Tar file created when you `docker save` an image. @@ -25,7 +28,7 @@ options: shorthand: a value_type: bool default_value: "false" - description: Show all images (default hides intermediate images) + description: Show all images (default hides intermediate and dangling images) deprecated: false hidden: false experimental: false @@ -415,8 +418,8 @@ examples: |- ```console $ docker images --format json - {"Containers":"N/A","CreatedAt":"2021-03-04 03:24:42 +0100 CET","CreatedSince":"5 days ago","Digest":"\u003cnone\u003e","ID":"4dd97cefde62","Repository":"ubuntu","SharedSize":"N/A","Size":"72.9MB","Tag":"latest","UniqueSize":"N/A","VirtualSize":"72.9MB"} - {"Containers":"N/A","CreatedAt":"2021-02-17 22:19:54 +0100 CET","CreatedSince":"2 weeks ago","Digest":"\u003cnone\u003e","ID":"28f6e2705743","Repository":"alpine","SharedSize":"N/A","Size":"5.61MB","Tag":"latest","UniqueSize":"N/A","VirtualSize":"5.613MB"} + {"Containers":"N/A","CreatedAt":"2021-03-04 03:24:42 +0100 CET","CreatedSince":"5 days ago","Digest":"\u003cnone\u003e","ID":"4dd97cefde62","Repository":"ubuntu","SharedSize":"N/A","Size":"72.9MB","Tag":"latest","UniqueSize":"N/A"} + {"Containers":"N/A","CreatedAt":"2021-02-17 22:19:54 +0100 CET","CreatedSince":"2 weeks ago","Digest":"\u003cnone\u003e","ID":"28f6e2705743","Repository":"alpine","SharedSize":"N/A","Size":"5.61MB","Tag":"latest","UniqueSize":"N/A"} ``` deprecated: false hidden: false diff --git a/data/engine-cli/docker_image_pull.yaml b/data/engine-cli/docker_image_pull.yaml index 7c42bc5fdc44..7f43742be118 100644 --- a/data/engine-cli/docker_image_pull.yaml +++ b/data/engine-cli/docker_image_pull.yaml @@ -43,9 +43,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_image_push.yaml b/data/engine-cli/docker_image_push.yaml index 89777eedede2..e0bb7e3177e8 100644 --- a/data/engine-cli/docker_image_push.yaml +++ b/data/engine-cli/docker_image_push.yaml @@ -42,9 +42,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image signing - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_image_save.yaml b/data/engine-cli/docker_image_save.yaml index bbec0590cb8d..3d242060281e 100644 --- a/data/engine-cli/docker_image_save.yaml +++ b/data/engine-cli/docker_image_save.yaml @@ -20,9 +20,10 @@ options: kubernetes: false swarm: false - option: platform - value_type: string + value_type: stringSlice + default_value: '[]' description: | - Save only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) + Save only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`) details_url: '#platform' deprecated: false hidden: false diff --git a/data/engine-cli/docker_images.yaml b/data/engine-cli/docker_images.yaml index 2cd119d0c057..52b190ed2e45 100644 --- a/data/engine-cli/docker_images.yaml +++ b/data/engine-cli/docker_images.yaml @@ -10,7 +10,7 @@ options: shorthand: a value_type: bool default_value: "false" - description: Show all images (default hides intermediate images) + description: Show all images (default hides intermediate and dangling images) deprecated: false hidden: false experimental: false diff --git a/data/engine-cli/docker_load.yaml b/data/engine-cli/docker_load.yaml index 3f7d02e1954c..6a80993f0031 100644 --- a/data/engine-cli/docker_load.yaml +++ b/data/engine-cli/docker_load.yaml @@ -17,9 +17,10 @@ options: kubernetes: false swarm: false - option: platform - value_type: string + value_type: stringSlice + default_value: '[]' description: | - Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) + Load only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`). deprecated: false hidden: false min_api_version: "1.48" diff --git a/data/engine-cli/docker_network_connect.yaml b/data/engine-cli/docker_network_connect.yaml index 7fc8ba9eb997..5285a834d4d4 100644 --- a/data/engine-cli/docker_network_connect.yaml +++ b/data/engine-cli/docker_network_connect.yaml @@ -41,7 +41,8 @@ options: kubernetes: false swarm: false - option: ip - value_type: string + value_type: ip + default_value: description: IPv4 address (e.g., `172.30.100.104`) details_url: '#ip' deprecated: false @@ -51,7 +52,8 @@ options: kubernetes: false swarm: false - option: ip6 - value_type: string + value_type: ip + default_value: description: IPv6 address (e.g., `2001:db8::33`) deprecated: false hidden: false @@ -70,7 +72,7 @@ options: kubernetes: false swarm: false - option: link-local-ip - value_type: stringSlice + value_type: ipSlice default_value: '[]' description: Add a link-local address for the container deprecated: false diff --git a/data/engine-cli/docker_network_create.yaml b/data/engine-cli/docker_network_create.yaml index 99706e3d55dd..12254577d942 100644 --- a/data/engine-cli/docker_network_create.yaml +++ b/data/engine-cli/docker_network_create.yaml @@ -108,7 +108,7 @@ options: kubernetes: false swarm: false - option: gateway - value_type: stringSlice + value_type: ipSlice default_value: '[]' description: IPv4 or IPv6 Gateway for the master subnet deprecated: false @@ -141,7 +141,7 @@ options: kubernetes: false swarm: false - option: ip-range - value_type: stringSlice + value_type: ipNetSlice default_value: '[]' description: Allocate container ip from a sub-range deprecated: false diff --git a/data/engine-cli/docker_plugin_install.yaml b/data/engine-cli/docker_plugin_install.yaml index e558715cd4ef..95ab5360cbf9 100644 --- a/data/engine-cli/docker_plugin_install.yaml +++ b/data/engine-cli/docker_plugin_install.yaml @@ -31,9 +31,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_plugin_push.yaml b/data/engine-cli/docker_plugin_push.yaml index dc2902ecdc0f..7c67d85d5e05 100644 --- a/data/engine-cli/docker_plugin_push.yaml +++ b/data/engine-cli/docker_plugin_push.yaml @@ -13,9 +13,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image signing - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_plugin_upgrade.yaml b/data/engine-cli/docker_plugin_upgrade.yaml index 31f3a7cdf769..42ba812357f5 100644 --- a/data/engine-cli/docker_plugin_upgrade.yaml +++ b/data/engine-cli/docker_plugin_upgrade.yaml @@ -12,9 +12,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_pull.yaml b/data/engine-cli/docker_pull.yaml index 8cd15e99e47e..ef853850fb93 100644 --- a/data/engine-cli/docker_pull.yaml +++ b/data/engine-cli/docker_pull.yaml @@ -20,9 +20,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_push.yaml b/data/engine-cli/docker_push.yaml index dcd3095f86c3..26e4ccbfe793 100644 --- a/data/engine-cli/docker_push.yaml +++ b/data/engine-cli/docker_push.yaml @@ -20,9 +20,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image signing - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_run.yaml b/data/engine-cli/docker_run.yaml index 9bced5ac57d2..b2f27bca7365 100644 --- a/data/engine-cli/docker_run.yaml +++ b/data/engine-cli/docker_run.yaml @@ -293,9 +293,9 @@ options: - option: disable-content-trust value_type: bool default_value: "true" - description: Skip image verification - deprecated: false - hidden: false + description: Skip image verification (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -530,7 +530,8 @@ options: swarm: false os_type: windows - option: ip - value_type: string + value_type: ip + default_value: description: IPv4 address (e.g., 172.30.100.104) deprecated: false hidden: false @@ -539,7 +540,8 @@ options: kubernetes: false swarm: false - option: ip6 - value_type: string + value_type: ip + default_value: description: IPv6 address (e.g., 2001:db8::33) deprecated: false hidden: false @@ -568,9 +570,9 @@ options: - option: kernel-memory value_type: bytes default_value: "0" - description: Kernel memory limit - deprecated: false - hidden: false + description: Kernel memory limit (deprecated) + deprecated: true + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/data/engine-cli/docker_save.yaml b/data/engine-cli/docker_save.yaml index f8876441f3e1..a983497a8007 100644 --- a/data/engine-cli/docker_save.yaml +++ b/data/engine-cli/docker_save.yaml @@ -17,9 +17,10 @@ options: kubernetes: false swarm: false - option: platform - value_type: string + value_type: stringSlice + default_value: '[]' description: | - Save only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`) + Save only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`) deprecated: false hidden: false min_api_version: "1.48" diff --git a/data/engine-cli/docker_service_create.yaml b/data/engine-cli/docker_service_create.yaml index 4a88cdc0f118..4857a66f479b 100644 --- a/data/engine-cli/docker_service_create.yaml +++ b/data/engine-cli/docker_service_create.yaml @@ -348,6 +348,28 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: memory-swap + value_type: bytes + default_value: "0" + description: Swap Bytes (-1 for unlimited) + deprecated: false + hidden: false + min_api_version: "1.52" + experimental: false + experimentalcli: false + kubernetes: false + swarm: false + - option: memory-swappiness + value_type: int64 + default_value: "-1" + description: Tune memory swappiness (0-100), -1 to reset to default + deprecated: false + hidden: false + min_api_version: "1.52" + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mode value_type: string default_value: replicated @@ -1143,20 +1165,6 @@ examples: |- When the option is not specified, the default behavior correponds to setting enabled. - - bind-nonrecursive - - bind-nonrecursive is deprecated since Docker Engine v25.0. - Use bind-recursiveinstead.
-
- A value is optional:
-
-
    -
  • true or 1: Equivalent to bind-recursive=disabled.
    • -
  • false or 0: Equivalent to bind-recursive=enabled.
    • -
- - ##### Bind propagation diff --git a/data/engine-cli/docker_service_update.yaml b/data/engine-cli/docker_service_update.yaml index 72eabe4417c4..177ebd0f050c 100644 --- a/data/engine-cli/docker_service_update.yaml +++ b/data/engine-cli/docker_service_update.yaml @@ -239,6 +239,7 @@ options: description: Add a Generic resource deprecated: false hidden: false + min_api_version: "1.32" experimental: false experimentalcli: false kubernetes: false @@ -248,6 +249,7 @@ options: description: Remove a Generic resource deprecated: false hidden: false + min_api_version: "1.32" experimental: false experimentalcli: false kubernetes: false @@ -340,7 +342,7 @@ options: description: Add a custom host-to-IP mapping (`host:ip`) deprecated: false hidden: false - min_api_version: "1.32" + min_api_version: "1.25" experimental: false experimentalcli: false kubernetes: false @@ -474,6 +476,28 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: memory-swap + value_type: bytes + default_value: "0" + description: Swap Bytes (-1 for unlimited) + deprecated: false + hidden: false + min_api_version: "1.52" + experimental: false + experimentalcli: false + kubernetes: false + swarm: false + - option: memory-swappiness + value_type: int64 + default_value: "-1" + description: Tune memory swappiness (0-100), -1 to reset to default + deprecated: false + hidden: false + min_api_version: "1.52" + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: mount-add value_type: mount description: Add or update a mount on a service diff --git a/data/engine-cli/docker_system_prune.yaml b/data/engine-cli/docker_system_prune.yaml index 1ae98cdc2e68..06776c5b9500 100644 --- a/data/engine-cli/docker_system_prune.yaml +++ b/data/engine-cli/docker_system_prune.yaml @@ -112,7 +112,8 @@ examples: |- my-network-b Deleted Volumes: - named-vol + 1e31bcd425e913d9f65ec0c3841e9c4ebb543aead2a1cfe0d95a7c5e88bb5026 + 6a6ab3d6b8d740a1c1d4dbe36a9c5f043dd4bac5f78abfa7d1f2ae5789fe60b0 Deleted Images: untagged: my-curl:latest diff --git a/data/engine-cli/docker_version.yaml b/data/engine-cli/docker_version.yaml index 88e35e84ee83..beff37ceb1f5 100644 --- a/data/engine-cli/docker_version.yaml +++ b/data/engine-cli/docker_version.yaml @@ -25,29 +25,29 @@ long: |- $ docker version Client: Docker Engine - Community - Version: 23.0.3 - API version: 1.42 - Go version: go1.19.7 - Git commit: 3e7cbfd - Built: Tue Apr 4 22:05:41 2023 - OS/Arch: darwin/amd64 - Context: default + Version: 28.5.1 + API version: 1.51 + Go version: go1.24.8 + Git commit: e180ab8 + Built: Wed Oct 8 12:16:17 2025 + OS/Arch: darwin/arm64 + Context: remote-test-server Server: Docker Desktop 4.19.0 (12345) Engine: - Version: 23.0.3 - API version: 1.42 (minimum version 1.12) - Go version: go1.19.7 - Git commit: 59118bf - Built: Tue Apr 4 22:05:41 2023 + Version: 27.5.1 + API version: 1.47 (minimum version 1.24) + Go version: go1.22.11 + Git commit: 4c9b3b0 + Built: Wed Jan 22 13:41:24 2025 OS/Arch: linux/amd64 - Experimental: false + Experimental: true containerd: - Version: 1.6.20 - GitCommit: 2806fc1057397dbaeefbea0e4e17bddfbd388f38 + Version: v1.7.25 + GitCommit: bcc810d6b9066471b0b6fa75f557a15a1cbf31bb runc: - Version: 1.1.5 - GitCommit: v1.1.5-0-gf19387a + Version: 1.2.4 + GitCommit: v1.2.4-0-g6c52b3f docker-init: Version: 0.19.0 GitCommit: de40ad0 @@ -70,31 +70,32 @@ long: |- $ docker version Client: Docker Engine - Community - Version: 23.0.3 - API version: 1.40 (downgraded from 1.42) - Go version: go1.19.7 - Git commit: 3e7cbfd - Built: Tue Apr 4 22:05:41 2023 - OS/Arch: darwin/amd64 + Version: 28.5.1 + API version: 1.51 + Go version: go1.24.8 + Git commit: e180ab8 + Built: Wed Oct 8 12:16:17 2025 + OS/Arch: darwin/arm64 Context: remote-test-server Server: Docker Engine - Community Engine: - Version: 19.03.8 - API version: 1.40 (minimum version 1.12) - Go version: go1.12.17 - Git commit: afacb8b - Built: Wed Mar 11 01:29:16 2020 + Version: 27.5.1 + API version: 1.47 (minimum version 1.24) + Go version: go1.22.11 + Git commit: 4c9b3b0 + Built: Wed Jan 22 13:41:24 2025 OS/Arch: linux/amd64 + Experimental: true containerd: - Version: v1.2.13 - GitCommit: 7ad184331fa3e55e52b890ea95e65ba581ae3429 + Version: v1.7.25 + GitCommit: bcc810d6b9066471b0b6fa75f557a15a1cbf31bb runc: - Version: 1.0.0-rc10 - GitCommit: dc9208a3303feef5b3839f4323d9beb36df0a9dd + Version: 1.2.4 + GitCommit: v1.2.4-0-g6c52b3f docker-init: - Version: 0.18.0 - GitCommit: fec3683 + Version: 0.19.0 + GitCommit: de40ad0 ``` ### API version and version negotiation @@ -104,14 +105,14 @@ long: |- and Docker Engine perform API version negotiation, and select the highest API version that is supported by both the Docker CLI and the Docker Engine. - For example, if the CLI is connecting with Docker Engine version 19.03, it downgrades - to API version 1.40 (refer to the [API version matrix](/reference/api/engine/#api-version-matrix) + For example, if the CLI is connecting with Docker Engine version 27.5, it downgrades + to API version 1.47 (refer to the [API version matrix](/reference/api/engine/#api-version-matrix) to learn about the supported API versions for Docker Engine): ```console $ docker version --format '{{.Client.APIVersion}}' - 1.40 + 1.47 ``` Be aware that API version can also be overridden using the `DOCKER_API_VERSION` @@ -122,14 +123,14 @@ long: |- ```console $ env | grep DOCKER_API_VERSION - DOCKER_API_VERSION=1.39 + DOCKER_API_VERSION=1.50 $ docker version --format '{{.Client.APIVersion}}' - 1.39 + 1.50 $ unset DOCKER_API_VERSION $ docker version --format '{{.Client.APIVersion}}' - 1.42 + 1.51 ``` usage: docker version [OPTIONS] pname: docker @@ -174,7 +175,7 @@ examples: |- ```console $ docker version --format '{{.Server.Version}}' - 23.0.3 + 28.5.1 ``` ### Get the client API version @@ -184,7 +185,7 @@ examples: |- ```console $ docker version --format '{{.Client.APIVersion}}' - 1.42 + 1.51 ``` The version shown is the API version that is negotiated between the client @@ -196,7 +197,7 @@ examples: |- ```console $ docker version --format '{{json .}}' - {"Client":"Version":"23.0.3","ApiVersion":"1.42", ...} + {"Client":"Version":"28.5.1","ApiVersion":"1.51", ...} ``` deprecated: false hidden: false