diff --git a/_vendor/github.com/docker/buildx/docs/bake-reference.md b/_vendor/github.com/docker/buildx/docs/bake-reference.md index afe87d4ba9f..ef3ee44640d 100644 --- a/_vendor/github.com/docker/buildx/docs/bake-reference.md +++ b/_vendor/github.com/docker/buildx/docs/bake-reference.md @@ -1069,20 +1069,20 @@ target "webapp-dev" { [attestations]: https://docs.docker.com/build/attestations/ [bake_stdlib]: https://github.com/docker/buildx/blob/master/bake/hclparser/stdlib.go -[build-arg]: https://docs.docker.com/engine/reference/commandline/image_build/#build-arg -[build-context]: https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context +[build-arg]: https://docs.docker.com/reference/cli/docker/image/build/#build-arg +[build-context]: https://docs.docker.com/reference/cli/docker/buildx/build/#build-context [cache-backends]: https://docs.docker.com/build/cache/backends/ -[cache-from]: https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-from -[cache-to]: https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-to -[context]: https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context -[file]: https://docs.docker.com/engine/reference/commandline/image_build/#file +[cache-from]: https://docs.docker.com/reference/cli/docker/buildx/build/#cache-from +[cache-to]: https://docs.docker.com/reference/cli/docker/buildx/build/#cache-to +[context]: https://docs.docker.com/reference/cli/docker/buildx/build/#build-context +[file]: https://docs.docker.com/reference/cli/docker/image/build/#file [go-cty]: https://github.com/zclconf/go-cty/tree/main/cty/function/stdlib [hcl-funcs]: https://docs.docker.com/build/bake/hcl-funcs/ -[output]: https://docs.docker.com/engine/reference/commandline/buildx_build/#output -[platform]: https://docs.docker.com/engine/reference/commandline/buildx_build/#platform -[run_mount_secret]: https://docs.docker.com/engine/reference/builder/#run---mounttypesecret -[secret]: https://docs.docker.com/engine/reference/commandline/buildx_build/#secret -[ssh]: https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh -[tag]: https://docs.docker.com/engine/reference/commandline/image_build/#tag -[target]: https://docs.docker.com/engine/reference/commandline/image_build/#target +[output]: https://docs.docker.com/reference/cli/docker/buildx/build/#output +[platform]: https://docs.docker.com/reference/cli/docker/buildx/build/#platform +[run_mount_secret]: https://docs.docker.com/reference/dockerfile/#run---mounttypesecret +[secret]: https://docs.docker.com/reference/cli/docker/buildx/build/#secret +[ssh]: https://docs.docker.com/reference/cli/docker/buildx/build/#ssh +[tag]: https://docs.docker.com/reference/cli/docker/image/build/#tag +[target]: https://docs.docker.com/reference/cli/docker/image/build/#target [userfunc]: https://github.com/hashicorp/hcl/tree/main/ext/userfunc diff --git a/_vendor/github.com/docker/cli/docs/extend/config.md b/_vendor/github.com/docker/cli/docs/extend/config.md index 1f96d3e0093..d2472a39f41 100644 --- a/_vendor/github.com/docker/cli/docs/extend/config.md +++ b/_vendor/github.com/docker/cli/docs/extend/config.md @@ -55,11 +55,11 @@ the registry. - `entrypoint` string array - Entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint) + Entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/reference/dockerfile/#entrypoint) - `workdir` string - Working directory of the plugin, see [`WORKDIR`](https://docs.docker.com/engine/reference/builder/#workdir) + Working directory of the plugin, see [`WORKDIR`](https://docs.docker.com/reference/dockerfile/#workdir) - `network` PluginNetwork diff --git a/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md b/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md index 0086761c192..830a7dce9c2 100644 --- a/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md +++ b/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md @@ -60,6 +60,7 @@ The sections below provide an overview of available third-party plugins. | [Infinit volume plugin](https://infinit.sh/documentation/docker/volume-plugin) | A volume plugin that makes it easy to mount and manage Infinit volumes using Docker. | | [IPFS Volume Plugin](https://github.com/vdemeester/docker-volume-ipfs) | An open source volume plugin that allows using an [ipfs](https://ipfs.io/) filesystem as a volume. | | [Keywhiz plugin](https://github.com/calavera/docker-volume-keywhiz) | A plugin that provides credentials and secret management using Keywhiz as a central repository. | +| [Linode Volume Plugin](https://github.com/linode/docker-volume-linode) | A plugin that adds the ability to manage Linode Block Storage as Docker Volumes from within a Linode. | | [Local Persist Plugin](https://github.com/CWSpear/local-persist) | A volume plugin that extends the default `local` driver's functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to *always persist*, even if the volume is removed via `docker volume rm`. | | [NetApp Plugin](https://github.com/NetApp/netappdvp) (nDVP) | A volume plugin that provides direct integration with the Docker ecosystem for the NetApp storage portfolio. The nDVP package supports the provisioning and management of storage resources from the storage platform to Docker hosts, with a robust framework for adding additional platforms in the future. | | [Netshare plugin](https://github.com/ContainX/docker-volume-netshare) | A volume plugin that provides volume management for NFS 3/4, AWS EFS and CIFS file systems. | diff --git a/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md b/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md index 8a646e50fa5..79201ec2367 100644 --- a/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md +++ b/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md @@ -104,7 +104,7 @@ Enable the authorization plugin with a dedicated command line flag in the `--authorization-plugin=PLUGIN_ID` format. The flag supplies a `PLUGIN_ID` value. This value can be the plugin’s socket or a path to a specification file. Authorization plugins can be loaded without restarting the daemon. Refer -to the [`dockerd` documentation](../reference/commandline/dockerd.md#configuration-reload-behavior) for more information. +to the [`dockerd` documentation](https://docs.docker.com/reference/cli/dockerd/#configuration-reload-behavior) for more information. ```console $ dockerd --authorization-plugin=plugin1 --authorization-plugin=plugin2,... diff --git a/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md b/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md index dbfe2a5e419..c6bd54337a9 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md +++ b/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md @@ -11,7 +11,7 @@ aliases: --- The base command for the Docker CLI is `docker`. For information about the -available flags and subcommands, refer to the [CLI reference](docker.md) +available flags and subcommands, refer to the [CLI reference](https://docs.docker.com/reference/cli/docker/) Depending on your Docker system configuration, you may be required to preface each `docker` command with `sudo`. To avoid having to use `sudo` with the @@ -26,20 +26,20 @@ the [installation](https://docs.docker.com/install/) instructions for your opera The following list of environment variables are supported by the `docker` command line: -| Variable | Description | -| :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DOCKER_API_VERSION` | Override the negotiated API version to use for debugging (e.g. `1.19`) | -| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the `docker` CLI and the [`dockerd` daemon](dockerd.md) | -| `DOCKER_CONFIG` | The location of your client configuration files. | -| `DOCKER_CONTENT_TRUST_SERVER` | The URL of the Notary server to use. Defaults to the same URL as the registry. | -| `DOCKER_CONTENT_TRUST` | When set Docker uses notary to sign and verify images. Equates to `--disable-content-trust=false` for build, create, pull, push, run. | -| `DOCKER_CONTEXT` | Name of the `docker context` to use (overrides `DOCKER_HOST` env var and default context set with `docker context use`) | -| `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. | -| `DOCKER_HIDE_LEGACY_COMMANDS` | When set, Docker hides "legacy" top-level commands (such as `docker rm`, and `docker pull`) in `docker help` output, and only `Management commands` per object-type (e.g., `docker container`) are printed. This may become the default in a future release. | -| `DOCKER_HOST` | Daemon socket to connect to. | -| `DOCKER_TLS` | Enable TLS for connections made by the `docker` CLI (equivalent of the `--tls` command-line option). Set to a non-empty value to enable TLS. Note that TLS is enabled automatically if any of the other TLS options are set. | -| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](dockerd.md) | -| `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`) when [building](image_build.md) with [BuildKit backend](https://docs.docker.com/build/buildkit/). Use plain to show container output (default `auto`). | +| Variable | Description | +| :---------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `DOCKER_API_VERSION` | Override the negotiated API version to use for debugging (e.g. `1.19`) | +| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the `docker` CLI and the [`dockerd` daemon](https://docs.docker.com/reference/cli/dockerd/) | +| `DOCKER_CONFIG` | The location of your client configuration files. | +| `DOCKER_CONTENT_TRUST_SERVER` | The URL of the Notary server to use. Defaults to the same URL as the registry. | +| `DOCKER_CONTENT_TRUST` | When set Docker uses notary to sign and verify images. Equates to `--disable-content-trust=false` for build, create, pull, push, run. | +| `DOCKER_CONTEXT` | Name of the `docker context` to use (overrides `DOCKER_HOST` env var and default context set with `docker context use`) | +| `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. | +| `DOCKER_HIDE_LEGACY_COMMANDS` | When set, Docker hides "legacy" top-level commands (such as `docker rm`, and `docker pull`) in `docker help` output, and only `Management commands` per object-type (e.g., `docker container`) are printed. This may become the default in a future release. | +| `DOCKER_HOST` | Daemon socket to connect to. | +| `DOCKER_TLS` | Enable TLS for connections made by the `docker` CLI (equivalent of the `--tls` command-line option). Set to a non-empty value to enable TLS. Note that TLS is enabled automatically if any of the other TLS options are set. | +| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](https://docs.docker.com/reference/cli/dockerd/) | +| `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`) when [building](https://docs.docker.com/reference/cli/docker/image/build/) with [BuildKit backend](https://docs.docker.com/build/buildkit/). Use plain to show container output (default `auto`). | Because Docker is developed using Go, you can also use any environment variables used by the Go runtime. In particular, you may find these useful: @@ -115,20 +115,20 @@ different location. These fields lets you customize the default output format for some commands if no `--format` flag is provided. -| Property | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `configFormat` | Custom default format for `docker config ls` output. See [`docker config ls`](config_ls.md#format) for a list of supported formatting directives. | -| `imagesFormat` | Custom default format for `docker images` / `docker image ls` output. See [`docker images`](image_ls.md#format) for a list of supported formatting directives. | -| `networksFormat` | Custom default format for `docker network ls` output. See [`docker network ls`](network_ls.md#format) for a list of supported formatting directives. | -| `nodesFormat` | Custom default format for `docker node ls` output. See [`docker node ls`](node_ls.md#format) for a list of supported formatting directives. | -| `pluginsFormat` | Custom default format for `docker plugin ls` output. See [`docker plugin ls`](plugin_ls.md#format) for a list of supported formatting directives. | -| `psFormat` | Custom default format for `docker ps` / `docker container ps` output. See [`docker ps`](container_ls.md#format) for a list of supported formatting directives. | -| `secretFormat` | Custom default format for `docker secret ls` output. See [`docker secret ls`](secret_ls.md#format) for a list of supported formatting directives. | -| `serviceInspectFormat` | Custom default format for `docker service inspect` output. See [`docker service inspect`](service_inspect.md#format) for a list of supported formatting directives. | -| `servicesFormat` | Custom default format for `docker service ls` output. See [`docker service ls`](service_ls.md#format) for a list of supported formatting directives. | -| `statsFormat` | Custom default format for `docker stats` output. See [`docker stats`](container_stats.md#format) for a list of supported formatting directives. | -| `tasksFormat` | Custom default format for `docker stack ps` output. See [`docker stack ps`](stack_ps.md#format) for a list of supported formatting directives. | -| `volumesFormat` | Custom default format for `docker volume ls` output. See [`docker volume ls`](volume_ls.md#format) for a list of supported formatting directives. | +| Property | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configFormat` | Custom default format for `docker config ls` output. See [`docker config ls`](https://docs.docker.com/reference/cli/docker/config/ls/#format) for a list of supported formatting directives. | +| `imagesFormat` | Custom default format for `docker images` / `docker image ls` output. See [`docker images`](https://docs.docker.com/reference/cli/docker/image/ls/#format) for a list of supported formatting directives. | +| `networksFormat` | Custom default format for `docker network ls` output. See [`docker network ls`](https://docs.docker.com/reference/cli/docker/network/ls/#format) for a list of supported formatting directives. | +| `nodesFormat` | Custom default format for `docker node ls` output. See [`docker node ls`](https://docs.docker.com/reference/cli/docker/node/ls/#format) for a list of supported formatting directives. | +| `pluginsFormat` | Custom default format for `docker plugin ls` output. See [`docker plugin ls`](https://docs.docker.com/reference/cli/docker/plugin/ls/#format) for a list of supported formatting directives. | +| `psFormat` | Custom default format for `docker ps` / `docker container ps` output. See [`docker ps`](https://docs.docker.com/reference/cli/docker/container/ls/#format) for a list of supported formatting directives. | +| `secretFormat` | Custom default format for `docker secret ls` output. See [`docker secret ls`](https://docs.docker.com/reference/cli/docker/secret/ls/#format) for a list of supported formatting directives. | +| `serviceInspectFormat` | Custom default format for `docker service inspect` output. See [`docker service inspect`](https://docs.docker.com/reference/cli/docker/service/inspect/#format) for a list of supported formatting directives. | +| `servicesFormat` | Custom default format for `docker service ls` output. See [`docker service ls`](https://docs.docker.com/reference/cli/docker/service/ls/#format) for a list of supported formatting directives. | +| `statsFormat` | Custom default format for `docker stats` output. See [`docker stats`](https://docs.docker.com/reference/cli/docker/container/stats/#format) for a list of supported formatting directives. | +| `tasksFormat` | Custom default format for `docker stack ps` output. See [`docker stack ps`](https://docs.docker.com/reference/cli/docker/stack/ps/#format) for a list of supported formatting directives. | +| `volumesFormat` | Custom default format for `docker volume ls` output. See [`docker volume ls`](https://docs.docker.com/reference/cli/docker/volume/ls/#format) for a list of supported formatting directives. | ### Custom HTTP headers @@ -144,14 +144,14 @@ credential store. When this property is set, `docker login` will attempt to store credentials in the binary specified by `docker-credential-` which is visible on `$PATH`. If this property isn't set, credentials are stored in the `auths` property of the CLI configuration file. For more information, -see the [**Credential stores** section in the `docker login` documentation](login.md#credential-stores) +see the [**Credential stores** section in the `docker login` documentation](https://docs.docker.com/reference/cli/docker/login/#credential-stores) The property `credHelpers` specifies a set of credential helpers to use preferentially over `credsStore` or `auths` when storing and retrieving credentials for specific registries. If this property is set, the binary `docker-credential-` will be used when storing or retrieving credentials for a specific registry. For more information, see the -[**Credential helpers** section in the `docker login` documentation](login.md#credential-helpers) +[**Credential helpers** section in the `docker login` documentation](https://docs.docker.com/reference/cli/docker/login/#credential-helpers) ### Automatic proxy configuration for containers @@ -299,12 +299,12 @@ commands use the following default sockets: - `npipe:////./pipe/docker_engine` on Windows To achieve a similar effect without having to specify the `-H` flag for every -command, you could also [create a context](context_create.md), +command, you could also [create a context](https://docs.docker.com/reference/cli/docker/context/create/), or alternatively, use the [`DOCKER_HOST` environment variable](#environment-variables). For more information about the `-H` flag, see -[Daemon socket option](dockerd.md#daemon-socket-option). +[Daemon socket option](https://docs.docker.com/reference/cli/dockerd/#daemon-socket-option). #### Using TCP sockets diff --git a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md b/_vendor/github.com/docker/cli/docs/reference/dockerd.md similarity index 98% rename from _vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md rename to _vendor/github.com/docker/cli/docs/reference/dockerd.md index 00397b7be89..5ada8973e7c 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md +++ b/_vendor/github.com/docker/cli/docs/reference/dockerd.md @@ -133,21 +133,21 @@ to [the `daemon.json` file](#daemon-configuration-file). The following list of environment variables are supported by the `dockerd` daemon. Some of these environment variables are supported both by the Docker Daemon and -the `docker` CLI. Refer to [Environment variables](cli.md#environment-variables) +the `docker` CLI. Refer to [Environment variables](https://docs.docker.com/engine/reference/commandline/cli/#environment-variables) in the CLI section to learn about environment variables supported by the `docker` CLI. -| Variable | Description | -|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the [`docker` CLI](cli.md) and the `dockerd` daemon. | -| `DOCKER_DRIVER` | The storage driver to use. | -| `DOCKER_RAMDISK` | If set this disables `pivot_root`. | -| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the [`docker` CLI](cli.md) and the `dockerd` daemon. | -| `DOCKER_TMPDIR` | Location for temporary files created by the daemon. | -| `HTTP_PROXY` | Proxy URL for HTTP requests unless overridden by NoProxy. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | -| `HTTPS_PROXY` | Proxy URL for HTTPS requests unless overridden by NoProxy. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | -| `MOBY_DISABLE_PIGZ` | Disables the use of [`unpigz`](https://linux.die.net/man/1/pigz) to decompress layers in parallel when pulling images, even if it is installed. | -| `NO_PROXY` | Comma-separated values specifying hosts that should be excluded from proxying. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | +| Variable | Description | +| :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the [`docker` CLI](https://docs.docker.com/engine/reference/commandline/cli/) and the `dockerd` daemon. | +| `DOCKER_DRIVER` | The storage driver to use. | +| `DOCKER_RAMDISK` | If set this disables `pivot_root`. | +| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the [`docker` CLI](https://docs.docker.com/engine/reference/commandline/cli/) and the `dockerd` daemon. | +| `DOCKER_TMPDIR` | Location for temporary files created by the daemon. | +| `HTTP_PROXY` | Proxy URL for HTTP requests unless overridden by NoProxy. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | +| `HTTPS_PROXY` | Proxy URL for HTTPS requests unless overridden by NoProxy. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | +| `MOBY_DISABLE_PIGZ` | Disables the use of [`unpigz`](https://linux.die.net/man/1/pigz) to decompress layers in parallel when pulling images, even if it is installed. | +| `NO_PROXY` | Comma-separated values specifying hosts that should be excluded from proxying. See the [Go specification](https://pkg.go.dev/golang.org/x/net/http/httpproxy#Config) for details. | ## Examples @@ -795,7 +795,7 @@ Any `--ulimit` options passed to `docker run` override the daemon defaults. Be careful setting `nproc` with the `ulimit` flag, as `nproc` is designed by Linux to set the maximum number of processes available to a user, not to a container. -For details, see [`docker run` reference](run.md#ulimit). +For details, see [`docker run` reference](https://docs.docker.com/reference/cli/docker/container/run/#ulimit). ### Access authorization @@ -819,7 +819,7 @@ If you have multiple plugins installed, each plugin, in order, must allow the request for it to complete. For information about how to create an authorization plugin, refer to the -[authorization plugin](../../extend/plugins_authorization.md) section. +[authorization plugin](https://docs.docker.com/engine/extend/plugins_authorization/) section. ### Daemon user namespace options diff --git a/_vendor/github.com/docker/cli/docs/reference/run.md b/_vendor/github.com/docker/cli/docs/reference/run.md index 41fd2c0dc2d..bad35ccf422 100644 --- a/_vendor/github.com/docker/cli/docs/reference/run.md +++ b/_vendor/github.com/docker/cli/docs/reference/run.md @@ -114,13 +114,13 @@ $ docker attach 0246aa4d1448 For more information about `docker run` flags related to foreground and background modes, see: -- [`docker run --detach`](commandline/container_run.md#detach): run container in background -- [`docker run --attach`](commandline/container_run.md#attach): attach to `stdin`, `stdout`, and `stderr` -- [`docker run --tty`](commandline/container_run.md#tty): allocate a pseudo-tty -- [`docker run --interactive`](commandline/container_run.md#interactive): keep `stdin` open even if not attached +- [`docker run --detach`](https://docs.docker.com/reference/cli/docker/container/run/#detach): run container in background +- [`docker run --attach`](https://docs.docker.com/reference/cli/docker/container/run/#attach): attach to `stdin`, `stdout`, and `stderr` +- [`docker run --tty`](https://docs.docker.com/reference/cli/docker/container/run/#tty): allocate a pseudo-tty +- [`docker run --interactive`](https://docs.docker.com/reference/cli/docker/container/run/#interactive): keep `stdin` open even if not attached For more information about re-attaching to a background container, see -[`docker attach`](commandline/container_attach.md). +[`docker attach`](https://docs.docker.com/reference/cli/docker/container/attach/). ## Container identification @@ -135,7 +135,7 @@ You can identify a container in three ways: The UUID identifier is a random ID assigned to the container by the daemon. The daemon generates a random string name for containers automatically. You can -also defined a custom name using [the `--name` flag](./commandline/container_run.md#name). +also defined a custom name using [the `--name` flag](https://docs.docker.com/reference/cli/docker/container/run/#name). Defining a `name` can be a handy way to add meaning to a container. If you specify a `name`, you can use it when referring to the container in a user-defined network. This works for both background and foreground Docker @@ -966,7 +966,7 @@ use of facilities allowed by the capabilities, so you should not have to adjust ## Overriding image defaults -When you build an image from a [Dockerfile](https://docs.docker.com/engine/reference/builder/), +When you build an image from a [Dockerfile](https://docs.docker.com/reference/dockerfile/), or when committing it, you can set a number of default parameters that take effect when the image starts up as a container. When you run an image, you can override those defaults using flags for the `docker run` command. diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md index 3728a76d48e..ce6c214d0d6 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md @@ -1,42 +1,42 @@ # docker compose -Define and run multi-container applications with Docker. +Define and run multi-container applications with Docker ### Subcommands -| Name | Description | -|:--------------------------------|:-----------------------------------------------------------------------------------------| -| [`attach`](compose_attach.md) | Attach local standard input, output, and error streams to a service's running container. | -| [`build`](compose_build.md) | Build or rebuild services | -| [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format | -| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | -| [`create`](compose_create.md) | Creates containers for a service. | -| [`down`](compose_down.md) | Stop and remove containers, networks | -| [`events`](compose_events.md) | Receive real time events from containers. | -| [`exec`](compose_exec.md) | Execute a command in a running container. | -| [`images`](compose_images.md) | List images used by the created containers | -| [`kill`](compose_kill.md) | Force stop service containers. | -| [`logs`](compose_logs.md) | View output from containers | -| [`ls`](compose_ls.md) | List running compose projects | -| [`pause`](compose_pause.md) | Pause services | -| [`port`](compose_port.md) | Print the public port for a port binding. | -| [`ps`](compose_ps.md) | List containers | -| [`pull`](compose_pull.md) | Pull service images | -| [`push`](compose_push.md) | Push service images | -| [`restart`](compose_restart.md) | Restart service containers | -| [`rm`](compose_rm.md) | Removes stopped service containers | -| [`run`](compose_run.md) | Run a one-off command on a service. | -| [`scale`](compose_scale.md) | Scale services | -| [`start`](compose_start.md) | Start services | -| [`stats`](compose_stats.md) | Display a live stream of container(s) resource usage statistics | -| [`stop`](compose_stop.md) | Stop services | -| [`top`](compose_top.md) | Display the running processes | -| [`unpause`](compose_unpause.md) | Unpause services | -| [`up`](compose_up.md) | Create and start containers | -| [`version`](compose_version.md) | Show the Docker Compose version information | -| [`wait`](compose_wait.md) | Block until the first service container stops | -| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated | +| Name | Description | +|:--------------------------------|:----------------------------------------------------------------------------------------| +| [`attach`](compose_attach.md) | Attach local standard input, output, and error streams to a service's running container | +| [`build`](compose_build.md) | Build or rebuild services | +| [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format | +| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | +| [`create`](compose_create.md) | Creates containers for a service | +| [`down`](compose_down.md) | Stop and remove containers, networks | +| [`events`](compose_events.md) | Receive real time events from containers | +| [`exec`](compose_exec.md) | Execute a command in a running container | +| [`images`](compose_images.md) | List images used by the created containers | +| [`kill`](compose_kill.md) | Force stop service containers | +| [`logs`](compose_logs.md) | View output from containers | +| [`ls`](compose_ls.md) | List running compose projects | +| [`pause`](compose_pause.md) | Pause services | +| [`port`](compose_port.md) | Print the public port for a port binding | +| [`ps`](compose_ps.md) | List containers | +| [`pull`](compose_pull.md) | Pull service images | +| [`push`](compose_push.md) | Push service images | +| [`restart`](compose_restart.md) | Restart service containers | +| [`rm`](compose_rm.md) | Removes stopped service containers | +| [`run`](compose_run.md) | Run a one-off command on a service | +| [`scale`](compose_scale.md) | Scale services | +| [`start`](compose_start.md) | Start services | +| [`stats`](compose_stats.md) | Display a live stream of container(s) resource usage statistics | +| [`stop`](compose_stop.md) | Stop services | +| [`top`](compose_top.md) | Display the running processes | +| [`unpause`](compose_unpause.md) | Unpause services | +| [`up`](compose_up.md) | Create and start containers | +| [`version`](compose_version.md) | Show the Docker Compose version information | +| [`wait`](compose_wait.md) | Block until the first service container stops | +| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated | ### Options @@ -46,7 +46,7 @@ Define and run multi-container applications with Docker. | `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") | | `--compatibility` | | | Run compose in backward compatibility mode | | `--dry-run` | | | Execute command in dry run mode | -| `--env-file` | `stringArray` | | Specify an alternate environment file. | +| `--env-file` | `stringArray` | | Specify an alternate environment file | | `-f`, `--file` | `stringArray` | | Compose configuration files | | `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | | `--profile` | `stringArray` | | Specify a profile to enable | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md index 9e8350e2a0c..7c68d94d66b 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md @@ -1,7 +1,7 @@ # docker compose alpha dry-run -Dry run command allows you to test a command without applying changes. +Dry run command allows you to test a command without applying changes diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md index 8424d7fbce5..02516d968b9 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md @@ -9,7 +9,7 @@ Publish compose application |:--------------------------|:---------|:--------|:-------------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | | `--oci-version` | `string` | | OCI Image/Artifact specification version (automatically determined by default) | -| `--resolve-image-digests` | | | Pin image tags to digests. | +| `--resolve-image-digests` | | | Pin image tags to digests | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md index 15536b359c9..f783f3335c7 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md @@ -1,14 +1,14 @@ # docker compose alpha scale -Scale services. +Scale services ### Options | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services | +| `--no-deps` | | | Don't start linked services | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_attach.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_attach.md index 405fed98ad0..5a033881922 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_attach.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_attach.md @@ -1,7 +1,7 @@ # docker compose attach -Attach local standard input, output, and error streams to a service's running container. +Attach local standard input, output, and error streams to a service's running container ### Options @@ -15,4 +15,3 @@ Attach local standard input, output, and error streams to a service's running co - diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md index 46bcedbbe7b..a0ceb050c09 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md @@ -7,16 +7,16 @@ Build or rebuild services | Name | Type | Default | Description | |:----------------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------| -| `--build-arg` | `stringArray` | | Set build-time variables for services. | -| `--builder` | `string` | | Set builder to use. | +| `--build-arg` | `stringArray` | | Set build-time variables for services | +| `--builder` | `string` | | Set builder to use | | `--dry-run` | | | Execute command in dry run mode | | `-m`, `--memory` | `bytes` | `0` | Set memory limit for the build container. Not supported by BuildKit. | | `--no-cache` | | | Do not use cache when building the image | -| `--pull` | | | Always attempt to pull a newer version of the image. | -| `--push` | | | Push service images. | +| `--pull` | | | Always attempt to pull a newer version of the image | +| `--push` | | | Push service images | | `-q`, `--quiet` | | | Don't print anything to STDOUT | | `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) | -| `--with-dependencies` | | | Also build dependencies (transitively). | +| `--with-dependencies` | | | Also build dependencies (transitively) | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md index 2639cd735eb..fd213b4c38c 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md @@ -13,18 +13,18 @@ Parse, resolve and render compose file in canonical format |:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | | `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | -| `--hash` | `string` | | Print the service config hash, one per line. | -| `--images` | | | Print the image names, one per line. | +| `--hash` | `string` | | Print the service config hash, one per line | +| `--images` | | | Print the image names, one per line | | `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output | -| `--no-interpolate` | | | Don't interpolate environment variables. | -| `--no-normalize` | | | Don't normalize compose model. | -| `--no-path-resolution` | | | Don't resolve file paths. | +| `--no-interpolate` | | | Don't interpolate environment variables | +| `--no-normalize` | | | Don't normalize compose model | +| `--no-path-resolution` | | | Don't resolve file paths | | `-o`, `--output` | `string` | | Save to file (default to stdout) | -| `--profiles` | | | Print the profile names, one per line. | -| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. | -| `--resolve-image-digests` | | | Pin image tags to digests. | -| `--services` | | | Print the service names, one per line. | -| `--volumes` | | | Print the volume names, one per line. | +| `--profiles` | | | Print the profile names, one per line | +| `-q`, `--quiet` | | | Only validate the configuration, don't print anything | +| `--resolve-image-digests` | | | Pin image tags to digests | +| `--services` | | | Print the service names, one per line | +| `--volumes` | | | Print the volume names, one per line | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md index 9be79443afe..a60388e306e 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md @@ -10,7 +10,7 @@ Copy files/folders between a service container and the local filesystem | `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | | `--dry-run` | | | Execute command in dry run mode | | `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `--index` | `int` | `0` | index of the container if service has multiple replicas | +| `--index` | `int` | `0` | Index of the container if service has multiple replicas | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md index 149ed6fe33f..386d6359aca 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md @@ -1,19 +1,19 @@ # docker compose create -Creates containers for a service. +Creates containers for a service ### Options | Name | Type | Default | Description | |:-------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------| -| `--build` | | | Build images before starting containers. | +| `--build` | | | Build images before starting containers | | `--dry-run` | | | Execute command in dry run mode | -| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | -| `--no-build` | | | Don't build an image, even if it's policy. | +| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed | +| `--no-build` | | | Don't build an image, even if it's policy | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never"\|"build") | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md index 4012b70ca40..2d7cf57271d 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md @@ -5,13 +5,13 @@ Stop and remove containers, networks ### Options -| Name | Type | Default | Description | -|:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | -| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | -| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. | +| Name | Type | Default | Description | +|:-------------------|:---------|:--------|:------------------------------------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | +| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | +| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md index 86c492e843d..0a97a46bc76 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md @@ -1,7 +1,7 @@ # docker compose events -Receive real time events from containers. +Receive real time events from containers ### Options @@ -33,4 +33,4 @@ With the `--json` flag, a json object is printed one per line with the format: } ``` -The events that can be received using this can be seen [here](https://docs.docker.com/engine/reference/commandline/system_events/#object-types). +The events that can be received using this can be seen [here](https://docs.docker.com/reference/cli/docker/system/events/#object-types). diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md index 7c5f7d6a4f5..fab82217828 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md @@ -1,20 +1,20 @@ # docker compose exec -Execute a command in a running container. +Execute a command in a running container ### Options | Name | Type | Default | Description | |:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: Run command in the background. | +| `-d`, `--detach` | | | Detached mode: Run command in the background | | `--dry-run` | | | Execute command in dry run mode | | `-e`, `--env` | `stringArray` | | Set environment variables | -| `--index` | `int` | `0` | index of the container if service has multiple replicas | +| `--index` | `int` | `0` | Index of the container if service has multiple replicas | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | -| `--privileged` | | | Give extended privileges to the process. | -| `-u`, `--user` | `string` | | Run the command as this user. | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | +| `--privileged` | | | Give extended privileges to the process | +| `-u`, `--user` | `string` | | Run the command as this user | +| `-w`, `--workdir` | `string` | | Path to workdir directory for this command | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md index 02a8f57ec48..a29af42f34f 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md @@ -5,11 +5,11 @@ List images used by the created containers ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:--------------------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs | +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:-------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--format` | `string` | `table` | Format the output. Values: [table \| json] | +| `-q`, `--quiet` | | | Only display IDs | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md index 2e79d806e93..a10ce55bef4 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md @@ -1,15 +1,15 @@ # docker compose kill -Force stop service containers. +Force stop service containers ### Options -| Name | Type | Default | Description | -|:-------------------|:---------|:----------|:----------------------------------------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | +| Name | Type | Default | Description | +|:-------------------|:---------|:----------|:---------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md index b6c705bab29..15291f71d90 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md @@ -8,13 +8,13 @@ View output from containers | Name | Type | Default | Description | |:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `-f`, `--follow` | | | Follow log output. | +| `-f`, `--follow` | | | Follow log output | | `--index` | `int` | `0` | index of the container if service has multiple replicas | -| `--no-color` | | | Produce monochrome output. | -| `--no-log-prefix` | | | Don't print prefix in logs. | +| `--no-color` | | | Produce monochrome output | +| `--no-log-prefix` | | | Don't print prefix in logs | | `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | -| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. | -| `-t`, `--timestamps` | | | Show timestamps. | +| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | +| `-t`, `--timestamps` | | | Show timestamps | | `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | @@ -22,4 +22,4 @@ View output from containers ## Description -Displays log output from services. \ No newline at end of file +Displays log output from services diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md index 50a13d96f05..a1148a1675c 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md @@ -5,17 +5,17 @@ List running compose projects ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:--------------------------------------------| -| `-a`, `--all` | | | Show all stopped Compose projects | -| `--dry-run` | | | Execute command in dry run mode | -| `--filter` | `filter` | | Filter output based on conditions provided. | -| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs. | +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:-------------------------------------------| +| `-a`, `--all` | | | Show all stopped Compose projects | +| `--dry-run` | | | Execute command in dry run mode | +| `--filter` | `filter` | | Filter output based on conditions provided | +| `--format` | `string` | `table` | Format the output. Values: [table \| json] | +| `-q`, `--quiet` | | | Only display IDs | ## Description -Lists running Compose projects. \ No newline at end of file +Lists running Compose projects diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md index ffd3d8eb53e..5e70b353292 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md @@ -1,14 +1,14 @@ # docker compose port -Print the public port for a port binding. +Print the public port for a port binding ### Options | Name | Type | Default | Description | |:-------------|:---------|:--------|:--------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--index` | `int` | `0` | index of the container if service has multiple replicas | +| `--index` | `int` | `0` | Index of the container if service has multiple replicas | | `--protocol` | `string` | `tcp` | tcp or udp | @@ -16,4 +16,4 @@ Print the public port for a port binding. ## Description -Prints the public port for a port binding. \ No newline at end of file +Prints the public port for a port binding diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md index 81ef2550981..f0c1a257627 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md @@ -9,7 +9,7 @@ List containers |:----------------------|:--------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `-a`, `--all` | | | Show all stopped containers (including those created by the run command) | | `--dry-run` | | | Execute command in dry run mode | -| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). | +| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status) | | [`--format`](#format) | `string` | `table` | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `--no-trunc` | | | Don't truncate output | | `--orphans` | | | Include orphaned services (not declared by project) | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md index 03be4de05e8..2c29052fd8d 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md @@ -5,22 +5,21 @@ Pull service images ### Options -| Name | Type | Default | Description | -|:-------------------------|:---------|:--------|:--------------------------------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--ignore-buildable` | | | Ignore images that can be built. | -| `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures. | -| `--include-deps` | | | Also pull services declared as dependencies. | -| `--policy` | `string` | | Apply pull policy ("missing"\|"always"). | -| `-q`, `--quiet` | | | Pull without printing progress information. | +| Name | Type | Default | Description | +|:-------------------------|:---------|:--------|:-------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--ignore-buildable` | | | Ignore images that can be built | +| `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures | +| `--include-deps` | | | Also pull services declared as dependencies | +| `--policy` | `string` | | Apply pull policy ("missing"\|"always") | +| `-q`, `--quiet` | | | Pull without printing progress information | ## Description -Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on -those images. +Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on those images ## Examples diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md index 1e7bdf3c8c3..d77b461a85e 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md @@ -8,7 +8,7 @@ Restart service containers | Name | Type | Default | Description | |:------------------|:------|:--------|:--------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't restart dependent services. | +| `--no-deps` | | | Don't restart dependent services | | `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md index 033ac5e78db..185b4ad073a 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md @@ -1,33 +1,33 @@ # docker compose run -Run a one-off command on a service. +Run a one-off command on a service ### Options -| Name | Type | Default | Description | -|:------------------------|:--------------|:--------|:----------------------------------------------------------------------------------| -| `--build` | | | Build image before starting container. | -| `--cap-add` | `list` | | Add Linux capabilities | -| `--cap-drop` | `list` | | Drop Linux capabilities | -| `-d`, `--detach` | | | Run container in background and print container ID | -| `--dry-run` | | | Execute command in dry run mode | -| `--entrypoint` | `string` | | Override the entrypoint of the image | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached. | -| `-l`, `--label` | `stringArray` | | Add or override a label | -| `--name` | `string` | | Assign a name to the container | -| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | -| `--no-deps` | | | Don't start linked services. | -| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `--rm` | | | Automatically remove the container when it exits | -| `-P`, `--service-ports` | | | Run command with all service's ports enabled and mapped to the host. | -| `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | -| `-u`, `--user` | `string` | | Run as specified username or uid | -| `-v`, `--volume` | `stringArray` | | Bind mount a volume. | -| `-w`, `--workdir` | `string` | | Working directory inside the container | +| Name | Type | Default | Description | +|:------------------------|:--------------|:--------|:---------------------------------------------------------------------------------| +| `--build` | | | Build image before starting container | +| `--cap-add` | `list` | | Add Linux capabilities | +| `--cap-drop` | `list` | | Drop Linux capabilities | +| `-d`, `--detach` | | | Run container in background and print container ID | +| `--dry-run` | | | Execute command in dry run mode | +| `--entrypoint` | `string` | | Override the entrypoint of the image | +| `-e`, `--env` | `stringArray` | | Set environment variables | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `-l`, `--label` | `stringArray` | | Add or override a label | +| `--name` | `string` | | Assign a name to the container | +| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected) | +| `--no-deps` | | | Don't start linked services | +| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host | +| `--quiet-pull` | | | Pull without printing progress information | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `--rm` | | | Automatically remove the container when it exits | +| `-P`, `--service-ports` | | | Run command with all service's ports enabled and mapped to the host | +| `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to | +| `-u`, `--user` | `string` | | Run as specified username or uid | +| `-v`, `--volume` | `stringArray` | | Bind mount a volume | +| `-w`, `--workdir` | `string` | | Working directory inside the container | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md index 5cf5830e286..e30508328a2 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md @@ -8,7 +8,7 @@ Scale services | Name | Type | Default | Description | |:------------|:-----|:--------|:--------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services. | +| `--no-deps` | | | Don't start linked services | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md index b525347f7e9..4ea26e9b592 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md @@ -14,4 +14,4 @@ Start services ## Description -Starts existing containers for a service. +Starts existing containers for a service diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md index 9aff0ce71ff..a23373832aa 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md @@ -14,7 +14,7 @@ Display the running processes ## Description -Displays the running processes. +Displays the running processes ## Examples diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md index 0df10a99243..9d810e47108 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md @@ -14,4 +14,4 @@ Unpause services ## Description -Unpauses paused containers of a service. +Unpauses paused containers of a service diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md index 49fc17225a5..38d678d00fa 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md @@ -5,33 +5,33 @@ Create and start containers ### Options -| Name | Type | Default | Description | -|:-----------------------------|:--------------|:---------|:---------------------------------------------------------------------------------------------------------| -| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | -| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | -| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | -| `--attach-dependencies` | | | Automatically attach to log output of dependent services. | -| `--build` | | | Build images before starting containers. | -| `-d`, `--detach` | | | Detached mode: Run containers in the background | -| `--dry-run` | | | Execute command in dry run mode | -| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | -| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | -| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services. | -| `--no-build` | | | Don't build an image, even if it's policy. | -| `--no-color` | | | Produce monochrome output. | -| `--no-deps` | | | Don't start linked services. | -| `--no-log-prefix` | | | Don't print prefix in logs. | -| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | | | Don't start the services after creating them. | -| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. | -| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running. | -| `--timestamps` | | | Show timestamps. | -| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | -| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy. | +| Name | Type | Default | Description | +|:-----------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------------| +| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | +| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | +| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | +| `--attach-dependencies` | | | Automatically attach to log output of dependent services | +| `--build` | | | Build images before starting containers | +| `-d`, `--detach` | | | Detached mode: Run containers in the background | +| `--dry-run` | | | Execute command in dry run mode | +| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | +| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed | +| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services | +| `--no-build` | | | Don't build an image, even if it's policy | +| `--no-color` | | | Produce monochrome output | +| `--no-deps` | | | Don't start linked services | +| `--no-log-prefix` | | | Don't print prefix in logs | +| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | +| `--no-start` | | | Don't start the services after creating them | +| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") | +| `--quiet-pull` | | | Pull without printing progress information | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | +| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | +| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | +| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | +| `--timestamps` | | | Show timestamps | +| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | +| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md index 66081d65ec9..9284d8e935e 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md @@ -9,7 +9,7 @@ Show the Docker Compose version information |:-----------------|:---------|:--------|:---------------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | | `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | -| `--short` | | | Shows only Compose's version number. | +| `--short` | | | Shows only Compose's version number | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml index 83f555b6c89..acdd3912610 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml @@ -242,7 +242,7 @@ options: - option: env-file value_type: stringArray default_value: '[]' - description: Specify an alternate environment file. + description: Specify an alternate environment file deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml index f2237f2ae43..38868104a5f 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml @@ -18,7 +18,7 @@ options: - option: resolve-image-digests value_type: bool default_value: "false" - description: Pin image tags to digests. + description: Pin image tags to digests deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_attach.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_attach.yaml index 14c584f4115..8fd6957ca18 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_attach.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_attach.yaml @@ -1,8 +1,8 @@ command: docker compose attach short: | - Attach local standard input, output, and error streams to a service's running container. + Attach local standard input, output, and error streams to a service's running container long: | - Attach local standard input, output, and error streams to a service's running container. + Attach local standard input, output, and error streams to a service's running container usage: docker compose attach [OPTIONS] SERVICE pname: docker compose plink: docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml index d6085d0d155..34175696fb5 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml @@ -17,7 +17,7 @@ options: - option: build-arg value_type: stringArray default_value: '[]' - description: Set build-time variables for services. + description: Set build-time variables for services deprecated: false hidden: false experimental: false @@ -26,7 +26,7 @@ options: swarm: false - option: builder value_type: string - description: Set builder to use. + description: Set builder to use deprecated: false hidden: false experimental: false @@ -109,7 +109,7 @@ options: - option: pull value_type: bool default_value: "false" - description: Always attempt to pull a newer version of the image. + description: Always attempt to pull a newer version of the image deprecated: false hidden: false experimental: false @@ -119,7 +119,7 @@ options: - option: push value_type: bool default_value: "false" - description: Push service images. + description: Push service images deprecated: false hidden: false experimental: false @@ -150,7 +150,7 @@ options: - option: with-dependencies value_type: bool default_value: "false" - description: Also build dependencies (transitively). + description: Also build dependencies (transitively) deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml index d180c8d1431..ea7669b0d97 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml @@ -21,7 +21,7 @@ options: swarm: false - option: hash value_type: string - description: Print the service config hash, one per line. + description: Print the service config hash, one per line deprecated: false hidden: false experimental: false @@ -31,7 +31,7 @@ options: - option: images value_type: bool default_value: "false" - description: Print the image names, one per line. + description: Print the image names, one per line deprecated: false hidden: false experimental: false @@ -52,7 +52,7 @@ options: - option: no-interpolate value_type: bool default_value: "false" - description: Don't interpolate environment variables. + description: Don't interpolate environment variables deprecated: false hidden: false experimental: false @@ -62,7 +62,7 @@ options: - option: no-normalize value_type: bool default_value: "false" - description: Don't normalize compose model. + description: Don't normalize compose model deprecated: false hidden: false experimental: false @@ -72,7 +72,7 @@ options: - option: no-path-resolution value_type: bool default_value: "false" - description: Don't resolve file paths. + description: Don't resolve file paths deprecated: false hidden: false experimental: false @@ -92,7 +92,7 @@ options: - option: profiles value_type: bool default_value: "false" - description: Print the profile names, one per line. + description: Print the profile names, one per line deprecated: false hidden: false experimental: false @@ -103,7 +103,7 @@ options: shorthand: q value_type: bool default_value: "false" - description: Only validate the configuration, don't print anything. + description: Only validate the configuration, don't print anything deprecated: false hidden: false experimental: false @@ -113,7 +113,7 @@ options: - option: resolve-image-digests value_type: bool default_value: "false" - description: Pin image tags to digests. + description: Pin image tags to digests deprecated: false hidden: false experimental: false @@ -123,7 +123,7 @@ options: - option: services value_type: bool default_value: "false" - description: Print the service names, one per line. + description: Print the service names, one per line deprecated: false hidden: false experimental: false @@ -133,7 +133,7 @@ options: - option: volumes value_type: bool default_value: "false" - description: Print the volume names, one per line. + description: Print the volume names, one per line deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml index 4551c13c648..8ff3cf37e03 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml @@ -10,7 +10,7 @@ options: - option: all value_type: bool default_value: "false" - description: copy to all the containers of the service. + description: Copy to all the containers of the service deprecated: true hidden: true experimental: false @@ -42,7 +42,7 @@ options: - option: index value_type: int default_value: "0" - description: index of the container if service has multiple replicas + description: Index of the container if service has multiple replicas deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml index 05a4a51437d..34425aebb80 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml @@ -1,6 +1,6 @@ command: docker compose create -short: Creates containers for a service. -long: Creates containers for a service. +short: Creates containers for a service +long: Creates containers for a service usage: docker compose create [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml @@ -8,7 +8,7 @@ options: - option: build value_type: bool default_value: "false" - description: Build images before starting containers. + description: Build images before starting containers deprecated: false hidden: false experimental: false @@ -19,7 +19,7 @@ options: value_type: bool default_value: "false" description: | - Recreate containers even if their configuration and image haven't changed. + Recreate containers even if their configuration and image haven't changed deprecated: false hidden: false experimental: false @@ -29,7 +29,7 @@ options: - option: no-build value_type: bool default_value: "false" - description: Don't build an image, even if it's policy. + description: Don't build an image, even if it's policy deprecated: false hidden: false experimental: false @@ -60,7 +60,7 @@ options: - option: remove-orphans value_type: bool default_value: "false" - description: Remove containers for services not defined in the Compose file. + description: Remove containers for services not defined in the Compose file deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml index 7964dd49c3b..77bf526289b 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml @@ -21,7 +21,7 @@ options: - option: remove-orphans value_type: bool default_value: "false" - description: Remove containers for services not defined in the Compose file. + description: Remove containers for services not defined in the Compose file deprecated: false hidden: false experimental: false @@ -54,7 +54,7 @@ options: value_type: bool default_value: "false" description: | - Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. + Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml index cd51372f720..fe6d4216ce1 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml @@ -1,5 +1,5 @@ command: docker compose events -short: Receive real time events from containers. +short: Receive real time events from containers long: |- Stream container events for every container in the project. @@ -19,7 +19,7 @@ long: |- } ``` - The events that can be received using this can be seen [here](/engine/reference/commandline/system_events/#object-types). + The events that can be received using this can be seen [here](/reference/cli/docker/system/events/#object-types). usage: docker compose events [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml index ce6faeda6d8..b2a1cf20685 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml @@ -1,5 +1,5 @@ command: docker compose exec -short: Execute a command in a running container. +short: Execute a command in a running container long: |- This is the equivalent of `docker exec` targeting a Compose service. @@ -13,7 +13,7 @@ options: shorthand: d value_type: bool default_value: "false" - description: 'Detached mode: Run command in the background.' + description: 'Detached mode: Run command in the background' deprecated: false hidden: false experimental: false @@ -34,7 +34,7 @@ options: - option: index value_type: int default_value: "0" - description: index of the container if service has multiple replicas + description: Index of the container if service has multiple replicas deprecated: false hidden: false experimental: false @@ -45,7 +45,7 @@ options: shorthand: i value_type: bool default_value: "true" - description: Keep STDIN open even if not attached. + description: Keep STDIN open even if not attached deprecated: false hidden: true experimental: false @@ -67,7 +67,7 @@ options: - option: privileged value_type: bool default_value: "false" - description: Give extended privileges to the process. + description: Give extended privileges to the process deprecated: false hidden: false experimental: false @@ -78,7 +78,7 @@ options: shorthand: t value_type: bool default_value: "true" - description: Allocate a pseudo-TTY. + description: Allocate a pseudo-TTY deprecated: false hidden: true experimental: false @@ -88,7 +88,7 @@ options: - option: user shorthand: u value_type: string - description: Run the command as this user. + description: Run the command as this user deprecated: false hidden: false experimental: false @@ -98,7 +98,7 @@ options: - option: workdir shorthand: w value_type: string - description: Path to workdir directory for this command. + description: Path to workdir directory for this command deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml index 4719590af59..33187df42d6 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml @@ -8,7 +8,7 @@ options: - option: format value_type: string default_value: table - description: 'Format the output. Values: [table | json].' + description: 'Format the output. Values: [table | json]' deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml index 21342276412..b6d5334827d 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml @@ -1,5 +1,5 @@ command: docker compose kill -short: Force stop service containers. +short: Force stop service containers long: |- Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example: @@ -13,7 +13,7 @@ options: - option: remove-orphans value_type: bool default_value: "false" - description: Remove containers for services not defined in the Compose file. + description: Remove containers for services not defined in the Compose file deprecated: false hidden: false experimental: false @@ -24,7 +24,7 @@ options: shorthand: s value_type: string default_value: SIGKILL - description: SIGNAL to send to the container. + description: SIGNAL to send to the container deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml index fe6bbdb424f..92d94dd108c 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml @@ -1,6 +1,6 @@ command: docker compose logs short: View output from containers -long: Displays log output from services. +long: Displays log output from services usage: docker compose logs [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml @@ -9,7 +9,7 @@ options: shorthand: f value_type: bool default_value: "false" - description: Follow log output. + description: Follow log output deprecated: false hidden: false experimental: false @@ -29,7 +29,7 @@ options: - option: no-color value_type: bool default_value: "false" - description: Produce monochrome output. + description: Produce monochrome output deprecated: false hidden: false experimental: false @@ -39,7 +39,7 @@ options: - option: no-log-prefix value_type: bool default_value: "false" - description: Don't print prefix in logs. + description: Don't print prefix in logs deprecated: false hidden: false experimental: false @@ -61,7 +61,7 @@ options: value_type: string default_value: all description: | - Number of lines to show from the end of the logs for each container. + Number of lines to show from the end of the logs for each container deprecated: false hidden: false experimental: false @@ -72,7 +72,7 @@ options: shorthand: t value_type: bool default_value: "false" - description: Show timestamps. + description: Show timestamps deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml index c4b6d5f7c10..a2efac2a88d 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml @@ -1,6 +1,6 @@ command: docker compose ls short: List running compose projects -long: Lists running Compose projects. +long: Lists running Compose projects usage: docker compose ls [OPTIONS] pname: docker compose plink: docker_compose.yaml @@ -18,7 +18,7 @@ options: swarm: false - option: filter value_type: filter - description: Filter output based on conditions provided. + description: Filter output based on conditions provided deprecated: false hidden: false experimental: false @@ -28,7 +28,7 @@ options: - option: format value_type: string default_value: table - description: 'Format the output. Values: [table | json].' + description: 'Format the output. Values: [table | json]' deprecated: false hidden: false experimental: false @@ -39,7 +39,7 @@ options: shorthand: q value_type: bool default_value: "false" - description: Only display IDs. + description: Only display IDs deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml index 7c8dee90ce4..8a07f31ea50 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml @@ -1,6 +1,6 @@ command: docker compose port -short: Print the public port for a port binding. -long: Prints the public port for a port binding. +short: Print the public port for a port binding +long: Prints the public port for a port binding usage: docker compose port [OPTIONS] SERVICE PRIVATE_PORT pname: docker compose plink: docker_compose.yaml @@ -8,7 +8,7 @@ options: - option: index value_type: int default_value: "0" - description: index of the container if service has multiple replicas + description: Index of the container if service has multiple replicas deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml index 78842a99908..d0370275695 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml @@ -35,7 +35,7 @@ options: swarm: false - option: filter value_type: string - description: 'Filter services by a property (supported filters: status).' + description: 'Filter services by a property (supported filters: status)' details_url: '#filter' deprecated: false hidden: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml index 46a47116247..5b1316df132 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml @@ -1,8 +1,7 @@ command: docker compose pull short: Pull service images -long: |- - Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on - those images. +long: | + Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on those images usage: docker compose pull [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml @@ -10,7 +9,7 @@ options: - option: ignore-buildable value_type: bool default_value: "false" - description: Ignore images that can be built. + description: Ignore images that can be built deprecated: false hidden: false experimental: false @@ -20,7 +19,7 @@ options: - option: ignore-pull-failures value_type: bool default_value: "false" - description: Pull what it can and ignores images with pull failures. + description: Pull what it can and ignores images with pull failures deprecated: false hidden: false experimental: false @@ -30,7 +29,7 @@ options: - option: include-deps value_type: bool default_value: "false" - description: Also pull services declared as dependencies. + description: Also pull services declared as dependencies deprecated: false hidden: false experimental: false @@ -40,7 +39,7 @@ options: - option: no-parallel value_type: bool default_value: "true" - description: DEPRECATED disable parallel pulling. + description: DEPRECATED disable parallel pulling deprecated: false hidden: true experimental: false @@ -50,7 +49,7 @@ options: - option: parallel value_type: bool default_value: "true" - description: DEPRECATED pull multiple images in parallel. + description: DEPRECATED pull multiple images in parallel deprecated: false hidden: true experimental: false @@ -59,7 +58,7 @@ options: swarm: false - option: policy value_type: string - description: Apply pull policy ("missing"|"always"). + description: Apply pull policy ("missing"|"always") deprecated: false hidden: false experimental: false @@ -70,7 +69,7 @@ options: shorthand: q value_type: bool default_value: "false" - description: Pull without printing progress information. + description: Pull without printing progress information deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml index 3126eb005ac..3b2a4bddd1b 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml @@ -18,7 +18,7 @@ options: - option: no-deps value_type: bool default_value: "false" - description: Don't restart dependent services. + description: Don't restart dependent services deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml index 12abafc3b69..0584bdd070b 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml @@ -1,5 +1,5 @@ command: docker compose run -short: Run a one-off command on a service. +short: Run a one-off command on a service long: |- Runs a one-time command against a service. @@ -61,7 +61,7 @@ options: - option: build value_type: bool default_value: "false" - description: Build image before starting container. + description: Build image before starting container deprecated: false hidden: false experimental: false @@ -121,7 +121,7 @@ options: shorthand: i value_type: bool default_value: "true" - description: Keep STDIN open even if not attached. + description: Keep STDIN open even if not attached deprecated: false hidden: false experimental: false @@ -152,7 +152,7 @@ options: shorthand: T value_type: bool default_value: "true" - description: 'Disable pseudo-TTY allocation (default: auto-detected).' + description: 'Disable pseudo-TTY allocation (default: auto-detected)' deprecated: false hidden: false experimental: false @@ -162,7 +162,7 @@ options: - option: no-deps value_type: bool default_value: "false" - description: Don't start linked services. + description: Don't start linked services deprecated: false hidden: false experimental: false @@ -173,7 +173,7 @@ options: shorthand: p value_type: stringArray default_value: '[]' - description: Publish a container's port(s) to the host. + description: Publish a container's port(s) to the host deprecated: false hidden: false experimental: false @@ -183,7 +183,7 @@ options: - option: quiet-pull value_type: bool default_value: "false" - description: Pull without printing progress information. + description: Pull without printing progress information deprecated: false hidden: false experimental: false @@ -193,7 +193,7 @@ options: - option: remove-orphans value_type: bool default_value: "false" - description: Remove containers for services not defined in the Compose file. + description: Remove containers for services not defined in the Compose file deprecated: false hidden: false experimental: false @@ -215,7 +215,7 @@ options: value_type: bool default_value: "false" description: | - Run command with all service's ports enabled and mapped to the host. + Run command with all service's ports enabled and mapped to the host deprecated: false hidden: false experimental: false @@ -226,7 +226,7 @@ options: shorthand: t value_type: bool default_value: "true" - description: Allocate a pseudo-TTY. + description: Allocate a pseudo-TTY deprecated: false hidden: true experimental: false @@ -237,7 +237,7 @@ options: value_type: bool default_value: "false" description: | - Use the service's network useAliases in the network(s) the container connects to. + Use the service's network useAliases in the network(s) the container connects to deprecated: false hidden: false experimental: false @@ -258,7 +258,7 @@ options: shorthand: v value_type: stringArray default_value: '[]' - description: Bind mount a volume. + description: Bind mount a volume deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml index 9391441f261..f840a51b4e1 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml @@ -8,7 +8,7 @@ options: - option: no-deps value_type: bool default_value: "false" - description: Don't start linked services. + description: Don't start linked services deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml index 9a7fa379bee..902b688d3e7 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml @@ -1,6 +1,6 @@ command: docker compose start short: Start services -long: Starts existing containers for a service. +long: Starts existing containers for a service usage: docker compose start [SERVICE...] pname: docker compose plink: docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml index 7d87f7ccab3..17cdf7e3818 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml @@ -1,6 +1,6 @@ command: docker compose top short: Display the running processes -long: Displays the running processes. +long: Displays the running processes usage: docker compose top [SERVICES...] pname: docker compose plink: docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml index 2679f53f699..e2047720b8f 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml @@ -1,6 +1,6 @@ command: docker compose unpause short: Unpause services -long: Unpauses paused containers of a service. +long: Unpauses paused containers of a service usage: docker compose unpause [SERVICE...] pname: docker compose plink: docker_compose.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml index 2ee4d199c6e..0ed06a09b2d 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml @@ -59,7 +59,7 @@ options: - option: attach-dependencies value_type: bool default_value: "false" - description: Automatically attach to log output of dependent services. + description: Automatically attach to log output of dependent services deprecated: false hidden: false experimental: false @@ -69,7 +69,7 @@ options: - option: build value_type: bool default_value: "false" - description: Build images before starting containers. + description: Build images before starting containers deprecated: false hidden: false experimental: false @@ -101,7 +101,7 @@ options: value_type: bool default_value: "false" description: | - Recreate containers even if their configuration and image haven't changed. + Recreate containers even if their configuration and image haven't changed deprecated: false hidden: false experimental: false @@ -111,7 +111,7 @@ options: - option: no-attach value_type: stringArray default_value: '[]' - description: Do not attach (stream logs) to the specified services. + description: Do not attach (stream logs) to the specified services deprecated: false hidden: false experimental: false @@ -121,7 +121,7 @@ options: - option: no-build value_type: bool default_value: "false" - description: Don't build an image, even if it's policy. + description: Don't build an image, even if it's policy deprecated: false hidden: false experimental: false @@ -131,7 +131,7 @@ options: - option: no-color value_type: bool default_value: "false" - description: Produce monochrome output. + description: Produce monochrome output deprecated: false hidden: false experimental: false @@ -141,7 +141,7 @@ options: - option: no-deps value_type: bool default_value: "false" - description: Don't start linked services. + description: Don't start linked services deprecated: false hidden: false experimental: false @@ -151,7 +151,7 @@ options: - option: no-log-prefix value_type: bool default_value: "false" - description: Don't print prefix in logs. + description: Don't print prefix in logs deprecated: false hidden: false experimental: false @@ -172,7 +172,7 @@ options: - option: no-start value_type: bool default_value: "false" - description: Don't start the services after creating them. + description: Don't start the services after creating them deprecated: false hidden: false experimental: false @@ -192,7 +192,7 @@ options: - option: quiet-pull value_type: bool default_value: "false" - description: Pull without printing progress information. + description: Pull without printing progress information deprecated: false hidden: false experimental: false @@ -202,7 +202,7 @@ options: - option: remove-orphans value_type: bool default_value: "false" - description: Remove containers for services not defined in the Compose file. + description: Remove containers for services not defined in the Compose file deprecated: false hidden: false experimental: false @@ -214,7 +214,7 @@ options: value_type: bool default_value: "false" description: | - Recreate anonymous volumes instead of retrieving data from the previous containers. + Recreate anonymous volumes instead of retrieving data from the previous containers deprecated: false hidden: false experimental: false @@ -237,7 +237,7 @@ options: value_type: int default_value: "0" description: | - Use this timeout in seconds for container shutdown when attached or when containers are already running. + Use this timeout in seconds for container shutdown when attached or when containers are already running deprecated: false hidden: false experimental: false @@ -247,7 +247,7 @@ options: - option: timestamps value_type: bool default_value: "false" - description: Show timestamps. + description: Show timestamps deprecated: false hidden: false experimental: false @@ -267,7 +267,7 @@ options: - option: wait-timeout value_type: int default_value: "0" - description: Maximum duration to wait for the project to be running|healthy. + description: Maximum duration to wait for the project to be running|healthy deprecated: false hidden: false experimental: false diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml index b06c4b15080..789e94818ea 100644 --- a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml @@ -18,7 +18,7 @@ options: - option: short value_type: bool default_value: "false" - description: Shows only Compose's version number. + description: Shows only Compose's version number deprecated: false hidden: false experimental: false diff --git a/_vendor/modules.txt b/_vendor/modules.txt index f3465157a9e..b496461ff26 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,6 +1,6 @@ # github.com/moby/moby v25.0.3-0.20240203133757-341a7978a541+incompatible # github.com/moby/buildkit v0.13.0-beta3.0.20240201135300-d906167d0b34 -# github.com/docker/buildx v0.12.2-0.20240126114058-d43cf8c2c6b4 +# github.com/docker/buildx v0.12.2-0.20240220084849-89154c7d3303 # github.com/docker/scout-cli v1.4.1 -# github.com/docker/cli v25.0.1+incompatible -# github.com/docker/compose/v2 v2.24.5 +# github.com/docker/cli v25.0.4-0.20240221083216-f67e569a8fb9+incompatible +# github.com/docker/compose/v2 v2.24.6 diff --git a/assets/js/src/tooltip.js b/assets/js/src/tooltip.js index 6e66dc6f4e1..acb7ecdc7ae 100644 --- a/assets/js/src/tooltip.js +++ b/assets/js/src/tooltip.js @@ -26,7 +26,7 @@ for (const cmd of cmds) { const a = document.createElement("a") a.classList.add("underline","underline-offset-4","decoration-dashed","cursor-pointer") a.title = `Learn more about the ${name} instruction` - a.href = `/engine/reference/builder/#${name.toLowerCase()}` + a.href = `/reference/dockerfile/#${name.toLowerCase()}` a.innerHTML = cmd.outerHTML cmd.insertAdjacentElement("beforebegin", a) cmd.remove() diff --git a/content/build/attestations/sbom.md b/content/build/attestations/sbom.md index a5cf608183e..20586689e34 100644 --- a/content/build/attestations/sbom.md +++ b/content/build/attestations/sbom.md @@ -173,7 +173,7 @@ sbom.spdx.json ## Inspecting SBOMs To explore created SBOMs exported through the `image` exporter, you can use -[`imagetools inspect`](../../engine/reference/commandline/buildx_imagetools_inspect.md). +[`imagetools inspect`](../../reference/cli/docker/buildx/imagetools/inspect.md). 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 diff --git a/content/build/attestations/slsa-provenance.md b/content/build/attestations/slsa-provenance.md index 15afc63eecf..0de3647f74f 100644 --- a/content/build/attestations/slsa-provenance.md +++ b/content/build/attestations/slsa-provenance.md @@ -141,18 +141,18 @@ detailed information for analysis. > **Warning** > > Note that `mode=max` exposes the values of -> [build arguments](../../engine/reference/commandline/buildx_build.md#build-arg). +> [build arguments](../../reference/cli/docker/buildx/build.md#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](../../engine/reference/commandline/buildx_build.md#secret) instead. +> [secret mounts](../../reference/cli/docker/buildx/build.md#secret) instead. > Secret mounts don't leak outside of the build and are never included in provenance attestations. {.warning} ## Inspecting Provenance To explore created Provenance exported through the `image` exporter, you can -use [`imagetools inspect`](../../engine/reference/commandline/buildx_imagetools_inspect.md). +use [`imagetools inspect`](../../reference/cli/docker/buildx/imagetools/inspect.md). Using the `--format` option, you can specify a template for the output. All provenance-related data is available under the `.Provenance` attribute. For diff --git a/content/build/bake/build-contexts.md b/content/build/bake/build-contexts.md index ed6f5435485..75d8a3eede3 100644 --- a/content/build/bake/build-contexts.md +++ b/content/build/bake/build-contexts.md @@ -11,7 +11,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](../../engine/reference/commandline/buildx_build.md#build-context). +command](../../reference/cli/docker/buildx/build.md#build-context). Inside the Dockerfile these contexts can be used with the `FROM` instruction or `--from` flag. diff --git a/content/build/bake/configuring-build.md b/content/build/bake/configuring-build.md index e16a791ede6..e4a0447ec6f 100644 --- a/content/build/bake/configuring-build.md +++ b/content/build/bake/configuring-build.md @@ -140,7 +140,7 @@ $ docker buildx bake --print foo bar ## From command line You can also override target configurations from the command line with the -[`--set` flag](../../engine/reference/commandline/buildx_bake.md#set): +[`--set` flag](../../reference/cli/docker/buildx/bake.md#set): ```hcl # docker-bake.hcl diff --git a/content/build/builders/manage.md b/content/build/builders/manage.md index 2cfe13e93da..e3b3d6e2037 100644 --- a/content/build/builders/manage.md +++ b/content/build/builders/manage.md @@ -16,7 +16,7 @@ that use other drivers, such as the which runs the BuildKit daemon in a container. Use the -[`docker buildx create`](../../engine/reference/commandline/buildx_create.md) +[`docker buildx create`](../../reference/cli/docker/buildx/create.md) command to create a builder. ```console @@ -100,7 +100,7 @@ Total: 2.01GB ## Remove a builder Use the -[`docker buildx remove`](../../engine/reference/commandline/buildx_create.md) +[`docker buildx remove`](../../reference/cli/docker/buildx/create.md) command to remove a builder. ```console diff --git a/content/build/building/annotations.md b/content/build/building/annotations.md index 8bcd22a6aab..752edf9032d 100644 --- a/content/build/building/annotations.md +++ b/content/build/building/annotations.md @@ -66,7 +66,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](../../engine/reference/commandline/buildx_imagetools_create.md#annotations). +[CLI reference](../../reference/cli/docker/buildx/imagetools/create.md#annotations). ## Inspect annotations @@ -177,9 +177,9 @@ Related articles: Reference information: -- [`docker buildx build --annotation`](../../engine/reference/commandline/buildx_build.md#annotation) +- [`docker buildx build --annotation`](../../reference/cli/docker/buildx/build.md#annotation) - [Bake file reference: `annotations`](../bake/reference.md#targetannotations) -- [`docker buildx imagetools create --annotation`](../../engine/reference/commandline/buildx_imagetools_create.md#annotation) +- [`docker buildx imagetools create --annotation`](../../reference/cli/docker/buildx/imagetools/create.md#annotation) diff --git a/content/build/building/base-images.md b/content/build/building/base-images.md index 683a041f49d..752045b2428 100644 --- a/content/build/building/base-images.md +++ b/content/build/building/base-images.md @@ -108,7 +108,7 @@ If you want to test it out, you can clone [the image repo](https://github.com/do There are lots of resources available to help you write your `Dockerfile`. -* There's a [complete guide to all the instructions](../../engine/reference/builder.md) available for use in a `Dockerfile` in the reference section. +* There's a [complete guide to all the instructions](../../reference/dockerfile.md) available for use in a `Dockerfile` in the reference section. * To help you write a clear, readable, maintainable `Dockerfile`, we've also written a [Dockerfile best practices guide](../../develop/develop-images/dockerfile_best-practices.md). * If your goal is to create a new Docker Official Image, read [Docker Official Images](../../trusted-content/official-images.md). diff --git a/content/build/building/context.md b/content/build/building/context.md index 586f82bbbe9..3cabf3b7bd0 100644 --- a/content/build/building/context.md +++ b/content/build/building/context.md @@ -5,7 +5,7 @@ keywords: build, buildx, buildkit, context, git, tarball, stdin --- The `docker build` and `docker buildx build` commands build Docker images from -a [Dockerfile](../../engine/reference/builder.md) and a context. +a [Dockerfile](../../reference/dockerfile.md) and a context. ## What is a build context? @@ -235,7 +235,7 @@ contexts: By default, BuildKit doesn't keep the `.git` directory when using Git contexts. You can configure BuildKit to keep the directory by setting the -[`BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument](../../engine/reference/builder.md#buildkit-built-in-build-args). +[`BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument](../../reference/dockerfile.md#buildkit-built-in-build-args). This can be useful to if you want to retrieve Git information during your build: ```dockerfile @@ -261,7 +261,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](../../engine/reference/commandline/buildx_build.md#ssh). +[`--ssh` flag](../../reference/cli/docker/buildx/build.md#ssh). ```console $ docker buildx build --ssh default git@github.com:user/private.git @@ -269,7 +269,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](../../engine/reference/commandline/buildx_build.md#secret). +[`--secret` flag](../../reference/cli/docker/buildx/build.md#secret). ```console $ GIT_AUTH_TOKEN= docker buildx build \ diff --git a/content/build/building/multi-platform.md b/content/build/building/multi-platform.md index f4559ac39dd..8466e8fc7c6 100644 --- a/content/build/building/multi-platform.md +++ b/content/build/building/multi-platform.md @@ -148,7 +148,7 @@ COPY --from=build /log /log ## Getting started -Run the [`docker buildx ls` command](../../engine/reference/commandline/buildx_ls.md) +Run the [`docker buildx ls` command](../../reference/cli/docker/buildx/ls.md) to list the existing builders: ```console @@ -235,7 +235,7 @@ $ docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t * The `--push` flag generates a multi-arch manifest and pushes all the images > to Docker Hub. -Inspect the image using [`docker buildx imagetools` command](../../engine/reference/commandline/buildx_imagetools.md): +Inspect the image using [`docker buildx imagetools` command](../../reference/cli/docker/buildx/imagetools/_index.md): ```console $ docker buildx imagetools inspect /:latest diff --git a/content/build/building/opentelemetry.md b/content/build/building/opentelemetry.md index 26f522cb0d2..431b2184715 100644 --- a/content/build/building/opentelemetry.md +++ b/content/build/building/opentelemetry.md @@ -27,7 +27,7 @@ $ docker buildx create --use \ --driver-opt "env.JAEGER_TRACE=localhost:6831" ``` -Boot and [inspect `mybuilder`](../../engine/reference/commandline/buildx_inspect.md): +Boot and [inspect `mybuilder`](../../reference/cli/docker/buildx/inspect.md): ```console $ docker buildx inspect --bootstrap diff --git a/content/build/building/packaging.md b/content/build/building/packaging.md index ec3e80a495d..6b3fc457cf2 100644 --- a/content/build/building/packaging.md +++ b/content/build/building/packaging.md @@ -12,17 +12,17 @@ It all starts with a Dockerfile. Docker builds images by reading the instructions from a Dockerfile. A Dockerfile is a text file containing instructions for building your source code. The Dockerfile instruction syntax is defined by the specification -reference in the [Dockerfile reference](../../engine/reference/builder.md). +reference in the [Dockerfile reference](../../reference/dockerfile.md). Here are the most common types of instructions: | Instruction | Description | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`FROM `](../../engine/reference/builder.md#from) | Defines a base for your image. | -| [`RUN `](../../engine/reference/builder.md#run) | Executes any commands in a new layer on top of the current image and commits the result. `RUN` also has a shell form for running commands. | -| [`WORKDIR `](../../engine/reference/builder.md#workdir) | Sets the working directory for any `RUN`, `CMD`, `ENTRYPOINT`, `COPY`, and `ADD` instructions that follow it in the Dockerfile. | -| [`COPY `](../../engine/reference/builder.md#copy) | Copies new files or directories from `` and adds them to the filesystem of the container at the path ``. | -| [`CMD `](../../engine/reference/builder.md#cmd) | Lets you define the default program that is run once you start the container based on this image. Each Dockerfile only has one `CMD`, and only the last `CMD` instance is respected when multiple exist. | +| [`FROM `](../../reference/dockerfile.md#from) | Defines a base for your image. | +| [`RUN `](../../reference/dockerfile.md#run) | Executes any commands in a new layer on top of the current image and commits the result. `RUN` also has a shell form for running commands. | +| [`WORKDIR `](../../reference/dockerfile.md#workdir) | Sets the working directory for any `RUN`, `CMD`, `ENTRYPOINT`, `COPY`, and `ADD` instructions that follow it in the Dockerfile. | +| [`COPY `](../../reference/dockerfile.md#copy) | Copies new files or directories from `` and adds them to the filesystem of the container at the path ``. | +| [`CMD `](../../reference/dockerfile.md#cmd) | Lets you define the default program that is run once you start the container based on this image. Each Dockerfile only has one `CMD`, and only the last `CMD` instance is respected when multiple exist. | Dockerfiles are crucial inputs for image builds and can facilitate automated, multi-layer image builds based on your unique configurations. Dockerfiles can @@ -38,7 +38,7 @@ Some projects may need distinct Dockerfiles for specific purposes. A common convention is to name these `.Dockerfile`. You can specify the Dockerfile filename using the `--file` flag for the `docker build` command. Refer to the -[`docker build` CLI reference](../../engine/reference/commandline/image_build.md#file) +[`docker build` CLI reference](../../reference/cli/docker/image/build.md#file) to learn about the `--file` flag. > **Note** @@ -109,11 +109,11 @@ Here's a breakdown of what this Dockerfile does: ### Dockerfile syntax -The first line to add to a Dockerfile is a [`# syntax` parser directive](../../engine/reference/builder.md#syntax). +The first line to add to a Dockerfile is a [`# syntax` parser directive](../../reference/dockerfile.md#syntax). While optional, this directive instructs the Docker builder what syntax to use when parsing the Dockerfile, and allows older Docker versions with [BuildKit enabled](../buildkit/index.md#getting-started) to use a specific [Dockerfile frontend](../dockerfile/frontend.md) before -starting the build. [Parser directives](../../engine/reference/builder.md/#parser-directives) +starting the build. [Parser directives](../../reference/dockerfile.md#parser-directives) must appear before any other comment, whitespace, or Dockerfile instruction in your Dockerfile, and should be the first line in Dockerfiles. @@ -136,7 +136,7 @@ The line following the syntax directive defines what base image to use: FROM ubuntu:22.04 ``` -The [`FROM` instruction](../../engine/reference/builder.md#from) sets your base +The [`FROM` instruction](../../reference/dockerfile.md#from) sets your base image to the 22.04 release of Ubuntu. All instructions that follow are executed in this base image: an Ubuntu environment. The notation `ubuntu:22.04`, follows the `name:tag` standard for naming Docker images. When you build images, you @@ -156,7 +156,7 @@ The following line executes a build command inside the base image. RUN apt-get update && apt-get install -y python3 python3-pip ``` -This [`RUN` instruction](../../engine/reference/builder.md#run) executes a +This [`RUN` instruction](../../reference/dockerfile.md#run) executes a shell in Ubuntu that updates the APT package index and installs Python tools in the container. @@ -191,7 +191,7 @@ use the command to install the flask web framework. ### Copying files The next instruction uses the -[`COPY` instruction](../../engine/reference/builder.md#copy) to copy the +[`COPY` instruction](../../reference/dockerfile.md#copy) to copy the `hello.py` file from the local build context into the root directory of our image. ```dockerfile @@ -207,7 +207,7 @@ of the build container. ### Setting environment variables If your application uses environment variables, you can set environment variables -in your Docker build using the [`ENV` instruction](../../engine/reference/builder.md#env). +in your Docker build using the [`ENV` instruction](../../reference/dockerfile.md#env). ```dockerfile ENV FLASK_APP=hello @@ -219,7 +219,7 @@ flask wouldn't know where to find our application to be able to run it. ### Exposed ports -The [`EXPOSE` instruction](../../engine/reference/builder.md#expose) marks that +The [`EXPOSE` instruction](../../reference/dockerfile.md#expose) marks that our final image has a service listening on port `8000`. ```dockerfile @@ -231,7 +231,7 @@ team members understand what this application is doing. ### Starting the application -Finally, [`CMD` instruction](../../engine/reference/builder.md#cmd) sets the +Finally, [`CMD` instruction](../../reference/dockerfile.md#cmd) sets the command that is run when the user starts a container based on this image. ```dockerfile @@ -249,7 +249,7 @@ CMD flask run --host 0.0.0.0 --port 8000 There are subtle differences between these two versions, for example in how they trap signals like `SIGTERM` and `SIGKILL`. For more information about these differences, see -[Shell and exec form](../../engine/reference/builder.md#shell-and-exec-form) +[Shell and exec form](../../reference/dockerfile.md#shell-and-exec-form) ## Building diff --git a/content/build/building/secrets.md b/content/build/building/secrets.md index 131e0eede54..b05f5986a47 100644 --- a/content/build/building/secrets.md +++ b/content/build/building/secrets.md @@ -15,7 +15,7 @@ secret mounts or SSH mounts, which expose secrets to your builds securely. Secret mounts expose secrets to the build containers as files. You [mount the secrets to the `RUN` -instructions](../../engine/reference/builder.md#run---mounttypesecret) that +instructions](../../reference/dockerfile.md#run---mounttypesecret) that need to access them, similar to how you would define a bind mount or cache mount. @@ -25,7 +25,7 @@ RUN --mount=type=secret,id=mytoken \ ``` To pass a secret to a build, use the [`docker build --secret` -flag](../../engine/reference/commandline/buildx_build.md#secret), or the +flag](../../reference/cli/docker/buildx/build.md#secret), or the equivalent options for [Bake](../bake/reference.md#targetsecret). {{< tabs >}} @@ -56,8 +56,8 @@ target "default" { ### Sources The source of a secret can be either a -[file](../../engine/reference/commandline/buildx_build.md#file) or an -[environment variable](../../engine/reference/commandline/buildx_build.md#env). +[file](../../reference/cli/docker/buildx/build.md#file) or an +[environment variable](../../reference/cli/docker/buildx/build.md#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`. @@ -98,7 +98,7 @@ you can use the SSH mount instead of a secret mount. Cloning private Git repositories is a common use case for SSH mounts. The following example clones a private GitHub repository using a [Dockerfile -SSH mount](../../engine/reference/builder.md#run---mounttypessh). +SSH mount](../../reference/dockerfile.md#run---mounttypessh). ```dockerfile # syntax=docker/dockerfile:1 @@ -107,7 +107,7 @@ ADD git@github.com:me/myprivaterepo.git /src/ ``` To pass an SSH socket the build, you use the [`docker build --ssh` -flag](../../engine/reference/commandline/buildx_build.md#ssh), or equivalent +flag](../../reference/cli/docker/buildx/build.md#ssh), or equivalent options for [Bake](../bake/reference.md#targetssh). ```console diff --git a/content/build/building/variables.md b/content/build/building/variables.md index a558b1d9901..03a6a871677 100644 --- a/content/build/building/variables.md +++ b/content/build/building/variables.md @@ -116,8 +116,8 @@ $ docker build --build-arg NODE_VERSION=current . For more information on how to use build arguments, refer to: -- [`ARG` Dockerfile reference](../../engine/reference/commandline/builder.md#arg) -- [`docker build --build-arg` reference](../../engine/reference/commandline/image_build.md#build-arg) +- [`ARG` Dockerfile reference](../../reference/dockerfile.md#arg) +- [`docker build --build-arg` reference](../../reference/cli/docker/image/build.md#build-arg) ## `ENV` usage example @@ -167,7 +167,7 @@ using them can lead to unintended side-effects for the application's runtime. For more information on how to use environment variables in builds, refer to: -- [`ENV` Dockerfile reference](../../engine/reference/commandline/builder.md#env) +- [`ENV` Dockerfile reference](../../reference/dockerfile.md#env) ## Scoping @@ -264,7 +264,7 @@ RUN GOOS=$TARGETOS go build -o ./exe . ``` For more information about multi-platform build arguments, refer to -[Multi-platform arguments](/engine/reference/builder/#automatic-platform-args-in-the-global-scope) +[Multi-platform arguments](../../reference/dockerfile.md#automatic-platform-args-in-the-global-scope) ### Proxy arguments @@ -293,7 +293,7 @@ $ docker build --build-arg HTTP_PROXY=https://my-proxy.example.com . ``` For more information about proxy build arguments, refer to -[Proxy arguments](/engine/reference/builder/#predefined-args). +[Proxy arguments](../../reference/dockerfile.md#predefined-args). ## Build tool configuration variables @@ -319,7 +319,7 @@ They're used to configure the Buildx client, or the BuildKit daemon. | [EXPERIMENTAL_BUILDKIT_SOURCE_POLICY](#experimental_buildkit_source_policy) | String | Specify a BuildKit source policy file. | BuildKit also supports a few additional configuration parameters. Refer to -[BuildKit built-in build args](../../engine/reference/builder.md#buildkit-built-in-build-args). +[BuildKit built-in build args](../../reference/dockerfile.md#buildkit-built-in-build-args). You can express Boolean values for environment variables in different ways. For example, `true`, `1`, and `T` all evaluate to true. diff --git a/content/build/buildkit/_index.md b/content/build/buildkit/_index.md index 91241183d24..e2ac7105c23 100644 --- a/content/build/buildkit/_index.md +++ b/content/build/buildkit/_index.md @@ -65,7 +65,7 @@ it to LLB so BuildKit can execute it. Frontends can be distributed as images, and the user can target a specific version of a frontend that is guaranteed to work for the features used by their definition. -For example, to build a [Dockerfile](../../engine/reference/builder.md) with +For example, to build a [Dockerfile](../../reference/dockerfile.md) with BuildKit, you would [use an external Dockerfile frontend](../dockerfile/frontend.md). diff --git a/content/build/buildkit/configure.md b/content/build/buildkit/configure.md index 3c0967d7ff7..88ee8c909a3 100644 --- a/content/build/buildkit/configure.md +++ b/content/build/buildkit/configure.md @@ -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 -[`--config` flag](../../engine/reference/commandline/buildx_create.md#config) to +[`--config` flag](../../reference/cli/docker/buildx/create.md#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](../../engine/reference/commandline/buildx_create.md#driver-opt): +[the `--driver-opt image` option](../../reference/cli/docker/buildx/create.md#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 [`--config` flags](../../engine/reference/commandline/buildx_create.md#config). +while creating a builder with the [`--config` flags](../../reference/cli/docker/buildx/create.md#config). ```toml # /etc/buildkitd.toml diff --git a/content/build/cache/_index.md b/content/build/cache/_index.md index ac2abe6d750..8791771b012 100644 --- a/content/build/cache/_index.md +++ b/content/build/cache/_index.md @@ -58,7 +58,7 @@ anything differently, they still need to re-run. > the image on the same host one week later will still get you the same packages > as before. The only way to force a rebuild is by making sure that a layer > before it has changed, or by clearing the build cache using -> [`docker builder prune`](../../engine/reference/commandline/builder_prune/). +> [`docker builder prune`](../../reference/cli/docker/builder/prune.md). ## How can I use the cache efficiently? diff --git a/content/build/cache/backends/_index.md b/content/build/cache/backends/_index.md index 2400672b2de..f0b4915f226 100644 --- a/content/build/cache/backends/_index.md +++ b/content/build/cache/backends/_index.md @@ -25,7 +25,7 @@ Other cache backends require you to select a different > > If you use secrets or credentials inside your build process, ensure you > manipulate them using the dedicated -> [`--secret` option](../../../engine/reference/commandline/buildx_build/#secret). +> [`--secret` option](../../../reference/cli/docker/buildx/build.md#secret). > Manually managing secrets using `COPY` or `ARG` could result in leaked > credentials. { .warning } @@ -57,9 +57,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](../../../engine/reference/commandline/buildx_build/#cache-to) +[`--cache-to` option](../../../reference/cli/docker/buildx/build.md#cache-to) to export the cache to your storage backend of choice. Then, use the -[`--cache-from` option](../../../engine/reference/commandline/buildx_build/#cache-from) +[`--cache-from` option](../../../reference/cli/docker/buildx/build.md#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. diff --git a/content/build/cache/garbage-collection.md b/content/build/cache/garbage-collection.md index f18bdb01179..bb5ad29934a 100644 --- a/content/build/cache/garbage-collection.md +++ b/content/build/cache/garbage-collection.md @@ -6,8 +6,8 @@ aliases: - /build/building/cache/garbage-collection/ --- -While [`docker builder prune`](../../engine/reference/commandline/builder_prune.md) -or [`docker buildx prune`](../../engine/reference/commandline/buildx_prune.md) +While [`docker builder prune`](../../reference/cli/docker/builder/prune.md) +or [`docker buildx prune`](../../reference/cli/docker/buildx/prune.md) commands run at once, garbage collection runs periodically and follows an ordered list of prune policies. @@ -22,7 +22,7 @@ Depending on the [driver](../drivers/index.md) used by your builder instance, the garbage collection will use a different configuration file. If you're using the [`docker` driver](../drivers/docker.md), garbage collection -can be configured in the [Docker Daemon configuration](../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +can be configured in the [Docker Daemon configuration](../../reference/cli/dockerd.md#daemon-configuration-file). file: ```json diff --git a/content/build/ci/github-actions/attestations.md b/content/build/ci/github-actions/attestations.md index 225a5abacc6..f431cea3239 100644 --- a/content/build/ci/github-actions/attestations.md +++ b/content/build/ci/github-actions/attestations.md @@ -33,7 +33,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](../../../engine/reference/commandline/buildx_build.md#secret) +> [secret mounts](../../../reference/cli/docker/buildx/build.md#secret) > instead. Also remember to rotate any secrets you may have exposed. { .warning } diff --git a/content/build/ci/github-actions/configure-builder.md b/content/build/ci/github-actions/configure-builder.md index 7ffa029cdbd..b72ff419217 100644 --- a/content/build/ci/github-actions/configure-builder.md +++ b/content/build/ci/github-actions/configure-builder.md @@ -146,11 +146,11 @@ fields: | Name | Type | Description | | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | String | [Name of the node](../../../engine/reference/commandline/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](../../../engine/reference/commandline/buildx_create.md#description) of the node to add to the builder | -| `driver-opts` | List | List of additional [driver-specific options](../../../engine/reference/commandline/buildx_create.md#driver-opt) | -| `buildkitd-flags` | String | [Flags for buildkitd](../../../engine/reference/commandline/buildx_create.md#buildkitd-flags) daemon | -| `platforms` | String | Fixed [platforms](../../../engine/reference/commandline/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.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. | Here is an example using remote nodes with the [`remote` driver](../../drivers/remote.md) and [TLS authentication](#tls-authentication): diff --git a/content/build/ci/github-actions/copy-image-registries.md b/content/build/ci/github-actions/copy-image-registries.md index 28511be10d9..409b809c917 100644 --- a/content/build/ci/github-actions/copy-image-registries.md +++ b/content/build/ci/github-actions/copy-image-registries.md @@ -5,7 +5,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](../../../engine/reference/commandline/buildx_imagetools_create.md): +be copied from one registry to another using the [`buildx imagetools create` command](../../../reference/cli/docker/buildx/imagetools/create.md): ```yaml name: ci diff --git a/content/build/ci/github-actions/multi-platform.md b/content/build/ci/github-actions/multi-platform.md index 8c53a91e9d0..b245991a689 100644 --- a/content/build/ci/github-actions/multi-platform.md +++ b/content/build/ci/github-actions/multi-platform.md @@ -53,7 +53,7 @@ take a long time depending on the number of platforms and your Dockerfile. To solve this issue you can use a matrix strategy to distribute the build for each platform across multiple runners and create manifest list using the -[`buildx imagetools create` command](../../../engine/reference/commandline/buildx_imagetools_create.md). +[`buildx imagetools create` command](../../../reference/cli/docker/buildx/imagetools/create.md). 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 diff --git a/content/build/ci/github-actions/named-contexts.md b/content/build/ci/github-actions/named-contexts.md index 749d9e75e58..070213d4075 100644 --- a/content/build/ci/github-actions/named-contexts.md +++ b/content/build/ci/github-actions/named-contexts.md @@ -4,7 +4,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](../../../engine/reference/commandline/buildx_build.md#build-context), +You can define [additional build contexts](../../../reference/cli/docker/buildx/build.md#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. diff --git a/content/build/cloud/optimization.md b/content/build/cloud/optimization.md index b5e05f45c58..9ecb7e0f59f 100644 --- a/content/build/cloud/optimization.md +++ b/content/build/cloud/optimization.md @@ -80,7 +80,7 @@ Docker Build Cloud server directly is better, because it will likely be faster than transferring the files with the build context. You can fetch remote files during the build using the -[Dockerfile `ADD` instruction](/engine/reference/builder/#add), +[Dockerfile `ADD` instruction](/reference/dockerfile/#add), or in your `RUN` instructions with tools like `wget` and `rsync`. ### Multi-threaded tools diff --git a/content/build/cloud/usage.md b/content/build/cloud/usage.md index 91d85203226..d3033fd7d0f 100644 --- a/content/build/cloud/usage.md +++ b/content/build/cloud/usage.md @@ -142,15 +142,15 @@ 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](../../engine/reference/commandline/buildx_build.md#secret) instead. +> [secret mounts](../../reference/cli/docker/buildx/build.md#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. {.warning} For more information, refer to: -- [`docker buildx build --secret`](/engine/reference/commandline/buildx_build/#secret) -- [`docker buildx build --ssh`](/engine/reference/commandline/buildx_build/#ssh) +- [`docker buildx build --secret`](/reference/cli/docker/buildx/build/#secret) +- [`docker buildx build --ssh`](/reference/cli/docker/buildx/build/#ssh) ## Managing build cache @@ -159,10 +159,10 @@ The system manages it for you through [garbage collection](/build/cache/garbage- Old cache is automatically removed if you hit your storage limit. You can check your current cache state using the -[`docker buildx du` command](/engine/reference/commandline/buildx_du/). +[`docker buildx du` command](/reference/cli/docker/buildx/du/). To clear the builder's cache manually, -use the [`docker buildx prune` command](/engine/reference/commandline/buildx_prune/). +use the [`docker buildx prune` command](/reference/cli/docker/buildx/prune/). This works like pruning the cache for any other builder. > **Warning** diff --git a/content/build/dockerfile/frontend.md b/content/build/dockerfile/frontend.md index ee284aa4bff..4d6f001f76d 100644 --- a/content/build/dockerfile/frontend.md +++ b/content/build/dockerfile/frontend.md @@ -9,8 +9,8 @@ aliases: ## Dockerfile frontend BuildKit supports loading frontends dynamically from container images. To use -an external Dockerfile frontend, the first line of your [Dockerfile](../../engine/reference/builder.md) -needs to set the [`syntax` directive](../../engine/reference/builder.md#syntax) +an external Dockerfile frontend, the first line of your [Dockerfile](../../reference/dockerfile.md) +needs to set the [`syntax` directive](../../reference/dockerfile.md#syntax) pointing to the specific image you want to use: ```dockerfile diff --git a/content/build/dockerfile/release-notes.md b/content/build/dockerfile/release-notes.md index 62be818eff7..077be3c860f 100644 --- a/content/build/dockerfile/release-notes.md +++ b/content/build/dockerfile/release-notes.md @@ -6,7 +6,7 @@ toc_max: 2 --- This page contains information about the new features, improvements, known -issues, and bug fixes in [Dockerfile reference](../../engine/reference/builder.md). +issues, and bug fixes in [Dockerfile reference](../../reference/dockerfile.md). For usage, see the [Dockerfile frontend syntax](frontend.md) page. @@ -17,12 +17,12 @@ For usage, see the [Dockerfile frontend syntax](frontend.md) page. ### New - Add `--start-interval` flag to the - [`HEALTHCHECK` instruction](../../engine/reference/builder.md#healthcheck). + [`HEALTHCHECK` instruction](../../reference/dockerfile.md#healthcheck). The following features have graduated from the labs channel to stable: -- The `ADD` instruction can now [import files directly from Git URLs](../../engine/reference/builder.md#adding-a-git-repository-add-git-ref-dir) -- The `ADD` instruction now supports [`--checksum` flag](../../engine/reference/builder.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) +- The `ADD` instruction can now [import files directly from Git URLs](../../reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) +- The `ADD` instruction now supports [`--checksum` flag](../../reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) to validate the contents of the remote URL contents ### Bug fixes and enhancements @@ -60,7 +60,7 @@ The following features have graduated from the labs channel to stable: ### New -- `ADD` command now supports [`--checksum` flag](../../engine/reference/builder.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) +- `ADD` command now supports [`--checksum` flag](../../reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) to validate the contents of the remote URL contents ## 1.5.0 @@ -69,7 +69,7 @@ The following features have graduated from the labs channel to stable: ### New -- `ADD` command can now [import files directly from Git URLs](../../engine/reference/builder.md#adding-a-git-repository-add-git-ref-dir) +- `ADD` command can now [import files directly from Git URLs](../../reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) ### Bug fixes and enhancements @@ -119,17 +119,17 @@ The following features have graduated from the labs channel to stable: ### New -- [`COPY --link` and `ADD --link`](../../engine/reference/builder.md#copy---link) +- [`COPY --link` and `ADD --link`](../../reference/dockerfile.md#copy---link) allow copying files with increased cache efficiency and rebase images without requiring them to be rebuilt. `--link` copies files to a separate layer and then uses new LLB MergeOp implementation to chain independent layers together -- [Heredocs](../../engine/reference/builder.md#here-documents) support have +- [Heredocs](../../reference/dockerfile.md#here-documents) support have been promoted from labs channel to stable. This feature allows writing multiline inline scripts and files -- Additional [named build contexts](../../engine/reference/commandline/buildx_build.md#build-context) +- Additional [named build contexts](../../reference/cli/docker/buildx/build.md#build-context) can be passed to build to add or overwrite a stage or an image inside the build. A source for the context can be a local source, image, Git, or HTTP URL -- [`BUILDKIT_SANDBOX_HOSTNAME` build-arg](../../engine/reference/builder.md#buildkit-built-in-build-args) +- [`BUILDKIT_SANDBOX_HOSTNAME` build-arg](../../reference/dockerfile.md#buildkit-built-in-build-args) can be used to set the default hostname for the `RUN` steps ### Bug fixes and enhancements @@ -154,7 +154,7 @@ The following features have graduated from the labs channel to stable: ### New -- `RUN` and `COPY` commands now support [Here-document syntax](../../engine/reference/builder.md#here-documents) +- `RUN` and `COPY` commands now support [Here-document syntax](../../reference/dockerfile.md#here-documents) allowing writing multiline inline scripts and files ## 1.3.0 @@ -163,7 +163,7 @@ The following features have graduated from the labs channel to stable: ### New -- `RUN` command allows [`--network` flag](../../engine/reference/builder.md#run---network) +- `RUN` command allows [`--network` flag](../../reference/dockerfile.md#run---network) for requesting a specific type of network conditions. `--network=host` requires allowing `network.host` entitlement. This feature was previously only available on labs channel @@ -171,9 +171,9 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements - `ADD` command with a remote URL input now correctly handles the `--chmod` flag -- Values for [`RUN --mount` flag](../../engine/reference/builder.md#run---mount) +- Values for [`RUN --mount` flag](../../reference/dockerfile.md#run---mount) now support variable expansion, except for the `from` field -- Allow [`BUILDKIT_MULTI_PLATFORM` build arg](../../engine/reference/builder.md#buildkit-built-in-build-args) +- Allow [`BUILDKIT_MULTI_PLATFORM` build arg](../../reference/dockerfile.md#buildkit-built-in-build-args) to force always creating multi-platform image, even if only contains single platform @@ -185,7 +185,7 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements -- `RUN` command allows [`--network` flag](../../engine/reference/builder.md#run---network) +- `RUN` command allows [`--network` flag](../../reference/dockerfile.md#run---network) for requesting a specific type of network conditions. `--network=host` requires allowing `network.host` entitlement @@ -214,10 +214,10 @@ The following features have graduated from the labs channel to stable: ### New -- [`RUN --mount` syntax](../../engine/reference/builder.md#run---mount) for +- [`RUN --mount` syntax](../../reference/dockerfile.md#run---mount) for creating secret, ssh, bind, and cache mounts have been moved to mainline channel -- [`ARG` command](../../engine/reference/builder.md#arg) now supports defining +- [`ARG` command](../../reference/dockerfile.md#arg) now supports defining multiple build args on the same line similarly to `ENV` ### Bug fixes and enhancements @@ -244,10 +244,10 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements - Allow setting security mode for a process with `RUN --security=sandbox|insecure` -- Allow setting uid/gid for [cache mounts](../../engine/reference/builder.md#run---mounttypecache) +- Allow setting uid/gid for [cache mounts](../../reference/dockerfile.md#run---mounttypecache) - Avoid requesting internally linked paths to be pulled to build context - Ensure missing cache IDs default to target paths -- Allow setting namespace for cache mounts with [`BUILDKIT_CACHE_MOUNT_NS` build arg](../../engine/reference/builder.md#buildkit-built-in-build-args) +- Allow setting namespace for cache mounts with [`BUILDKIT_CACHE_MOUNT_NS` build arg](../../reference/dockerfile.md#buildkit-built-in-build-args) ## 1.1.2 diff --git a/content/build/drivers/docker-container.md b/content/build/drivers/docker-container.md index 1705c1fb126..e3583623fe2 100644 --- a/content/build/drivers/docker-container.md +++ b/content/build/drivers/docker-container.md @@ -155,14 +155,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](../../engine/reference/commandline/network_create.md) +For example, let's [create a network](../../reference/cli/docker/network/create.md) named `foonet`: ```console $ docker network create foonet ``` -Now create a [`docker-container` builder](../../engine/reference/commandline/buildx_create.md) +Now create a [`docker-container` builder](../../reference/cli/docker/buildx/create.md) that will use this network: ```console @@ -172,13 +172,13 @@ $ docker buildx create --use \ --driver-opt "network=foonet" ``` -Boot and [inspect `mybuilder`](../../engine/reference/commandline/buildx_inspect.md): +Boot and [inspect `mybuilder`](../../reference/cli/docker/buildx/inspect.md): ```console $ docker buildx inspect --bootstrap ``` -[Inspect the builder container](../../engine/reference/commandline/inspect.md) +[Inspect the builder container](../../reference/cli/docker/inspect.md) and see what network is being used: ```console @@ -189,4 +189,4 @@ map[foonet:0xc00018c0c0] ## Further reading For more information on the Docker container driver, see the -[buildx reference](../../engine/reference/commandline/buildx_create.md#driver). +[buildx reference](../../reference/cli/docker/buildx/create.md#driver). diff --git a/content/build/drivers/docker.md b/content/build/drivers/docker.md index db86ba15dc5..117c1f76c3b 100644 --- a/content/build/drivers/docker.md +++ b/content/build/drivers/docker.md @@ -36,4 +36,4 @@ If you need additional configuration and flexibility, consider using the ## Further reading For more information on the Docker driver, see the -[buildx reference](../../engine/reference/commandline/buildx_create.md#driver). +[buildx reference](../../reference/cli/docker/buildx/create.md#driver). diff --git a/content/build/drivers/kubernetes.md b/content/build/drivers/kubernetes.md index 2c418f2e7dc..e799cb96c9d 100644 --- a/content/build/drivers/kubernetes.md +++ b/content/build/drivers/kubernetes.md @@ -103,7 +103,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`](../../engine/reference/commandline/buildx_create.md#driver-opt). +[`docker buildx create`](../../reference/cli/docker/buildx/create.md#driver-opt). ## Node assignment @@ -342,4 +342,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](../../engine/reference/commandline/buildx_create.md#driver). +[buildx reference](../../reference/cli/docker/buildx/create.md#driver). diff --git a/content/build/exporters/_index.md b/content/build/exporters/_index.md index 0d9f926cfd2..13e261f9f0f 100644 --- a/content/build/exporters/_index.md +++ b/content/build/exporters/_index.md @@ -8,7 +8,7 @@ aliases: Exporters save your build results to a specified output type. You specify the exporter to use with the -[`--output` CLI option](../../engine/reference/commandline/buildx_build/#output). +[`--output` CLI option](../../reference/cli/docker/buildx/build.md#output). Buildx supports the following exporters: - `image`: exports the build result to a container image. diff --git a/content/build/guide/build-args.md b/content/build/guide/build-args.md index 445d3f66a7e..0b803b24738 100644 --- a/content/build/guide/build-args.md +++ b/content/build/guide/build-args.md @@ -143,7 +143,7 @@ configurable, and inject values at build-time. Related information: -- [`ARG` Dockerfile reference](../../engine/reference/builder.md#arg) +- [`ARG` Dockerfile reference](../../reference/dockerfile.md#arg) ## Next steps diff --git a/content/build/guide/export.md b/content/build/guide/export.md index 674cf90a83c..e695ef44c42 100644 --- a/content/build/guide/export.md +++ b/content/build/guide/export.md @@ -103,7 +103,7 @@ This is explored later on in this guide. Related information: -- [`docker build --output` CLI reference](../../engine/reference/commandline/image_build.md#output) +- [`docker build --output` CLI reference](../../reference/cli/docker/image/build.md#output) - [Build exporters](../exporters/index.md) ## Next steps diff --git a/content/build/guide/intro.md b/content/build/guide/intro.md index 5a55da8cf41..32ce6f13121 100644 --- a/content/build/guide/intro.md +++ b/content/build/guide/intro.md @@ -67,7 +67,7 @@ Here’s what this Dockerfile does: 1. `# syntax=docker/dockerfile:1` This comment is a - [Dockerfile parser directive](../../engine/reference/builder.md#parser-directives). + [Dockerfile parser directive](../../reference/dockerfile.md#parser-directives). It specifies which version of the Dockerfile syntax to use. This file uses the `dockerfile:1` syntax which is best practice: it ensures that you have access to the latest Docker build features. @@ -159,9 +159,9 @@ container image and created a container from it. Related information: -- [Dockerfile reference](../../engine/reference/builder.md) -- [`docker build` CLI reference](../../engine/reference/commandline/image_build.md) -- [`docker run` CLI reference](../../engine/reference/commandline/container_run.md) +- [Dockerfile reference](../../reference/dockerfile.md) +- [`docker build` CLI reference](../../reference/cli/docker/image/build.md) +- [`docker run` CLI reference](../../reference/cli/docker/container/run.md) ## Next steps diff --git a/content/build/guide/mounts.md b/content/build/guide/mounts.md index d93135f989e..eaceb6bd33c 100644 --- a/content/build/guide/mounts.md +++ b/content/build/guide/mounts.md @@ -214,7 +214,7 @@ mounts. Related information: -- [Dockerfile reference](../../engine/reference/builder.md#run---mount) +- [Dockerfile reference](../../reference/dockerfile.md#run---mount) - [Bind mounts](../../storage/bind-mounts.md) ## Next steps diff --git a/content/build/release-notes.md b/content/build/release-notes.md index 150390a73ac..d351bf7effc 100644 --- a/content/build/release-notes.md +++ b/content/build/release-notes.md @@ -323,7 +323,7 @@ The full release note for this release is available - Bake definition now supports null values for [variables](bake/reference.md#variable) and [labels](bake/reference.md#targetlabels) for build arguments and labels to use the defaults set in the Dockerfile. [docker/buildx#1449](https://github.com/docker/buildx/issues/1449) -- The [`buildx imagetools inspect` command](../engine/reference/commandline/buildx_imagetools_inspect.md) +- The [`buildx imagetools inspect` command](../reference/cli/docker/buildx/imagetools/inspect.md) now supports showing SBOM and Provenance data. [docker/buildx#1444](https://github.com/docker/buildx/issues/1444), [docker/buildx#1498](https://github.com/docker/buildx/issues/1498) @@ -385,7 +385,7 @@ For more details, see the complete release notes in the [Buildx GitHub repositor - You can now load Dockerfile from standard input even when the build context is coming from external Git or HTTP URL. [docker/buildx#994](https://github.com/docker/buildx/issues/994) - Build commands now support new the build context type `oci-layout://` for loading - [build context from local OCI layout directories](../engine/reference/commandline/buildx_build.md#source-oci-layout). + [build context from local OCI layout directories](../reference/cli/docker/buildx/build.md#source-oci-layout). Note that this feature depends on an unreleased BuildKit feature and builder instance from `moby/buildkit:master` needs to be used until BuildKit v0.11 is released. [docker/buildx#1173](https://github.com/docker/buildx/issues/1173) @@ -500,7 +500,7 @@ For more details, see the complete release notes in the [Buildx GitHub repositor ### New -- Build command now accepts `--build-context` flag to [define additional named build contexts](/engine/reference/commandline/buildx_build/#build-context) +- Build command now accepts `--build-context` flag to [define additional named build contexts](/reference/cli/docker/buildx/build/#build-context) for your builds. [docker/buildx#904](https://github.com/docker/buildx/issues/904) - Bake definitions now support [defining dependencies between targets](bake/build-contexts.md) and using the result of one target in another build. diff --git a/content/compose/compose-file/05-services.md b/content/compose/compose-file/05-services.md index 4b4439b3649..6a6daa57f31 100644 --- a/content/compose/compose-file/05-services.md +++ b/content/compose/compose-file/05-services.md @@ -203,7 +203,7 @@ cgroup_parent: m-executor-abcd command: bundle exec thin -p 3000 ``` -The value can also be a list, in a manner similar to [Dockerfile](https://docs.docker.com/engine/reference/builder/#cmd): +The value can also be a list, in a manner similar to [Dockerfile](https://docs.docker.com/reference/dockerfile/#cmd): ```yaml command: [ "bundle", "exec", "thin", "-p", "3000" ] @@ -523,7 +523,7 @@ entrypoint: /code/entrypoint.sh ``` Alternatively, the value can also be a list, in a manner similar to the -[Dockerfile](https://docs.docker.com/engine/reference/builder/#cmd): +[Dockerfile](https://docs.docker.com/reference/dockerfile/#cmd): ```yml entrypoint: @@ -938,7 +938,7 @@ been the case if `group_add` were not declared. ## healthcheck `healthcheck` declares a check that's run to determine whether or not the service containers are "healthy". It works in the same way, and has the same default values, as the -[HEALTHCHECK Dockerfile instruction](https://docs.docker.com/engine/reference/builder/#healthcheck) +[HEALTHCHECK Dockerfile instruction](https://docs.docker.com/reference/dockerfile/#healthcheck) set by the service's Docker image. Your Compose file can override the values set in the Dockerfile. ```yml @@ -1799,4 +1799,4 @@ volumes_from: ## working_dir -`working_dir` overrides the container's working directory which is specified by the image, for example Dockerfile's `WORKDIR`. \ No newline at end of file +`working_dir` overrides the container's working directory which is specified by the image, for example Dockerfile's `WORKDIR`. diff --git a/content/compose/compose-file/compose-file-v2.md b/content/compose/compose-file/compose-file-v2.md index 76b08dabdc6..cd7bfc83760 100644 --- a/content/compose/compose-file/compose-file-v2.md +++ b/content/compose/compose-file/compose-file-v2.md @@ -217,7 +217,7 @@ build: > In your Dockerfile, if you specify `ARG` before the `FROM` instruction, > `ARG` is not available in the build instructions under `FROM`. > If you need an argument to be available in both places, also specify it under -> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../engine/reference/builder.md#understand-how-arg-and-from-interact) +> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../reference/dockerfile.md#understand-how-arg-and-from-interact) > section in the documentation for usage details. You can omit the value when specifying a build argument, in which case its value @@ -273,7 +273,7 @@ An entry with the ip address and hostname is created in `/etc/hosts` inside cont Specify a build’s container isolation technology. On Linux, the only supported value is `default`. On Windows, acceptable values are `default`, `process` and `hyperv`. Refer to the -[Docker Engine docs](../../engine/reference/commandline/container_run.md#isolation) +[Docker Engine docs](../../reference/cli/docker/container/run.md#isolation) for details. If unspecified, Compose will use the `isolation` value found in the service's definition @@ -399,7 +399,7 @@ command: bundle exec thin -p 3000 ``` The command can also be a list, in a manner similar to -[dockerfile](../../engine/reference/builder.md#cmd): +[dockerfile](../../reference/dockerfile.md#cmd): ```yaml command: ["bundle", "exec", "thin", "-p", "3000"] @@ -574,7 +574,7 @@ entrypoint: /code/entrypoint.sh ``` The entrypoint can also be a list, in a manner similar to -[dockerfile](../../engine/reference/builder.md#entrypoint): +[dockerfile](../../reference/dockerfile.md#entrypoint): ```yaml entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"] @@ -778,7 +778,7 @@ host system to be added. An example of where this is useful is when multiple containers (running as different users) need to all read or write the same file on the host system. That file can be owned by a group shared by all the containers, and specified in `group_add`. See the -[Docker documentation](../../engine/reference/commandline/container_run.md#additional-groups) for more +[Docker documentation](../../reference/cli/docker/container/run.md#additional-groups) for more details. A full example: @@ -802,7 +802,7 @@ used. Configure a check that's run to determine whether or not containers for this service are "healthy". See the docs for the -[HEALTHCHECK Dockerfile instruction](../../engine/reference/builder.md#healthcheck) +[HEALTHCHECK Dockerfile instruction](../../reference/dockerfile.md#healthcheck) for details on how healthchecks work. ```yaml @@ -891,7 +891,7 @@ services: > The default init binary that is used is [Tini](https://github.com/krallin/tini), > and is installed in `/usr/libexec/docker-init` on the daemon host. You can > configure the daemon to use a custom init binary through the -> [`init-path` configuration option](../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +> [`init-path` configuration option](../../reference/cli/dockerd.md#daemon-configuration-file). ### isolation @@ -900,7 +900,7 @@ services: Specify a container’s isolation technology. On Linux, the only supported value is `default`. On Windows, acceptable values are `default`, `process` and `hyperv`. Refer to the -[Docker Engine docs](../../engine/reference/commandline/container_run.md#isolation) +[Docker Engine docs](../../reference/cli/docker/container/run.md#isolation) for details. ### labels @@ -1294,7 +1294,7 @@ web: Specify the default number of containers to deploy for this service. Whenever you run `docker-compose up`, Compose creates or removes containers to match the specified number. This value can be overridden using the -[`--scale`](../../engine/reference/commandline/compose_up.md) +[`--scale`](../../reference/cli/docker/compose/up.md) ```yaml web: @@ -1557,7 +1557,7 @@ restart: "unless-stopped" ### cpu_count, cpu_percent, cpu\_shares, cpu\_period, cpu\_quota, cpus, cpuset, domainname, hostname, ipc, mac\_address, mem\_limit, memswap\_limit, mem\_swappiness, mem\_reservation, oom_kill_disable, oom_score_adj, privileged, read\_only, shm\_size, stdin\_open, tty, user, working\_dir Each of these is a single value, analogous to its -[docker run](../../engine/reference/commandline/container_run.md#runtime-constraints-on-resources) counterpart. +[docker run](../../reference/cli/docker/container/run.md#runtime-constraints-on-resources) counterpart. > Added in [version 2.2](compose-versioning.md#version-22) file format. > @@ -1635,7 +1635,7 @@ While it is possible to declare [volumes](#volumes) on the fly as part of the service declaration, this section allows you to create named volumes that can be reused across multiple services (without relying on `volumes_from`), and are easily retrieved and inspected using the docker command line or API. -See the [docker volume](../../engine/reference/commandline/volume_create.md) +See the [docker volume](../../reference/cli/docker/volume/create.md) subcommand documentation for more information. See [use volumes](../../storage/volumes.md) and [volume plugins](/engine/extend/plugins_volume/) diff --git a/content/compose/compose-file/compose-file-v3.md b/content/compose/compose-file/compose-file-v3.md index 29f5a80cbd3..77953ebbf4f 100644 --- a/content/compose/compose-file/compose-file-v3.md +++ b/content/compose/compose-file/compose-file-v3.md @@ -206,7 +206,7 @@ This results in an image named `webapp` and tagged `tag`, built from `./dir`. > Note when using docker stack deploy > > The `build` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) > The `docker stack` command does not build images before deploying. { .important } @@ -280,7 +280,7 @@ build: > In your Dockerfile, if you specify `ARG` before the `FROM` instruction, > `ARG` is not available in the build instructions under `FROM`. > If you need an argument to be available in both places, also specify it under -> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../engine/reference/builder.md#understand-how-arg-and-from-interact) +> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../reference/dockerfile.md#understand-how-arg-and-from-interact) > section in the documentation for usage details. You can omit the value when specifying a build argument, in which case its value @@ -426,7 +426,7 @@ cgroup_parent: m-executor-abcd > Note when using docker stack deploy > > The `cgroup_parent` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) { .important } ### command @@ -438,7 +438,7 @@ command: bundle exec thin -p 3000 ``` The command can also be a list, in a manner similar to -[dockerfile](../../engine/reference/builder.md#cmd): +[dockerfile](../../reference/dockerfile.md#cmd): ```yaml command: ["bundle", "exec", "thin", "-p", "3000"] @@ -555,7 +555,7 @@ an error. > Note when using docker stack deploy > > The `container_name` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) { .important } ### credential_spec @@ -646,7 +646,7 @@ services: > for a service to be ready, see [Controlling startup order](../startup-order.md) > for more on this problem and strategies for solving it. > - The `depends_on` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) > with a version 3 Compose file. ### deploy @@ -655,7 +655,7 @@ services: Specify configuration related to the deployment and running of services. The following sub-options only takes effect when deploying to a [swarm](../../engine/swarm/index.md) with -[docker stack deploy](../../engine/reference/commandline/stack_deploy.md), and is +[docker stack deploy](../../reference/cli/docker/stack/deploy.md), and is ignored by `docker-compose up` and `docker-compose run`, except for `resources`. ```yaml @@ -730,7 +730,7 @@ networks: ``` The options for `endpoint_mode` also work as flags on the swarm mode CLI command -[docker service create](../../engine/reference/commandline/service_create.md). For a +[docker service create](../../reference/cli/docker/service/create.md). For a quick list of all swarm related `docker` commands, see [Swarm mode CLI commands](../../engine/swarm/index.md#swarm-mode-key-concepts-and-tutorial). @@ -786,9 +786,9 @@ services: Specify placement of constraints and preferences. See the docker service create documentation for a full description of the syntax and available types of -[constraints](../../engine/reference/commandline/service_create.md#constraint), -[preferences](../../engine/reference/commandline/service_create.md#placement-pref), -and [specifying the maximum replicas per node](../../engine/reference/commandline/service_create.md#replicas-max-per-node) +[constraints](../../reference/cli/docker/service/create.md#constraint), +[preferences](../../reference/cli/docker/service/create.md#placement-pref), +and [specifying the maximum replicas per node](../../reference/cli/docker/service/create.md#replicas-max-per-node) ```yaml version: "{{% param "compose_file_v3" %}}" @@ -808,7 +808,7 @@ services: > Added in [version 3.8](compose-versioning.md#version-38) file format. -If the service is `replicated` (which is the default), [limit the number of replicas](../../engine/reference/commandline/service_create.md#replicas-max-per-node) +If the service is `replicated` (which is the default), [limit the number of replicas](../../reference/cli/docker/service/create.md#replicas-max-per-node) that can run on a node at any time. When there are more tasks requested than running nodes, an error @@ -860,7 +860,7 @@ Configures resource constraints. > to learn about differences between version 2 and 3 of the compose-file format. Each of these is a single value, analogous to its -[docker service create](../../engine/reference/commandline/service_create.md) counterpart. +[docker service create](../../reference/cli/docker/service/create.md) counterpart. In this general example, the `redis` service is constrained to use no more than 50M of memory and `0.50` (50% of a single core) of available processing time (CPU), @@ -1017,7 +1017,7 @@ devices: > Note when using docker stack deploy > > The `devices` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) { .important } ### dns @@ -1057,7 +1057,7 @@ entrypoint: /code/entrypoint.sh ``` The entrypoint can also be a list, in a manner similar to -[dockerfile](../../engine/reference/builder.md#entrypoint): +[dockerfile](../../reference/dockerfile.md#entrypoint): ```yaml entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"] @@ -1219,7 +1219,7 @@ external_links: > Note when using docker stack deploy > > The `external_links` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) { .important } ### extra_hosts @@ -1243,7 +1243,7 @@ An entry with the ip address and hostname is created in `/etc/hosts` inside cont Configure a check that's run to determine whether or not containers for this service are "healthy". See the docs for the -[HEALTHCHECK Dockerfile instruction](../../engine/reference/builder.md#healthcheck) +[HEALTHCHECK Dockerfile instruction](../../reference/dockerfile.md#healthcheck) for details on how healthchecks work. ```yaml @@ -1332,14 +1332,14 @@ services: > The default init binary that is used is [Tini](https://github.com/krallin/tini), > and is installed in `/usr/libexec/docker-init` on the daemon host. You can > configure the daemon to use a custom init binary through the -> [`init-path` configuration option](/engine/reference/commandline/dockerd/#daemon-configuration-file). +> [`init-path` configuration option](/reference/cli/docker/dockerd/#daemon-configuration-file). ### isolation Specify a container’s isolation technology. On Linux, the only supported value is `default`. On Windows, acceptable values are `default`, `process` and `hyperv`. Refer to the -[Docker Engine docs](../../engine/reference/commandline/container_run.md#isolation) +[Docker Engine docs](../../reference/cli/docker/container/run.md#isolation) for details. ### labels @@ -1407,7 +1407,7 @@ Links also express dependency between services in the same way as > Note when using docker stack deploy > > The `links` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) { .important } ### logging @@ -1512,7 +1512,7 @@ network_mode: "container:[container name/id]" > **Note** > > * This option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md). +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md). > * `network_mode: "host"` cannot be mixed with [links](#links). { .important } @@ -1742,7 +1742,7 @@ container is stopped (manually or otherwise). > Note when using docker stack deploy > > The `restart` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md). +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md). { .important } ### secrets @@ -1853,7 +1853,7 @@ security_opt: > Note when using docker stack deploy > > The `security_opt` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md). +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md). { .important } ### stop_grace_period @@ -1904,12 +1904,12 @@ sysctls: You can only use sysctls that are namespaced in the kernel. Docker does not support changing sysctls inside a container that also modify the host system. For an overview of supported sysctls, refer to -[configure namespaced kernel parameters (sysctls) at runtime](../../engine/reference/commandline/container_run.md#sysctl). +[configure namespaced kernel parameters (sysctls) at runtime](../../reference/cli/docker/container/run.md#sysctl). > Note when using docker stack deploy > > This option requires Docker Engine 19.03 or up when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md). +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md). ### tmpfs @@ -1930,7 +1930,7 @@ tmpfs: > Note when using docker stack deploy > > This option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md) +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md) > with a (version 3-3.5) Compose file. Mount a temporary file system inside the container. Size parameter specifies the size @@ -1969,7 +1969,7 @@ more information. > Note when using docker stack deploy > > The `userns_mode` option is ignored when -> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md). +> [deploying a stack in swarm mode](../../reference/cli/docker/stack/deploy.md). { .important } ### volumes @@ -2151,7 +2151,7 @@ services: ### domainname, hostname, ipc, mac\_address, privileged, read\_only, shm\_size, stdin\_open, tty, user, working\_dir Each of these is a single value, analogous to its -[docker run](../../engine/reference/commandline/container_run.md) counterpart. Note that `mac_address` is a legacy option. +[docker run](../../reference/cli/docker/container/run.md) counterpart. Note that `mac_address` is a legacy option. ```yaml user: postgresql @@ -2206,7 +2206,7 @@ While it is possible to declare [volumes](#volumes) on the fly as part of the service declaration, this section allows you to create named volumes that can be reused across multiple services (without relying on `volumes_from`), and are easily retrieved and inspected using the docker command line or API. -See the [docker volume](../../engine/reference/commandline/volume_create.md) +See the [docker volume](../../reference/cli/docker/volume/create.md) subcommand documentation for more information. See [use volumes](../../storage/volumes.md) and [volume @@ -2311,7 +2311,7 @@ volumes: > > External volumes that do not exist _are created_ if you use [docker stack deploy](#deploy) > to launch the app in [swarm mode](../../engine/swarm/index.md) (instead of -> [docker compose up](../../engine/reference/commandline/compose_up.md)). In swarm mode, a volume is +> [docker compose up](../../reference/cli/docker/compose/up.md)). In swarm mode, a volume is > automatically created when it is defined by a service. As service tasks are > scheduled on new nodes, [swarmkit](https://github.com/docker/swarmkit/blob/master/README.md) > creates the volume on the local node. To learn more, see [moby/moby#29976](https://github.com/moby/moby/issues/29976). diff --git a/content/compose/environment-variables/envvars-precedence.md b/content/compose/environment-variables/envvars-precedence.md index a7db7649834..6e90e49c5bd 100644 --- a/content/compose/environment-variables/envvars-precedence.md +++ b/content/compose/environment-variables/envvars-precedence.md @@ -18,7 +18,7 @@ The order of precedence (highest to lowest) is as follows: 4. Use of the [`--env-file` argument](set-environment-variables.md#substitute-with---env-file) in the CLI 5. Use of the [`env_file` attribute](set-environment-variables.md#use-the-env_file-attribute) in the Compose file 6. Set using an [`.env` file](set-environment-variables.md#substitute-with-an-env-file) placed at base of your project directory -7. Set in a container image in the [ENV directive](../../engine/reference/builder.md#env). +7. Set in a container image in the [ENV directive](../../reference/dockerfile.md#env). Having any `ARG` or `ENV` setting in a `Dockerfile` evaluates only if there is no Docker Compose entry for `environment`, `env_file` or `run --env`. ## Simple example diff --git a/content/compose/environment-variables/envvars.md b/content/compose/environment-variables/envvars.md index 081d44879f9..841f435f726 100644 --- a/content/compose/environment-variables/envvars.md +++ b/content/compose/environment-variables/envvars.md @@ -165,4 +165,4 @@ For more information, see [Migrate to Compose V2](../migrate.md). - `COMPOSE_FORCE_WINDOWS_HOST` - `COMPOSE_INTERACTIVE_NO_CLI` - `COMPOSE_DOCKER_CLI_BUILD` - Use `DOCKER_BUILDKIT` to select between BuildKit and the classic builder. If `DOCKER_BUILDKIT=0` then `docker compose build` uses the classic builder to build images. \ No newline at end of file + Use `DOCKER_BUILDKIT` to select between BuildKit and the classic builder. If `DOCKER_BUILDKIT=0` then `docker compose build` uses the classic builder to build images. diff --git a/content/compose/environment-variables/set-environment-variables.md b/content/compose/environment-variables/set-environment-variables.md index 6a5e25c5a5a..242dd1e8905 100644 --- a/content/compose/environment-variables/set-environment-variables.md +++ b/content/compose/environment-variables/set-environment-variables.md @@ -38,7 +38,7 @@ services: When you run `docker compose up`, the `web` service defined in the Compose file [interpolates](env-file.md#interpolation) in the image `webapp:v1.5` which was set in the `.env` file. You can verify this with the -[config command](../../engine/reference/commandline/compose_config.md), which prints your resolved application config to the terminal: +[config command](../../reference/cli/docker/compose/config.md), which prints your resolved application config to the terminal: ```console $ docker compose config diff --git a/content/compose/faq.md b/content/compose/faq.md index 3d6036c4aa2..ac410fc8dd0 100644 --- a/content/compose/faq.md +++ b/content/compose/faq.md @@ -37,7 +37,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](../engine/reference/commandline/compose_stop.md). After the timeout, +for a [default timeout of 10 seconds](../reference/cli/docker/compose/stop.md). 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. diff --git a/content/compose/gettingstarted.md b/content/compose/gettingstarted.md index f8865997e76..3c61a8278b9 100644 --- a/content/compose/gettingstarted.md +++ b/content/compose/gettingstarted.md @@ -119,7 +119,7 @@ This tells Docker to: For more information on how to write Dockerfiles, see the [Docker user guide](../develop/index.md) -and the [Dockerfile reference](/engine/reference/builder/). +and the [Dockerfile reference](/reference/dockerfile/). ## Step 3: Define services in a Compose file diff --git a/content/compose/multiple-compose-files/merge.md b/content/compose/multiple-compose-files/merge.md index 7808055994e..b06eec13563 100644 --- a/content/compose/multiple-compose-files/merge.md +++ b/content/compose/multiple-compose-files/merge.md @@ -101,7 +101,7 @@ relative to the base file. - 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.yml` file in a directory called `sandbox/rails`. You can use a command like [docker compose pull](../../engine/reference/commandline/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.yml 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.yml` 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.yml pull db` Here's the full example: @@ -368,4 +368,4 @@ With such a constraint, code organization in a monorepo can become hard as a nat ## Reference information -- [Merge rules](../compose-file/13-merge.md) \ No newline at end of file +- [Merge rules](../compose-file/13-merge.md) diff --git a/content/compose/networking.md b/content/compose/networking.md index 7abbf36ecc2..dd8728ceed2 100644 --- a/content/compose/networking.md +++ b/content/compose/networking.md @@ -7,7 +7,7 @@ title: Networking in Compose {{< include "compose-eol.md" >}} By default Compose sets up a single -[network](../engine/reference/commandline/network_create.md) for your app. Each +[network](../reference/cli/docker/network/create.md) 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. diff --git a/content/compose/reference/_index.md b/content/compose/reference/_index.md index f905e5cebec..e3bbf1e0d3a 100644 --- a/content/compose/reference/_index.md +++ b/content/compose/reference/_index.md @@ -78,4 +78,4 @@ You can use Docker Compose binary, `docker compose [-f ...] [options] - [Specify a project name](../project-name.md) - [Using environment variables](../environment-variables/_index.md) - [Working with multiple Compose files](../multiple-compose-files/_index.md) -- [Compose Specification](../compose-file/_index.md) \ No newline at end of file +- [Compose Specification](../compose-file/_index.md) diff --git a/content/compose/release-notes.md b/content/compose/release-notes.md index c1fadfb0d2c..09f1d44d851 100644 --- a/content/compose/release-notes.md +++ b/content/compose/release-notes.md @@ -3278,8 +3278,8 @@ Several new configuration keys have been added to `docker-compose.yml`: - `pid: host`, like `docker run --pid=host`, lets you reuse the same PID namespace as the host machine. - `cpuset`, like `docker run --cpuset-cpus`, lets you specify which CPUs to allow execution in. - `read_only`, like `docker run --read-only`, lets you mount a container's filesystem as read-only. -- `security_opt`, like `docker run --security-opt`, lets you specify [security options](/engine/reference/commandline/container_run/#security-opt). -- `log_driver`, like `docker run --log-driver`, lets you specify a [log driver](/engine/reference/commandline/container_run/#log-driver). +- `security_opt`, like `docker run --security-opt`, lets you specify [security options](/reference/cli/docker/container/run/#security-opt). +- `log_driver`, like `docker run --log-driver`, lets you specify a [log driver](/reference/cli/docker/container/run/#log-driver). ### Bug fixes diff --git a/content/compose/samples-for-compose.md b/content/compose/samples-for-compose.md index 966fd6df1b7..5a162183073 100644 --- a/content/compose/samples-for-compose.md +++ b/content/compose/samples-for-compose.md @@ -16,7 +16,7 @@ The samples should help you to: [Compose files](compose-file/index.md): `compose.yml` and `docker-stack.yml` - Understand the relationship between `compose.yml` and - [Dockerfiles](/engine/reference/builder/) + [Dockerfiles](/reference/dockerfile/) - Learn how to make calls to your application services from Compose files - Learn how to deploy applications and services to a [swarm](../engine/swarm/index.md) diff --git a/content/config/containers/logging/_index.md b/content/config/containers/logging/_index.md index 11dc356331d..84546f10135 100644 --- a/content/config/containers/logging/_index.md +++ b/content/config/containers/logging/_index.md @@ -50,4 +50,4 @@ its errors to `/proc/self/fd/2` (which is `STDERR`). See the ## Next steps - Configure [logging drivers](configure.md). -- Write a [Dockerfile](../../../engine/reference/builder.md). +- Write a [Dockerfile](../../../reference/dockerfile.md). diff --git a/content/config/containers/logging/awslogs.md b/content/config/containers/logging/awslogs.md index 982c3a33f63..c4bbfb9e89e 100644 --- a/content/config/containers/logging/awslogs.md +++ b/content/config/containers/logging/awslogs.md @@ -20,7 +20,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `awslogs` and sets the `awslogs-region` option. diff --git a/content/config/containers/logging/configure.md b/content/config/containers/logging/configure.md index 7b781689eae..d7947c43903 100644 --- a/content/config/containers/logging/configure.md +++ b/content/config/containers/logging/configure.md @@ -45,7 +45,7 @@ included with Docker, you can also implement and use [logging driver plugins](pl To configure the Docker daemon to default to a specific logging driver, set the value of `log-driver` to the name of the logging driver in the `daemon.json` configuration file. Refer to the "daemon configuration file" section in the -[`dockerd` reference manual](/engine/reference/commandline/dockerd/#daemon-configuration-file) +[`dockerd` reference manual](/reference/cli/dockerd/#daemon-configuration-file) for details. The default logging driver is `json-file`. The following example sets the default diff --git a/content/config/containers/logging/dual-logging.md b/content/config/containers/logging/dual-logging.md index e2a193e9792..a8d52036367 100644 --- a/content/config/containers/logging/dual-logging.md +++ b/content/config/containers/logging/dual-logging.md @@ -111,7 +111,7 @@ as a default, with dual logging caching enabled: The dual logging cache accepts the same configuration options as the [`local` logging driver](local.md), but with a `cache-` prefix. These options can be specified per container, and defaults for new containers can be set using -the [daemon configuration file](/engine/reference/commandline/dockerd/#daemon-configuration-file). +the [daemon configuration file](/reference/cli/dockerd/#daemon-configuration-file). By default, the cache has log-file rotation enabled, and is limited to a maximum of 5 files of 20MB each (before compression) per container. Use the configuration @@ -132,7 +132,7 @@ through a remote logging system, and if there is no need to read logs through `docker logs` for debugging purposes. Caching can be disabled for individual containers or by default for new containers, -when using the [daemon configuration file](/engine/reference/commandline/dockerd/#daemon-configuration-file). +when using the [daemon configuration file](/reference/cli/dockerd/#daemon-configuration-file). The following example uses the daemon configuration file to use the [`splunk`](splunk.md) logging driver as a default, with caching disabled: diff --git a/content/config/containers/logging/fluentd.md b/content/config/containers/logging/fluentd.md index 57fa8bd46d9..d5ba0d713b7 100644 --- a/content/config/containers/logging/fluentd.md +++ b/content/config/containers/logging/fluentd.md @@ -35,7 +35,7 @@ To use the `fluentd` driver as the default logging driver, set the `log-driver` and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about -configuring Docker using `daemon.json`, see [daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +configuring Docker using `daemon.json`, see [daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `fluentd` and sets the `fluentd-address` option. diff --git a/content/config/containers/logging/gcplogs.md b/content/config/containers/logging/gcplogs.md index 4eb1fe719d3..18fced97500 100644 --- a/content/config/containers/logging/gcplogs.md +++ b/content/config/containers/logging/gcplogs.md @@ -17,7 +17,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `gcplogs` and sets the `gcp-meta-name` option. diff --git a/content/config/containers/logging/gelf.md b/content/config/containers/logging/gelf.md index 02306ef4aa3..2457396090a 100644 --- a/content/config/containers/logging/gelf.md +++ b/content/config/containers/logging/gelf.md @@ -25,7 +25,7 @@ To use the `gelf` driver as the default logging driver, set the `log-driver` and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `gelf` and sets the `gelf-address` option. diff --git a/content/config/containers/logging/journald.md b/content/config/containers/logging/journald.md index d6d08efff10..8cace0abae2 100644 --- a/content/config/containers/logging/journald.md +++ b/content/config/containers/logging/journald.md @@ -30,7 +30,7 @@ and `log-opts` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `journald`: diff --git a/content/config/containers/logging/json-file.md b/content/config/containers/logging/json-file.md index b72a1012d0b..6f045bb44c4 100644 --- a/content/config/containers/logging/json-file.md +++ b/content/config/containers/logging/json-file.md @@ -35,7 +35,7 @@ and `log-opts` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\` on Windows Server. If the file does not exist, create it first. For more information about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `json-file` and sets the `max-size` and `max-file` options to enable automatic log-rotation. diff --git a/content/config/containers/logging/local.md b/content/config/containers/logging/local.md index 5930936cedd..3a349e71b50 100644 --- a/content/config/containers/logging/local.md +++ b/content/config/containers/logging/local.md @@ -30,7 +30,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `local` and sets the `max-size` option. diff --git a/content/config/containers/logging/splunk.md b/content/config/containers/logging/splunk.md index 94bf006b574..90fd3095ee8 100644 --- a/content/config/containers/logging/splunk.md +++ b/content/config/containers/logging/splunk.md @@ -34,7 +34,7 @@ configuration file and restart Docker. For example: The daemon.json file is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). > **Note** > diff --git a/content/config/containers/logging/syslog.md b/content/config/containers/logging/syslog.md index b0df12f9488..5b2f3ad8554 100644 --- a/content/config/containers/logging/syslog.md +++ b/content/config/containers/logging/syslog.md @@ -38,7 +38,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../engine/reference/commandline/dockerd.md#daemon-configuration-file). +[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `syslog` and sets the `syslog-address` option. The `syslog-address` options supports both UDP and TCP; diff --git a/content/config/containers/resource_constraints.md b/content/config/containers/resource_constraints.md index 75327b94dd3..3aa20a21ca5 100644 --- a/content/config/containers/resource_constraints.md +++ b/content/config/containers/resource_constraints.md @@ -15,7 +15,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`](../../engine/reference/commandline/system_info.md) command. If a capability +[`docker info`](../../reference/cli/docker/system/info.md) command. If a capability is disabled in your kernel, you may see a warning at the end of the output like the following: diff --git a/content/config/containers/runmetrics.md b/content/config/containers/runmetrics.md index dfa5183d0b3..257b096595f 100644 --- a/content/config/containers/runmetrics.md +++ b/content/config/containers/runmetrics.md @@ -25,7 +25,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`](../../engine/reference/commandline/container_stats.md) reference +The [`docker stats`](../../reference/cli/docker/container/stats.md) reference page has more details about the `docker stats` command. ## Control groups diff --git a/content/config/containers/start-containers-automatically.md b/content/config/containers/start-containers-automatically.md index f4568998c97..3d47c1d25f4 100644 --- a/content/config/containers/start-containers-automatically.md +++ b/content/config/containers/start-containers-automatically.md @@ -66,7 +66,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](../../engine/reference/commandline/service_create.md). + [flags related to service restart](../../reference/cli/docker/service/create.md). ### Restarting foreground containers diff --git a/content/config/daemon/_index.md b/content/config/daemon/_index.md index 59cd93f8f56..1428bcb126b 100644 --- a/content/config/daemon/_index.md +++ b/content/config/daemon/_index.md @@ -67,7 +67,7 @@ You can also explicitly specify the location of the configuration file on startup, using the `dockerd --config-file` flag. Learn about the available configuration options in the -[dockerd reference docs](../../engine/reference/commandline/dockerd.md#daemon-configuration-file) +[dockerd reference docs](../../reference/cli/dockerd.md#daemon-configuration-file) ### Configuration using flags @@ -86,7 +86,7 @@ $ dockerd --debug \ ``` Learn about the available configuration options in the -[dockerd reference docs](../../engine/reference/commandline/dockerd.md), or by +[dockerd reference docs](../../reference/cli/dockerd.md), or by running: ```console diff --git a/content/config/daemon/remote-access.md b/content/config/daemon/remote-access.md index e13ad5b4775..2b59a039e7f 100644 --- a/content/config/daemon/remote-access.md +++ b/content/config/daemon/remote-access.md @@ -12,7 +12,7 @@ requests from local clients. It's possible to allow Docker to accept requests from remote hosts by configuring it to listen on an IP address and port as well as the Unix socket. For more detailed information on this configuration option, refer to the -[dockerd CLI reference](/engine/reference/commandline/dockerd/#bind-docker-to-another-hostport-or-a-unix-socket). +[dockerd CLI reference](/reference/cli/dockerd/#bind-docker-to-another-hostport-or-a-unix-socket). > **Warning** diff --git a/content/config/filter.md b/content/config/filter.md index 1029cc51e6d..fa26725fb48 100644 --- a/content/config/filter.md +++ b/content/config/filter.md @@ -92,21 +92,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`](../engine/reference/commandline/config_ls.md) -- [`docker container prune`](../engine/reference/commandline/container_prune.md) -- [`docker image prune`](../engine/reference/commandline/image_prune.md) -- [`docker image ls`](../engine/reference/commandline/image_ls.md) -- [`docker network ls`](../engine/reference/commandline/network_ls.md) -- [`docker network prune`](../engine/reference/commandline/network_prune.md) -- [`docker node ls`](../engine/reference/commandline/node_ls.md) -- [`docker node ps`](../engine/reference/commandline/node_ps.md) -- [`docker plugin ls`](../engine/reference/commandline/plugin_ls.md) -- [`docker container ls`](../engine/reference/commandline/container_ls.md) -- [`docker search`](../engine/reference/commandline/search.md) -- [`docker secret ls`](../engine/reference/commandline/secret_ls.md) -- [`docker service ls`](../engine/reference/commandline/service_ls.md) -- [`docker service ps`](../engine/reference/commandline/service_ps.md) -- [`docker stack ps`](../engine/reference/commandline/stack_ps.md) -- [`docker system prune`](../engine/reference/commandline/system_prune.md) -- [`docker volume ls`](../engine/reference/commandline/volume_ls.md) -- [`docker volume prune`](../engine/reference/commandline/volume_prune.md) +- [`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) diff --git a/content/config/labels-custom-metadata.md b/content/config/labels-custom-metadata.md index 4752ed36e5d..31b7a0b339a 100644 --- a/content/config/labels-custom-metadata.md +++ b/content/config/labels-custom-metadata.md @@ -79,37 +79,37 @@ Labels on Swarm nodes and services can be updated dynamically. - Images and containers - - [Adding labels to images](../engine/reference/builder.md#label) - - [Overriding a container's labels at runtime](../engine/reference/commandline/container_run.md#label) - - [Inspecting labels on images or containers](../engine/reference/commandline/inspect.md) - - [Filtering images by label](../engine/reference/commandline/image_ls.md#filter) - - [Filtering containers by label](../engine/reference/commandline/container_ls.md#filter) + - [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) - Local Docker daemons - - [Adding labels to a Docker daemon at runtime](../engine/reference/commandline/dockerd.md) - - [Inspecting a Docker daemon's labels](../engine/reference/commandline/system_info.md) + - [Adding labels to a Docker daemon at runtime](../reference/cli/dockerd.md) + - [Inspecting a Docker daemon's labels](../reference/cli/docker/system/info.md) - Volumes - - [Adding labels to volumes](../engine/reference/commandline/volume_create.md) - - [Inspecting a volume's labels](../engine/reference/commandline/volume_inspect.md) - - [Filtering volumes by label](../engine/reference/commandline/volume_ls.md#filter) + - [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) - Networks - - [Adding labels to a network](../engine/reference/commandline/network_create.md) - - [Inspecting a network's labels](../engine/reference/commandline/network_inspect.md) - - [Filtering networks by label](../engine/reference/commandline/network_ls.md#filter) + - [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) - Swarm nodes - - [Adding or updating a Swarm node's labels](../engine/reference/commandline/node_update.md#label-add) - - [Inspecting a Swarm node's labels](../engine/reference/commandline/node_inspect.md) - - [Filtering Swarm nodes by label](../engine/reference/commandline/node_ls.md#filter) + - [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) - Swarm services - - [Adding labels when creating a Swarm service](../engine/reference/commandline/service_create.md#label) - - [Updating a Swarm service's labels](../engine/reference/commandline/service_update.md) - - [Inspecting a Swarm service's labels](../engine/reference/commandline/service_inspect.md) - - [Filtering Swarm services by label](../engine/reference/commandline/service_ls.md#filter) + - [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) diff --git a/content/config/pruning.md b/content/config/pruning.md index 67abd0727a5..712f606db15 100644 --- a/content/config/pruning.md +++ b/content/config/pruning.md @@ -51,7 +51,7 @@ $ docker image prune -a --filter "until=24h" ``` Other filtering expressions are available. See the -[`docker image prune` reference](../engine/reference/commandline/image_prune.md) +[`docker image prune` reference](../reference/cli/docker/image/prune.md) for more examples. ## Prune containers @@ -82,7 +82,7 @@ $ docker container prune --filter "until=24h" ``` Other filtering expressions are available. See the -[`docker container prune` reference](../engine/reference/commandline/container_prune.md) +[`docker container prune` reference](../reference/cli/docker/container/prune.md) for more examples. ## Prune volumes @@ -110,7 +110,7 @@ $ docker volume prune --filter "label!=keep" ``` Other filtering expressions are available. See the -[`docker volume prune` reference](../engine/reference/commandline/volume_prune.md) +[`docker volume prune` reference](../reference/cli/docker/volume/prune.md) for more examples. ## Prune networks @@ -139,7 +139,7 @@ $ docker network prune --filter "until=24h" ``` Other filtering expressions are available. See the -[`docker network prune` reference](../engine/reference/commandline/network_prune.md) +[`docker network prune` reference](../reference/cli/docker/network/prune.md) for more examples. ## Prune everything @@ -187,5 +187,5 @@ $ docker system prune --filter "until=24h" ``` Other filtering expressions are available. See the -[`docker system prune` reference](../engine/reference/commandline/system_prune.md) +[`docker system prune` reference](../reference/cli/docker/system/prune.md) for more examples. diff --git a/content/desktop/backup-and-restore.md b/content/desktop/backup-and-restore.md index b472070616e..df8054c22e0 100644 --- a/content/desktop/backup-and-restore.md +++ b/content/desktop/backup-and-restore.md @@ -14,7 +14,7 @@ computer, for example. ## Save your data -1. Commit your containers to an image with [`docker container commit`](../engine/reference/commandline/container_commit.md). +1. Commit your containers to an image with [`docker container commit`](../reference/cli/docker/container/commit.md). Committing a container stores the container filesystem changes and some of the container's configuration, for example labels and environment-variables, as a local image. Be aware that environment variables may contain sensitive @@ -26,13 +26,13 @@ computer, for example. If you used a [named volume](../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](../storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section. -2. Use [`docker push`](../engine/reference/commandline/image_push.md) to push any +2. Use [`docker push`](../reference/cli/docker/image/push.md) to push any images you have built locally and want to keep to the [Docker Hub registry](../docker-hub/index.md). Make sure to configure the [repository's visibility as "private"](../docker-hub/repos/index.md) for images that should not be publicly accessible. - Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](../engine/reference/commandline/image_save.md) + Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](../reference/cli/docker/image/save.md) 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 @@ -40,13 +40,13 @@ and [install a different version](release-notes.md) or reset Docker Desktop to f ## Restore your data -1. Use [`docker pull`](../engine/reference/commandline/image_pull.md) to restore images +1. Use [`docker pull`](../reference/cli/docker/image/pull.md) to restore images you pushed to Docker Hub. - If you backed up your images to a local tar file, use [`docker image load -i images.tar`](../engine/reference/commandline/image_load.md) + If you backed up your images to a local tar file, use [`docker image load -i images.tar`](../reference/cli/docker/image/load.md) to restore previously saved images. -2. Re-create your containers if needed, using [`docker run`](../engine/reference/commandline/container_run.md), +2. Re-create your containers if needed, using [`docker run`](../reference/cli/docker/container/run.md), or [Docker Compose](../compose/index.md). Refer to the [backup, restore, or migrate data volumes](../storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section to restore volume data. diff --git a/content/desktop/extensions-sdk/extensions/labels.md b/content/desktop/extensions-sdk/extensions/labels.md index ba5d3f913c4..eca61e1a835 100644 --- a/content/desktop/extensions-sdk/extensions/labels.md +++ b/content/desktop/extensions-sdk/extensions/labels.md @@ -10,7 +10,7 @@ This information is then displayed as an overview of the extension, so users can ![An extension overveiw, generated from labels](images/marketplace-details.png) -You can define [Image labels](../../../engine/reference/builder.md#label) in the extension's `Dockerfile`. +You can define [Image labels](../../../reference/dockerfile.md#label) in the extension's `Dockerfile`. Here is the list of labels you need to specify when building your extension: diff --git a/content/desktop/extensions-sdk/extensions/multi-arch.md b/content/desktop/extensions-sdk/extensions/multi-arch.md index a2bc2cc0fbd..dcc0d3bae38 100644 --- a/content/desktop/extensions-sdk/extensions/multi-arch.md +++ b/content/desktop/extensions-sdk/extensions/multi-arch.md @@ -34,7 +34,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](../../../engine/reference/commandline/buildx_imagetools.md): +architectures using the [`docker buildx imagetools` command](../../../reference/cli/docker/buildx/imagetools/_index.md): ```console $ docker buildx imagetools inspect username/my-extension:0.0.1 @@ -141,4 +141,4 @@ When the extension is installed, the extension framework copies the binaries fro ## Can I develop extensions that run Windows containers? -Although Docker Extensions is supported on Docker Desktop for Windows, Mac, and Linux, the extension framework only supports Linux containers. Therefore, you must target `linux` as the OS when you build your extension image. \ No newline at end of file +Although Docker Extensions is supported on Docker Desktop for Windows, Mac, and Linux, the extension framework only supports Linux containers. Therefore, you must target `linux` as the OS when you build your extension image. diff --git a/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md b/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md index 45f887f2325..93f03df36bd 100644 --- a/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md +++ b/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md @@ -8,7 +8,7 @@ Extensions can invoke Docker commands directly from the frontend with the SDK. In some cases, it is useful to also interact with the Docker Engine from the backend. Extension backend containers can mount the Docker socket and use it to -interact with the Docker engine from the extension backend logic. Learn more about the [Docker Engine socket](/engine/reference/commandline/dockerd/#examples) +interact with the Docker engine from the extension backend logic. Learn more about the [Docker Engine socket](/reference/cli/dockerd/#examples) However, when mounting the Docker socket from an extension container that lives in the Desktop virtual machine, you want to mount the Docker socket from inside the VM, and not mount `/var/run/docker.sock` from the host filesystem (using @@ -22,4 +22,4 @@ services: image: ${DESKTOP_PLUGIN_IMAGE} volumes: - /var/run/docker.sock.raw:/var/run/docker.sock -``` \ No newline at end of file +``` diff --git a/content/desktop/hardened-desktop/settings-management/configure.md b/content/desktop/hardened-desktop/settings-management/configure.md index 27c8465c737..bb7f0585472 100644 --- a/content/desktop/hardened-desktop/settings-management/configure.md +++ b/content/desktop/hardened-desktop/settings-management/configure.md @@ -154,18 +154,18 @@ The following `admin-settings.json` code and table provides an example of the re |               `commandList` | | Restricts the commands that containers can issue via the bind-mounted Docker Engine socket. | | `linuxVM` | |Parameters and settings related to Linux VM options - grouped together here for convenience. | |        `wslEngineEnabled` | Windows only | If `value` is set to true, Docker Desktop uses the WSL 2 based engine. This overrides anything that may have been set at installation using the `--backend=` flag. | -|       `dockerDaemonOptions`| |If `value` is set to true, it overrides the options in the Docker Engine config file. See the [Docker Engine reference](/engine/reference/commandline/dockerd/#daemon-configuration-file). Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled. | +|       `dockerDaemonOptions`| |If `value` is set to true, it overrides the options in the Docker Engine config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file). Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled. | |       `vpnkitCIDR` | |Overrides the network range used for vpnkit DHCP/DNS for `*.docker.internal` | |`kubernetes`| | If `enabled` is set to true, a Kubernetes single-node cluster is started when Docker Desktop starts. If `showSystemContainers` is set to true, Kubernetes containers are displayed in the UI and when you run `docker ps`. `imagesRepository` allows you to specify which repository Docker Desktop pulls the Kubernetes images from. For example, `"imagesRepository": "registry-1.docker.io/docker"`. | | `windowsContainers` | | Parameters and settings related to `windowsContainers` options - grouped together here for convenience. | -|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/engine/reference/commandline/dockerd/#daemon-configuration-file).| +|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file).| |`disableUpdate`| |If `value` is set to true, checking for and notifications about Docker Desktop updates is disabled.| |`analyticsEnabled`| |If `value` is set to false, Docker Desktop doesn't send usage statistics to Docker. | |`extensionsEnabled`| |If `value` is set to false, Docker extensions are disabled. | |`scout`|| Setting `useBackgroundIndexing` to `false` disables automatic indexing of images loaded to the image store. Setting `sbomIndexing` to `false` prevents the manual indexing triggered by inspecting an image in Docker Desktop.

**Note**: Users can still use the `docker scout` CLI commands to index images, even if indexing is disabled in Settings Management. | | `allowExperimentalFeatures`| | If `value` is set to `false`, experimental features are disabled.| | `allowBetaFeatures`| | If `value` is set to `false`, beta features are disabled.| -| `blockDockerLoad` | | If `value` is set to `true`, users are no longer able to run [`docker load`](../../../engine/reference/commandline/image_load.md) and receive an error if they try to.| +| `blockDockerLoad` | | If `value` is set to `true`, users are no longer able to run [`docker load`](../../../reference/cli/docker/image/load.md) and receive an error if they try to.| ### Step three: Re-launch Docker Desktop >**Note** diff --git a/content/desktop/networking.md b/content/desktop/networking.md index 28fbd182a33..e76fbc9460c 100644 --- a/content/desktop/networking.md +++ b/content/desktop/networking.md @@ -169,5 +169,5 @@ container to random ports on the host. $ docker run -d -P --name webserver nginx ``` -See the [run command](../engine/reference/commandline/container_run.md) for more details on +See the [run command](../reference/cli/docker/container/run.md) for more details on publish options used with `docker run`. diff --git a/content/desktop/previous-versions/archive-mac.md b/content/desktop/previous-versions/archive-mac.md index eac97cfdd1c..c1a459a8c13 100644 --- a/content/desktop/previous-versions/archive-mac.md +++ b/content/desktop/previous-versions/archive-mac.md @@ -35,7 +35,7 @@ This page contains release notes for older versions of Docker Desktop for Mac. - Re-enable raw as the default disk format for users running macOS 10.13.4 and higher. Note this change only takes effect after a "reset to factory defaults" or "remove all data" (from the Whale menu -> Preferences -> Reset). Related to [docker/for-mac#2625](https://github.com/docker/for-mac/issues/2625) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/engine/reference/commandline/image_save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) - OS X El Captain 10.11 is deprecated in Docker Desktop. You will not be able to install updates after Docker Desktop 18.06.x. We recommend upgrading to the latest version of macOS. - Fix bug which would cause VM logs to be written to RAM rather than disk in some cases, and the VM to hang. See [docker/for-mac#2984](https://github.com/docker/for-mac/issues/2984) - Fix network connection leak triggered by haproxy TCP health-checks [docker/for-mac#1132](https://github.com/docker/for-mac/issues/1132) diff --git a/content/desktop/previous-versions/archive-windows.md b/content/desktop/previous-versions/archive-windows.md index 792c5d3a73e..3e016fbe37a 100644 --- a/content/desktop/previous-versions/archive-windows.md +++ b/content/desktop/previous-versions/archive-windows.md @@ -49,7 +49,7 @@ This page contains release notes for older versions of Docker Desktop for Window - Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker for Windows settings and use kubectl commands as well as Docker commands. See [the Kubernetes section](../kubernetes.md) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset the disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/engine/reference/commandline/image_save/#examples) and [backup volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset the disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [backup volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix bug which would in some cases cause virtual machine logs to be written to RAM rather than disk, and the virtual machine to hang. - Fix security issue with named pipe connection to docker service. - Fix VPNKit memory leak. Fixes [docker/for-win#2087](https://github.com/docker/for-win/issues/2087), [moby/vpnkit#371](https://github.com/moby/vpnkit/issues/371) diff --git a/content/desktop/previous-versions/edge-releases-mac.md b/content/desktop/previous-versions/edge-releases-mac.md index 7379be6ec01..fb2c8ca88e0 100644 --- a/content/desktop/previous-versions/edge-releases-mac.md +++ b/content/desktop/previous-versions/edge-releases-mac.md @@ -732,7 +732,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - Add an experimental SOCKS server to allow access to container networks, see [docker/for-mac#2670](https://github.com/docker/for-mac/issues/2670#issuecomment-372365274). Also see [docker/for-mac#2721](https://github.com/docker/for-mac/issues/2721) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/engine/reference/commandline/image_save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix startup issue with AUFS [docker/for-mac#2804](https://github.com/docker/for-mac/issues/2804) - Fix status bug which could prevent the Kubernetes cluster from starting. Fixes [docker/for-mac#2990](https://github.com/docker/for-mac/issues/2990) - Fix bug which would cause virtual machine logs to be written to RAM rather than disk in some cases, and the virtual machine to hang. See [docker/for-mac#2984](https://github.com/docker/for-mac/issues/2984) diff --git a/content/desktop/previous-versions/edge-releases-windows.md b/content/desktop/previous-versions/edge-releases-windows.md index eac960beb75..c4b79efdfa9 100644 --- a/content/desktop/previous-versions/edge-releases-windows.md +++ b/content/desktop/previous-versions/edge-releases-windows.md @@ -953,7 +953,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - New Kubernetes menu item allowing to switch Kubernetes context & connect to clusters other than the local one. * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/engine/reference/commandline/image_save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](../../storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix startup issue with AUFS - Fix status bug which could prevent the kubernetes cluster from starting. - Fix bug which would cause VM logs to be written to RAM rather than disk in some cases, and the VM to hang. diff --git a/content/desktop/release-notes.md b/content/desktop/release-notes.md index 5d05309a2bd..768001c9b6a 100644 --- a/content/desktop/release-notes.md +++ b/content/desktop/release-notes.md @@ -90,7 +90,7 @@ For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/re - [Synchronized File Shares](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](hardened-desktop/enhanced-container-isolation/config.md) when ECI is enabled. - [Containerd Image Store](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](../engine/reference/commandline/debug.md) (Beta). +- Get a debug shell into any container or image with the new [`docker debug` command](../reference/cli/docker/debug.md) (Beta). - Organization admins, with a Docker Business subscription, can now configure a custom list of extensions with [Private Extensions Marketplace](extensions/private-marketplace.md) enabled (Beta) ### Upgrades @@ -109,7 +109,7 @@ For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/re #### 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](../engine/reference/commandline/scout.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/_index.md). - 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). @@ -480,7 +480,7 @@ For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/re ### New - Added support for new Wasm runtimes: wws and lunatic. -- [`docker init`](../engine/reference/commandline/init.md) now supports ASP.NET +- [`docker init`](../reference/cli/docker/init.md) now supports ASP.NET - Increased performance of exposed ports on macOS, for example with `docker run -p`. ### Bug fixes and enhancements @@ -741,7 +741,7 @@ For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/re ### 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](../engine/reference/commandline/scout.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/_index.md). ### Upgrades @@ -2040,7 +2040,7 @@ CVE-2021-44228](https://www.docker.com/blog/apache-log4j-2-cve-2021-44228/). Docker Dashboard incorrectly displays the container memory usage as zero on Hyper-V based machines. -You can use the [`docker stats`](../engine/reference/commandline/container_stats.md) +You can use the [`docker stats`](../reference/cli/docker/container/stats.md) 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). diff --git a/content/desktop/settings/linux.md b/content/desktop/settings/linux.md index f3bc4dbf127..13724bc5311 100644 --- a/content/desktop/settings/linux.md +++ b/content/desktop/settings/linux.md @@ -179,7 +179,7 @@ edit the file using your favorite text editor. > about how to configure the Docker daemon on a manually installed Docker Engine. To see the full list of possible configuration options, see the -[dockerd command reference](/engine/reference/commandline/dockerd/). +[dockerd command reference](/reference/cli/dockerd/). Select **Apply & Restart** to save your settings and restart Docker Desktop. diff --git a/content/desktop/settings/mac.md b/content/desktop/settings/mac.md index 2befb5eed49..73a6d2b037a 100644 --- a/content/desktop/settings/mac.md +++ b/content/desktop/settings/mac.md @@ -226,7 +226,7 @@ edit the JSON configuration directly from the dashboard in Docker Desktop, or op edit the file using your favorite text editor. To see the full list of possible configuration options, see the -[dockerd command reference](/engine/reference/commandline/dockerd/). +[dockerd command reference](/reference/cli/dockerd/). Select **Apply & Restart** to save your settings and restart Docker Desktop. diff --git a/content/desktop/settings/windows.md b/content/desktop/settings/windows.md index 6f4bf393362..a6f9cc10a72 100644 --- a/content/desktop/settings/windows.md +++ b/content/desktop/settings/windows.md @@ -260,7 +260,7 @@ edit the JSON configuration directly from the dashboard in Docker Desktop, or op edit the file using your favorite text editor. To see the full list of possible configuration options, see the -[dockerd command reference](/engine/reference/commandline/dockerd/). +[dockerd command reference](/reference/cli/dockerd/). Select **Apply & Restart** to save your settings and restart Docker Desktop. diff --git a/content/desktop/synchronized-file-sharing.md b/content/desktop/synchronized-file-sharing.md index d82c6c05c4a..03a09b17f7a 100644 --- a/content/desktop/synchronized-file-sharing.md +++ b/content/desktop/synchronized-file-sharing.md @@ -45,7 +45,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](../engine/reference/commandline/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.md#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares. ## Explore your file share instance diff --git a/content/develop/_index.md b/content/develop/_index.md index 541cdc959fd..701861ab9d7 100644 --- a/content/develop/_index.md +++ b/content/develop/_index.md @@ -16,7 +16,7 @@ If you're just getting started developing a brand new app on Docker, check out these resources to understand some of the most common patterns for getting the most benefits from Docker. -- Learn how to [build an image](../engine/reference/builder.md) using a Dockerfile +- Learn how to [build an image](../reference/dockerfile.md) using a Dockerfile - Use [multi-stage builds](../build/building/multi-stage.md) to keep your images lean - Manage application data using [volumes](../storage/volumes.md) and [bind mounts](../storage/bind-mounts.md) - [Scale your app with Kubernetes](../get-started/kube-deploy.md) diff --git a/content/develop/dev-best-practices.md b/content/develop/dev-best-practices.md index 7dc33096774..99cb4ae0e22 100644 --- a/content/develop/dev-best-practices.md +++ b/content/develop/dev-best-practices.md @@ -87,7 +87,7 @@ keep image size small: it. - Take this even further by requiring your development, testing, and - security teams to [sign images](../engine/reference/commandline/trust.md) + security teams to [sign images](../reference/cli/docker/trust/_index.md) before the teams deploy the images into production. This way, before an image is deployed into production, it has been tested and signed off by, for instance, development, quality, and security teams. diff --git a/content/develop/develop-images/dockerfile_best-practices.md b/content/develop/develop-images/dockerfile_best-practices.md index f626a77f9ff..a4655a1b223 100644 --- a/content/develop/develop-images/dockerfile_best-practices.md +++ b/content/develop/develop-images/dockerfile_best-practices.md @@ -18,7 +18,7 @@ efficient images. It provides [general guidelines for your Dockerfiles](guidelin Docker builds images automatically by reading the instructions from a Dockerfile which is a text file that contains all commands, in order, needed to build a given image. A Dockerfile adheres to a specific format and set of -instructions which you can find at [Dockerfile reference](../../engine/reference/builder.md). +instructions which you can find at [Dockerfile reference](../../reference/dockerfile.md). A Docker image consists of read-only layers each of which represents a Dockerfile instruction. The layers are stacked and each one is a delta of the @@ -46,7 +46,7 @@ deleting files, are written to this writable container layer. ## Additional resources -* [Dockerfile reference](../../engine/reference/builder.md) +* [Dockerfile reference](../../reference/dockerfile.md) * [More about Automated builds](../../docker-hub/builds/index.md) * [Guidelines for creating Docker Official Images](../../trusted-content/official-images.md) * [Best practices to containerize Node.js web applications with Docker](https://snyk.io/blog/10-best-practices-to-containerize-nodejs-web-applications-with-docker) diff --git a/content/develop/develop-images/instructions.md b/content/develop/develop-images/instructions.md index 79c43aad581..17077aa9b89 100644 --- a/content/develop/develop-images/instructions.md +++ b/content/develop/develop-images/instructions.md @@ -14,7 +14,7 @@ images. Docker recommends the [Alpine image](https://hub.docker.com/_/alpine/) a is tightly controlled and small in size (currently under 6 MB), while still being a full Linux distribution. -For more information about the `FROM` instruction, see [Dockerfile reference for the FROM instruction](../../engine/reference/builder.md#from). +For more information about the `FROM` instruction, see [Dockerfile reference for the FROM instruction](../../reference/dockerfile.md#from). ### LABEL @@ -60,7 +60,7 @@ See [Understanding object labels](../../config/labels-custom-metadata.md) for guidelines about acceptable label keys and values. For information about querying labels, refer to the items related to filtering in [Managing labels on objects](../../config/labels-custom-metadata.md#manage-labels-on-objects). -See also [LABEL](../../engine/reference/builder.md#label) in the Dockerfile reference. +See also [LABEL](../../reference/dockerfile.md#label) in the Dockerfile reference. ### RUN @@ -68,7 +68,7 @@ Split long or complex `RUN` statements on multiple lines separated with backslashes to make your Dockerfile more readable, understandable, and maintainable. -For more information about `RUN`, see [Dockerfile reference for the RUN instruction](../../engine/reference/builder.md#run). +For more information about `RUN`, see [Dockerfile reference for the RUN instruction](../../reference/dockerfile.md#run). #### apt-get @@ -211,11 +211,11 @@ python and perl. For example, `CMD ["perl", "-de0"]`, `CMD ["python"]`, or `CMD ["php", "-a"]`. Using this form means that when you execute something like `docker run -it python`, you’ll get dropped into a usable shell, ready to go. `CMD` should rarely be used in the manner of `CMD ["param", "param"]` in -conjunction with [`ENTRYPOINT`](../../engine/reference/builder.md#entrypoint), unless +conjunction with [`ENTRYPOINT`](../../reference/dockerfile.md#entrypoint), unless you and your expected users are already quite familiar with how `ENTRYPOINT` works. -For more information about `CMD`, see [Dockerfile reference for the CMD instruction](../../engine/reference/builder.md#cmd). +For more information about `CMD`, see [Dockerfile reference for the CMD instruction](../../reference/dockerfile.md#cmd). ### EXPOSE @@ -230,7 +230,7 @@ how to map the specified port to the port of their choice. For container linking, Docker provides environment variables for the path from the recipient container back to the source (for example, `MYSQL_PORT_3306_TCP`). -For more information about `EXPOSE`, see [Dockerfile reference for the EXPOSE instruction](../../engine/reference/builder.md#expose). +For more information about `EXPOSE`, see [Dockerfile reference for the EXPOSE instruction](../../reference/dockerfile.md#expose). ### ENV @@ -298,7 +298,7 @@ $ docker run --rm test sh -c 'echo $ADMIN_USER' ``` -For more information about `ENV`, see [Dockerfile reference for the ENV instruction](../../engine/reference/builder.md#env). +For more information about `ENV`, see [Dockerfile reference for the ENV instruction](../../reference/dockerfile.md#env). ### ADD or COPY @@ -330,7 +330,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](../../engine/reference/commandline/image_build.md#git-repositories). +[Git URLs](../../reference/cli/docker/image/build.md#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 @@ -359,8 +359,8 @@ RUN ln -s /usr/share/dotnet/dotnet /usr/bin/dotnet ``` For more information about `ADD` or `COPY`, see the following: -- [Dockerfile reference for the ADD instruction](../../engine/reference/builder.md#add) -- [Dockerfile reference for the COPY instruction](../../engine/reference/builder.md#copy) +- [Dockerfile reference for the ADD instruction](../../reference/dockerfile.md#add) +- [Dockerfile reference for the COPY instruction](../../reference/dockerfile.md#copy) ### ENTRYPOINT @@ -416,7 +416,7 @@ exec "$@" ``` -This script uses [the `exec` Bash command](https://wiki.bash-hackers.org/commands/builtin/exec) so that the final running application becomes the container's PID 1. This allows the application to receive any Unix signals sent to the container. For more information, see the [`ENTRYPOINT` reference](../../engine/reference/builder.md#entrypoint). +This script uses [the `exec` Bash command](https://wiki.bash-hackers.org/commands/builtin/exec) so that the final running application becomes the container's PID 1. This allows the application to receive any Unix signals sent to the container. For more information, see the [`ENTRYPOINT` reference](../../reference/dockerfile.md#entrypoint). In the following example, a helper script is copied into the container and run via `ENTRYPOINT` on container start: @@ -447,7 +447,7 @@ Lastly, you can use it to start a totally different tool, such as Bash: $ docker run --rm -it postgres bash ``` -For more information about `ENTRYPOINT`, see [Dockerfile reference for the ENTRYPOINT instruction](../../engine/reference/builder.md#entrypoint). +For more information about `ENTRYPOINT`, see [Dockerfile reference for the ENTRYPOINT instruction](../../reference/dockerfile.md#entrypoint). ### VOLUME @@ -456,7 +456,7 @@ configuration storage, or files and folders created by your Docker container. Yo are strongly encouraged to use `VOLUME` for any combination of mutable or user-serviceable parts of your image. -For more information about `VOLUME`, see [Dockerfile reference for the VOLUME instruction](../../engine/reference/builder.md#volume). +For more information about `VOLUME`, see [Dockerfile reference for the VOLUME instruction](../../reference/dockerfile.md#volume). ### USER @@ -493,7 +493,7 @@ running it as non-`root`, consider using [“gosu”](https://github.com/tianon/ Lastly, to reduce layers and complexity, avoid switching `USER` back and forth frequently. -For more information about `USER`, see [Dockerfile reference for the USER instruction](../../engine/reference/builder.md#user). +For more information about `USER`, see [Dockerfile reference for the USER instruction](../../reference/dockerfile.md#user). ### WORKDIR @@ -502,7 +502,7 @@ For clarity and reliability, you should always use absolute paths for your like `RUN cd … && do-something`, which are hard to read, troubleshoot, and maintain. -For more information about `WORKDIR`, see [Dockerfile reference for the WORKDIR instruction](../../engine/reference/builder.md#workdir). +For more information about `WORKDIR`, see [Dockerfile reference for the WORKDIR instruction](../../reference/dockerfile.md#workdir). ### ONBUILD @@ -527,4 +527,4 @@ fails catastrophically if the new build's context is missing the resource being added. Adding a separate tag, as recommended above, helps mitigate this by allowing the Dockerfile author to make a choice. -For more information about `ONBUILD`, see [Dockerfile reference for the ONBUILD instruction](../../engine/reference/builder.md#onbuild). +For more information about `ONBUILD`, see [Dockerfile reference for the ONBUILD instruction](../../reference/dockerfile.md#onbuild). diff --git a/content/develop/security-best-practices.md b/content/develop/security-best-practices.md index c08344158c5..150a6ca2c72 100644 --- a/content/develop/security-best-practices.md +++ b/content/develop/security-best-practices.md @@ -132,7 +132,7 @@ that affect images that you build or use. the "core" vulnerability scanning solution with enhanced capabilities and more detailed and actionable insights. - For the CLI, there's the - [`docker scout` CLI plugin](../engine/reference/commandline/scout.md) + [`docker scout` CLI plugin](../reference/cli/docker/scout/_index.md) which lets you explore vulnerabilities for images using the terminal. - Docker Desktop has a detailed image view for images in your local image store, that visualizes all of the known vulnerabilities affecting an image. diff --git a/content/docker-hub/builds/advanced.md b/content/docker-hub/builds/advanced.md index d6e540775fb..88251bd3d06 100644 --- a/content/docker-hub/builds/advanced.md +++ b/content/docker-hub/builds/advanced.md @@ -115,11 +115,11 @@ $ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME . > **Important** > -> A `hooks/build` file overrides the basic [docker build](../../engine/reference/commandline/image_build.md) command used by the builder, so you must include a similar build command in the hook or +> A `hooks/build` file overrides the basic [docker build](../../reference/cli/docker/image/build.md) command used by the builder, so you must include a similar build command in the hook or the automated build fails. { .important } -Refer to the [docker build documentation](../../engine/reference/commandline/image_build.md#build-arg) +Refer to the [docker build documentation](../../reference/cli/docker/image/build.md#build-arg) to learn more about Docker build-time variables. #### Push to multiple repositories diff --git a/content/docker-hub/download-rate-limit.md b/content/docker-hub/download-rate-limit.md index e152f352c85..612a6380297 100644 --- a/content/docker-hub/download-rate-limit.md +++ b/content/docker-hub/download-rate-limit.md @@ -113,11 +113,11 @@ Select **Sign in / Create Docker ID** from the Docker Desktop menu and follow th ### Docker Engine -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](../engine/reference/commandline/login.md). +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). ### 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](../engine/reference/commandline/service_create.md/#create-a-service). If you are using a Docker Compose file to deploy an application stack, see [docker stack deploy](../engine/reference/commandline/stack_deploy.md). +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/#create-a-service). If you are using a Docker Compose file to deploy an application stack, see [docker stack deploy](../reference/cli/docker/stack/deploy.md). ### GitHub Actions diff --git a/content/docker-hub/mirror.md b/content/docker-hub/mirror.md index 586cc037ea6..8461d8dd34c 100644 --- a/content/docker-hub/mirror.md +++ b/content/docker-hub/mirror.md @@ -112,7 +112,7 @@ proxy: ### Configure the Docker daemon Either pass the `--registry-mirror` option when starting `dockerd` manually, -or edit [`/etc/docker/daemon.json`](../../engine/reference/commandline/dockerd.md#daemon-configuration-file) +or edit [`/etc/docker/daemon.json`](../../reference/cli/dockerd.md#daemon-configuration-file) and add the `registry-mirrors` key and value, to make the change persistent. ```json diff --git a/content/docker-hub/quickstart.md b/content/docker-hub/quickstart.md index 0d6869b0a3c..000aecaa4ef 100644 --- a/content/docker-hub/quickstart.md +++ b/content/docker-hub/quickstart.md @@ -152,7 +152,7 @@ You need to download Docker Desktop to build, push, and pull container images. ### Step 5: Build and push a container image to Docker Hub from your computer -1. Start by creating a [Dockerfile](../engine/reference/builder.md) to specify your application as shown below: +1. Start by creating a [Dockerfile](../reference/dockerfile.md) to specify your application as shown below: ```dockerfile # syntax=docker/dockerfile:1 diff --git a/content/docker-hub/repos/create.md b/content/docker-hub/repos/create.md index 859809e060a..e8545e59a00 100644 --- a/content/docker-hub/repos/create.md +++ b/content/docker-hub/repos/create.md @@ -11,7 +11,7 @@ aliases: Repositories let you share container images with your team, customers, or the Docker community at large. -A single Docker Hub repository can hold many Docker images which are stored as **tags**. You can push Docker images to Docker Hub with the [`docker push`](/engine/reference/commandline/push/)command. +A single Docker Hub repository can hold many Docker images which are stored as **tags**. You can push Docker images to Docker Hub with the [`docker push`](/reference/cli/docker/image/push/)command. ## Create a repository @@ -77,4 +77,4 @@ Then, you can push this image to the repository designated by its name or tag: $ docker push /: ``` -The image is then uploaded and available for use by your teammates and/or the community. \ No newline at end of file +The image is then uploaded and available for use by your teammates and/or the community. diff --git a/content/docker-hub/vulnerability-scanning.md b/content/docker-hub/vulnerability-scanning.md index 312cf2387e0..77d5f14166b 100644 --- a/content/docker-hub/vulnerability-scanning.md +++ b/content/docker-hub/vulnerability-scanning.md @@ -84,7 +84,7 @@ repository for which you have turned on scanning: 1. Ensure you have installed Docker locally. See [Get Docker](../get-docker.md) to download and install Docker on your local machine. 2. Use the command line to log into your Docker account. See - [`docker login`](../engine/reference/commandline/login.md) for more + [`docker login`](../reference/cli/docker/login.md) for more information. 3. Tag the image to scan. For example, to tag a Redis image, run: diff --git a/content/docker-id/_index.md b/content/docker-id/_index.md index 208be1b18f0..68fe0087967 100644 --- a/content/docker-id/_index.md +++ b/content/docker-id/_index.md @@ -66,7 +66,7 @@ Your Docker ID becomes your username for hosted Docker services, and [Docker for Once you register and verify your Docker ID email address, you can sign in to [your Docker account](https://login.docker.com/u/login/). You can sign in with your email address (or username) and password. Or, you can sign in with your social provider. See [Sign in with your social provider](#sign-in-with-your-social-provider). -You can also sign in through the CLI using the `docker login` command. For more information, see [`docker login`](../engine/reference/commandline/login.md). +You can also sign in through the CLI using the `docker login` command. For more information, see [`docker login`](../reference/cli/docker/login.md). > **Warning** > diff --git a/content/engine/_index.md b/content/engine/_index.md index 09cd7ed8422..f8269bf1204 100644 --- a/content/engine/_index.md +++ b/content/engine/_index.md @@ -52,11 +52,11 @@ containerizing your applications. Docker Engine acts as a client-server application with: - A server with a long-running daemon process - [`dockerd`](/engine/reference/commandline/dockerd). + [`dockerd`](/reference/cli/dockerd). - APIs which specify interfaces that programs can use to talk to and instruct the Docker daemon. - A command line interface (CLI) client - [`docker`](/engine/reference/commandline/cli/). + [`docker`](/reference/cli/docker/). The CLI uses [Docker APIs](api/index.md) to control or interact with the Docker daemon through scripting or direct CLI commands. Many other Docker applications diff --git a/content/engine/alternative-runtimes.md b/content/engine/alternative-runtimes.md index 38052a1d1e2..7c7b4ed57ca 100644 --- a/content/engine/alternative-runtimes.md +++ b/content/engine/alternative-runtimes.md @@ -107,7 +107,7 @@ use the `runtimes` option in the daemon configuration file. ``` For more information about the configuration options for containerd shims, see -[Configure containerd shims](./reference/commandline/dockerd.md#configure-containerd-shims). +[Configure containerd shims](./../reference/cli/dockerd.md#configure-containerd-shims). ## Examples @@ -127,7 +127,7 @@ youki functions as a drop-in replacement for runc, meaning it relies on the runc shim to invoke the runtime binary. When you register runtimes acting as runc replacements, you configure the path to the runtime executable, and optionally a set of runtime arguments. For more information, see -[Configure runc drop-in replacements](./reference/commandline/dockerd.md#configure-runc-drop-in-replacements). +[Configure runc drop-in replacements](./../reference/cli/dockerd.md#configure-runc-drop-in-replacements). To add youki as a container runtime: @@ -233,6 +233,6 @@ $ docker run --rm \ ## Related information - To learn more about the configuration options for container runtimes, - see [Configure container runtimes](./reference/commandline/dockerd.md#configure-container-runtimes). + see [Configure container runtimes](./../reference/cli/dockerd.md#configure-container-runtimes). - You can configure which runtime that the daemon should use as its default. - Refer to [Configure the default container runtime](./reference/commandline/dockerd.md#configure-the-default-container-runtime). + Refer to [Configure the default container runtime](./../reference/cli/dockerd.md#configure-the-default-container-runtime). diff --git a/content/engine/api/sdk/examples.md b/content/engine/api/sdk/examples.md index 008242fad73..7254fd76059 100644 --- a/content/engine/api/sdk/examples.md +++ b/content/engine/api/sdk/examples.md @@ -608,7 +608,7 @@ func main() { {{< tab name="Python" >}} The Python SDK retrieves authentication information from the [credentials -store](/engine/reference/commandline/login/#credentials-store) file and +store](/reference/cli/docker/login/#credentials-store) file and integrates with [credential helpers](https://github.com/docker/docker-credential-helpers). It's possible to override these credentials, but that's out of scope for this example guide. After using `docker login`, the Python SDK diff --git a/content/engine/faq.md b/content/engine/faq.md index ea585b6a092..273bd6a9905 100644 --- a/content/engine/faq.md +++ b/content/engine/faq.md @@ -43,7 +43,7 @@ offers a high-level tool with several powerful functionalities: - *Automatic build.* Docker includes [*a tool for developers to automatically assemble a container from their source - code*](/engine/reference/builder/), with full control over application + code*](/reference/dockerfile/), with full control over application dependencies, build tools, packaging etc. They are free to use `make`, `maven`, `chef`, `puppet`, `salt,` Debian packages, RPMs, source tarballs, or any combination of the above, regardless of the configuration of the machines. diff --git a/content/engine/install/binaries.md b/content/engine/install/binaries.md index 1392c8aadcd..41dd998fbc8 100644 --- a/content/engine/install/binaries.md +++ b/content/engine/install/binaries.md @@ -92,7 +92,7 @@ instructions for enabling and configuring AppArmor or SELinux. [Enabling `seccomp` for Docker](../security/seccomp.md). - Enable user namespaces if possible. See the - [Daemon user namespace options](/engine/reference/commandline/dockerd/#daemon-user-namespace-options). + [Daemon user namespace options](/reference/cli/dockerd/#daemon-user-namespace-options). ### Install static binaries @@ -252,4 +252,4 @@ version. - Continue to [Post-installation steps for Linux](linux-postinstall.md). - Review the topics in [Develop with Docker](../../develop/index.md) to learn - how to build new applications using Docker. \ No newline at end of file + how to build new applications using Docker. diff --git a/content/engine/security/_index.md b/content/engine/security/_index.md index b2127d1da58..7b03fd7cf4e 100644 --- a/content/engine/security/_index.md +++ b/content/engine/security/_index.md @@ -255,7 +255,7 @@ to a non uid-0 user outside the container, which can help to mitigate the risks of container breakout. This facility is available but not enabled by default. -Refer to the [daemon command](../reference/commandline/dockerd.md#daemon-user-namespace-options) +Refer to the [daemon command](../../reference/cli/dockerd.md#daemon-user-namespace-options) in the command line reference for more information on this feature. Additional information on the implementation of User Namespaces in Docker can be found in diff --git a/content/engine/security/trust/deploying_notary.md b/content/engine/security/trust/deploying_notary.md index 535a14fac5f..ec14211ede8 100644 --- a/content/engine/security/trust/deploying_notary.md +++ b/content/engine/security/trust/deploying_notary.md @@ -22,11 +22,11 @@ The easiest way to deploy Notary Server is by using Docker Compose. To follow th 3. Make sure that your Docker or Notary client trusts Notary Server's certificate before you try to interact with the Notary server. -See the instructions for [Docker](../../reference/commandline/cli.md#notary) or +See the instructions for [Docker](../../../engine/reference/commandline/cli.md#notary) or for [Notary](https://github.com/docker/notary#using-notary) depending on which one you are using. ## If you want to use Notary in production Check back here for instructions after Notary Server has an official stable release. To get a head start on deploying Notary in production, see -[the Notary repository](https://github.com/theupdateframework/notary). \ No newline at end of file +[the Notary repository](https://github.com/theupdateframework/notary). diff --git a/content/engine/swarm/_index.md b/content/engine/swarm/_index.md index 6f5612ed2d1..33c4cd7716b 100644 --- a/content/engine/swarm/_index.md +++ b/content/engine/swarm/_index.md @@ -129,12 +129,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/commandline/swarm_init.md) - * [swarm join](../reference/commandline/swarm_join.md) - * [service create](../reference/commandline/service_create.md) - * [service inspect](../reference/commandline/service_inspect.md) - * [service ls](../reference/commandline/service_ls.md) - * [service rm](../reference/commandline/service_rm.md) - * [service scale](../reference/commandline/service_scale.md) - * [service ps](../reference/commandline/service_ps.md) - * [service update](../reference/commandline/service_update.md) \ No newline at end of file + * [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) \ No newline at end of file diff --git a/content/engine/swarm/admin_guide.md b/content/engine/swarm/admin_guide.md index ee5460e47a7..dcdc47036a2 100644 --- a/content/engine/swarm/admin_guide.md +++ b/content/engine/swarm/admin_guide.md @@ -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/commandline/service_scale.md) and -[`docker service ps`](../reference/commandline/service_ps.md). \ No newline at end of file +[`docker service scale`](../../reference/cli/docker/service/scale.md) and +[`docker service ps`](../../reference/cli/docker/service/ps.md). \ No newline at end of file diff --git a/content/engine/swarm/configs.md b/content/engine/swarm/configs.md index 860c5ce2bd8..2b122c04ecc 100644 --- a/content/engine/swarm/configs.md +++ b/content/engine/swarm/configs.md @@ -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/commandline/config_create.md) -- [`docker config inspect`](../reference/commandline/config_inspect.md) -- [`docker config ls`](../reference/commandline/config_ls.md) -- [`docker config rm`](../reference/commandline/config_rm.md) +- [`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) ## Examples diff --git a/content/engine/swarm/how-swarm-mode-works/nodes.md b/content/engine/swarm/how-swarm-mode-works/nodes.md index c9b0423e5c0..718812f4826 100644 --- a/content/engine/swarm/how-swarm-mode-works/nodes.md +++ b/content/engine/swarm/how-swarm-mode-works/nodes.md @@ -68,17 +68,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/commandline/node_update.md) +Refer to the [`docker node update`](../../../reference/cli/docker/node/update.md) 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/commandline/node_promote.md). +take a manager node offline for maintenance. See [node promote](../../../reference/cli/docker/node/promote.md). You can also demote a manager node to a worker node. See -[node demote](../../reference/commandline/node_demote.md). +[node demote](../../../reference/cli/docker/node/demote.md). ## Learn more diff --git a/content/engine/swarm/how-swarm-mode-works/pki.md b/content/engine/swarm/how-swarm-mode-works/pki.md index 143a21f21ab..8ba21bc2152 100644 --- a/content/engine/swarm/how-swarm-mode-works/pki.md +++ b/content/engine/swarm/how-swarm-mode-works/pki.md @@ -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/commandline/swarm_init.md) command. +[docker swarm init](../../../reference/cli/docker/swarm/init.md) 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