mirror of
https://github.com/docker/docs.git
synced 2026-10-23 18:09:02 +03:00
site: use content adapters for cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
@@ -111,14 +111,17 @@ If this command doesn't result in any errors, you're good to go!
|
||||
|
||||
## Content not edited here
|
||||
|
||||
CLI reference documentation is maintained in upstream repositories. It's
|
||||
partially generated from code, and is only vendored here for publishing. To
|
||||
update the CLI reference docs, refer to the corresponding repository:
|
||||
CLI reference documentation is maintained in upstream repositories and
|
||||
generated from YAML data files in `data/cli/`. A Hugo content adapter
|
||||
(`content/reference/cli/_content.gotmpl`) turns these data files into pages
|
||||
automatically. To update the CLI reference docs, refer to the corresponding
|
||||
repository:
|
||||
|
||||
- [docker/cli](https://github.com/docker/cli)
|
||||
- [docker/buildx](https://github.com/docker/buildx)
|
||||
- [docker/compose](https://github.com/docker/compose)
|
||||
- [docker/model-runner](https://github.com/docker/model-runner)
|
||||
- [docker/mcp-gateway](https://github.com/docker/mcp-gateway)
|
||||
|
||||
Feel free to raise an issue on this repository if you're not sure how to
|
||||
proceed, and we'll help out.
|
||||
|
||||
@@ -84,7 +84,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
|
||||
|
||||
### Search for and download an image
|
||||
|
||||
1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search.md) command:
|
||||
1. Open a terminal and search for images using the [`docker search`](/reference/cli/docker/search/) command:
|
||||
|
||||
```console
|
||||
docker search docker/welcome-to-docker
|
||||
@@ -99,7 +99,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
|
||||
|
||||
This output shows you information about relevant images available on Docker Hub.
|
||||
|
||||
2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull.md) command.
|
||||
2. Pull the image using the [`docker pull`](/reference/cli/docker/image/pull/) command.
|
||||
|
||||
```console
|
||||
docker pull docker/welcome-to-docker
|
||||
@@ -127,7 +127,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
|
||||
|
||||
### Learn about the image
|
||||
|
||||
1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls.md) command:
|
||||
1. List your downloaded images using the [`docker image ls`](/reference/cli/docker/image/ls/) command:
|
||||
|
||||
```console
|
||||
docker image ls
|
||||
@@ -146,7 +146,7 @@ Follow the instructions to search and pull a Docker image using CLI to view its
|
||||
>
|
||||
> The image size represented here reflects the uncompressed size of the image, not the download size of the layers.
|
||||
|
||||
2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history.md) command:
|
||||
2. List the image's layers using the [`docker image history`](/reference/cli/docker/image/history/) command:
|
||||
|
||||
```console
|
||||
docker image history docker/welcome-to-docker
|
||||
|
||||
@@ -283,7 +283,7 @@ the way you define and share multi-service applications.
|
||||
Related information:
|
||||
- [Compose overview](/manuals/compose/_index.md)
|
||||
- [Compose file reference](/reference/compose-file/_index.md)
|
||||
- [Compose CLI reference](/reference/cli/docker/compose/_index.md)
|
||||
- [Compose CLI reference](/reference/cli/docker/compose/)
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -538,7 +538,7 @@ $ docker compose down
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -107,7 +107,7 @@ Time: 1.529 s
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -210,7 +210,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -133,7 +133,7 @@ application using Docker.
|
||||
|
||||
Related information:
|
||||
|
||||
- [docker init CLI reference](../../../reference/cli/docker/init.md)
|
||||
- [docker init CLI reference](/reference/cli/docker/init/)
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -317,7 +317,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the
|
||||
[Compose CLI reference](/reference/cli/docker/compose/_index.md).
|
||||
[Compose CLI reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -829,7 +829,7 @@ $ docker compose down
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -118,7 +118,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
@@ -127,7 +127,7 @@ application using Docker.
|
||||
|
||||
Related information:
|
||||
|
||||
- [docker init reference](/reference/cli/docker/init.md)
|
||||
- [docker init reference](/reference/cli/docker/init/)
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -567,7 +567,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -83,7 +83,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -518,7 +518,7 @@ $ docker compose down
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ This command will:
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -371,7 +371,7 @@ $ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](/reference/cli/docker/compose/_index.md).
|
||||
reference](/reference/cli/docker/compose/).
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -344,8 +344,8 @@ Related information:
|
||||
|
||||
- [Dockerfile reference](/reference/dockerfile.md)
|
||||
- [.dockerignore file](/reference/dockerfile.md#dockerignore-file)
|
||||
- [docker init CLI reference](/reference/cli/docker/init.md)
|
||||
- [docker build CLI reference](/reference/cli/docker/buildx/build.md)
|
||||
- [docker init CLI reference](/reference/cli/docker/init/)
|
||||
- [docker build CLI reference](/reference/cli/docker/buildx/build/)
|
||||
- [Docker Hardened Images](/dhi/)
|
||||
|
||||
## Next steps
|
||||
|
||||
@@ -191,7 +191,7 @@ In this section, you took a look at running containers. You also took a look at
|
||||
|
||||
Related information:
|
||||
|
||||
- [docker run CLI reference](/reference/cli/docker/container/run.md)
|
||||
- [docker run CLI reference](/reference/cli/docker/container/run/)
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -540,7 +540,7 @@ $ docker compose down
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -108,7 +108,7 @@ Duration: 718ms
|
||||
|
||||
> [!NOTE]
|
||||
> For more information about Compose commands, see the [Compose CLI
|
||||
> reference](/reference/cli/docker/compose/_index.md).
|
||||
> reference](/reference/cli/docker/compose/).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -144,7 +144,7 @@ The traffic is encrypted and secrets are never stored in the build cache.
|
||||
>
|
||||
> If you're misusing build arguments to pass credentials, authentication
|
||||
> tokens, or other secrets, you should refactor your build to pass the secrets using
|
||||
> [secret mounts](/reference/cli/docker/buildx/build.md#secret) instead.
|
||||
> [secret mounts](/reference/cli/docker/buildx/build/#secret) instead.
|
||||
> Build arguments are stored in the cache and their values are exposed through attestations.
|
||||
> Secret mounts don't leak outside of the build and are never included in attestations.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ aliases:
|
||||
In addition to the main `context` key that defines the build context, each
|
||||
target can also define additional named contexts with a map defined with key
|
||||
`contexts`. These values map to the `--build-context` flag in the [build
|
||||
command](/reference/cli/docker/buildx/build.md#build-context).
|
||||
command](/reference/cli/docker/buildx/build/#build-context).
|
||||
|
||||
Inside the Dockerfile these contexts can be used with the `FROM` instruction or
|
||||
`--from` flag.
|
||||
|
||||
@@ -177,7 +177,7 @@ $ docker buildx bake -f docker-bake.hcl -f overrides.hcl --print
|
||||
## Command line
|
||||
|
||||
You can also override target configurations from the command line with the
|
||||
[`--set` flag](/reference/cli/docker/buildx/bake.md#set):
|
||||
[`--set` flag](/reference/cli/docker/buildx/bake/#set):
|
||||
|
||||
```hcl
|
||||
# docker-bake.hcl
|
||||
|
||||
@@ -134,14 +134,14 @@ $ docker buildx build \
|
||||
You can customize the network that the builder container uses. This is useful
|
||||
if you need to use a specific network for your builds.
|
||||
|
||||
For example, let's [create a network](/reference/cli/docker/network/create.md)
|
||||
For example, let's [create a network](/reference/cli/docker/network/create/)
|
||||
named `foonet`:
|
||||
|
||||
```console
|
||||
$ docker network create foonet
|
||||
```
|
||||
|
||||
Now create a [`docker-container` builder](/reference/cli/docker/buildx/create.md)
|
||||
Now create a [`docker-container` builder](/reference/cli/docker/buildx/create/)
|
||||
that will use this network:
|
||||
|
||||
```console
|
||||
@@ -151,13 +151,13 @@ $ docker buildx create --use \
|
||||
--driver-opt "network=foonet"
|
||||
```
|
||||
|
||||
Boot and [inspect `mybuilder`](/reference/cli/docker/buildx/inspect.md):
|
||||
Boot and [inspect `mybuilder`](/reference/cli/docker/buildx/inspect/):
|
||||
|
||||
```console
|
||||
$ docker buildx inspect --bootstrap
|
||||
```
|
||||
|
||||
[Inspect the builder container](/reference/cli/docker/inspect.md)
|
||||
[Inspect the builder container](/reference/cli/docker/inspect/)
|
||||
and see what network is being used:
|
||||
|
||||
```console
|
||||
@@ -168,4 +168,4 @@ map[foonet:0xc00018c0c0]
|
||||
## Further reading
|
||||
|
||||
For more information on the Docker container driver, see the
|
||||
[buildx reference](/reference/cli/docker/buildx/create.md#driver).
|
||||
[buildx reference](/reference/cli/docker/buildx/create/#driver).
|
||||
|
||||
@@ -37,4 +37,4 @@ If you need additional configuration and flexibility, consider using the
|
||||
## Further reading
|
||||
|
||||
For more information on the Docker driver, see the
|
||||
[buildx reference](/reference/cli/docker/buildx/create.md#driver).
|
||||
[buildx reference](/reference/cli/docker/buildx/create/#driver).
|
||||
|
||||
@@ -109,7 +109,7 @@ replicas. `sticky` (the default) attempts to connect the same build performed
|
||||
multiple times to the same node each time, ensuring better use of local cache.
|
||||
|
||||
For more information on scalability, see the options for
|
||||
[`docker buildx create`](/reference/cli/docker/buildx/create.md#driver-opt).
|
||||
[`docker buildx create`](/reference/cli/docker/buildx/create/#driver-opt).
|
||||
|
||||
## Node assignment
|
||||
|
||||
@@ -349,4 +349,4 @@ That's it: you've now built an image from a Kubernetes pod, using Buildx.
|
||||
## Further reading
|
||||
|
||||
For more information on the Kubernetes driver, see the
|
||||
[buildx reference](/reference/cli/docker/buildx/create.md#driver).
|
||||
[buildx reference](/reference/cli/docker/buildx/create/#driver).
|
||||
|
||||
@@ -16,7 +16,7 @@ that use other drivers, such as the
|
||||
which runs the BuildKit daemon in a container.
|
||||
|
||||
Use the
|
||||
[`docker buildx create`](/reference/cli/docker/buildx/create.md)
|
||||
[`docker buildx create`](/reference/cli/docker/buildx/create/)
|
||||
command to create a builder.
|
||||
|
||||
```console
|
||||
@@ -100,7 +100,7 @@ Total: 2.01GB
|
||||
## Remove a builder
|
||||
|
||||
Use the
|
||||
[`docker buildx remove`](/reference/cli/docker/buildx/create.md)
|
||||
[`docker buildx remove`](/reference/cli/docker/buildx/create/)
|
||||
command to remove a builder.
|
||||
|
||||
```console
|
||||
|
||||
@@ -631,7 +631,7 @@ as part of your build. `ADD` is better than manually adding files using
|
||||
something like `wget` and `tar`, because it ensures a more precise build cache.
|
||||
`ADD` also has built-in support for checksum validation of the remote
|
||||
resources, and a protocol for parsing branches, tags, and subdirectories from
|
||||
[Git URLs](/reference/cli/docker/buildx/build.md#git-repositories).
|
||||
[Git URLs](/reference/cli/docker/buildx/build/#git-repositories).
|
||||
|
||||
The following example uses `ADD` to download a .NET installer. Combined with
|
||||
multi-stage builds, only the .NET runtime remains in the final stage, no
|
||||
|
||||
@@ -145,7 +145,7 @@ Devices:
|
||||
Automatically allowed: false
|
||||
```
|
||||
|
||||
To allow the device, you can use the [`--allow` flag](/reference/cli/docker/buildx/build.md#allow)
|
||||
To allow the device, you can use the [`--allow` flag](/reference/cli/docker/buildx/build/#allow)
|
||||
with the `docker buildx build` command:
|
||||
|
||||
```console
|
||||
@@ -206,7 +206,7 @@ was injected into the build environment as specified in the CDI specification.
|
||||
In this section, we will show you how to set up a [container builder](../builders/drivers/docker-container.md)
|
||||
using NVIDIA GPUs. Since Buildx v0.22, when creating a new container builder, a
|
||||
GPU request is automatically added to the container builder if the host has GPU
|
||||
drivers installed in the kernel. This is similar to using [`--gpus=all` with the `docker run`](/reference/cli/docker/container/run.md#gpus)
|
||||
drivers installed in the kernel. This is similar to using [`--gpus=all` with the `docker run`](/reference/cli/docker/container/run/#gpus)
|
||||
command.
|
||||
|
||||
Now let's create a container builder named `gpubuilder` using Buildx:
|
||||
|
||||
@@ -37,7 +37,7 @@ First you need to pass the secret into the `docker build` command, and then you
|
||||
need to consume the secret in your Dockerfile.
|
||||
|
||||
To pass a secret to a build, use the [`docker build --secret`
|
||||
flag](/reference/cli/docker/buildx/build.md#secret), or the
|
||||
flag](/reference/cli/docker/buildx/build/#secret), or the
|
||||
equivalent options for [Bake](../bake/reference.md#targetsecret).
|
||||
|
||||
{{< tabs >}}
|
||||
@@ -84,8 +84,8 @@ builds, such as API tokens, passwords, or SSH keys.
|
||||
### Sources
|
||||
|
||||
The source of a secret can be either a
|
||||
[file](/reference/cli/docker/buildx/build.md#file) or an
|
||||
[environment variable](/reference/cli/docker/buildx/build.md#env).
|
||||
[file](/reference/cli/docker/buildx/build/#file) or an
|
||||
[environment variable](/reference/cli/docker/buildx/build/#env).
|
||||
When you use the CLI or Bake, the type can be detected automatically. You can
|
||||
also specify it explicitly with `type=file` or `type=env`.
|
||||
|
||||
@@ -159,7 +159,7 @@ ADD git@github.com:me/myprivaterepo.git /src/
|
||||
```
|
||||
|
||||
To pass an SSH socket the build, you use the [`docker build --ssh`
|
||||
flag](/reference/cli/docker/buildx/build.md#ssh), or equivalent
|
||||
flag](/reference/cli/docker/buildx/build/#ssh), or equivalent
|
||||
options for [Bake](../bake/reference.md#targetssh).
|
||||
|
||||
```console
|
||||
|
||||
@@ -119,7 +119,7 @@ $ docker build --build-arg NODE_VERSION=current .
|
||||
For more information on how to use build arguments, refer to:
|
||||
|
||||
- [`ARG` Dockerfile reference](/reference/dockerfile.md#arg)
|
||||
- [`docker build --build-arg` reference](/reference/cli/docker/buildx/build.md#build-arg)
|
||||
- [`docker build --build-arg` reference](/reference/cli/docker/buildx/build/#build-arg)
|
||||
|
||||
## `ENV` usage example
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ keywords: build, buildkit, configuration, buildx, network, cni, registry
|
||||
|
||||
If you create a `docker-container` or `kubernetes` builder with Buildx, you can
|
||||
apply a custom [BuildKit configuration](toml-configuration.md) by passing the
|
||||
[`--buildkitd-config` flag](/reference/cli/docker/buildx/create.md#buildkitd-config)
|
||||
[`--buildkitd-config` flag](/reference/cli/docker/buildx/create/#buildkitd-config)
|
||||
to the `docker buildx create` command.
|
||||
|
||||
## Registry mirror
|
||||
@@ -166,7 +166,7 @@ ADD https://raw.githubusercontent.com/moby/buildkit/${BUILDKIT_VERSION}/hack/fix
|
||||
```
|
||||
|
||||
Now you can build this image, and create a builder instance from it using
|
||||
[the `--driver-opt image` option](/reference/cli/docker/buildx/create.md#driver-opt):
|
||||
[the `--driver-opt image` option](/reference/cli/docker/buildx/create/#driver-opt):
|
||||
|
||||
```console
|
||||
$ docker buildx build --tag buildkit-cni:local --load .
|
||||
@@ -183,7 +183,7 @@ $ docker buildx create --use --bootstrap \
|
||||
|
||||
You can limit the parallelism of the BuildKit solver, which is particularly useful
|
||||
for low-powered machines, using a [BuildKit configuration](toml-configuration.md)
|
||||
while creating a builder with the [`--buildkitd-config` flag](/reference/cli/docker/buildx/create.md#buildkitd-config).
|
||||
while creating a builder with the [`--buildkitd-config` flag](/reference/cli/docker/buildx/create/#buildkitd-config).
|
||||
|
||||
```toml
|
||||
# /etc/buildkitd.toml
|
||||
|
||||
@@ -25,7 +25,7 @@ Other cache backends require you to select a different [driver](/manuals/build/b
|
||||
>
|
||||
> If you use secrets or credentials inside your build process, ensure you
|
||||
> manipulate them using the dedicated
|
||||
> [`--secret` option](/reference/cli/docker/buildx/build.md#secret).
|
||||
> [`--secret` option](/reference/cli/docker/buildx/build/#secret).
|
||||
> Manually managing secrets using `COPY` or `ARG` could result in leaked
|
||||
> credentials.
|
||||
|
||||
@@ -56,9 +56,9 @@ Buildx supports the following cache storage backends:
|
||||
## Command syntax
|
||||
|
||||
To use any of the cache backends, you first need to specify it on build with the
|
||||
[`--cache-to` option](/reference/cli/docker/buildx/build.md#cache-to)
|
||||
[`--cache-to` option](/reference/cli/docker/buildx/build/#cache-to)
|
||||
to export the cache to your storage backend of choice. Then, use the
|
||||
[`--cache-from` option](/reference/cli/docker/buildx/build.md#cache-from)
|
||||
[`--cache-from` option](/reference/cli/docker/buildx/build/#cache-from)
|
||||
to import the cache from the storage backend into the current build. Unlike the
|
||||
local BuildKit cache (which is always enabled), all of the cache storage
|
||||
backends must be explicitly exported to, and explicitly imported from.
|
||||
|
||||
@@ -6,8 +6,8 @@ aliases:
|
||||
- /build/building/cache/garbage-collection/
|
||||
---
|
||||
|
||||
While [`docker builder prune`](/reference/cli/docker/builder/prune.md)
|
||||
or [`docker buildx prune`](/reference/cli/docker/buildx/prune.md)
|
||||
While [`docker builder prune`](/reference/cli/docker/builder/prune/)
|
||||
or [`docker buildx prune`](/reference/cli/docker/buildx/prune/)
|
||||
commands run at once, Garbage Collection (GC) runs periodically and follows an
|
||||
ordered list of prune policies. The BuildKit daemon clears the build cache when
|
||||
the cache size becomes too big, or when the cache age expires.
|
||||
|
||||
2
content/manuals/build/cache/invalidation.md
vendored
2
content/manuals/build/cache/invalidation.md
vendored
@@ -77,7 +77,7 @@ To force a re-execution of the `RUN` instruction, you can:
|
||||
|
||||
- Make sure that a layer before it has changed
|
||||
- Clear the build cache ahead of the build using
|
||||
[`docker builder prune`](/reference/cli/docker/builder/prune.md)
|
||||
[`docker builder prune`](/reference/cli/docker/builder/prune/)
|
||||
- Use the `--no-cache` or `--no-cache-filter` options
|
||||
|
||||
The `--no-cache-filter` option lets you specify a specific build stage to
|
||||
|
||||
@@ -34,7 +34,7 @@ attestations to your image, with the following conditions:
|
||||
> arguments to pass secrets to your build, such as user credentials or
|
||||
> authentication tokens, those secrets are exposed in the provenance
|
||||
> attestation. Refactor your build to pass those secrets using
|
||||
> [secret mounts](/reference/cli/docker/buildx/build.md#secret)
|
||||
> [secret mounts](/reference/cli/docker/buildx/build/#secret)
|
||||
> instead. Also remember to rotate any secrets you may have exposed.
|
||||
|
||||
## Max-level provenance
|
||||
|
||||
@@ -140,11 +140,11 @@ fields:
|
||||
|
||||
| Name | Type | Description |
|
||||
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | String | [Name of the node](/reference/cli/docker/buildx/create.md#node). If empty, it's the name of the builder it belongs to, with an index number suffix. This is useful to set it if you want to modify/remove a node in an underlying step of you workflow. |
|
||||
| `endpoint` | String | [Docker context or endpoint](/reference/cli/docker/buildx/create.md#description) of the node to add to the builder |
|
||||
| `driver-opts` | List | List of additional [driver-specific options](/reference/cli/docker/buildx/create.md#driver-opt) |
|
||||
| `buildkitd-flags` | String | [Flags for buildkitd](/reference/cli/docker/buildx/create.md#buildkitd-flags) daemon |
|
||||
| `platforms` | String | Fixed [platforms](/reference/cli/docker/buildx/create.md#platform) for the node. If not empty, values take priority over the detected ones. |
|
||||
| `name` | String | [Name of the node](/reference/cli/docker/buildx/create/#node). If empty, it's the name of the builder it belongs to, with an index number suffix. This is useful to set it if you want to modify/remove a node in an underlying step of you workflow. |
|
||||
| `endpoint` | String | [Docker context or endpoint](/reference/cli/docker/buildx/create/#description) of the node to add to the builder |
|
||||
| `driver-opts` | List | List of additional [driver-specific options](/reference/cli/docker/buildx/create/#driver-opt) |
|
||||
| `buildkitd-flags` | String | [Flags for buildkitd](/reference/cli/docker/buildx/create/#buildkitd-flags) daemon |
|
||||
| `platforms` | String | Fixed [platforms](/reference/cli/docker/buildx/create/#platform) for the node. If not empty, values take priority over the detected ones. |
|
||||
|
||||
Here is an example using remote nodes with the [`remote` driver](/manuals/build/builders/drivers/remote.md)
|
||||
and [TLS authentication](#tls-authentication):
|
||||
|
||||
@@ -6,7 +6,7 @@ keywords: ci, github actions, gha, buildkit, buildx, registry
|
||||
---
|
||||
|
||||
[Multi-platform images](../../building/multi-platform.md) built using Buildx can
|
||||
be copied from one registry to another using the [`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create.md):
|
||||
be copied from one registry to another using the [`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create/):
|
||||
|
||||
```yaml
|
||||
name: ci
|
||||
|
||||
@@ -107,7 +107,7 @@ runners using a matrix strategy, you can drastically reduce build durations and
|
||||
streamline your CI pipeline. These examples demonstrate how to allocate each
|
||||
platform build to a dedicated runner, including ARM-native runners where
|
||||
applicable, and create a unified manifest list using the
|
||||
[`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create.md).
|
||||
[`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create/).
|
||||
|
||||
The following workflow will build the image for each platform on a dedicated
|
||||
runner using a matrix strategy and push by digest. Then, the `merge` job will
|
||||
|
||||
@@ -5,7 +5,7 @@ description: Use additional contexts in multi-stage builds with GitHub Actions
|
||||
keywords: ci, github actions, gha, buildkit, buildx, context
|
||||
---
|
||||
|
||||
You can define [additional build contexts](/reference/cli/docker/buildx/build.md#build-context),
|
||||
You can define [additional build contexts](/reference/cli/docker/buildx/build/#build-context),
|
||||
and access them in your Dockerfile with `FROM name` or `--from=name`. When
|
||||
Dockerfile defines a stage with the same name it's overwritten.
|
||||
|
||||
|
||||
@@ -319,7 +319,7 @@ either SSH or token-based authentication.
|
||||
Buildx automatically detects and uses SSH credentials if the Git context you
|
||||
specify is an SSH or Git address. By default, this uses `$SSH_AUTH_SOCK`.
|
||||
You can configure the SSH credentials to use with the
|
||||
[`--ssh` flag](/reference/cli/docker/buildx/build.md#ssh).
|
||||
[`--ssh` flag](/reference/cli/docker/buildx/build/#ssh).
|
||||
|
||||
```console
|
||||
$ docker buildx build --ssh default git@github.com:user/private.git
|
||||
@@ -327,7 +327,7 @@ $ docker buildx build --ssh default git@github.com:user/private.git
|
||||
|
||||
If you want to use token-based authentication instead, you can pass the token
|
||||
using the
|
||||
[`--secret` flag](/reference/cli/docker/buildx/build.md#secret).
|
||||
[`--secret` flag](/reference/cli/docker/buildx/build/#secret).
|
||||
|
||||
```console
|
||||
$ GIT_AUTH_TOKEN=<token> docker buildx build \
|
||||
@@ -802,5 +802,5 @@ $ docker buildx bake app
|
||||
|
||||
For more information about working with named contexts, see:
|
||||
|
||||
- [`--build-context` CLI reference](/reference/cli/docker/buildx/build.md#build-context)
|
||||
- [`--build-context` CLI reference](/reference/cli/docker/buildx/build/#build-context)
|
||||
- [Using Bake with additional contexts](/manuals/build/bake/contexts.md)
|
||||
|
||||
@@ -43,7 +43,7 @@ Some projects may need distinct Dockerfiles for specific purposes. A common
|
||||
convention is to name these `<something>.Dockerfile`. You can specify the
|
||||
Dockerfile filename using the `--file` flag for the `docker build` command.
|
||||
Refer to the
|
||||
[`docker build` CLI reference](/reference/cli/docker/buildx/build.md#file)
|
||||
[`docker build` CLI reference](/reference/cli/docker/buildx/build/#file)
|
||||
to learn about the `--file` flag.
|
||||
|
||||
> [!NOTE]
|
||||
|
||||
@@ -29,7 +29,7 @@ $ docker buildx create --use \
|
||||
--driver-opt "env.JAEGER_TRACE=localhost:6831"
|
||||
```
|
||||
|
||||
Boot and [inspect `mybuilder`](/reference/cli/docker/buildx/inspect.md):
|
||||
Boot and [inspect `mybuilder`](/reference/cli/docker/buildx/inspect/):
|
||||
|
||||
```console
|
||||
$ docker buildx inspect --bootstrap
|
||||
|
||||
@@ -10,7 +10,7 @@ aliases:
|
||||
|
||||
Exporters save your build results to a specified output type. You specify the
|
||||
exporter to use with the
|
||||
[`--output` CLI option](/reference/cli/docker/buildx/build.md#output).
|
||||
[`--output` CLI option](/reference/cli/docker/buildx/build/#output).
|
||||
Buildx supports the following exporters:
|
||||
|
||||
- `image`: exports the build result to a container image.
|
||||
|
||||
@@ -70,7 +70,7 @@ For examples on how to add annotations to images built with GitHub Actions, see
|
||||
You can also add annotations to an image created using `docker buildx
|
||||
imagetools create`. This command only supports adding annotations to an index
|
||||
or manifest descriptors, see
|
||||
[CLI reference](/reference/cli/docker/buildx/imagetools/create.md#annotation).
|
||||
[CLI reference](/reference/cli/docker/buildx/imagetools/create/#annotation).
|
||||
|
||||
## Inspect annotations
|
||||
|
||||
@@ -204,9 +204,9 @@ Related articles:
|
||||
|
||||
Reference information:
|
||||
|
||||
- [`docker buildx build --annotation`](/reference/cli/docker/buildx/build.md#annotation)
|
||||
- [`docker buildx build --annotation`](/reference/cli/docker/buildx/build/#annotation)
|
||||
- [Bake file reference: `annotations`](/manuals/build/bake/reference.md#targetannotations)
|
||||
- [`docker buildx imagetools create --annotation`](/reference/cli/docker/buildx/imagetools/create.md#annotation)
|
||||
- [`docker buildx imagetools create --annotation`](/reference/cli/docker/buildx/imagetools/create/#annotation)
|
||||
|
||||
<!-- links -->
|
||||
|
||||
|
||||
@@ -167,7 +167,7 @@ sbom.spdx.json
|
||||
## Inspecting SBOMs
|
||||
|
||||
To explore created SBOMs exported through the `image` exporter, you can use
|
||||
[`imagetools inspect`](/reference/cli/docker/buildx/imagetools/inspect.md).
|
||||
[`imagetools inspect`](/reference/cli/docker/buildx/imagetools/inspect/).
|
||||
|
||||
Using the `--format` option, you can specify a template for the output. All
|
||||
SBOM-related data is available under the `.SBOM` attribute. For example, to get
|
||||
|
||||
@@ -146,11 +146,11 @@ detailed information for analysis.
|
||||
> [!WARNING]
|
||||
>
|
||||
> Note that `mode=max` exposes the values of
|
||||
> [build arguments](/reference/cli/docker/buildx/build.md#build-arg).
|
||||
> [build arguments](/reference/cli/docker/buildx/build/#build-arg).
|
||||
>
|
||||
> If you're misusing build arguments to pass credentials, authentication
|
||||
> tokens, or other secrets, you should refactor your build to pass the secrets using
|
||||
> [secret mounts](/reference/cli/docker/buildx/build.md#secret) instead.
|
||||
> [secret mounts](/reference/cli/docker/buildx/build/#secret) instead.
|
||||
> Secret mounts don't leak outside of the build and are never included in provenance attestations.
|
||||
|
||||
## Version
|
||||
@@ -173,7 +173,7 @@ difference between SLSA v0.2 and v1 provenance attestations, refer to
|
||||
## Inspecting Provenance
|
||||
|
||||
To explore created Provenance exported through the `image` exporter, you can
|
||||
use [`imagetools inspect`](/reference/cli/docker/buildx/imagetools/inspect.md).
|
||||
use [`imagetools inspect`](/reference/cli/docker/buildx/imagetools/inspect/).
|
||||
|
||||
Using the `--format` option, you can specify a template for the output. All
|
||||
provenance-related data is available under the `.Provenance` attribute. For
|
||||
|
||||
@@ -352,6 +352,6 @@ This is a simplified example, but it demonstrates the basic principle of `includ
|
||||
## Where to go next
|
||||
|
||||
- Try the [Sample apps with Compose](https://github.com/docker/awesome-compose)
|
||||
- [Explore the full list of Compose commands](/reference/cli/docker/compose.md)
|
||||
- [Explore the full list of Compose commands](/reference/cli/docker/compose/)
|
||||
- [Explore the Compose file reference](/reference/compose-file/_index.md)
|
||||
- [Check out the Learning Docker Compose video on LinkedIn Learning](https://www.linkedin.com/learning/learning-docker-compose/)
|
||||
|
||||
@@ -165,5 +165,5 @@ Bake can also be selected as the default builder by editing your `$HOME/.docker/
|
||||
|
||||
## Additional resources
|
||||
|
||||
- [Docker Compose build reference](/reference/cli/docker/compose/build.md)
|
||||
- [Docker Compose build reference](/reference/cli/docker/compose/build/)
|
||||
- [Learn about multi-stage Dockerfiles](/manuals/build/building/multi-stage.md)
|
||||
|
||||
@@ -66,7 +66,7 @@ underscores, and must begin with a lowercase letter or decimal digit. If the
|
||||
`basename` of the project directory or current directory violates this
|
||||
constraint, you must use one of the other mechanisms.
|
||||
|
||||
See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-p` to specify a project name](/reference/cli/docker/compose/_index.md#use--p-to-specify-a-project-name).
|
||||
See also the [command-line options overview](/reference/cli/docker/compose/#command-options-overview-and-help) and [using `-p` to specify a project name](/reference/cli/docker/compose/#use--p-to-specify-a-project-name).
|
||||
|
||||
#### COMPOSE\_FILE
|
||||
|
||||
@@ -83,7 +83,7 @@ Specifies the path to a Compose file. Specifying multiple Compose files is suppo
|
||||
```
|
||||
The path separator can also be customized using [`COMPOSE_PATH_SEPARATOR`](#compose_path_separator).
|
||||
|
||||
See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](/reference/cli/docker/compose/_index.md#use--f-to-specify-the-name-and-path-of-one-or-more-compose-files).
|
||||
See also the [command-line options overview](/reference/cli/docker/compose/#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](/reference/cli/docker/compose/#use--f-to-specify-the-name-and-path-of-one-or-more-compose-files).
|
||||
|
||||
#### COMPOSE\_PROFILES
|
||||
|
||||
@@ -102,7 +102,7 @@ The following example enables all services matching both the `frontend` and `deb
|
||||
COMPOSE_PROFILES=frontend,debug
|
||||
```
|
||||
|
||||
See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](/reference/cli/docker/compose/_index.md#use-profiles-to-enable-optional-services).
|
||||
See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](/reference/cli/docker/compose/#use-profiles-to-enable-optional-services).
|
||||
|
||||
#### COMPOSE\_PATH\_SEPARATOR
|
||||
|
||||
@@ -203,7 +203,7 @@ Default is `auto`.
|
||||
|
||||
{{< summary-bar feature_name="Compose menu" >}}
|
||||
|
||||
When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md).
|
||||
When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug/).
|
||||
|
||||
- Supported values:
|
||||
- `true` or `1`, to enable
|
||||
|
||||
@@ -28,7 +28,7 @@ services:
|
||||
```
|
||||
|
||||
When you run `docker compose up`, the `web` service defined in the Compose file [interpolates](variable-interpolation.md) in the image `webapp:v1.5` which was set in the `.env` file. You can verify this with the
|
||||
[config command](/reference/cli/docker/compose/config.md), which prints your resolved application config to the terminal:
|
||||
[config command](/reference/cli/docker/compose/config/), which prints your resolved application config to the terminal:
|
||||
|
||||
```console
|
||||
$ docker compose config
|
||||
|
||||
@@ -246,7 +246,7 @@ For more merging rules, see [Merge and override](/reference/compose-file/merge.m
|
||||
|
||||
- You can use the `-f` flag to specify a path to a Compose file that is not located in the current directory, either from the command line or by setting up a [COMPOSE_FILE environment variable](../environment-variables/envvars.md#compose_file) in your shell or in an environment file.
|
||||
|
||||
For example, if you are running the [Compose Rails sample](https://github.com/docker/awesome-compose/tree/master/official-documentation-samples/rails/README.md), and have a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like [docker compose pull](/reference/cli/docker/compose/pull.md) to get the postgres image for the `db` service from anywhere by using the `-f` flag as follows: `docker compose -f ~/sandbox/rails/compose.yaml pull db`
|
||||
For example, if you are running the [Compose Rails sample](https://github.com/docker/awesome-compose/tree/master/official-documentation-samples/rails/README.md), and have a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like [docker compose pull](/reference/cli/docker/compose/pull/) to get the postgres image for the `db` service from anywhere by using the `-f` flag as follows: `docker compose -f ~/sandbox/rails/compose.yaml pull db`
|
||||
|
||||
Here's the full example:
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ aliases:
|
||||
---
|
||||
|
||||
By default Compose sets up a single
|
||||
[network](/reference/cli/docker/network/create.md) for your app. Each
|
||||
[network](/reference/cli/docker/network/create/) for your app. Each
|
||||
container for a service joins the default network and is both reachable by
|
||||
other containers on that network, and discoverable by the service's name.
|
||||
|
||||
@@ -17,7 +17,7 @@ other containers on that network, and discoverable by the service's name.
|
||||
>
|
||||
> Your app's network is given a name based on the "project name",
|
||||
> which is based on the name of the directory it lives in. You can override the
|
||||
> project name with either the [`--project-name` flag](/reference/cli/docker/compose.md)
|
||||
> project name with either the [`--project-name` flag](/reference/cli/docker/compose/)
|
||||
> or the [`COMPOSE_PROJECT_NAME` environment variable](environment-variables/envvars.md#compose_project_name).
|
||||
|
||||
For example, suppose your app is in a directory called `myapp`, and your `compose.yaml` looks like this:
|
||||
|
||||
@@ -146,5 +146,5 @@ $ docker compose publish -y username/my-compose-app:latest
|
||||
## Next steps
|
||||
|
||||
- [Learn about OCI artifacts in Docker Hub](/manuals/docker-hub/repos/manage/hub-images/oci-artifacts.md)
|
||||
- [Compose publish command](/reference/cli/docker/compose/publish.md)
|
||||
- [Compose publish command](/reference/cli/docker/compose/publish/)
|
||||
- [Understand `include`](/reference/compose-file/include.md)
|
||||
|
||||
@@ -50,7 +50,7 @@ Valid profiles names follow the regex format of `[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
|
||||
|
||||
## Start specific profiles
|
||||
|
||||
To start a specific profile supply the `--profile` [command-line option](/reference/cli/docker/compose.md) or
|
||||
To start a specific profile supply the `--profile` [command-line option](/reference/cli/docker/compose/) or
|
||||
use the [`COMPOSE_PROFILES` environment variable](environment-variables/envvars.md#compose_profiles):
|
||||
|
||||
```console
|
||||
@@ -130,7 +130,7 @@ If the targeted service has dependencies that are also gated behind a profile, y
|
||||
|
||||
## Stop application and services with specific profiles
|
||||
|
||||
As with starting specific profiles, you can use the `--profile` [command-line option](/reference/cli/docker/compose.md#use--p-to-specify-a-project-name) or
|
||||
As with starting specific profiles, you can use the `--profile` [command-line option](/reference/cli/docker/compose/#use--p-to-specify-a-project-name) or
|
||||
use the [`COMPOSE_PROFILES` environment variable](environment-variables/envvars.md#compose_profiles):
|
||||
|
||||
```console
|
||||
|
||||
@@ -14,7 +14,7 @@ This page offers examples of scenarios where custom project names can be helpful
|
||||
> [!NOTE]
|
||||
>
|
||||
> The default project directory is the base directory of the Compose file. A custom value can also be set
|
||||
> for it using the [`--project-directory` command line option](/reference/cli/docker/compose.md#options).
|
||||
> for it using the [`--project-directory` command line option](/reference/cli/docker/compose/#options).
|
||||
|
||||
## Example use cases
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ To list all the services along with their current status:
|
||||
$ docker compose ps
|
||||
```
|
||||
|
||||
For a full list of all the Compose CLI commands, see the [reference documentation](/reference/cli/docker/compose/_index.md).
|
||||
For a full list of all the Compose CLI commands, see the [reference documentation](/reference/cli/docker/compose/).
|
||||
|
||||
## Illustrative example
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ containers.
|
||||
### Why do my services take 10 seconds to recreate or stop?
|
||||
|
||||
The `docker compose stop` command attempts to stop a container by sending a `SIGTERM`. It then waits
|
||||
for a [default timeout of 10 seconds](/reference/cli/docker/compose/stop.md). After the timeout,
|
||||
for a [default timeout of 10 seconds](/reference/cli/docker/compose/stop/). After the timeout,
|
||||
a `SIGKILL` is sent to the container to forcefully kill it. If you
|
||||
are waiting for this timeout, it means that your containers aren't shutting down
|
||||
when they receive the `SIGTERM` signal.
|
||||
|
||||
@@ -39,4 +39,4 @@ docker desktop COMMAND [OPTIONS]
|
||||
| `kubernetes` | List Kubernetes images used by Docker Desktop or restart the cluster. Available with Docker Desktop version 4.44 and later. |
|
||||
| `diagnose`. | Diagnose Docker Desktop and upload the diagnostics. Available with Docker Desktop 4.60 and later. |
|
||||
|
||||
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
|
||||
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/).
|
||||
|
||||
@@ -73,7 +73,7 @@ $ docker run -d -P --name webserver nginx
|
||||
Alternatively, you can also use [host networking](/manuals/engine/network/drivers/host.md#docker-desktop)
|
||||
to give the container direct access to the network stack of the host.
|
||||
|
||||
See the [run command](/reference/cli/docker/container/run.md) for more details on
|
||||
See the [run command](/reference/cli/docker/container/run/) for more details on
|
||||
publish options used with `docker run`.
|
||||
|
||||
All inbound connections pass through the Docker Desktop backend process (`com.docker.backend` (Mac), `com.docker.backend` (Windows), or `qemu` (Linux), which handles port forwarding into the VM.
|
||||
|
||||
@@ -49,7 +49,7 @@ When the status indicator displays **Watching for filesystem changes**, your fil
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> When you create a new service, setting the [bind mount option consistency](/reference/cli/docker/service/create.md#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares.
|
||||
> When you create a new service, setting the [bind mount option consistency](/reference/cli/docker/service/create/#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
|
||||
@@ -446,7 +446,7 @@ For more frequently asked questions, see the [FAQs](/manuals/desktop/troubleshoo
|
||||
### New
|
||||
|
||||
- [cagent](/manuals/ai/cagent/_index.md) is now available through Docker Desktop.
|
||||
- [Docker Debug](/reference/cli/docker/debug.md) is now free for all users.
|
||||
- [Docker Debug](/reference/cli/docker/debug/) is now free for all users.
|
||||
|
||||
### Upgrades
|
||||
|
||||
@@ -1051,7 +1051,7 @@ We are aware of [CVE-2025-23266](https://nvd.nist.gov/vuln/detail/CVE-2025-23266
|
||||
### New
|
||||
|
||||
- The [Docker Desktop CLI](/manuals/desktop/features/desktop-cli.md) is now generally available. You can now also print logs with the new `docker desktop logs` command.
|
||||
- Docker Desktop now supports the `--platform` flag on [`docker load`](/reference/cli/docker/image/load.md) and [`docker save`](/reference/cli/docker/image/save.md). This helps you import and export a subset of multi-platform images.
|
||||
- Docker Desktop now supports the `--platform` flag on [`docker load`](/reference/cli/docker/image/load/) and [`docker save`](/reference/cli/docker/image/save/). This helps you import and export a subset of multi-platform images.
|
||||
|
||||
### Upgrades
|
||||
|
||||
@@ -1107,7 +1107,7 @@ We are aware of [CVE-2025-23266](https://nvd.nist.gov/vuln/detail/CVE-2025-23266
|
||||
- Installing Docker Desktop via the PKG installer is now generally available.
|
||||
- Enforcing sign-in via configuration profiles is now generally available.
|
||||
- Docker Compose, Docker Scout, the Docker CLI, and Ask Gordon can now be updated independently of Docker Desktop and without a full restart (Beta).
|
||||
- The new [`update` command](/reference/cli/docker/desktop/update.md) has been added to the Docker Desktop CLI (Mac only).
|
||||
- The new [`update` command](/reference/cli/docker/desktop/update/) has been added to the Docker Desktop CLI (Mac only).
|
||||
- [Bake](/manuals//build/bake/_index.md) is now generally available, with support for entitlements and composable attributes.
|
||||
- You can now create [multi-node Kubernetes clusters](/manuals/desktop/settings-and-maintenance/settings.md#kubernetes) in Docker Desktop.
|
||||
- [Ask Gordon](/manuals/ai/gordon/_index.md) is more widely available. It is still in Beta.
|
||||
@@ -1582,7 +1582,7 @@ We are aware of [CVE-2025-23266](https://nvd.nist.gov/vuln/detail/CVE-2025-23266
|
||||
|
||||
### New
|
||||
|
||||
- [Docker Debug](/reference/cli/docker/debug.md) is now generally available.
|
||||
- [Docker Debug](/reference/cli/docker/debug/) is now generally available.
|
||||
- BuildKit now evaluates Dockerfile rules to inform you of potential issues.
|
||||
- **Resource Allocation** settings can now be accessed directly from the resource usage data displayed in the Dashboard footer.
|
||||
- New and improved experience for [troubleshooting](/manuals/desktop/troubleshoot-and-support/troubleshoot/_index.md).
|
||||
@@ -2110,7 +2110,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
|
||||
- [Synchronized File Shares](/manuals/desktop/features/synchronized-file-sharing.md) provides fast and flexible host-to-VM file sharing within Docker Desktop. Utilizing the technology behind [Docker’s acquisition of Mutagen](https://www.docker.com/blog/mutagen-acquisition/), this feature provides an alternative to virtual bind mounts that uses synchronized filesystem caches, improving performance for developers working with large codebases.
|
||||
- Organization admins can now [configure Docker socket mount permissions](/manuals/enterprise/security/hardened-desktop/enhanced-container-isolation/config.md) when ECI is enabled.
|
||||
- [Containerd Image Store](/manuals/desktop/features/containerd.md) support is now generally available to all users.
|
||||
- Get a debug shell into any container or image with the new [`docker debug` command](/reference/cli/docker/debug.md) (Beta).
|
||||
- Get a debug shell into any container or image with the new [`docker debug` command](/reference/cli/docker/debug/) (Beta).
|
||||
- Organization admins, with a Docker Business subscription, can now configure a custom list of extensions with [Private Extensions Marketplace](/manuals/extensions/private-marketplace.md) enabled (Beta)
|
||||
|
||||
### Upgrades
|
||||
@@ -2129,7 +2129,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
|
||||
|
||||
#### For all platforms
|
||||
|
||||
- The `docker scan` command has been removed. To continue learning about the vulnerabilities of your images, and many other features, use the [`docker scout` command](/reference/cli/docker/scout/_index.md).
|
||||
- The `docker scan` command has been removed. To continue learning about the vulnerabilities of your images, and many other features, use the [`docker scout` command](/reference/cli/docker/scout/).
|
||||
- Fixed a bug where automatic updates would not download when the **Always download updates** checkbox was selected.
|
||||
- Fixed typo in the dashboard tooltip. Fixes [docker/for-mac#7132](https://github.com/docker/for-mac/issues/7132)
|
||||
- Improved signal handling behavior (e.g. when pressing Ctrl-C in the terminal while running a `docker` command).
|
||||
@@ -2487,7 +2487,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
|
||||
### New
|
||||
|
||||
- Added support for new Wasm runtimes: wws and lunatic.
|
||||
- [`docker init`](/reference/cli/docker/init.md) now supports ASP.NET
|
||||
- [`docker init`](/reference/cli/docker/init/) now supports ASP.NET
|
||||
- Increased performance of exposed ports on macOS, for example with `docker run -p`.
|
||||
|
||||
### Removed
|
||||
@@ -2738,7 +2738,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
|
||||
|
||||
### Removed
|
||||
|
||||
- Removed `docker scan` command. To continue learning about the vulnerabilities of your images, and many other features, use the new `docker scout` command. Run `docker scout --help`, or [read the docs to learn more](/reference/cli/docker/scout/_index.md).
|
||||
- Removed `docker scan` command. To continue learning about the vulnerabilities of your images, and many other features, use the new `docker scout` command. Run `docker scout --help`, or [read the docs to learn more](/reference/cli/docker/scout/).
|
||||
|
||||
### Upgrades
|
||||
|
||||
@@ -4035,7 +4035,7 @@ CVE-2021-44228](https://www.docker.com/blog/apache-log4j-2-cve-2021-44228/).
|
||||
|
||||
Docker Desktop Dashboard incorrectly displays the container memory usage as zero on
|
||||
Hyper-V based machines.
|
||||
You can use the [`docker stats`](/reference/cli/docker/container/stats.md)
|
||||
You can use the [`docker stats`](/reference/cli/docker/container/stats/)
|
||||
command on the command line as a workaround to view the
|
||||
actual memory usage. See
|
||||
[docker/for-mac#6076](https://github.com/docker/for-mac/issues/6076).
|
||||
|
||||
@@ -18,7 +18,7 @@ Use this procedure to back up and restore your images and container data. This i
|
||||
|
||||
### Save your data
|
||||
|
||||
1. Commit your containers to an image with [`docker container commit`](/reference/cli/docker/container/commit.md).
|
||||
1. Commit your containers to an image with [`docker container commit`](/reference/cli/docker/container/commit/).
|
||||
|
||||
Committing a container stores filesystem changes and some container configurations, such as labels and environment variables, as a local image. Be aware that environment variables may contain sensitive
|
||||
information such as passwords or proxy-authentication, so take care when pushing the resulting image to a registry.
|
||||
@@ -28,14 +28,14 @@ Use this procedure to back up and restore your images and container data. This i
|
||||
|
||||
If you used a [named volume](/manuals/engine/storage/_index.md#more-details-about-mount-types) to store container data, such as databases, refer to the [back up, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section.
|
||||
|
||||
2. Use [`docker push`](/reference/cli/docker/image/push.md) to push any
|
||||
2. Use [`docker push`](/reference/cli/docker/image/push/) to push any
|
||||
images you have built locally and want to keep to the [Docker Hub registry](/manuals/docker-hub/_index.md).
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> [Set the repository visibility to private](/manuals/docker-hub/repos/_index.md) if your image includes sensitive content.
|
||||
|
||||
Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](/reference/cli/docker/image/save.md)
|
||||
Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](/reference/cli/docker/image/save/)
|
||||
to save any images you want to keep to a local `.tar` file.
|
||||
|
||||
After backing up your data, you can uninstall the current version of Docker Desktop
|
||||
@@ -57,7 +57,7 @@ and [install a different version](/manuals/desktop/release-notes.md) or reset Do
|
||||
$ docker image load -i images.tar
|
||||
```
|
||||
|
||||
2. Re-create your containers if needed, using [`docker run`](/reference/cli/docker/container/run.md),
|
||||
2. Re-create your containers if needed, using [`docker run`](/reference/cli/docker/container/run/),
|
||||
or [Docker Compose](/manuals/compose/_index.md).
|
||||
|
||||
To restore volume data, refer to [backup, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes).
|
||||
|
||||
@@ -83,7 +83,7 @@ Example output:
|
||||
...
|
||||
```
|
||||
|
||||
For more detailed filtering and JSON output, see [Docker Scout CLI reference](../../../reference/cli/docker/scout/_index.md).
|
||||
For more detailed filtering and JSON output, see [Docker Scout CLI reference](/reference/cli/docker/scout/).
|
||||
|
||||
### Grype
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ maintain productivity while enhancing security.
|
||||
|
||||
| Concern | How Docker Hardened Images help |
|
||||
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Debuggability | Hardened images exclude shells and CLI tools by default. Use [Docker Debug](../../../reference/cli/docker/debug.md) to temporarily attach a debug sidecar for troubleshooting without modifying the original container. |
|
||||
| Debuggability | Hardened images exclude shells and CLI tools by default. Use [Docker Debug](/reference/cli/docker/debug/) to temporarily attach a debug sidecar for troubleshooting without modifying the original container. |
|
||||
| Familiarity | DHI supports multiple base images, including Alpine and Debian variants, so you can choose a familiar environment while still benefiting from hardening practices. |
|
||||
| Flexibility | Runtime immutability helps secure your containers. Use multi-stage builds and CI/CD to control changes, and optionally use dev-focused base images during development. |
|
||||
|
||||
|
||||
@@ -75,6 +75,6 @@ Because Docker Hardened Images strip out many common tools, they may not work ou
|
||||
|
||||
- Use multi-stage builds to compile code or install dependencies in a `-dev` image and copy the output into a hardened runtime image
|
||||
- Replace shell scripts with equivalent entrypoint binaries or explicitly include a shell if needed
|
||||
- Use [Docker Debug](../../../reference/cli/docker/debug.md) to temporarily inspect or troubleshoot containers without altering the base image
|
||||
- Use [Docker Debug](/reference/cli/docker/debug/) to temporarily inspect or troubleshoot containers without altering the base image
|
||||
|
||||
These trade-offs are intentional and help support best practices for building secure, reproducible, and production-ready containers.
|
||||
@@ -36,7 +36,7 @@ organizations can shift left and reduce both cost and complexity.
|
||||
Docker provides tools and secure content that make SSDLC practices easier to
|
||||
adopt across the container lifecycle. With [Docker Hardened
|
||||
Images](../_index.md) (DHIs), [Docker
|
||||
Debug](../../../reference/cli/docker/debug.md), and [Docker
|
||||
Debug](/reference/cli/docker/debug/), and [Docker
|
||||
Scout](../../../manuals/scout/_index.md), teams can add security without losing
|
||||
velocity.
|
||||
|
||||
@@ -61,7 +61,7 @@ Hardened Images support secure-by-default development:
|
||||
- Minimal runtime variants reduce attack surface in final images
|
||||
- Multi-stage builds let you separate build-time tools from runtime environments
|
||||
|
||||
[Docker Debug](../../../reference/cli/docker/debug.md) helps developers:
|
||||
[Docker Debug](/reference/cli/docker/debug/) helps developers:
|
||||
|
||||
- Temporarily inject debugging tools into minimal containers
|
||||
- Avoid modifying base images during troubleshooting
|
||||
|
||||
@@ -10,7 +10,7 @@ Docker Hardened Images (DHI) prioritize minimalism and security, which means
|
||||
they intentionally leave out many common debugging tools (like shells or package
|
||||
managers). This makes direct troubleshooting difficult without introducing risk.
|
||||
To address this, you can use [Docker
|
||||
Debug](../../../reference/cli/docker/debug.md), a secure workflow that
|
||||
Debug](/reference/cli/docker/debug/), a secure workflow that
|
||||
temporarily attaches an ephemeral debug container to a running service or image
|
||||
without modifying the original image.
|
||||
|
||||
|
||||
@@ -157,7 +157,7 @@ ECR, Google Artifact Registry, GitHub Container Registry, or a private Harbor
|
||||
instance.
|
||||
|
||||
You can use any standard workflow to mirror the image, such as the
|
||||
[Docker CLI](/reference/cli/docker/_index.md), [Docker Hub Registry
|
||||
[Docker CLI](/reference/cli/docker/), [Docker Hub Registry
|
||||
API](/reference/api/registry/latest/), third-party registry tools, or CI/CD
|
||||
automation.
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ Example output:
|
||||
...
|
||||
```
|
||||
|
||||
For more detailed filtering and JSON output, see [Docker Scout CLI reference](../../../reference/cli/docker/scout/_index.md).
|
||||
For more detailed filtering and JSON output, see [Docker Scout CLI reference](/reference/cli/docker/scout/).
|
||||
|
||||
### Automate DHI scanning in CI/CD with Docker Scout
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ You can run images from Docker Hub using the CLI or Docker Desktop Dashboard.
|
||||
The `docker run` command automatically pulls and runs the image without the
|
||||
need to run `docker pull` first. To learn more about the command and its
|
||||
options, see the [`docker run` CLI
|
||||
reference](../../reference/cli/docker/container/run.md). After running the
|
||||
reference](/reference/cli/docker/container/run/). After running the
|
||||
command, you should see output similar to the following.
|
||||
|
||||
```console {collapse=true}
|
||||
@@ -216,7 +216,7 @@ customize your own images to suit specific needs.
|
||||
This command builds your image and tags it so that Docker understands which
|
||||
repository to push it to in Docker Hub. To learn more about the command and
|
||||
its options, see the [`docker build` CLI
|
||||
reference](../../reference/cli/docker/buildx/build.md). After running the
|
||||
reference](/reference/cli/docker/buildx/build/). After running the
|
||||
command, you should see output similar to the following.
|
||||
|
||||
```console {collapse=true}
|
||||
@@ -262,7 +262,7 @@ customize your own images to suit specific needs.
|
||||
The command pushes the image to Docker Hub and automatically
|
||||
creates the repository if it doesn't exist. To learn more about the command,
|
||||
see the [`docker push` CLI
|
||||
reference](../../reference/cli/docker/image/push.md). After running the
|
||||
reference](/reference/cli/docker/image/push/). After running the
|
||||
command, you should see output similar to the following.
|
||||
|
||||
```console {collapse=true}
|
||||
|
||||
@@ -119,7 +119,7 @@ $ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME .
|
||||
> A `hooks/build` file overrides the basic `docker build` command used by the builder, so you must include a similar build command in the hook or
|
||||
the automated build fails.
|
||||
|
||||
Refer to the [docker build documentation](/reference/cli/docker/buildx/build.md#build-arg)
|
||||
Refer to the [docker build documentation](/reference/cli/docker/buildx/build/#build-arg)
|
||||
to learn more about Docker build-time variables.
|
||||
|
||||
#### Push to multiple repositories
|
||||
|
||||
@@ -82,15 +82,15 @@ the on-screen instructions to complete the sign-in process.
|
||||
|
||||
If you're using a standalone version of Docker Engine, run the `docker login`
|
||||
command from a terminal to authenticate with Docker Hub. For information on how
|
||||
to use the command, see [docker login](/reference/cli/docker/login.md).
|
||||
to use the command, see [docker login](/reference/cli/docker/login/).
|
||||
|
||||
#### Docker Swarm
|
||||
|
||||
If you're running Docker Swarm, you must use the `--with-registry-auth` flag to
|
||||
authenticate with Docker Hub. For more information, see [Create a
|
||||
service](/reference/cli/docker/service/create.md#with-registry-auth). If you
|
||||
service](/reference/cli/docker/service/create/#with-registry-auth). If you
|
||||
are using a Docker Compose file to deploy an application stack, see [docker
|
||||
stack deploy](/reference/cli/docker/stack/deploy.md).
|
||||
stack deploy](/reference/cli/docker/stack/deploy/).
|
||||
|
||||
#### GitHub Actions
|
||||
|
||||
|
||||
@@ -95,21 +95,21 @@ $ docker container prune --filter "label!=foo" --filter "label!=bar"
|
||||
For more information about filtering commands, refer to the CLI reference
|
||||
description for commands that support the `--filter` flag:
|
||||
|
||||
- [`docker config ls`](/reference/cli/docker/config/ls.md)
|
||||
- [`docker container prune`](/reference/cli/docker/container/prune.md)
|
||||
- [`docker image prune`](/reference/cli/docker/image/prune.md)
|
||||
- [`docker image ls`](/reference/cli/docker/image/ls.md)
|
||||
- [`docker network ls`](/reference/cli/docker/network/ls.md)
|
||||
- [`docker network prune`](/reference/cli/docker/network/prune.md)
|
||||
- [`docker node ls`](/reference/cli/docker/node/ls.md)
|
||||
- [`docker node ps`](/reference/cli/docker/node/ps.md)
|
||||
- [`docker plugin ls`](/reference/cli/docker/plugin/ls.md)
|
||||
- [`docker container ls`](/reference/cli/docker/container/ls.md)
|
||||
- [`docker search`](/reference/cli/docker/search.md)
|
||||
- [`docker secret ls`](/reference/cli/docker/secret/ls.md)
|
||||
- [`docker service ls`](/reference/cli/docker/service/ls.md)
|
||||
- [`docker service ps`](/reference/cli/docker/service/ps.md)
|
||||
- [`docker stack ps`](/reference/cli/docker/stack/ps.md)
|
||||
- [`docker system prune`](/reference/cli/docker/system/prune.md)
|
||||
- [`docker volume ls`](/reference/cli/docker/volume/ls.md)
|
||||
- [`docker volume prune`](/reference/cli/docker/volume/prune.md)
|
||||
- [`docker config ls`](/reference/cli/docker/config/ls/)
|
||||
- [`docker container prune`](/reference/cli/docker/container/prune/)
|
||||
- [`docker image prune`](/reference/cli/docker/image/prune/)
|
||||
- [`docker image ls`](/reference/cli/docker/image/ls/)
|
||||
- [`docker network ls`](/reference/cli/docker/network/ls/)
|
||||
- [`docker network prune`](/reference/cli/docker/network/prune/)
|
||||
- [`docker node ls`](/reference/cli/docker/node/ls/)
|
||||
- [`docker node ps`](/reference/cli/docker/node/ps/)
|
||||
- [`docker plugin ls`](/reference/cli/docker/plugin/ls/)
|
||||
- [`docker container ls`](/reference/cli/docker/container/ls/)
|
||||
- [`docker search`](/reference/cli/docker/search/)
|
||||
- [`docker secret ls`](/reference/cli/docker/secret/ls/)
|
||||
- [`docker service ls`](/reference/cli/docker/service/ls/)
|
||||
- [`docker service ps`](/reference/cli/docker/service/ps/)
|
||||
- [`docker stack ps`](/reference/cli/docker/stack/ps/)
|
||||
- [`docker system prune`](/reference/cli/docker/system/prune/)
|
||||
- [`docker volume ls`](/reference/cli/docker/volume/ls/)
|
||||
- [`docker volume prune`](/reference/cli/docker/volume/prune/)
|
||||
|
||||
@@ -16,7 +16,7 @@ on when you should set such limits and the possible implications of setting them
|
||||
|
||||
Many of these features require your kernel to support Linux capabilities. To
|
||||
check for support, you can use the
|
||||
[`docker info`](/reference/cli/docker/system/info.md) command. If a capability
|
||||
[`docker info`](/reference/cli/docker/system/info/) command. If a capability
|
||||
is disabled in your kernel, you may see a warning at the end of the output like
|
||||
the following:
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ redis1 0.07% 796 KB / 64 MB 1.21%
|
||||
redis2 0.07% 2.746 MB / 64 MB 4.29% 1.266 KB / 648 B 12.4 MB / 0 B
|
||||
```
|
||||
|
||||
The [`docker stats`](/reference/cli/docker/container/stats.md) reference
|
||||
The [`docker stats`](/reference/cli/docker/container/stats/) reference
|
||||
page has more details about the `docker stats` command.
|
||||
|
||||
## Control groups
|
||||
|
||||
@@ -10,7 +10,7 @@ aliases:
|
||||
- /config/containers/start-containers-automatically/
|
||||
---
|
||||
|
||||
Docker provides [restart policies](/reference/cli/docker/container/run.md#restart)
|
||||
Docker provides [restart policies](/reference/cli/docker/container/run/#restart)
|
||||
to control whether your containers start automatically when they exit, or when
|
||||
Docker restarts. Restart policies start linked containers in the correct order.
|
||||
Docker recommends that you use restart policies, and avoid using process
|
||||
@@ -22,7 +22,7 @@ a Docker upgrade, though networking and user input are interrupted.
|
||||
|
||||
## Use a restart policy
|
||||
|
||||
To configure the restart policy for a container, use the [`--restart`](/reference/cli/docker/container/run.md#restart) flag
|
||||
To configure the restart policy for a container, use the [`--restart`](/reference/cli/docker/container/run/#restart) flag
|
||||
when using the `docker run` command. The value of the `--restart` flag can be
|
||||
any of the following:
|
||||
|
||||
@@ -68,7 +68,7 @@ Keep the following in mind when using restart policies:
|
||||
|
||||
- Restart policies only apply to containers. To configure restart policies for
|
||||
Swarm services, see
|
||||
[flags related to service restart](/reference/cli/docker/service/create.md).
|
||||
[flags related to service restart](/reference/cli/docker/service/create/).
|
||||
|
||||
### Restarting foreground containers
|
||||
|
||||
|
||||
@@ -81,36 +81,36 @@ Labels on Swarm nodes and services can be updated dynamically.
|
||||
- Images and containers
|
||||
|
||||
- [Adding labels to images](/reference/dockerfile.md#label)
|
||||
- [Overriding a container's labels at runtime](/reference/cli/docker/container/run.md#label)
|
||||
- [Inspecting labels on images or containers](/reference/cli/docker/inspect.md)
|
||||
- [Filtering images by label](/reference/cli/docker/image/ls.md#filter)
|
||||
- [Filtering containers by label](/reference/cli/docker/container/ls.md#filter)
|
||||
- [Overriding a container's labels at runtime](/reference/cli/docker/container/run/#label)
|
||||
- [Inspecting labels on images or containers](/reference/cli/docker/inspect/)
|
||||
- [Filtering images by label](/reference/cli/docker/image/ls/#filter)
|
||||
- [Filtering containers by label](/reference/cli/docker/container/ls/#filter)
|
||||
|
||||
- Local Docker daemons
|
||||
|
||||
- [Adding labels to a Docker daemon at runtime](/reference/cli/dockerd.md)
|
||||
- [Inspecting a Docker daemon's labels](/reference/cli/docker/system/info.md)
|
||||
- [Inspecting a Docker daemon's labels](/reference/cli/docker/system/info/)
|
||||
|
||||
- Volumes
|
||||
|
||||
- [Adding labels to volumes](/reference/cli/docker/volume/create.md)
|
||||
- [Inspecting a volume's labels](/reference/cli/docker/volume/inspect.md)
|
||||
- [Filtering volumes by label](/reference/cli/docker/volume/ls.md#filter)
|
||||
- [Adding labels to volumes](/reference/cli/docker/volume/create/)
|
||||
- [Inspecting a volume's labels](/reference/cli/docker/volume/inspect/)
|
||||
- [Filtering volumes by label](/reference/cli/docker/volume/ls/#filter)
|
||||
|
||||
- Networks
|
||||
|
||||
- [Adding labels to a network](/reference/cli/docker/network/create.md)
|
||||
- [Inspecting a network's labels](/reference/cli/docker/network/inspect.md)
|
||||
- [Filtering networks by label](/reference/cli/docker/network/ls.md#filter)
|
||||
- [Adding labels to a network](/reference/cli/docker/network/create/)
|
||||
- [Inspecting a network's labels](/reference/cli/docker/network/inspect/)
|
||||
- [Filtering networks by label](/reference/cli/docker/network/ls/#filter)
|
||||
|
||||
- Swarm nodes
|
||||
|
||||
- [Adding or updating a Swarm node's labels](/reference/cli/docker/node/update.md#label-add)
|
||||
- [Inspecting a Swarm node's labels](/reference/cli/docker/node/inspect.md)
|
||||
- [Filtering Swarm nodes by label](/reference/cli/docker/node/ls.md#filter)
|
||||
- [Adding or updating a Swarm node's labels](/reference/cli/docker/node/update/#label-add)
|
||||
- [Inspecting a Swarm node's labels](/reference/cli/docker/node/inspect/)
|
||||
- [Filtering Swarm nodes by label](/reference/cli/docker/node/ls/#filter)
|
||||
|
||||
- Swarm services
|
||||
- [Adding labels when creating a Swarm service](/reference/cli/docker/service/create.md#label)
|
||||
- [Updating a Swarm service's labels](/reference/cli/docker/service/update.md)
|
||||
- [Inspecting a Swarm service's labels](/reference/cli/docker/service/inspect.md)
|
||||
- [Filtering Swarm services by label](/reference/cli/docker/service/ls.md#filter)
|
||||
- [Adding labels when creating a Swarm service](/reference/cli/docker/service/create/#label)
|
||||
- [Updating a Swarm service's labels](/reference/cli/docker/service/update/)
|
||||
- [Inspecting a Swarm service's labels](/reference/cli/docker/service/inspect/)
|
||||
- [Filtering Swarm services by label](/reference/cli/docker/service/ls/#filter)
|
||||
|
||||
@@ -52,7 +52,7 @@ $ docker image prune -a --filter "until=24h"
|
||||
```
|
||||
|
||||
Other filtering expressions are available. See the
|
||||
[`docker image prune` reference](/reference/cli/docker/image/prune.md)
|
||||
[`docker image prune` reference](/reference/cli/docker/image/prune/)
|
||||
for more examples.
|
||||
|
||||
## Prune containers
|
||||
@@ -83,7 +83,7 @@ $ docker container prune --filter "until=24h"
|
||||
```
|
||||
|
||||
Other filtering expressions are available. See the
|
||||
[`docker container prune` reference](/reference/cli/docker/container/prune.md)
|
||||
[`docker container prune` reference](/reference/cli/docker/container/prune/)
|
||||
for more examples.
|
||||
|
||||
## Prune volumes
|
||||
@@ -111,7 +111,7 @@ $ docker volume prune --filter "label!=keep"
|
||||
```
|
||||
|
||||
Other filtering expressions are available. See the
|
||||
[`docker volume prune` reference](/reference/cli/docker/volume/prune.md)
|
||||
[`docker volume prune` reference](/reference/cli/docker/volume/prune/)
|
||||
for more examples.
|
||||
|
||||
## Prune networks
|
||||
@@ -140,7 +140,7 @@ $ docker network prune --filter "until=24h"
|
||||
```
|
||||
|
||||
Other filtering expressions are available. See the
|
||||
[`docker network prune` reference](/reference/cli/docker/network/prune.md)
|
||||
[`docker network prune` reference](/reference/cli/docker/network/prune/)
|
||||
for more examples.
|
||||
|
||||
## Prune everything
|
||||
@@ -188,5 +188,5 @@ $ docker system prune --filter "until=24h"
|
||||
```
|
||||
|
||||
Other filtering expressions are available. See the
|
||||
[`docker system prune` reference](/reference/cli/docker/system/prune.md)
|
||||
[`docker system prune` reference](/reference/cli/docker/system/prune/)
|
||||
for more examples.
|
||||
|
||||
@@ -120,8 +120,8 @@ The default gateway is selected by Docker, and may change whenever a
|
||||
container's network connections change.
|
||||
To make Docker choose a specific default gateway when creating the container
|
||||
or connecting a new network, set a gateway priority. See option `gw-priority`
|
||||
for the [`docker run`](/reference/cli/docker/container/run.md) and
|
||||
[`docker network connect`](/reference/cli/docker/network/connect.md) commands.
|
||||
for the [`docker run`](/reference/cli/docker/container/run/) and
|
||||
[`docker network connect`](/reference/cli/docker/network/connect/) commands.
|
||||
|
||||
The default `gw-priority` is `0` and the gateway in the network with the
|
||||
highest priority is the default gateway. So, when a network should always
|
||||
@@ -284,7 +284,7 @@ Your container will have lines in `/etc/hosts` which define the hostname of the
|
||||
container itself, as well as `localhost` and a few other common things. Custom
|
||||
hosts, defined in `/etc/hosts` on the host machine, aren't inherited by
|
||||
containers. To pass additional hosts into a container, refer to [add entries to
|
||||
container hosts file](/reference/cli/docker/container/run.md#add-host) in the
|
||||
container hosts file](/reference/cli/docker/container/run/#add-host) in the
|
||||
`docker run` reference documentation.
|
||||
|
||||
## Container networks
|
||||
|
||||
@@ -178,7 +178,7 @@ $ docker network create my-net
|
||||
|
||||
You can specify the subnet, the IP address range, the gateway, and other
|
||||
options. See the
|
||||
[docker network create](/reference/cli/docker/network/create.md#specify-advanced-options)
|
||||
[docker network create](/reference/cli/docker/network/create/#specify-advanced-options)
|
||||
reference or the output of `docker network create --help` for details.
|
||||
|
||||
Use the `docker network rm` command to remove a user-defined bridge
|
||||
|
||||
@@ -48,8 +48,8 @@ participating in an overlay network:
|
||||
|
||||
| Ports | Description |
|
||||
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `2377/tcp` | The default Swarm control plane port, is configurable with [`docker swarm join --listen-addr`](/reference/cli/docker/swarm/join.md#--listen-addr-value) |
|
||||
| `4789/udp` | The default overlay traffic port, configurable with [`docker swarm init --data-path-addr`](/reference/cli/docker/swarm/init.md#data-path-port) |
|
||||
| `2377/tcp` | The default Swarm control plane port, is configurable with [`docker swarm join --listen-addr`](/reference/cli/docker/swarm/join/#--listen-addr-value) |
|
||||
| `4789/udp` | The default overlay traffic port, configurable with [`docker swarm init --data-path-addr`](/reference/cli/docker/swarm/init/#data-path-port) |
|
||||
| `7946/tcp`, `7946/udp` | Used for communication among nodes, not configurable |
|
||||
|
||||
To create an overlay network that containers on other Docker hosts can connect to,
|
||||
|
||||
@@ -130,12 +130,12 @@ roll back to a previous version of the service.
|
||||
* Learn Swarm mode [key concepts](key-concepts.md).
|
||||
* Get started with the [Swarm mode tutorial](swarm-tutorial/_index.md).
|
||||
* Explore Swarm mode CLI commands
|
||||
* [swarm init](/reference/cli/docker/swarm/init.md)
|
||||
* [swarm join](/reference/cli/docker/swarm/join.md)
|
||||
* [service create](/reference/cli/docker/service/create.md)
|
||||
* [service inspect](/reference/cli/docker/service/inspect.md)
|
||||
* [service ls](/reference/cli/docker/service/ls.md)
|
||||
* [service rm](/reference/cli/docker/service/rm.md)
|
||||
* [service scale](/reference/cli/docker/service/scale.md)
|
||||
* [service ps](/reference/cli/docker/service/ps.md)
|
||||
* [service update](/reference/cli/docker/service/update.md)
|
||||
* [swarm init](/reference/cli/docker/swarm/init/)
|
||||
* [swarm join](/reference/cli/docker/swarm/join/)
|
||||
* [service create](/reference/cli/docker/service/create/)
|
||||
* [service inspect](/reference/cli/docker/service/inspect/)
|
||||
* [service ls](/reference/cli/docker/service/ls/)
|
||||
* [service rm](/reference/cli/docker/service/rm/)
|
||||
* [service scale](/reference/cli/docker/service/scale/)
|
||||
* [service ps](/reference/cli/docker/service/ps/)
|
||||
* [service update](/reference/cli/docker/service/update/)
|
||||
|
||||
@@ -395,5 +395,5 @@ down to the original scale. You can use `docker service ps` to assess the curren
|
||||
balance of your service across nodes.
|
||||
|
||||
See also
|
||||
[`docker service scale`](/reference/cli/docker/service/scale.md) and
|
||||
[`docker service ps`](/reference/cli/docker/service/ps.md).
|
||||
[`docker service scale`](/reference/cli/docker/service/scale/) and
|
||||
[`docker service ps`](/reference/cli/docker/service/ps/).
|
||||
|
||||
@@ -113,10 +113,10 @@ those remaining after a `docker service update --config-rm`.
|
||||
Use these links to read about specific commands, or continue to the
|
||||
[example about using configs with a service](#advanced-example-use-configs-with-a-nginx-service).
|
||||
|
||||
- [`docker config create`](/reference/cli/docker/config/create.md)
|
||||
- [`docker config inspect`](/reference/cli/docker/config/inspect.md)
|
||||
- [`docker config ls`](/reference/cli/docker/config/ls.md)
|
||||
- [`docker config rm`](/reference/cli/docker/config/rm.md)
|
||||
- [`docker config create`](/reference/cli/docker/config/create/)
|
||||
- [`docker config inspect`](/reference/cli/docker/config/inspect/)
|
||||
- [`docker config ls`](/reference/cli/docker/config/ls/)
|
||||
- [`docker config rm`](/reference/cli/docker/config/rm/)
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -67,17 +67,17 @@ gracefully stops tasks on nodes in `Drain` mode and schedules the tasks on an
|
||||
`Active` node. The scheduler does not assign new tasks to nodes with `Drain`
|
||||
availability.
|
||||
|
||||
Refer to the [`docker node update`](/reference/cli/docker/node/update.md)
|
||||
Refer to the [`docker node update`](/reference/cli/docker/node/update/)
|
||||
command line reference to see how to change node availability.
|
||||
|
||||
## Change roles
|
||||
|
||||
You can promote a worker node to be a manager by running `docker node promote`.
|
||||
For example, you may want to promote a worker node when you
|
||||
take a manager node offline for maintenance. See [node promote](/reference/cli/docker/node/promote.md).
|
||||
take a manager node offline for maintenance. See [node promote](/reference/cli/docker/node/promote/).
|
||||
|
||||
You can also demote a manager node to a worker node. See
|
||||
[node demote](/reference/cli/docker/node/demote.md).
|
||||
[node demote](/reference/cli/docker/node/demote/).
|
||||
|
||||
|
||||
## Learn more
|
||||
|
||||
@@ -14,7 +14,7 @@ as a manager node. By default, the manager node generates a new root Certificate
|
||||
Authority (CA) along with a key pair, which are used to secure communications
|
||||
with other nodes that join the swarm. If you prefer, you can specify your own
|
||||
externally-generated root CA, using the `--external-ca` flag of the
|
||||
[docker swarm init](/reference/cli/docker/swarm/init.md) command.
|
||||
[docker swarm init](/reference/cli/docker/swarm/init/) command.
|
||||
|
||||
The manager node also generates two tokens to use when you join additional nodes
|
||||
to the swarm: one worker token and one manager token. Each token
|
||||
@@ -55,7 +55,7 @@ By default, each node in the swarm renews its certificate every three months.
|
||||
You can configure this interval by running the `docker swarm update
|
||||
--cert-expiry <TIME PERIOD>` command. The minimum rotation value is 1 hour.
|
||||
Refer to the
|
||||
[docker swarm update](/reference/cli/docker/swarm/update.md) CLI
|
||||
[docker swarm update](/reference/cli/docker/swarm/update/) CLI
|
||||
reference for details.
|
||||
|
||||
## Rotating the CA certificate
|
||||
|
||||
@@ -98,5 +98,5 @@ This node joined a swarm as a manager.
|
||||
|
||||
## Learn More
|
||||
|
||||
* `swarm join` [command line reference](/reference/cli/docker/swarm/join.md)
|
||||
* `swarm join` [command line reference](/reference/cli/docker/swarm/join/)
|
||||
* [Swarm mode tutorial](swarm-tutorial/_index.md)
|
||||
|
||||
@@ -148,7 +148,7 @@ decentralized manner. For instance, an engine could have a label to indicate
|
||||
that it has a certain type of disk device, which may not be relevant to security
|
||||
directly. These labels are more easily "trusted" by the swarm orchestrator.
|
||||
|
||||
Refer to the `docker service create` [CLI reference](/reference/cli/docker/service/create.md)
|
||||
Refer to the `docker service create` [CLI reference](/reference/cli/docker/service/create/)
|
||||
for more information about service constraints.
|
||||
|
||||
### Promote or demote a node
|
||||
|
||||
@@ -394,7 +394,7 @@ order to delete an existing bridge. The package name is `bridge-utils`.
|
||||
|
||||
4. Create or re-create the `docker_gwbridge` bridge with your custom settings.
|
||||
This example uses the subnet `10.11.0.0/16`. For a full list of customizable
|
||||
options, see [Bridge driver options](/reference/cli/docker/network/create.md#bridge-driver-options).
|
||||
options, see [Bridge driver options](/reference/cli/docker/network/create/#bridge-driver-options).
|
||||
|
||||
```console
|
||||
$ docker network create \
|
||||
|
||||
@@ -118,12 +118,12 @@ the mount point of the secret within a given container.
|
||||
Use these links to read about specific commands, or continue to the
|
||||
[example about using secrets with a service](secrets.md#simple-example-get-started-with-secrets).
|
||||
|
||||
- [`docker secret create`](/reference/cli/docker/secret/create.md)
|
||||
- [`docker secret inspect`](/reference/cli/docker/secret/inspect.md)
|
||||
- [`docker secret ls`](/reference/cli/docker/secret/ls.md)
|
||||
- [`docker secret rm`](/reference/cli/docker/secret/rm.md)
|
||||
- [`--secret`](/reference/cli/docker/service/create.md#secret) flag for `docker service create`
|
||||
- [`--secret-add` and `--secret-rm`](/reference/cli/docker/service/update.md#secret-add) flags for `docker service update`
|
||||
- [`docker secret create`](/reference/cli/docker/secret/create/)
|
||||
- [`docker secret inspect`](/reference/cli/docker/secret/inspect/)
|
||||
- [`docker secret ls`](/reference/cli/docker/secret/ls/)
|
||||
- [`docker secret rm`](/reference/cli/docker/secret/rm/)
|
||||
- [`--secret`](/reference/cli/docker/service/create/#secret) flag for `docker service create`
|
||||
- [`--secret-add` and `--secret-rm`](/reference/cli/docker/service/update/#secret-add) flags for `docker service update`
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -213,8 +213,8 @@ define a configuration at service creation, you can also update an existing
|
||||
service's configuration in a similar way.
|
||||
|
||||
See the command-line references for
|
||||
[`docker service create`](/reference/cli/docker/service/create.md) and
|
||||
[`docker service update`](/reference/cli/docker/service/update.md), or run
|
||||
[`docker service create`](/reference/cli/docker/service/create/) and
|
||||
[`docker service update`](/reference/cli/docker/service/update/), or run
|
||||
one of those commands with the `--help` flag.
|
||||
|
||||
### Configure the runtime environment
|
||||
@@ -670,7 +670,7 @@ Service constraints let you set criteria for a node to meet before the scheduler
|
||||
deploys a service to the node. You can apply constraints to the
|
||||
service based upon node attributes and metadata or engine metadata. For more
|
||||
information on constraints, refer to the `docker service create`
|
||||
[CLI reference](/reference/cli/docker/service/create.md).
|
||||
[CLI reference](/reference/cli/docker/service/create/).
|
||||
|
||||
#### Reserve memory or CPUs for a service
|
||||
|
||||
@@ -733,7 +733,7 @@ and CPU/memory constraints. Be careful not to use settings that are not
|
||||
possible to fulfill.
|
||||
|
||||
For more information on constraints, refer to the `docker service create`
|
||||
[CLI reference](/reference/cli/docker/service/create.md).
|
||||
[CLI reference](/reference/cli/docker/service/create/).
|
||||
|
||||
#### Placement preferences
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ and try the [Swarm mode tutorial](swarm-tutorial/_index.md).
|
||||
|
||||
When you run the command to create a swarm, Docker Engine starts running in Swarm mode.
|
||||
|
||||
Run [`docker swarm init`](/reference/cli/docker/swarm/init.md)
|
||||
Run [`docker swarm init`](/reference/cli/docker/swarm/init/)
|
||||
to create a single-node swarm on the current node. The engine sets up the swarm
|
||||
as follows:
|
||||
|
||||
@@ -107,7 +107,7 @@ all the subnets are exhausted.
|
||||
|
||||
Refer to the following pages for more information:
|
||||
- [Swarm networking](./networking.md) for more information about the default address pool usage
|
||||
- `docker swarm init` [CLI reference](/reference/cli/docker/swarm/init.md) for more detail on the `--default-addr-pool` flag.
|
||||
- `docker swarm init` [CLI reference](/reference/cli/docker/swarm/init/) for more detail on the `--default-addr-pool` flag.
|
||||
|
||||
### Configure the advertise address
|
||||
|
||||
@@ -133,7 +133,7 @@ you use for access from outside that region. In this case, specify the external
|
||||
address with `--advertise-addr` so that the node can propagate that information
|
||||
to other nodes that subsequently connect to it.
|
||||
|
||||
Refer to the `docker swarm init` [CLI reference](/reference/cli/docker/swarm/init.md)
|
||||
Refer to the `docker swarm init` [CLI reference](/reference/cli/docker/swarm/init/)
|
||||
for more detail on the advertise address.
|
||||
|
||||
### View the join command or update a swarm join token
|
||||
@@ -214,5 +214,5 @@ To add a worker to this swarm, run the following command:
|
||||
## Learn more
|
||||
|
||||
* [Join nodes to a swarm](join-nodes.md)
|
||||
* `swarm init` [command line reference](/reference/cli/docker/swarm/init.md)
|
||||
* `swarm init` [command line reference](/reference/cli/docker/swarm/init/)
|
||||
* [Swarm mode tutorial](swarm-tutorial/_index.md)
|
||||
|
||||
@@ -36,7 +36,7 @@ $ docker buildx build --push --platform=linux/amd64,linux/arm64 --tag=username/m
|
||||
```
|
||||
|
||||
You can then check the image manifest to see if the image is available for both
|
||||
architectures using the [`docker buildx imagetools` command](/reference/cli/docker/buildx/imagetools/_index.md):
|
||||
architectures using the [`docker buildx imagetools` command](/reference/cli/docker/buildx/imagetools/):
|
||||
|
||||
```console
|
||||
$ docker buildx imagetools inspect username/my-extension:0.0.1
|
||||
|
||||
@@ -183,8 +183,8 @@ $ docker scout cves --format only-packages --only-vuln-packages \
|
||||
For more information about these commands and how to use them, refer to the CLI
|
||||
reference documentation:
|
||||
|
||||
- [`docker scout quickview`](/reference/cli/docker/scout/quickview.md)
|
||||
- [`docker scout cves`](/reference/cli/docker/scout/cves.md)
|
||||
- [`docker scout quickview`](/reference/cli/docker/scout/quickview/)
|
||||
- [`docker scout cves`](/reference/cli/docker/scout/cves/)
|
||||
|
||||
## Vulnerability severity assessment
|
||||
|
||||
|
||||
@@ -176,6 +176,6 @@ $ docker scout sbom --format spdx -o sbom.spdx.json archive://scout-cli.tar
|
||||
|
||||
Read about the commands and supported flags in the CLI reference documentation:
|
||||
|
||||
- [`docker scout quickview`](/reference/cli/docker/scout/quickview.md)
|
||||
- [`docker scout cves`](/reference/cli/docker/scout/cves.md)
|
||||
- [`docker scout compare`](/reference/cli/docker/scout/compare.md)
|
||||
- [`docker scout quickview`](/reference/cli/docker/scout/quickview/)
|
||||
- [`docker scout cves`](/reference/cli/docker/scout/cves/)
|
||||
- [`docker scout compare`](/reference/cli/docker/scout/compare/)
|
||||
|
||||
@@ -57,7 +57,7 @@ $ docker scout sbom --format list alpine
|
||||
```
|
||||
|
||||
For more information about the `docker scout sbom` command, refer to the [CLI
|
||||
reference](/reference/cli/docker/scout/sbom.md).
|
||||
reference](/reference/cli/docker/scout/sbom/).
|
||||
|
||||
## Attach as build attestation {#attest}
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ comparing the image built from the code in the PR to the corresponding image in
|
||||
staging or production.
|
||||
|
||||
You can also compare with streams using the `--to-env` flag on the
|
||||
[`docker scout compare`](/reference/cli/docker/scout/compare.md)
|
||||
[`docker scout compare`](/reference/cli/docker/scout/compare/)
|
||||
CLI command:
|
||||
|
||||
```console
|
||||
|
||||
@@ -13,7 +13,7 @@ GitHub and as a container image on Docker Hub. Use the client to invoke the
|
||||
`docker scout environment` command to assign your images to environments.
|
||||
|
||||
For more information about how to use the `docker scout environment` command,
|
||||
refer to the [CLI reference](/reference/cli/docker/scout/environment.md).
|
||||
refer to the [CLI reference](/reference/cli/docker/scout/environment/).
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -111,4 +111,4 @@ $ docker scout policy \
|
||||
```
|
||||
|
||||
For more information about the command, refer to the [CLI
|
||||
reference](/reference/cli/docker/scout/policy.md).
|
||||
reference](/reference/cli/docker/scout/policy/).
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user