From 0168540b668279698470e9fb2c453afbc53574d4 Mon Sep 17 00:00:00 2001 From: Joseph Ferguson Date: Thu, 20 Nov 2025 16:22:41 -0800 Subject: [PATCH] Document `dind` and `cli` variants --- docker/variant-cli.md | 3 +++ docker/variant-dind.md | 3 +++ docker/variant.md | 8 ++++++++ 3 files changed, 14 insertions(+) create mode 100644 docker/variant-cli.md create mode 100644 docker/variant-dind.md create mode 100644 docker/variant.md diff --git a/docker/variant-cli.md b/docker/variant-cli.md new file mode 100644 index 000000000000..d9c7a73c8fa6 --- /dev/null +++ b/docker/variant-cli.md @@ -0,0 +1,3 @@ +## `%%IMAGE%%:-cli` + +This image contains the Docker client command line interface (CLI) and Docker CLI plugins like `buildx` and `compose`. This is useful if you need to interact with a remote Docker engine but aren't planning to run the Docker engine in the container. diff --git a/docker/variant-dind.md b/docker/variant-dind.md new file mode 100644 index 000000000000..fb089329ba8a --- /dev/null +++ b/docker/variant-dind.md @@ -0,0 +1,3 @@ +## `%%IMAGE%%:`, `%%IMAGE%%:-dind` + +The default variant is the Docker in Docker variant. It contains the Docker engine as well as the Docker CLI and plugins that are included in the `cli` variant. It is useful for running Docker in Docker and for interacting with a Docker engine via the Docker CLI. diff --git a/docker/variant.md b/docker/variant.md new file mode 100644 index 000000000000..cae730143d90 --- /dev/null +++ b/docker/variant.md @@ -0,0 +1,8 @@ +# Image Variants + +The `%%IMAGE%%` images come in many flavors, each designed for a specific use case. + +**Note:** The `%%IMAGE%%:stable`, `%%IMAGE%%:test`, and related "channel" tags have been deprecated since June 2020 (see [docker-library/docker#179](https://github.com/docker-library/docker/pull/179)) and have not been updated since December 2020 (when Docker 20.10 was released). Suggested alternatives are below. `X` is a placeholder for the version; see the supported tags list for the current set of tags. + +- `%%IMAGE%%:stable` ⏩ `%%IMAGE%%:latest`, `%%IMAGE%%:dind`, `%%IMAGE%%:X`, `%%IMAGE%%:cli`, etc +- `%%IMAGE%%:test` ⏩ `%%IMAGE%%:rc`, `%%IMAGE%%:rc-dind`, `%%IMAGE%%:X-rc`, `%%IMAGE%%:rc-cli`, etc (only updated when there is an active pre-release; will not point to the same thing as `latest`)