From f8f3058b2293c21bf4ca98d5073229b43a7421ad Mon Sep 17 00:00:00 2001 From: khs1994 Date: Fri, 13 Oct 2023 09:01:34 +0800 Subject: [PATCH] Sync from docker/docker.github.io@d08111e by PCIT --- SUMMARY.md | 46 ++ .../cli/docs/reference/commandline/cli.md | 1 + .../cli/docs/reference/commandline/dockerd.md | 19 + .../docker/cli/docs/reference/run.md | 4 +- .../compose/v2/docs/reference/compose.md | 200 ++++++++ .../v2/docs/reference/compose_alpha.md | 22 + .../docs/reference/compose_alpha_dry-run.md | 8 + .../docs/reference/compose_alpha_publish.md | 14 + .../v2/docs/reference/compose_alpha_scale.md | 15 + .../v2/docs/reference/compose_alpha_viz.md | 19 + .../v2/docs/reference/compose_alpha_watch.md | 16 + .../v2/docs/reference/compose_build.md | 33 ++ .../v2/docs/reference/compose_config.md | 36 ++ .../compose/v2/docs/reference/compose_cp.md | 17 + .../v2/docs/reference/compose_create.md | 21 + .../compose/v2/docs/reference/compose_down.md | 33 ++ .../v2/docs/reference/compose_events.md | 36 ++ .../compose/v2/docs/reference/compose_exec.md | 27 ++ .../v2/docs/reference/compose_images.md | 16 + .../compose/v2/docs/reference/compose_kill.md | 23 + .../compose/v2/docs/reference/compose_logs.md | 24 + .../compose/v2/docs/reference/compose_ls.md | 21 + .../v2/docs/reference/compose_pause.md | 17 + .../compose/v2/docs/reference/compose_port.md | 19 + .../compose/v2/docs/reference/compose_ps.md | 121 +++++ .../compose/v2/docs/reference/compose_pull.md | 70 +++ .../compose/v2/docs/reference/compose_push.md | 37 ++ .../v2/docs/reference/compose_restart.md | 28 ++ .../compose/v2/docs/reference/compose_rm.md | 39 ++ .../compose/v2/docs/reference/compose_run.md | 89 ++++ .../v2/docs/reference/compose_scale.md | 15 + .../v2/docs/reference/compose_start.md | 17 + .../compose/v2/docs/reference/compose_stop.md | 18 + .../compose/v2/docs/reference/compose_top.md | 26 + .../v2/docs/reference/compose_unpause.md | 17 + .../compose/v2/docs/reference/compose_up.md | 59 +++ .../v2/docs/reference/compose_version.md | 15 + .../compose/v2/docs/reference/compose_wait.md | 15 + .../v2/docs/reference/compose_watch.md | 16 + .../v2/docs/reference}/docker_compose.yaml | 4 + .../docs/reference}/docker_compose_alpha.yaml | 2 + .../docker_compose_alpha_dry-run.yaml | 0 .../docker_compose_alpha_publish.yaml | 24 + .../reference/docker_compose_alpha_scale.yaml | 14 +- .../reference}/docker_compose_alpha_viz.yaml | 0 .../reference/docker_compose_alpha_watch.yaml | 47 ++ .../docs/reference}/docker_compose_build.yaml | 0 .../reference}/docker_compose_config.yaml | 0 .../reference}/docker_compose_convert.yaml | 0 .../v2/docs/reference}/docker_compose_cp.yaml | 0 .../reference}/docker_compose_create.yaml | 6 +- .../docs/reference}/docker_compose_down.yaml | 0 .../reference}/docker_compose_events.yaml | 0 .../docs/reference}/docker_compose_exec.yaml | 0 .../reference}/docker_compose_images.yaml | 0 .../docs/reference}/docker_compose_kill.yaml | 0 .../docs/reference}/docker_compose_logs.yaml | 0 .../v2/docs/reference}/docker_compose_ls.yaml | 0 .../docs/reference}/docker_compose_pause.yaml | 0 .../docs/reference}/docker_compose_port.yaml | 0 .../v2/docs/reference}/docker_compose_ps.yaml | 8 +- .../docs/reference}/docker_compose_pull.yaml | 9 + .../docs/reference}/docker_compose_push.yaml | 0 .../reference}/docker_compose_restart.yaml | 0 .../v2/docs/reference}/docker_compose_rm.yaml | 0 .../docs/reference}/docker_compose_run.yaml | 0 .../docs/reference/docker_compose_scale.yaml | 35 ++ .../docs/reference}/docker_compose_start.yaml | 0 .../docs/reference}/docker_compose_stop.yaml | 0 .../docs/reference}/docker_compose_top.yaml | 0 .../reference}/docker_compose_unpause.yaml | 0 .../v2/docs/reference}/docker_compose_up.yaml | 15 +- .../reference}/docker_compose_version.yaml | 0 .../docs/reference}/docker_compose_wait.yaml | 0 .../docs/reference/docker_compose_watch.yaml | 47 ++ .../moby/buildkit/docs/buildkitd.toml.md | 15 +- .../frontend/dockerfile/docs/reference.md | 101 +--- _vendor/modules.txt | 5 +- content/build/building/context.md | 455 ++++++++++++------ content/build/building/packaging.md | 6 +- content/build/cache/_index.md | 2 +- content/build/hydrobuild.md | 6 +- content/desktop/install/archlinux.md | 4 +- content/desktop/install/debian.md | 4 +- content/desktop/install/fedora.md | 4 +- content/desktop/install/ubuntu.md | 4 +- content/desktop/release-notes.md | 15 +- content/desktop/troubleshoot/topics.md | 4 +- content/develop/develop-images/guidelines.md | 268 ++--------- .../reference/commandline/compose_alpha.md | 13 + .../commandline/compose_alpha_dry-run.md | 13 + .../commandline/compose_alpha_publish.md | 13 + .../commandline/compose_alpha_scale.md | 13 + .../commandline/compose_alpha_viz.md | 13 + .../reference/commandline/compose_wait.md | 13 + .../reference/commandline/compose_watch.md | 13 + content/get-started/09_image_best.md | 4 +- content/network/proxy.md | 2 +- data/toc.yaml | 16 +- go.mod | 11 +- go.sum | 8 + hugo.yaml | 5 + layouts/shortcodes/admin-users.html | 30 +- 103 files changed, 2010 insertions(+), 530 deletions(-) create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_viz.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_watch.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_build.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_config.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_create.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_down.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_events.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_images.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_pause.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_port.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_push.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_rm.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_run.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_start.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_stop.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_top.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_up.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_version.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_wait.md create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/compose_watch.md rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose.yaml (99%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_alpha.yaml (90%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_alpha_dry-run.yaml (100%) create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml rename data/compose-cli/docker_compose_alpha_watch.yaml => _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_scale.yaml (64%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_alpha_viz.yaml (100%) create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_watch.yaml rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_build.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_config.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_convert.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_cp.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_create.yaml (94%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_down.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_events.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_exec.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_images.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_kill.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_logs.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_ls.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_pause.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_port.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_ps.yaml (93%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_pull.yaml (94%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_push.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_restart.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_rm.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_run.yaml (100%) create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_start.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_stop.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_top.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_unpause.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_up.yaml (94%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_version.yaml (100%) rename {data/compose-cli => _vendor/github.com/docker/compose/v2/docs/reference}/docker_compose_wait.yaml (100%) create mode 100644 _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_watch.yaml create mode 100644 content/engine/reference/commandline/compose_alpha.md create mode 100644 content/engine/reference/commandline/compose_alpha_dry-run.md create mode 100644 content/engine/reference/commandline/compose_alpha_publish.md create mode 100644 content/engine/reference/commandline/compose_alpha_scale.md create mode 100644 content/engine/reference/commandline/compose_alpha_viz.md create mode 100644 content/engine/reference/commandline/compose_wait.md create mode 100644 content/engine/reference/commandline/compose_watch.md diff --git a/SUMMARY.md b/SUMMARY.md index f49f05c01..c28d5c315 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -67,6 +67,45 @@ * [Dockerd](_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md) * [Run](_vendor/github.com/docker/cli/docs/reference/run.md) * [Deprecated](_vendor/github.com/docker/cli/docs/deprecated.md) + - Compose + - V 2 + - Docs + - Reference + * [Compose Alpha Dry Run](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md) + * [Compose Alpha Publish](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md) + * [Compose Alpha Scale](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md) + * [Compose Alpha Viz](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_viz.md) + * [Compose Alpha Watch](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_watch.md) + * [Compose Alpha](_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha.md) + * [Compose Build](_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md) + * [Compose Config](_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md) + * [Compose Cp](_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md) + * [Compose Create](_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md) + * [Compose Down](_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md) + * [Compose Events](_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md) + * [Compose Exec](_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md) + * [Compose Images](_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md) + * [Compose Kill](_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md) + * [Compose Logs](_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md) + * [Compose Ls](_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md) + * [Compose Pause](_vendor/github.com/docker/compose/v2/docs/reference/compose_pause.md) + * [Compose Port](_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md) + * [Compose Ps](_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md) + * [Compose Pull](_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md) + * [Compose Push](_vendor/github.com/docker/compose/v2/docs/reference/compose_push.md) + * [Compose Restart](_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md) + * [Compose Rm](_vendor/github.com/docker/compose/v2/docs/reference/compose_rm.md) + * [Compose Run](_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md) + * [Compose Scale](_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md) + * [Compose Start](_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md) + * [Compose Stop](_vendor/github.com/docker/compose/v2/docs/reference/compose_stop.md) + * [Compose Top](_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md) + * [Compose Unpause](_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md) + * [Compose Up](_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md) + * [Compose Version](_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md) + * [Compose Wait](_vendor/github.com/docker/compose/v2/docs/reference/compose_wait.md) + * [Compose Watch](_vendor/github.com/docker/compose/v2/docs/reference/compose_watch.md) + * [Compose](_vendor/github.com/docker/compose/v2/docs/reference/compose.md) - Compose Cli - Docs * [ACI Integration Compose Features](_vendor/github.com/docker/compose-cli/docs/aci-compose-features.md) @@ -639,6 +678,11 @@ * [Docker Checkpoint Rm](content/engine/reference/commandline/checkpoint_rm.md) * [Docker Checkpoint](content/engine/reference/commandline/checkpoint.md) * [Docker Commit](content/engine/reference/commandline/commit.md) + * [Docker Compose Alpha Dry Run](content/engine/reference/commandline/compose_alpha_dry-run.md) + * [Docker Compose Alpha Publish](content/engine/reference/commandline/compose_alpha_publish.md) + * [Docker Compose Alpha Scale](content/engine/reference/commandline/compose_alpha_scale.md) + * [Docker Compose Alpha Viz](content/engine/reference/commandline/compose_alpha_viz.md) + * [Docker Compose Alpha](content/engine/reference/commandline/compose_alpha.md) * [Docker Compose Build](content/engine/reference/commandline/compose_build.md) * [Docker Compose Config](content/engine/reference/commandline/compose_config.md) * [Docker Compose Cp](content/engine/reference/commandline/compose_cp.md) @@ -664,6 +708,8 @@ * [Docker Compose Unpause](content/engine/reference/commandline/compose_unpause.md) * [Docker Compose Up](content/engine/reference/commandline/compose_up.md) * [Docker Compose Version](content/engine/reference/commandline/compose_version.md) + * [Docker Compose Wait](content/engine/reference/commandline/compose_wait.md) + * [Docker Compose Watch](content/engine/reference/commandline/compose_watch.md) * [Docker Compose](content/engine/reference/commandline/compose.md) * [Docker Config Create](content/engine/reference/commandline/config_create.md) * [Docker Config Inspect](content/engine/reference/commandline/config_inspect.md) 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 93df51ea4..92f4f3907 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md +++ b/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md @@ -134,6 +134,7 @@ line: | `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](build.md) with [BuildKit backend](https://docs.docker.com/build/buildkit/). Use plain to show container output (default `auto`). | diff --git a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md b/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md index ae733592d..f29004547 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md +++ b/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md @@ -1265,6 +1265,25 @@ the host. For details about how to use this feature, as well as limitations, see [Isolate containers with a user namespace](https://docs.docker.com/engine/security/userns-remap/). +### Configure host gateway IP + +The Docker daemon supports a special `host-gateway` value for the `--add-host` +flag for the `docker run` and `docker build` commands. This value resolves to +the host's gateway IP and lets containers connect to services running on the +host. + +By default, `host-gateway` resolves to the IP address of the default bridge. +You can configure this to resolve to a different IP using the `--host-gateway-ip` +flag for the dockerd command line interface, or the `host-gateway-ip` key in +the daemon configuration file. + +```console +$ dockerd --host-gateway-ip 192.0.2.0 +$ docker run -it --add-host host.docker.internal:host-gateway \ + busybox ping host.docker.internal +PING host.docker.internal (192.0.2.0): 56 data bytes +``` + ### Miscellaneous options IP masquerading uses address translation to allow containers without a public diff --git a/_vendor/github.com/docker/cli/docs/reference/run.md b/_vendor/github.com/docker/cli/docs/reference/run.md index e9a671c27..5737bb3dc 100644 --- a/_vendor/github.com/docker/cli/docs/reference/run.md +++ b/_vendor/github.com/docker/cli/docs/reference/run.md @@ -672,7 +672,7 @@ the container exits**, you can add the `--rm` flag: > ```console > $ docker run --rm -v /foo -v awesome:/bar busybox top > ``` -> +> > the volume for `/foo` will be removed, but the volume for `/bar` will not. > Volumes inherited via `--volumes-from` will be removed with the same logic: if > the original volume was specified with a name it will **not** be removed. @@ -1418,7 +1418,7 @@ container's logging driver. The following options are supported: | `fluentd` | Fluentd logging driver for Docker. Writes log messages to `fluentd` (forward input). | | `awslogs` | Amazon CloudWatch Logs logging driver for Docker. Writes log messages to Amazon CloudWatch Logs. | | `splunk` | Splunk logging driver for Docker. Writes log messages to `splunk` using Event Http Collector. | -| `etwlogs` | Event Tracing for Windows (ETW) events. Writes log messages as Event Tracing for Windows (ETW) events. Only Windows platforms. | +| `etwlogs` | Event Tracing for Windows (ETW) events. Writes log messages as Event Tracing for Windows (ETW) events. Only Windows platforms. | | `gcplogs` | Google Cloud Platform (GCP) Logging. Writes log messages to Google Cloud Platform (GCP) Logging. | | `logentries` | Rapid7 Logentries. Writes log messages to Rapid7 Logentries. | diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md new file mode 100644 index 000000000..052124bbe --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose.md @@ -0,0 +1,200 @@ +# docker compose + + +Define and run multi-container applications with Docker. + +### Subcommands + +| Name | Description | +|:--------------------------------|:--------------------------------------------------------------------------------------| +| [`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 | +| [`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 + +| Name | Type | Default | Description | +|:-----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------| +| `--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. | +| `-f`, `--file` | `stringArray` | | Compose configuration files | +| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | +| `--profile` | `stringArray` | | Specify a profile to enable | +| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) | +| `--project-directory` | `string` | | Specify an alternate working directory
(default: the path of the, first specified, Compose file) | +| `-p`, `--project-name` | `string` | | Project name | + + + + +## Description + +You can use compose subcommand, `docker compose [-f ...] [options] [COMMAND] [ARGS...]`, to build and manage +multiple services in Docker containers. + +### Use `-f` to specify the name and path of one or more Compose files +Use the `-f` flag to specify the location of a Compose configuration file. + +#### Specifying multiple Compose files +You can supply multiple `-f` configuration files. When you supply multiple files, Compose combines them into a single +configuration. Compose builds the configuration in the order you supply the files. Subsequent files override and add +to their predecessors. + +For example, consider this command line: + +```console +$ docker compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db +``` + +The `docker-compose.yml` file might specify a `webapp` service. + +```yaml +services: + webapp: + image: examples/web + ports: + - "8000:8000" + volumes: + - "/data" +``` +If the `docker-compose.admin.yml` also specifies this same service, any matching fields override the previous file. +New values, add to the `webapp` service configuration. + +```yaml +services: + webapp: + build: . + environment: + - DEBUG=1 +``` + +When you use multiple Compose files, all paths in the files are relative to the first configuration file specified +with `-f`. You can use the `--project-directory` option to override this base path. + +Use a `-f` with `-` (dash) as the filename to read the configuration from stdin. When stdin is used all paths in the +configuration are relative to the current working directory. + +The `-f` flag is optional. If you don’t provide this flag on the command line, Compose traverses the working directory +and its parent directories looking for a `compose.yaml` or `docker-compose.yaml` file. + +#### Specifying a path to a single Compose 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 in your shell or in an environment file. + +For an example of using the `-f` option at the command line, suppose you are running the Compose Rails sample, and +have a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like `docker compose pull` to +get the postgres image for the db service from anywhere by using the `-f` flag as follows: + +```console +$ docker compose -f ~/sandbox/rails/compose.yaml pull db +``` + +### Use `-p` to specify a project name + +Each configuration has a project name. Compose sets the project name using +the following mechanisms, in order of precedence: +- The `-p` command line flag +- The `COMPOSE_PROJECT_NAME` environment variable +- The top level `name:` variable from the config file (or the last `name:` +from a series of config files specified using `-f`) +- The `basename` of the project directory containing the config file (or +containing the first config file specified using `-f`) +- The `basename` of the current directory if no config file is specified +Project names must contain only lowercase letters, decimal digits, dashes, +and underscores, and must begin with a lowercase letter or decimal digit. If +the `basename` of the project directory or current directory violates this +constraint, you must use one of the other mechanisms. + +```console +$ docker compose -p my_project ps -a +NAME SERVICE STATUS PORTS +my_project_demo_1 demo running + +$ docker compose -p my_project logs +demo_1 | PING localhost (127.0.0.1): 56 data bytes +demo_1 | 64 bytes from 127.0.0.1: seq=0 ttl=64 time=0.095 ms +``` + +### Use profiles to enable optional services + +Use `--profile` to specify one or more active profiles +Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services +without any specified profiles. +You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. + +Profiles can also be set by `COMPOSE_PROFILES` environment variable. + +### Configuring parallelism + +Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. +Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file +one at a time. This can also be used to control build concurrency. + +Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. + +### Set up environment variables + +You can set environment variables for various docker compose options, including the `-f`, `-p` and `--profiles` flags. + +Setting the `COMPOSE_FILE` environment variable is equivalent to passing the `-f` flag, +`COMPOSE_PROJECT_NAME` environment variable does the same as the `-p` flag, +`COMPOSE_PROFILES` environment variable is equivalent to the `--profiles` flag +and `COMPOSE_PARALLEL_LIMIT` does the same as the `--parallel` flag. + +If flags are explicitly set on the command line, the associated environment variable is ignored. + +Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned +containers for the project. + +### Use Dry Run mode to test your command + +Use `--dry-run` flag to test a command without changing your application stack state. +Dry Run mode shows you all the steps Compose applies when executing a command, for example: +```console +$ docker compose --dry-run up --build -d +[+] Pulling 1/1 + ✔ DRY-RUN MODE - db Pulled 0.9s +[+] Running 10/8 + ✔ DRY-RUN MODE - build service backend 0.0s + ✔ DRY-RUN MODE - ==> ==> writing image dryRun-754a08ddf8bcb1cf22f310f09206dd783d42f7dd 0.0s + ✔ DRY-RUN MODE - ==> ==> naming to nginx-golang-mysql-backend 0.0s + ✔ DRY-RUN MODE - Network nginx-golang-mysql_default Created 0.0s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-db-1 Created 0.0s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Created 0.0s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Created 0.0s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-db-1 Healthy 0.5s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Started 0.0s + ✔ DRY-RUN MODE - Container nginx-golang-mysql-proxy-1 Started Started +``` +From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service. +Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting. + +Dry Run mode works with almost all commands. You cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example. diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha.md new file mode 100644 index 000000000..34485d7de --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha.md @@ -0,0 +1,22 @@ +# docker compose alpha + + +Experimental commands + +### Subcommands + +| Name | Description | +|:----------------------------------|:-----------------------------------------------------------------------------------------------------| +| [`viz`](compose_alpha_viz.md) | EXPERIMENTAL - Generate a graphviz graph from your compose file | +| [`watch`](compose_alpha_watch.md) | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated | + + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + 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 new file mode 100644 index 000000000..a66ed5340 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_dry-run.md @@ -0,0 +1,8 @@ +# docker compose alpha dry-run + + +EXPERIMENTAL - Dry run command allow 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 new file mode 100644 index 000000000..056d211b0 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_publish.md @@ -0,0 +1,14 @@ +# docker compose alpha publish + + +Publish compose application + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + 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 new file mode 100644 index 000000000..3cda50e20 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_scale.md @@ -0,0 +1,15 @@ +# docker compose alpha scale + + +Scale services + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--no-deps` | | | Don't start linked services. | + + + + diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_viz.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_viz.md new file mode 100644 index 000000000..04bffc0b8 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_viz.md @@ -0,0 +1,19 @@ +# docker compose alpha viz + + +EXPERIMENTAL - Generate a graphviz graph from your compose file + +### Options + +| Name | Type | Default | Description | +|:---------------------|:------|:--------|:---------------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--image` | | | Include service's image name in output graph | +| `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | +| `--networks` | | | Include service's attached networks in output graph | +| `--ports` | | | Include service's exposed ports in output graph | +| `--spaces` | | | If given, space character ' ' will be used to indent,
otherwise tab character '\t' will be used | + + + + diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_watch.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_watch.md new file mode 100644 index 000000000..aa8130e7a --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_alpha_watch.md @@ -0,0 +1,16 @@ +# docker compose alpha watch + + +Watch build context for service and rebuild/refresh containers when files are updated + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:----------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--no-up` | | | Do not build & start services before watching | +| `--quiet` | | | hide build output | + + + + 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 new file mode 100644 index 000000000..1eaec63e8 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_build.md @@ -0,0 +1,33 @@ +# docker compose build + + +Build or rebuild services + +### Options + +| Name | Type | Default | Description | +|:-----------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------| +| `--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. | +| `-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) | + + + + +## Description + +Services are built once and then tagged, by default as `project_service`. + +If the Compose file specifies an +[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, +the image is tagged with that name, substituting any variables beforehand. See +[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). + +If you change a service's `Dockerfile` or the contents of its build directory, +run `docker compose build` to rebuild it. 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 new file mode 100644 index 000000000..15612ea33 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_config.md @@ -0,0 +1,36 @@ +# docker compose convert + + +Parse, resolve and render compose file in canonical format + +### Aliases + +`docker compose config`, `docker compose convert` + +### Options + +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| +| `--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. | +| `--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. | +| `-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. | + + + + +## Description + +`docker compose config` renders the actual data model to be applied on the Docker engine. +it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into +the canonical format. 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 new file mode 100644 index 000000000..9be79443a --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_cp.md @@ -0,0 +1,17 @@ +# docker compose cp + + +Copy files/folders between a service container and the local filesystem + +### Options + +| Name | Type | Default | Description | +|:----------------------|:------|:--------|:--------------------------------------------------------| +| `-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 | + + + + 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 new file mode 100644 index 000000000..0efcc9017 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_create.md @@ -0,0 +1,21 @@ +# docker compose create + + +Creates containers for a service. + +### Options + +| Name | Type | Default | Description | +|:-------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------| +| `--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. | +| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | +| `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | +| `--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 new file mode 100644 index 000000000..92d10389d --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_down.md @@ -0,0 +1,33 @@ +# docker compose down + + +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. | + + + + +## Description + +Stops containers and removes containers, networks, volumes, and images created by `up`. + +By default, the only things removed are: + +- Containers for services defined in the Compose file +- Networks defined in the networks section of the Compose file +- The default network, if one is used + +Networks and volumes defined as external are never removed. + +Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically +mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or +named volumes. 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 new file mode 100644 index 000000000..3c231fbc4 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_events.md @@ -0,0 +1,36 @@ +# docker compose events + + +Receive real time events from containers. + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--json` | | | Output events as a stream of json objects | + + + + +## Description + +Stream container events for every container in the project. + +With the `--json` flag, a json object is printed one per line with the format: + +```json +{ + "time": "2015-11-20T18:01:03.615550", + "type": "container", + "action": "create", + "id": "213cf7...5fc39a", + "service": "web", + "attributes": { + "name": "application_web_1", + "image": "alpine:edge" + } +} +``` + +The events that can be received using this can be seen [here](https://docs.docker.com/engine/reference/commandline/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 new file mode 100644 index 000000000..7c5f7d6a4 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_exec.md @@ -0,0 +1,27 @@ +# docker compose exec + + +Execute a command in a running container. + +### Options + +| Name | Type | Default | Description | +|:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| +| `-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 | +| `-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. | + + + + +## Description + +This is the equivalent of `docker exec` targeting a Compose service. + +With this subcommand, you can run arbitrary commands in your services. Commands allocate a TTY by default, so +you can use a command such as `docker compose exec web sh` to get an interactive prompt. 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 new file mode 100644 index 000000000..02a8f57ec --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_images.md @@ -0,0 +1,16 @@ +# docker compose images + + +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 | + + + + 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 new file mode 100644 index 000000000..2e79d806e --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_kill.md @@ -0,0 +1,23 @@ +# docker compose kill + + +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. | + + + + +## Description + +Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example: + +```console +$ docker-compose kill -s SIGINT +``` 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 new file mode 100644 index 000000000..58f56ed09 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_logs.md @@ -0,0 +1,24 @@ +# docker compose logs + + +View output from containers + +### Options + +| Name | Type | Default | Description | +|:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `-f`, `--follow` | | | Follow log output. | +| `--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. | +| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | + + + + +## Description + +Displays log output from services. \ No newline at end of file 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 new file mode 100644 index 000000000..50a13d96f --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ls.md @@ -0,0 +1,21 @@ +# docker compose ls + + +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. | + + + + +## Description + +Lists running Compose projects. \ No newline at end of file diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_pause.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_pause.md new file mode 100644 index 000000000..334c82f18 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_pause.md @@ -0,0 +1,17 @@ +# docker compose pause + + +Pause services + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + +## Description + +Pauses running containers of a service. They can be unpaused with `docker compose unpause`. \ No newline at end of file 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 new file mode 100644 index 000000000..ffd3d8eb5 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_port.md @@ -0,0 +1,19 @@ +# docker compose port + + +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 | +| `--protocol` | `string` | `tcp` | tcp or udp | + + + + +## Description + +Prints the public port for a port binding. \ No newline at end of file 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 new file mode 100644 index 000000000..15c7b1b69 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_ps.md @@ -0,0 +1,121 @@ +# docker compose ps + + +List containers + +### Options + +| Name | Type | Default | Description | +|:----------------------|:--------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-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). | +| [`--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 | +| `-q`, `--quiet` | | | Only display IDs | +| `--services` | | | Display services | +| [`--status`](#status) | `stringArray` | | Filter services by status. Values: [paused \| restarting \| removing \| running \| dead \| created \| exited] | + + + + +## Description + +Lists containers for a Compose project, with current status and exposed ports. + +```console +$ docker compose ps +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp +``` + +By default, only running containers are shown. `--all` flag can be used to include stopped containers + +```console +$ docker compose ps --all +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp +example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0) +``` + +## Examples + +### Format the output (--format) + +By default, the `docker compose ps` command uses a table ("pretty") format to +show the containers. The `--format` flag allows you to specify alternative +presentations for the output. Currently, supported options are `pretty` (default), +and `json`, which outputs information about the containers as a JSON array: + +```console +$ docker compose ps --format json +[{"ID":"1553b0236cf4d2715845f053a4ee97042c4f9a2ef655731ee34f1f7940eaa41a","Name":"example-bar-1","Command":"/docker-entrypoint.sh nginx -g 'daemon off;'","Project":"example","Service":"bar","State":"exited","Health":"","ExitCode":0,"Publishers":null},{"ID":"f02a4efaabb67416e1ff127d51c4b5578634a0ad5743bd65225ff7d1909a3fa0","Name":"example-foo-1","Command":"/docker-entrypoint.sh nginx -g 'daemon off;'","Project":"example","Service":"foo","State":"running","Health":"","ExitCode":0,"Publishers":[{"URL":"0.0.0.0","TargetPort":80,"PublishedPort":8080,"Protocol":"tcp"}]}] +``` + +The JSON output allows you to use the information in other tools for further +processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} +to pretty-print the JSON: + +```console +$ docker compose ps --format json | jq . +[ + { + "ID": "1553b0236cf4d2715845f053a4ee97042c4f9a2ef655731ee34f1f7940eaa41a", + "Name": "example-bar-1", + "Command": "/docker-entrypoint.sh nginx -g 'daemon off;'", + "Project": "example", + "Service": "bar", + "State": "exited", + "Health": "", + "ExitCode": 0, + "Publishers": null + }, + { + "ID": "f02a4efaabb67416e1ff127d51c4b5578634a0ad5743bd65225ff7d1909a3fa0", + "Name": "example-foo-1", + "Command": "/docker-entrypoint.sh nginx -g 'daemon off;'", + "Project": "example", + "Service": "foo", + "State": "running", + "Health": "", + "ExitCode": 0, + "Publishers": [ + { + "URL": "0.0.0.0", + "TargetPort": 80, + "PublishedPort": 8080, + "Protocol": "tcp" + } + ] + } +] +``` + +### Filter containers by status (--status) + +Use the `--status` flag to filter the list of containers by status. For example, +to show only containers that are running or only containers that have exited: + +```console +$ docker compose ps --status=running +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp + +$ docker compose ps --status=exited +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0) +``` + +### Filter containers by status (--filter) + +The [`--status` flag](#status) is a convenient shorthand for the `--filter status=` +flag. The example below is the equivalent to the example from the previous section, +this time using the `--filter` flag: + +```console +$ docker compose ps --filter status=running +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp +``` + +The `docker compose ps` command currently only supports the `--filter status=` +option, but additional filter options may be added in the future. 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 new file mode 100644 index 000000000..e68328fa7 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_pull.md @@ -0,0 +1,70 @@ +# docker compose pull + + +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. | + + + + +## Description + +Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on +those images. + + +## Examples + +suppose you have this `compose.yaml`: + +```yaml +services: + db: + image: postgres + web: + build: . + command: bundle exec rails s -p 3000 -b '0.0.0.0' + volumes: + - .:/myapp + ports: + - "3000:3000" + depends_on: + - db +``` + +If you run `docker compose pull ServiceName` in the same directory as the `compose.yaml` file that defines the service, +Docker pulls the associated image. For example, to call the postgres image configured as the db service in our example, +you would run `docker compose pull db`. + +```console +$ docker compose pull db +[+] Running 1/15 + ⠸ db Pulling 12.4s + ⠿ 45b42c59be33 Already exists 0.0s + ⠹ 40adec129f1a Downloading 3.374MB/4.178MB 9.3s + ⠹ b4c431d00c78 Download complete 9.3s + ⠹ 2696974e2815 Download complete 9.3s + ⠹ 564b77596399 Downloading 5.622MB/7.965MB 9.3s + ⠹ 5044045cf6f2 Downloading 216.7kB/391.1kB 9.3s + ⠹ d736e67e6ac3 Waiting 9.3s + ⠹ 390c1c9a5ae4 Waiting 9.3s + ⠹ c0e62f172284 Waiting 9.3s + ⠹ ebcdc659c5bf Waiting 9.3s + ⠹ 29be22cb3acc Waiting 9.3s + ⠹ f63c47038e66 Waiting 9.3s + ⠹ 77a0c198cde5 Waiting 9.3s + ⠹ c8752d5b785c Waiting 9.3s +``` + +`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let +user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_push.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_push.md new file mode 100644 index 000000000..90a4fef24 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_push.md @@ -0,0 +1,37 @@ +# docker compose push + + +Push service images + +### Options + +| Name | Type | Default | Description | +|:-------------------------|:-----|:--------|:-------------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--ignore-push-failures` | | | Push what it can and ignores images with push failures | +| `--include-deps` | | | Also push images of services declared as dependencies | +| `-q`, `--quiet` | | | Push without printing progress information | + + + + +## Description + +Pushes images for services to their respective registry/repository. + +The following assumptions are made: +- You are pushing an image you have built locally +- You have access to the build key + +Examples + +```yaml +services: + service1: + build: . + image: localhost:5000/yourimage ## goes to local registry + + service2: + build: . + image: your-dockerid/yourimage ## goes to your repository on Docker Hub +``` 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 new file mode 100644 index 000000000..973851ab5 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_restart.md @@ -0,0 +1,28 @@ +# docker compose restart + + +Restart service containers + +### Options + +| Name | Type | Default | Description | +|:------------------|:------|:--------|:--------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--no-deps` | | | Don't restart dependent services. | +| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | + + + + +## Description + +Restarts all stopped and running services, or the specified services only. + +If you make changes to your `compose.yml` configuration, these changes are not reflected +after running this command. For example, changes to environment variables (which are added +after a container is built, but before the container's command is executed) are not updated +after restarting. + +If you are looking to configure a service's restart policy, please refer to +[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) +or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_rm.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_rm.md new file mode 100644 index 000000000..cbd8e50f6 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_rm.md @@ -0,0 +1,39 @@ +# docker compose rm + + +Removes stopped service containers + +By default, anonymous volumes attached to containers will not be removed. You +can override this with -v. To list all volumes, use "docker volume ls". + +Any data which is not in a volume will be lost. + +### Options + +| Name | Type | Default | Description | +|:------------------|:-----|:--------|:----------------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `-f`, `--force` | | | Don't ask to confirm removal | +| `-s`, `--stop` | | | Stop the containers, if required, before removing | +| `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers | + + + + +## Description + +Removes stopped service containers. + +By default, anonymous volumes attached to containers are not removed. You can override this with `-v`. To list all +volumes, use `docker volume ls`. + +Any data which is not in a volume is lost. + +Running the command with no options also removes one-off containers created by `docker compose run`: + +```console +$ docker compose rm +Going to remove djangoquickstart_web_run_1 +Are you sure? [yN] y +Removing djangoquickstart_web_run_1 ... done +``` 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 new file mode 100644 index 000000000..3eea660e5 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_run.md @@ -0,0 +1,89 @@ +# docker compose run + + +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 | +| `--service-ports` | | | Run command with the 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 | + + + + +## Description + +Runs a one-time command against a service. + +The following command starts the `web` service and runs `bash` as its command: + +```console +$ docker compose run web bash +``` + +Commands you use with run start in new containers with configuration defined by that of the service, +including volumes, links, and other details. However, there are two important differences: + +First, the command passed by `run` overrides the command defined in the service configuration. For example, if the +`web` service configuration is started with `bash`, then `docker compose run web python app.py` overrides it with +`python app.py`. + +The second difference is that the `docker compose run` command does not create any of the ports specified in the +service configuration. This prevents port collisions with already-open ports. If you do want the service’s ports +to be created and mapped to the host, specify the `--service-ports` + +```console +$ docker compose run --service-ports web python manage.py shell +``` + +Alternatively, manual port mapping can be specified with the `--publish` or `-p` options, just as when using docker run: + +```console +$ docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell +``` + +If you start a service configured with links, the run command first checks to see if the linked service is running +and starts the service if it is stopped. Once all the linked services are running, the run executes the command you +passed it. For example, you could run: + +```console +$ docker compose run db psql -h db -U docker +``` + +This opens an interactive PostgreSQL shell for the linked `db` container. + +If you do not want the run command to start linked containers, use the `--no-deps` flag: + +```console +$ docker compose run --no-deps web python manage.py shell +``` + +If you want to remove the container after running while overriding the container’s restart policy, use the `--rm` flag: + +```console +$ docker compose run --rm web python manage.py db upgrade +``` + +This runs a database upgrade script, and removes the container when finished running, even if a restart policy is +specified in the service configuration. 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 new file mode 100644 index 000000000..5cf5830e2 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_scale.md @@ -0,0 +1,15 @@ +# docker compose scale + + +Scale services + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--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 new file mode 100644 index 000000000..b525347f7 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_start.md @@ -0,0 +1,17 @@ +# docker compose start + + +Start services + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + +## Description + +Starts existing containers for a service. diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_stop.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_stop.md new file mode 100644 index 000000000..e7cf92a80 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_stop.md @@ -0,0 +1,18 @@ +# docker compose stop + + +Stop services + +### Options + +| Name | Type | Default | Description | +|:------------------|:------|:--------|:--------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | + + + + +## Description + +Stops running containers without removing them. They can be started again with `docker compose start`. 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 new file mode 100644 index 000000000..9aff0ce71 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_top.md @@ -0,0 +1,26 @@ +# docker compose top + + +Display the running processes + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + +## Description + +Displays the running processes. + +## Examples + +```console +$ docker compose top +example_foo_1 +UID PID PPID C STIME TTY TIME CMD +root 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5 +``` 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 new file mode 100644 index 000000000..0df10a992 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_unpause.md @@ -0,0 +1,17 @@ +# docker compose unpause + + +Unpause services + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:--------------------------------| +| `--dry-run` | | | Execute command in dry run mode | + + + + +## Description + +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 new file mode 100644 index 000000000..8f7428e05 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_up.md @@ -0,0 +1,59 @@ +# docker compose up + + +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"\|"policy"\|"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. | + + + + +## Description + +Builds, (re)creates, starts, and attaches to containers for a service. + +Unless they are already running, this command also starts any linked services. + +The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does). +One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using +`--no-attach` to prevent output to be flooded by some verbose services. + +When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the +background and leaves them running. + +If there are existing containers for a service, and the service’s configuration or image was changed after the +container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers +(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag. + +If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag. + +If the process encounters an error, the exit code for this command is `1`. +If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`. 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 new file mode 100644 index 000000000..66081d65e --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_version.md @@ -0,0 +1,15 @@ +# docker compose version + + +Show the Docker Compose version information + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:---------------------------------------------------------------| +| `--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. | + + + diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_wait.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_wait.md new file mode 100644 index 000000000..9c9ff6f1c --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_wait.md @@ -0,0 +1,15 @@ +# docker compose wait + + +Block until the first service container stops + +### Options + +| Name | Type | Default | Description | +|:-----------------|:-----|:--------|:---------------------------------------------| +| `--down-project` | | | Drops project when the first container stops | +| `--dry-run` | | | Execute command in dry run mode | + + + + diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/compose_watch.md b/_vendor/github.com/docker/compose/v2/docs/reference/compose_watch.md new file mode 100644 index 000000000..068704618 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/compose_watch.md @@ -0,0 +1,16 @@ +# docker compose watch + + +Watch build context for service and rebuild/refresh containers when files are updated + +### Options + +| Name | Type | Default | Description | +|:------------|:-----|:--------|:----------------------------------------------| +| `--dry-run` | | | Execute command in dry run mode | +| `--no-up` | | | Do not build & start services before watching | +| `--quiet` | | | hide build output | + + + + diff --git a/data/compose-cli/docker_compose.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml similarity index 99% rename from data/compose-cli/docker_compose.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml index 4f7416676..b6f5d76c5 100644 --- a/data/compose-cli/docker_compose.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose.yaml @@ -165,6 +165,7 @@ cname: - docker compose restart - docker compose rm - docker compose run + - docker compose scale - docker compose start - docker compose stop - docker compose top @@ -172,6 +173,7 @@ cname: - docker compose up - docker compose version - docker compose wait + - docker compose watch clink: - docker_compose_build.yaml - docker_compose_config.yaml @@ -192,6 +194,7 @@ clink: - docker_compose_restart.yaml - docker_compose_rm.yaml - docker_compose_run.yaml + - docker_compose_scale.yaml - docker_compose_start.yaml - docker_compose_stop.yaml - docker_compose_top.yaml @@ -199,6 +202,7 @@ clink: - docker_compose_up.yaml - docker_compose_version.yaml - docker_compose_wait.yaml + - docker_compose_watch.yaml options: - option: ansi value_type: string diff --git a/data/compose-cli/docker_compose_alpha.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha.yaml similarity index 90% rename from data/compose-cli/docker_compose_alpha.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha.yaml index 2598c0e88..43994d80c 100644 --- a/data/compose-cli/docker_compose_alpha.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha.yaml @@ -4,9 +4,11 @@ long: Experimental commands pname: docker compose plink: docker_compose.yaml cname: + - docker compose alpha publish - docker compose alpha viz - docker compose alpha watch clink: + - docker_compose_alpha_publish.yaml - docker_compose_alpha_viz.yaml - docker_compose_alpha_watch.yaml inherited_options: diff --git a/data/compose-cli/docker_compose_alpha_dry-run.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_dry-run.yaml similarity index 100% rename from data/compose-cli/docker_compose_alpha_dry-run.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_dry-run.yaml 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 new file mode 100644 index 000000000..ba01e166a --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_publish.yaml @@ -0,0 +1,24 @@ +command: docker compose alpha publish +short: Publish compose application +long: Publish compose application +usage: docker compose alpha publish [OPTIONS] [REPOSITORY] +pname: docker compose alpha +plink: docker_compose_alpha.yaml +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/data/compose-cli/docker_compose_alpha_watch.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_scale.yaml similarity index 64% rename from data/compose-cli/docker_compose_alpha_watch.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_scale.yaml index 6a3f5d52e..cc381493f 100644 --- a/data/compose-cli/docker_compose_alpha_watch.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_scale.yaml @@ -1,16 +1,14 @@ -command: docker compose alpha watch -short: | - EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated -long: | - EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated -usage: docker compose alpha watch [SERVICE...] +command: docker compose alpha scale +short: Scale services +long: Scale services +usage: docker compose alpha scale [SERVICE=REPLICAS...] pname: docker compose alpha plink: docker_compose_alpha.yaml options: - - option: quiet + - option: no-deps value_type: bool default_value: "false" - description: hide build output + description: Don't start linked services. deprecated: false hidden: false experimental: false diff --git a/data/compose-cli/docker_compose_alpha_viz.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_viz.yaml similarity index 100% rename from data/compose-cli/docker_compose_alpha_viz.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_viz.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_watch.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_watch.yaml new file mode 100644 index 000000000..e8a7d9845 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_alpha_watch.yaml @@ -0,0 +1,47 @@ +command: docker compose alpha watch +short: | + Watch build context for service and rebuild/refresh containers when files are updated +long: | + Watch build context for service and rebuild/refresh containers when files are updated +usage: docker compose alpha watch [SERVICE...] +pname: docker compose alpha +plink: docker_compose_alpha.yaml +options: + - option: no-up + value_type: bool + default_value: "false" + description: Do not build & start services before watching + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false + - option: quiet + value_type: bool + default_value: "false" + description: hide build output + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/data/compose-cli/docker_compose_build.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml similarity index 100% rename from data/compose-cli/docker_compose_build.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_build.yaml diff --git a/data/compose-cli/docker_compose_config.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml similarity index 100% rename from data/compose-cli/docker_compose_config.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_config.yaml diff --git a/data/compose-cli/docker_compose_convert.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_convert.yaml similarity index 100% rename from data/compose-cli/docker_compose_convert.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_convert.yaml diff --git a/data/compose-cli/docker_compose_cp.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml similarity index 100% rename from data/compose-cli/docker_compose_cp.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_cp.yaml diff --git a/data/compose-cli/docker_compose_create.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml similarity index 94% rename from data/compose-cli/docker_compose_create.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml index 0e3e77d6e..b7821e775 100644 --- a/data/compose-cli/docker_compose_create.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_create.yaml @@ -29,7 +29,7 @@ options: - option: no-build value_type: bool default_value: "false" - description: Don't build an image, even if it's missing. + description: Don't build an image, even if it's policy. deprecated: false hidden: false experimental: false @@ -49,8 +49,8 @@ options: swarm: false - option: pull value_type: string - default_value: missing - description: Pull image before running ("always"|"missing"|"never") + default_value: policy + description: Pull image before running ("always"|"policy"|"never") deprecated: false hidden: false experimental: false diff --git a/data/compose-cli/docker_compose_down.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml similarity index 100% rename from data/compose-cli/docker_compose_down.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_down.yaml diff --git a/data/compose-cli/docker_compose_events.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml similarity index 100% rename from data/compose-cli/docker_compose_events.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_events.yaml diff --git a/data/compose-cli/docker_compose_exec.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml similarity index 100% rename from data/compose-cli/docker_compose_exec.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_exec.yaml diff --git a/data/compose-cli/docker_compose_images.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml similarity index 100% rename from data/compose-cli/docker_compose_images.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_images.yaml diff --git a/data/compose-cli/docker_compose_kill.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml similarity index 100% rename from data/compose-cli/docker_compose_kill.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_kill.yaml diff --git a/data/compose-cli/docker_compose_logs.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml similarity index 100% rename from data/compose-cli/docker_compose_logs.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_logs.yaml diff --git a/data/compose-cli/docker_compose_ls.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml similarity index 100% rename from data/compose-cli/docker_compose_ls.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ls.yaml diff --git a/data/compose-cli/docker_compose_pause.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pause.yaml similarity index 100% rename from data/compose-cli/docker_compose_pause.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pause.yaml diff --git a/data/compose-cli/docker_compose_port.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml similarity index 100% rename from data/compose-cli/docker_compose_port.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_port.yaml diff --git a/data/compose-cli/docker_compose_ps.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml similarity index 93% rename from data/compose-cli/docker_compose_ps.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml index a8c76c3ca..d51d0ac96 100644 --- a/data/compose-cli/docker_compose_ps.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_ps.yaml @@ -46,7 +46,13 @@ options: - option: format value_type: string default_value: table - description: 'Format the output. Values: [table | json]' + description: |- + 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 details_url: '#format' deprecated: false hidden: false diff --git a/data/compose-cli/docker_compose_pull.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml similarity index 94% rename from data/compose-cli/docker_compose_pull.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml index 757f31be6..5d2886afa 100644 --- a/data/compose-cli/docker_compose_pull.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_pull.yaml @@ -57,6 +57,15 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: policy + value_type: string + description: Apply pull policy ("missing"|"always"). + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: quiet shorthand: q value_type: bool diff --git a/data/compose-cli/docker_compose_push.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_push.yaml similarity index 100% rename from data/compose-cli/docker_compose_push.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_push.yaml diff --git a/data/compose-cli/docker_compose_restart.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml similarity index 100% rename from data/compose-cli/docker_compose_restart.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_restart.yaml diff --git a/data/compose-cli/docker_compose_rm.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_rm.yaml similarity index 100% rename from data/compose-cli/docker_compose_rm.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_rm.yaml diff --git a/data/compose-cli/docker_compose_run.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml similarity index 100% rename from data/compose-cli/docker_compose_run.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_run.yaml 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 new file mode 100644 index 000000000..9391441f2 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_scale.yaml @@ -0,0 +1,35 @@ +command: docker compose scale +short: Scale services +long: Scale services +usage: docker compose scale [SERVICE=REPLICAS...] +pname: docker compose +plink: docker_compose.yaml +options: + - option: no-deps + value_type: bool + default_value: "false" + description: Don't start linked services. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/data/compose-cli/docker_compose_start.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml similarity index 100% rename from data/compose-cli/docker_compose_start.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_start.yaml diff --git a/data/compose-cli/docker_compose_stop.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_stop.yaml similarity index 100% rename from data/compose-cli/docker_compose_stop.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_stop.yaml diff --git a/data/compose-cli/docker_compose_top.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml similarity index 100% rename from data/compose-cli/docker_compose_top.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_top.yaml diff --git a/data/compose-cli/docker_compose_unpause.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml similarity index 100% rename from data/compose-cli/docker_compose_unpause.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_unpause.yaml diff --git a/data/compose-cli/docker_compose_up.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml similarity index 94% rename from data/compose-cli/docker_compose_up.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml index 042e2b491..9515ebe32 100644 --- a/data/compose-cli/docker_compose_up.yaml +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_up.yaml @@ -48,7 +48,8 @@ options: - option: attach value_type: stringArray default_value: '[]' - description: Attach to service output. + description: | + Restrict attaching to the specified services. Incompatible with --attach-dependencies. deprecated: false hidden: false experimental: false @@ -58,7 +59,7 @@ options: - option: attach-dependencies value_type: bool default_value: "false" - description: Attach to dependent containers. + description: Automatically attach to log output of dependent services. deprecated: false hidden: false experimental: false @@ -110,7 +111,7 @@ options: - option: no-attach value_type: stringArray default_value: '[]' - description: Don't attach to specified service. + description: Do not attach (stream logs) to the specified services. deprecated: false hidden: false experimental: false @@ -120,7 +121,7 @@ options: - option: no-build value_type: bool default_value: "false" - description: Don't build an image, even if it's missing. + description: Don't build an image, even if it's policy. deprecated: false hidden: false experimental: false @@ -180,8 +181,8 @@ options: swarm: false - option: pull value_type: string - default_value: missing - description: Pull image before running ("always"|"missing"|"never") + default_value: policy + description: Pull image before running ("always"|"policy"|"never") deprecated: false hidden: false experimental: false @@ -266,7 +267,7 @@ options: - option: wait-timeout value_type: int default_value: "0" - description: timeout waiting for application 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/data/compose-cli/docker_compose_version.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml similarity index 100% rename from data/compose-cli/docker_compose_version.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_version.yaml diff --git a/data/compose-cli/docker_compose_wait.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_wait.yaml similarity index 100% rename from data/compose-cli/docker_compose_wait.yaml rename to _vendor/github.com/docker/compose/v2/docs/reference/docker_compose_wait.yaml diff --git a/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_watch.yaml b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_watch.yaml new file mode 100644 index 000000000..8cb20b1d4 --- /dev/null +++ b/_vendor/github.com/docker/compose/v2/docs/reference/docker_compose_watch.yaml @@ -0,0 +1,47 @@ +command: docker compose watch +short: | + Watch build context for service and rebuild/refresh containers when files are updated +long: | + Watch build context for service and rebuild/refresh containers when files are updated +usage: docker compose watch [SERVICE...] +pname: docker compose +plink: docker_compose.yaml +options: + - option: no-up + value_type: bool + default_value: "false" + description: Do not build & start services before watching + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false + - option: quiet + value_type: bool + default_value: "false" + description: hide build output + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: + - option: dry-run + value_type: bool + default_value: "false" + description: Execute command in dry run mode + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md b/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md index e3551af75..4650852eb 100644 --- a/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md +++ b/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md @@ -22,6 +22,11 @@ insecure-entitlements = [ "network.host", "security.insecure" ] # log formatter: json or text format = "text" +[dns] + nameservers=["1.1.1.1","8.8.8.8"] + options=["edns0"] + searchDomains=["example.com"] + [grpc] address = [ "tcp://0.0.0.0:1234" ] # debugAddress is address for attaching go profiles and debuggers. @@ -54,6 +59,9 @@ insecure-entitlements = [ "network.host", "security.insecure" ] # running rootless buildkit inside a container. noProcessSandbox = false gc = true + # gckeepstorage can be an integer number of bytes (e.g. 512000000), a string + # with a unit (e.g. "512MB"), or a string percentage of the total disk + # space (e.g. "10%") gckeepstorage = 9000 # alternate OCI worker binary name(example 'crun'), by default either # buildkit-runc or runc binary is used @@ -89,7 +97,7 @@ insecure-entitlements = [ "network.host", "security.insecure" ] platforms = [ "linux/amd64", "linux/arm64" ] namespace = "buildkit" gc = true - # gckeepstorage sets storage limit for default gc profile, in MB. + # gckeepstorage sets storage limit for default gc profile, in bytes. gckeepstorage = 9000 # maintain a pool of reusable CNI network namespaces to amortize the overhead # of allocating and releasing the namespaces @@ -98,6 +106,11 @@ insecure-entitlements = [ "network.host", "security.insecure" ] [worker.containerd.labels] "foo" = "bar" + # configure the containerd runtime + [worker.containerd.runtime] + name = "io.containerd.runc.v2" + options = { BinaryName = "runc" } + [[worker.containerd.gcpolicy]] keepBytes = 512000000 keepDuration = 172800 diff --git a/_vendor/github.com/moby/buildkit/frontend/dockerfile/docs/reference.md b/_vendor/github.com/moby/buildkit/frontend/dockerfile/docs/reference.md index 8cb99da1a..d4b34f3f9 100644 --- a/_vendor/github.com/moby/buildkit/frontend/dockerfile/docs/reference.md +++ b/_vendor/github.com/moby/buildkit/frontend/dockerfile/docs/reference.md @@ -334,104 +334,9 @@ that set `abc` to `bye`. ## .dockerignore file -Before the docker CLI sends the context to the docker daemon, it looks -for a file named `.dockerignore` in the root directory of the context. -If this file exists, the CLI modifies the context to exclude files and -directories that match patterns in it. This helps to avoid -unnecessarily sending large or sensitive files and directories to the -daemon and potentially adding them to images using `ADD` or `COPY`. - -The CLI interprets the `.dockerignore` file as a newline-separated -list of patterns similar to the file globs of Unix shells. For the -purposes of matching, the root of the context is considered to be both -the working and the root directory. For example, the patterns -`/foo/bar` and `foo/bar` both exclude a file or directory named `bar` -in the `foo` subdirectory of `PATH` or in the root of the git -repository located at `URL`. Neither excludes anything else. - -If a line in `.dockerignore` file starts with `#` in column 1, then this line is -considered as a comment and is ignored before interpreted by the CLI. - -Here is an example `.dockerignore` file: - -```gitignore -# comment -*/temp* -*/*/temp* -temp? -``` - -This file causes the following build behavior: - -| Rule | Behavior | -|:------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `# comment` | Ignored. | -| `*/temp*` | Exclude files and directories whose names start with `temp` in any immediate subdirectory of the root. For example, the plain file `/somedir/temporary.txt` is excluded, as is the directory `/somedir/temp`. | -| `*/*/temp*` | Exclude files and directories starting with `temp` from any subdirectory that is two levels below the root. For example, `/somedir/subdir/temporary.txt` is excluded. | -| `temp?` | Exclude files and directories in the root directory whose names are a one-character extension of `temp`. For example, `/tempa` and `/tempb` are excluded. | - - -Matching is done using Go's -[filepath.Match](https://golang.org/pkg/path/filepath#Match) rules. A -preprocessing step removes leading and trailing whitespace and -eliminates `.` and `..` elements using Go's -[filepath.Clean](https://golang.org/pkg/path/filepath/#Clean). Lines -that are blank after preprocessing are ignored. - -Beyond Go's filepath.Match rules, Docker also supports a special -wildcard string `**` that matches any number of directories (including -zero). For example, `**/*.go` will exclude all files that end with `.go` -that are found in all directories, including the root of the build context. - -Lines starting with `!` (exclamation mark) can be used to make exceptions -to exclusions. The following is an example `.dockerignore` file that -uses this mechanism: - -```gitignore -*.md -!README.md -``` - -All markdown files right under the context directory *except* `README.md` -are excluded from the context. Note that markdown files under subdirectories -are still included. - -The placement of `!` exception rules influences the behavior: the last -line of the `.dockerignore` that matches a particular file determines -whether it is included or excluded. Consider the following example: - -```gitignore -*.md -!README*.md -README-secret.md -``` - -No markdown files are included in the context except README files other than -`README-secret.md`. - -Now consider this example: - -```gitignore -*.md -README-secret.md -!README*.md -``` - -All of the README files are included. The middle line has no effect because -`!README*.md` matches `README-secret.md` and comes last. - -You can even use the `.dockerignore` file to exclude the `Dockerfile` -and `.dockerignore` files. These files are still sent to the daemon -because it needs them to do its job. But the `ADD` and `COPY` instructions -do not copy them to the image. - -Finally, you may want to specify which files to include in the -context, rather than which to exclude. To achieve this, specify `*` as -the first pattern, followed by one or more `!` exception patterns. - -> **Note** -> -> For historical reasons, the pattern `.` is ignored. +You can use `.dockerignore` file to exclude files and directories from the +build context. For more information, see +[.dockerignore file](https://docs.docker.com/build/building/context#dockerignore-files/). ## FROM diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 12f60f264..31de5ca8a 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,8 +1,9 @@ # github.com/moby/moby v24.0.5+incompatible -# github.com/moby/buildkit v0.12.1-0.20230830200556-05eb7287534b +# github.com/moby/buildkit v0.13.0-beta1.0.20231011101155-c444964c2e8f # github.com/docker/buildx v0.11.2 # github.com/docker/scout-cli v1.0.2 -# github.com/docker/cli v24.0.5+incompatible +# github.com/docker/cli v24.0.6+incompatible # github.com/docker/compose-cli v1.0.35 # github.com/distribution/distribution v2.8.4-0.20231004140828-d607c6ccb937+incompatible # github.com/compose-spec/compose-spec v0.0.0-20230927132538-f223c5150d5d +# github.com/docker/compose/v2 v2.22.0 diff --git a/content/build/building/context.md b/content/build/building/context.md index a710e3c3f..f43bfccb2 100644 --- a/content/build/building/context.md +++ b/content/build/building/context.md @@ -4,48 +4,57 @@ description: Learn how to use the build context to access files from your Docker keywords: build, buildx, buildkit, context, git, tarball, stdin --- -The [`docker build`](../../engine/reference/commandline/build.md) or -[`docker buildx build`](../../engine/reference/commandline/buildx_build.md) -commands build Docker images from a [Dockerfile](../../engine/reference/builder.md) -and a "context". +The `docker build` and `docker buildx build` commands build Docker images from +a [Dockerfile](../../engine/reference/builder.md) and a context. -The build context is the argument that you pass to the build command: +## What is a build context? + +The build context is the set of files that your build can access. +The positional argument that you pass to the build command specifies the +context that you want to use for the build: ```console $ docker build [OPTIONS] PATH | URL | - ^^^^^^^^^^^^^^ ``` -## What is a build context? - You can pass any of the following inputs as the context for a build: - The relative or absolute path to a local directory -- The address of a remote Git repository, tarball, or plain-text file -- A piped plain-text file or a tarball using standard input +- A remote URL of a Git repository, tarball, or plain-text file +- A plain-text file or tarball piped to the `docker build` command through standard input ### Filesystem contexts -When your build context is a local directory, a remote Git repository, or a tar file, -then that becomes the set of files that the builder can access during the build. -Build instructions can refer to any of the files and directories in the context. -For example, when you use a [`COPY` instruction](../../engine/reference/builder.md#copy), -the builder copies the file or directory from the build context, into the build container. +When your build context is a local directory, a remote Git repository, or a tar +file, then that becomes the set of files that the builder can access during the +build. Build instructions such as `COPY` and `ADD` can refer to any of the +files and directories in the context. + A filesystem build context is processed recursively: - When you specify a local directory or a tarball, all subdirectories are included - When you specify a remote Git repository, the repository and all submodules are included +For more information about the different types of filesystem contexts that you +can use with your builds, see: + +- [Local files](#local-context) +- [Git repositories](#git-repositories) +- [Remote tarballs](#remote-tarballs) + ### Text file contexts When your build context is a plain-text file, the builder interprets the file -as a Dockerfile. With this approach, the builder doesn't receive a filesystem context. -For more information about building with a text file context, see [Text files](#text-files). +as a Dockerfile. With this approach, the build doesn't use a filesystem context. -## Local directories and tarballs +For more information, see [empty build context](#empty-context). -The following example shows a build command that uses the current directory -(`.`) as a build context: +## Local context + +To use a local build context, you can specify a relative or absolute filepath +to the `docker build` command. The following example shows a build command that +uses the current directory (`.`) as a build context: ```console $ docker build . @@ -56,11 +65,16 @@ $ docker build . ... ``` -This makes files and directories in the current working directory available -to the builder. The builder loads the files that it needs from the build context, -when it needs them. +This makes files and directories in the current working directory available to +the builder. The builder loads the files it needs from the build context when +needed. + +You can also use local tarballs as build context, by piping the tarball +contents to the `docker build` command. See [Tarballs](#local-tarballs). + +### Local directories -For example, given the following directory structure: +Consider the following directory structure: ``` . @@ -71,8 +85,8 @@ For example, given the following directory structure: └── package-lock.json ``` -Dockerfile instructions can reference and include these files in the build -if you pass the directory as a context. +Dockerfile instructions can reference and include these files in the build if +you pass this directory as a context. ```dockerfile # syntax=docker/dockerfile:1 @@ -83,46 +97,93 @@ RUN npm ci COPY index.ts src . ``` -### `.dockerignore` +```console +$ docker build . +``` + +### Local context with Dockerfile from stdin -You can use a [`.dockerignore`](../../engine/reference/builder.md#dockerignore-file) -file to exclude some files or directories from being sent: +Use the following syntax to build an image using files on your local +filesystem, while using a Dockerfile from stdin. -```gitignore -# .dockerignore -node_modules -bar +```console +$ docker build -f- ``` -A `.dockerignore` file located at the root of build context is automatically -detected and used. +The syntax uses the -f (or --file) option to specify the Dockerfile to use, and +it uses a hyphen (-) as filename to instruct Docker to read the Dockerfile from +stdin. -If you use multiple Dockerfiles, you can use different ignore-files for each -Dockerfile. You do so using a special naming convention for the ignore-files. -Place your ignore-file in the same directory as the Dockerfile, and prefix the -ignore-file with the name of the Dockerfile. +The following example uses the current directory (.) as the build context, and +builds an image using a Dockerfile passed through stdin using a here-document. + +```bash +# create a directory to work in +mkdir example +cd example -For example: +# create an example file +touch somefile.txt -```console +# build an image using the current directory as context +# and a Dockerfile passed through stdin +docker build -t myimage:latest -f- . < docker buildx build \ > **Note** > -> Don't use `--build-arg` for secrets, except for -> [HTTP proxies](../../network/proxy.md#set-proxy-using-the-cli) +> Don't use `--build-arg` for secrets. -### Remote tarballs +### Remote context with Dockerfile from stdin -If you pass the URL to a remote tarball, then the URL itself is sent to the builder. +Use the following syntax to build an image using files on your local +filesystem, while using a Dockerfile from stdin. ```console -$ docker build http://server/context.tar.gz -#1 [internal] load remote build context -#1 DONE 0.2s - -#2 copy /context / -#2 DONE 0.1s -... +$ docker build -f- ``` -The download operation will be performed on the host the daemon is running on, -which is not necessarily the same host from which the build command is being -issued. The daemon will fetch `context.tar.gz` and use it as the build context. -Tarball contexts must be tar archives conforming to the standard `tar` Unix -format and can be compressed with any one of the `xz`, `bzip2`, `gzip` or -`identity` (no compression) formats. +The syntax uses the -f (or --file) option to specify the Dockerfile to use, and +it uses a hyphen (-) as filename to instruct Docker to read the Dockerfile from +stdin. -## Pipes +This can be useful in situations where you want to build an image from a +repository that doesn't contain a Dockerfile. Or if you want to build with a +custom Dockerfile, without maintaining your own fork of the repository. -When you pass a single dash `-` as the argument to the build command, you can -pipe a plain-text file or a tarball as the context: +The following example builds an image using a Dockerfile from stdin, and adds +the `hello.c` file from the [hello-world](https://github.com/docker-library/hello-world) +repository on GitHub. -```console -$ docker build - PIPE -``` - -For example: - -```console -$ docker build - < Dockerfile -$ docker build - < archive.tar -$ docker build - <}} +{{< tab name="Unix pipe" >}} + ```console $ docker build - < Dockerfile ``` -With PowerShell on Windows, you can run: +{{< /tab >}} +{{< tab name="PowerShell" >}} ```powershell Get-Content Dockerfile | docker build - ``` -To use a remote text file, pass the URL of the text file as the argument to the -build command: +{{< /tab >}} +{{< tab name="Heredocs" >}} + +```bash +docker build -t myimage:latest - <}} +{{< tab name="Remote file" >}} ```console $ docker build https://raw.githubusercontent.com/dvdksn/clockbox/main/Dockerfile ``` -Again, this means that the build has no filesystem context, -so Dockerfile commands such as `COPY` can't refer to local files: +{{< /tab >}} +{{< /tabs >}} + +When you build without a filesystem context, Dockerfile instructions such as +`COPY` can't refer to local files: ```console $ ls @@ -352,18 +406,143 @@ Dockerfile:2 ERROR: failed to solve: failed to compute cache key: failed to calculate checksum of ref 7ab2bb61-0c28-432e-abf5-a4c3440bc6b6::4lgfpdf54n5uqxnv9v6ymg7ih: "/main.c": not found ``` -#### Build using heredocs +## .dockerignore files -The following example builds an image using a `Dockerfile` that is passed -through standard input using -[shell heredocs](https://en.wikipedia.org/wiki/Here_document): +You can use a `.dockerignore` file to exclude files or directories from the +build context. -```bash -docker build -t myimage:latest - < **Note** +> +> For historical reasons, the pattern `.` is ignored. + +Beyond Go's `filepath.Match` rules, Docker also supports a special wildcard +string `**` that matches any number of directories (including zero). For +example, `**/*.go` excludes all files that end with `.go` found anywhere in the +build context. + +You can use the `.dockerignore` file to exclude the `Dockerfile` and +`.dockerignore` files. These files are still sent to the builder as they're +needed for running the build. But you can't copy the files into the image using +`ADD`, `COPY`, or bind mounts. + +#### Negating matches + +You can prepend lines with a `!` (exclamation mark) to make exceptions to +exclusions. The following is an example `.dockerignore` file that uses this +mechanism: + +```gitignore +*.md +!README.md +``` + +All markdown files right under the context directory _except_ `README.md` are +excluded from the context. Note that markdown files under subdirectories are +still included. + +The placement of `!` exception rules influences the behavior: the last line of +the `.dockerignore` that matches a particular file determines whether it's +included or excluded. Consider the following example: + +```gitignore +*.md +!README*.md +README-secret.md +``` + +No markdown files are included in the context except README files other than +`README-secret.md`. + +Now consider this example: + +```gitignore +*.md +README-secret.md +!README*.md ``` -This approach is useful when you want to quickly run a build command with a -Dockerfile that's short and concise. \ No newline at end of file +All of the README files are included. The middle line has no effect because +`!README*.md` matches `README-secret.md` and comes last. diff --git a/content/build/building/packaging.md b/content/build/building/packaging.md index 9ce8c79c8..2f230637c 100644 --- a/content/build/building/packaging.md +++ b/content/build/building/packaging.md @@ -198,7 +198,7 @@ The next instruction uses the COPY hello.py / ``` -A [build context](context.md) is the set of files that you can access +A [build context](./context.md) is the set of files that you can access in Dockerfile instructions such as `COPY` and `ADD`. After the `COPY` instruction, the `hello.py` file is added to the filesystem @@ -253,7 +253,7 @@ $ docker build -t test:latest . The `-t test:latest` option specifies the name and tag of the image. The single dot (`.`) at the end of the command sets the -[build context](context.md) to the current directory. This means that the +[build context](./context.md) to the current directory. This means that the build expects to find the Dockerfile and the `hello.py` file in the directory where the command is invoked. If those files aren't there, the build fails. @@ -273,4 +273,4 @@ If you are interested in examples in other languages, such as Go, check out our [language-specific guides](../../language/index.md) in the Guides section. For more information about building, including advanced use cases and patterns, -refer to the [Build with Docker](../guide/index.md) guide. \ No newline at end of file +refer to the [Build with Docker](../guide/index.md) guide. diff --git a/content/build/cache/_index.md b/content/build/cache/_index.md index 857e063de..42507216f 100644 --- a/content/build/cache/_index.md +++ b/content/build/cache/_index.md @@ -144,7 +144,7 @@ COPY . /src ``` You can also create a -[`.dockerignore` file](../../engine/reference/builder.md#dockerignore-file), +[`.dockerignore` file](../../build/building/context.md#dockerignore-files), and use that to specify which files and directories to exclude from the build context. diff --git a/content/build/hydrobuild.md b/content/build/hydrobuild.md index 4d70d69b3..00fbe886d 100644 --- a/content/build/hydrobuild.md +++ b/content/build/hydrobuild.md @@ -391,10 +391,10 @@ more efficient: ### Dockerignore files -Using a [`.dockerignore` file](./building/context.md#dockerignore), you can be +Using a [`.dockerignore` file](./building/context.md#dockerignore-files), you can be explicit about which local files that you don’t want to include in the build -context. Files caught by the [glob patterns](../engine/reference/builder.md#dockerignore-file) -you specify in your ignore-file are not transferred to the remote builder. +context. Files caught by the glob patterns you specify in your ignore-file are +not transferred to the remote builder. Some examples of things you might want to add to your `.dockerignore` file are: diff --git a/content/desktop/install/archlinux.md b/content/desktop/install/archlinux.md index f01b7f85f..bebd0779a 100644 --- a/content/desktop/install/archlinux.md +++ b/content/desktop/install/archlinux.md @@ -8,9 +8,9 @@ aliases: - /desktop/linux/install/archlinux/ --- -This topic discusses installation of Docker Desktop from an [Arch package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-x86_64.pkg.tar.zst) that Docker provides in addition to the supported platforms. Docker has not tested or verified the installation. +This topic discusses installation of Docker Desktop from an [Arch package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-x86_64.pkg.tar.zst) that Docker provides in addition to the supported platforms. Docker has not tested or verified the installation. -{{< button text="Arch package (experimental)" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-x86_64.pkg.tar.zst?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} +{{< button text="Arch package (experimental)" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-x86_64.pkg.tar.zst?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} _For checksums, see [Release notes](../release-notes.md)_ diff --git a/content/desktop/install/debian.md b/content/desktop/install/debian.md index 829798c04..3954de0d2 100644 --- a/content/desktop/install/debian.md +++ b/content/desktop/install/debian.md @@ -10,7 +10,7 @@ aliases: This page contains information on how to install, launch, and upgrade Docker Desktop on a Debian distribution. -{{< button text="DEB package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} +{{< button text="DEB package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} _For checksums, see [Release notes](../release-notes.md)_ @@ -53,7 +53,7 @@ Recommended approach to install Docker Desktop on Debian: 1. Set up Docker's Apt repository. See [Install using the Apt repository, step 1](../../engine/install/debian.md#install-using-the-repository). -2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). +2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). 3. Install the package with apt as follows: diff --git a/content/desktop/install/fedora.md b/content/desktop/install/fedora.md index f2ce482d8..782d94fa4 100644 --- a/content/desktop/install/fedora.md +++ b/content/desktop/install/fedora.md @@ -10,7 +10,7 @@ aliases: This page contains information on how to install, launch and upgrade Docker Desktop on a Fedora distribution. -{{< button text="RPM package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} +{{< button text="RPM package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} ## Prerequisites @@ -33,7 +33,7 @@ To install Docker Desktop on Fedora: 1. Set up [Docker's package repository](../../engine/install/fedora.md#set-up-the-repository). -2. Download latest [RPM package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). +2. Download latest [RPM package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). 3. Install the package with dnf as follows: diff --git a/content/desktop/install/ubuntu.md b/content/desktop/install/ubuntu.md index ccc16c1ba..ceefbd4ae 100644 --- a/content/desktop/install/ubuntu.md +++ b/content/desktop/install/ubuntu.md @@ -13,7 +13,7 @@ aliases: This page contains information on how to install, launch and upgrade Docker Desktop on an Ubuntu distribution. -{{< button text="DEB package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} +{{< button text="DEB package" url="https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64" >}} _For checksums, see [Release notes](../release-notes.md)_ @@ -53,7 +53,7 @@ Recommended approach to install Docker Desktop on Ubuntu: 1. Set up Docker's package repository. See [Install using the Apt repository, step 1](../../engine/install/ubuntu.md#install-using-the-repository). -2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). +2. Download latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.24.2-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). 3. Install the package with apt as follows: diff --git a/content/desktop/release-notes.md b/content/desktop/release-notes.md index b77bec327..a024be375 100644 --- a/content/desktop/release-notes.md +++ b/content/desktop/release-notes.md @@ -24,11 +24,24 @@ Take a look at the [Docker Public Roadmap](https://github.com/docker/roadmap/pro For frequently asked questions about Docker Desktop releases, see [FAQs](faqs/releases.md). +# 4.24.2 + +{{< release-date date="2023-10-12" >}} + +{{< desktop-install all=true version="4.24.1" build_path="/124339/" >}} + +### Bug fixes and enhancements + +#### For all platforms + +- Fixed a bug where Docker Desktop would send multiple requests to `notify.bugsnag.com`. Fixes [docker/for-win#13722](https://github.com/docker/for-win/issues/13722). +- Fixed a performance regression for PyTorch. + # 4.24.1 {{< release-date date="2023-10-04" >}} -{{< desktop-install win=true version="4.24.1" build_path="/" >}} +{{< desktop-install win=true version="4.24.1" build_path="/123237/" >}} ### Bug fixes and enhancements diff --git a/content/desktop/troubleshoot/topics.md b/content/desktop/troubleshoot/topics.md index a2feac4b1..febe4fd16 100644 --- a/content/desktop/troubleshoot/topics.md +++ b/content/desktop/troubleshoot/topics.md @@ -234,7 +234,7 @@ Your machine must have the following features for Docker Desktop to function cor 1. Virtual Machine Platform 2. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) -3. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html) +3. [Virtualization enabled in the BIOS](https://www.virtualmetric.com/blog/how-to-enable-hardware-virtualization) 4. Hypervisor enabled at Windows startup ![WSL 2 enabled](../images/wsl2-enabled.png) @@ -245,7 +245,7 @@ On Windows 10 Pro or Enterprise, you can also use Hyper-V with the following fea 1. [Hyper-V](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-technology-overview) installed and working -2. [Virtualization enabled in the BIOS](https://bce.berkeley.edu/enabling-virtualization-in-your-pc-bios.html) +2. [Virtualization enabled in the BIOS](https://www.virtualmetric.com/blog/how-to-enable-hardware-virtualization) 3. Hypervisor enabled at Windows startup ![Hyper-V on Windows features](../images/hyperv-enabled.png) diff --git a/content/develop/develop-images/guidelines.md b/content/develop/develop-images/guidelines.md index 5b83e09ae..294665a96 100644 --- a/content/develop/develop-images/guidelines.md +++ b/content/develop/develop-images/guidelines.md @@ -1,9 +1,29 @@ --- description: Hints, tips and guidelines for writing clean, reliable Dockerfiles keywords: parent image, images, dockerfile, best practices, hub, official image -title: General best practices for writing Dockerfiles +title: General best practices for writing Dockerfiles --- +## Use multi-stage builds + +Multi-stage builds let you reduce the size of your final image, by creating a +cleaner separation between the building of your image and the final output. +Split your Dockerfile instructions into distinct stages to make sure that the +resulting output only contains the files that's needed to run the application. + +Using multiple stages can also let you build more efficiently by executing +build steps in parallel. + +See [Multi-stage builds](../../build/building/multi-stage.md) for more +information. + +## Exclude with .dockerignore + +To exclude files not relevant to the build, without restructuring your source +repository, use a `.dockerignore` file. This file supports exclusion patterns +similar to `.gitignore` files. For information on creating one, see +[Dockerignore file](../../build/building/context.md#dockerignore-files). + ## Create ephemeral containers The image defined by your Dockerfile should generate containers that are as @@ -15,13 +35,6 @@ Refer to [Processes](https://12factor.net/processes) under _The Twelve-factor Ap methodology to get a feel for the motivations of running containers in such a stateless fashion. -## Exclude with .dockerignore - -To exclude files not relevant to the build, without restructuring your source -repository, use a `.dockerignore` file. This file supports exclusion patterns -similar to `.gitignore` files. For information on creating one, see -[.dockerignore file](../../engine/reference/builder.md#dockerignore-file). - ## Don't install unnecessary packages Avoid installing extra or unnecessary packages just because they might be nice to have. For example, you don’t need to include a text editor in a database image. @@ -48,23 +61,9 @@ Use your best judgment to keep containers as clean and modular as possible. If containers depend on each other, you can use [Docker container networks](../../network/index.md) to ensure that these containers can communicate. -## Minimize the number of layers - -In older versions of Docker, it was important that you minimized the number of -layers in your images to ensure they were performant. The following features -were added to reduce this limitation: - -- Only the instructions `RUN`, `COPY`, and `ADD` create layers. Other instructions - create temporary intermediate images, and don't increase the size of the build. - -- Where possible, use [multi-stage builds](../../build/building/multi-stage.md), - and only copy the artifacts you need into the final image. This allows you to - include tools and debug information in your intermediate build stages without - increasing the size of the final image. - ## Sort multi-line arguments -Whenever possible, sort multi-line arguments alphanumerically to make maintenance easier. +Whenever possible, sort multi-line arguments alphanumerically to make maintenance easier. This helps to avoid duplication of packages and make the list much easier to update. This also makes PRs a lot easier to read and review. Adding a space before a backslash (`\`) helps as well. @@ -81,213 +80,13 @@ RUN apt-get update && apt-get install -y \ && rm -rf /var/lib/apt/lists/* ``` -## Understand build context - -See [Build context](../../build/building/context.md) for more information. - -## Pipe a Dockerfile through stdin - -Docker has the ability to build images by piping a Dockerfile through stdin -with a local or remote build context. Piping a Dockerfile through stdin -can be useful to perform one-off builds without writing a Dockerfile to disk, -or in situations where the Dockerfile is generated, and should not persist -afterward. - -> **Note** -> -> The examples in the following sections use [here documents](https://tldp.org/LDP/abs/html/here-docs.html) -> for convenience, but any method to provide the Dockerfile on stdin can be -> used. -> -> For example, the following commands are equal: -> -> ```bash -> echo -e 'FROM busybox\nRUN echo "hello world"' | docker build - -> ``` -> -> ```bash -> docker build -< FROM busybox -> RUN echo "hello world" -> EOF -> ``` -> -> You can substitute the examples with your preferred approach, or the approach -> that best fits your use case. - -### Build an image using a Dockerfile from stdin, without sending build context - -Use this syntax to build an image using a Dockerfile from stdin, without -sending additional files as build context. The hyphen (`-`) takes the position -of the `PATH`, and instructs Docker to read the build context, which only -contains a Dockerfile, from stdin instead of a directory: - -```bash -docker build [OPTIONS] - -``` - -The following example builds an image using a Dockerfile that is passed through -stdin. No files are sent as build context to the daemon. - -```bash -docker build -t myimage:latest -< **Note** -> -> If you attempt to build an image using a Dockerfile from stdin, without sending a build context, then the build will fail if you use `COPY` or `ADD`. -> The following example illustrates this: -> -> ```bash -> # create a directory to work in -> mkdir example -> cd example -> -> # create an example file -> touch somefile.txt -> -> docker build -t myimage:latest -< FROM busybox -> COPY somefile.txt ./ -> RUN cat /somefile.txt -> EOF -> -> # observe that the build fails -> ... -> Step 2/3 : COPY somefile.txt ./ -> COPY failed: stat /var/lib/docker/tmp/docker-builder249218248/somefile.txt: no such file or directory -> ``` - -### Build from a local build context, using a Dockerfile from stdin - -Use this syntax to build an image using files on your local filesystem, but using -a Dockerfile from stdin. The syntax uses the `-f` (or `--file`) option to -specify the Dockerfile to use, and it uses a hyphen (`-`) as filename to instruct -Docker to read the Dockerfile from stdin: - -```bash -docker build [OPTIONS] -f- PATH -``` - -The following example uses the current directory (`.`) as the build context, and builds -an image using a Dockerfile that is passed through stdin using a [here -document](https://tldp.org/LDP/abs/html/here-docs.html). - -```bash -# create a directory to work in -mkdir example -cd example - -# create an example file -touch somefile.txt - -# build an image using the current directory as context, and a Dockerfile passed through stdin -docker build -t myimage:latest -f- . < **Note** -> -> When building an image using a remote Git repository as the build context, Docker -> performs a `git clone` of the repository on the local machine, and sends -> those files as the build context to the daemon. This feature requires you to -> install Git on the host where you run the `docker build` command. - -## Use multi-stage builds - -[Multi-stage builds](../../build/building/multi-stage.md) allow you to -drastically reduce the size of your final image, without struggling to reduce -the number of intermediate layers and files. - -Because an image is built during the final stage of the build process, you can -minimize image layers by [leveraging build cache](#leverage-build-cache). - -For example, if your build contains several layers and you want to ensure the build cache is reusable, you can order them from the less frequently changed to the more frequently changed. The following list is an example of the order of instructions: - -1. Install tools you need to build your application - -2. Install or update library dependencies - -3. Generate your application - -A Dockerfile for a Go application could look like: - -```dockerfile -# syntax=docker/dockerfile:1 -FROM golang:{{% param "example_go_version" %}}-alpine AS build - -# Install tools required for project -# Run `docker build --no-cache .` to update dependencies -RUN apk add --no-cache git - -# List project dependencies with go.mod and go.sum -# These layers are only re-built when Gopkg files are updated -WORKDIR /go/src/project/ -COPY go.mod go.sum /go/src/project/ -# Install library dependencies -RUN go mod download - -# Copy the entire project and build it -# This layer is rebuilt when a file changes in the project directory -COPY . /go/src/project/ -RUN go build -o /bin/project - -# This results in a single layer image -FROM scratch -COPY --from=build /bin/project /bin/project -ENTRYPOINT ["/bin/project"] -CMD ["--help"] -``` - ### Leverage build cache When building an image, Docker steps through the instructions in your -Dockerfile, executing each in the order specified. As each instruction is -examined, Docker looks for an existing image in its cache, -rather than creating a new, duplicate image. +Dockerfile, executing each in the order specified. For each instruction, Docker +checks whether it can reuse the instruction from the build cache. -If you don't want to use the cache at all, you can use the `--no-cache=true` -option on the `docker build` command. However, if you do let Docker use its -cache, it's important to understand when it can, and can't, find a matching -image. The basic rules that Docker follows are outlined below: +The basic rules of build cache invalidation are as follows: - Starting with a parent image that's already in the cache, the next instruction is compared against all child images derived from that base @@ -298,12 +97,10 @@ image. The basic rules that Docker follows are outlined below: of the child images is sufficient. However, certain instructions require more examination and explanation. -- For the `ADD` and `COPY` instructions, the contents of each file - in the image are examined and a checksum is calculated for each file. - The last-modified and last-accessed times of each file aren't considered in - these checksums. During the cache lookup, the checksum is compared against the - checksum in the existing images. If anything has changed in any file, such - as the contents and metadata, then the cache is invalidated. +- For the `ADD` and `COPY` instructions, the modification time and size file + metadata is used to determine whether cache is valid. During cache lookup, + cache is invalidated if the file metadata has changed for any of the files + involved. - Aside from the `ADD` and `COPY` commands, cache checking doesn't look at the files in the container to determine a cache match. For example, when processing @@ -313,3 +110,10 @@ image. The basic rules that Docker follows are outlined below: Once the cache is invalidated, all subsequent Dockerfile commands generate new images and the cache isn't used. + +If your build contains several layers and you want to ensure the build cache is +reusable, order the instructions from less frequently changed to more +frequently changed where possible. + +For more information about the Docker build cache and how to optimize your +builds, see [cache management](../../build/cache/_index.md). diff --git a/content/engine/reference/commandline/compose_alpha.md b/content/engine/reference/commandline/compose_alpha.md new file mode 100644 index 000000000..2d8595bad --- /dev/null +++ b/content/engine/reference/commandline/compose_alpha.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_alpha +title: docker compose alpha +layout: cli +--- + + \ No newline at end of file diff --git a/content/engine/reference/commandline/compose_alpha_dry-run.md b/content/engine/reference/commandline/compose_alpha_dry-run.md new file mode 100644 index 000000000..1761f9e84 --- /dev/null +++ b/content/engine/reference/commandline/compose_alpha_dry-run.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_alpha_dry-run +title: docker compose alpha dry-run +layout: cli +--- + + \ No newline at end of file diff --git a/content/engine/reference/commandline/compose_alpha_publish.md b/content/engine/reference/commandline/compose_alpha_publish.md new file mode 100644 index 000000000..11fa2e5a3 --- /dev/null +++ b/content/engine/reference/commandline/compose_alpha_publish.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_alpha_publish +title: docker compose alpha publish +layout: cli +--- + + \ No newline at end of file diff --git a/content/engine/reference/commandline/compose_alpha_scale.md b/content/engine/reference/commandline/compose_alpha_scale.md new file mode 100644 index 000000000..3c5d1acee --- /dev/null +++ b/content/engine/reference/commandline/compose_alpha_scale.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_alpha_scale +title: docker compose alpha scale +layout: cli +--- + + \ No newline at end of file diff --git a/content/engine/reference/commandline/compose_alpha_viz.md b/content/engine/reference/commandline/compose_alpha_viz.md new file mode 100644 index 000000000..d6ae3d46a --- /dev/null +++ b/content/engine/reference/commandline/compose_alpha_viz.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_alpha_viz +title: docker compose alpha viz +layout: cli +--- + + \ No newline at end of file diff --git a/content/engine/reference/commandline/compose_wait.md b/content/engine/reference/commandline/compose_wait.md new file mode 100644 index 000000000..76812be14 --- /dev/null +++ b/content/engine/reference/commandline/compose_wait.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_wait +title: docker compose wait +layout: cli +--- + + diff --git a/content/engine/reference/commandline/compose_watch.md b/content/engine/reference/commandline/compose_watch.md new file mode 100644 index 000000000..659277ffe --- /dev/null +++ b/content/engine/reference/commandline/compose_watch.md @@ -0,0 +1,13 @@ +--- +datafolder: compose-cli +datafile: docker_compose_watch +title: docker compose watch +layout: cli +--- + + diff --git a/content/get-started/09_image_best.md b/content/get-started/09_image_best.md index 5510c8543..ed4005211 100644 --- a/content/get-started/09_image_best.md +++ b/content/get-started/09_image_best.md @@ -92,7 +92,7 @@ dependencies if there was a change to the `package.json`. `.dockerignore` files are an easy way to selectively copy only image relevant files. You can read more about this - [here](../engine/reference/builder.md#dockerignore-file). + [here](../build/building/context.md#dockerignore-files). In this case, the `node_modules` folder should be omitted in the second `COPY` step because otherwise, it would possibly overwrite files which were created by the command in the `RUN` step. For further details on why this is recommended for Node.js applications and other best practices, @@ -212,7 +212,7 @@ into an nginx container. In this section, you learned a few image building best practices, including layer caching and multi-stage builds. Related information: - - [.dockerignore](../engine/reference/builder.md#dockerignore-file) + - [.dockerignore](../build/building/context.md#dockerignore-files) - [Dockerfile reference](../engine/reference/builder.md) - [Build with Docker guide](../build/guide/index.md) - [Dockerfile best practices](../develop/develop-images/dockerfile_best-practices.md) diff --git a/content/network/proxy.md b/content/network/proxy.md index 157cf2d7e..5d9b39244 100644 --- a/content/network/proxy.md +++ b/content/network/proxy.md @@ -188,4 +188,4 @@ If the proxy is an internal proxy, it might not be accessible for containers created from that image. Embedding proxy settings in images also poses a security risk, as the values -may include sensitive information. \ No newline at end of file +may include sensitive information. diff --git a/data/toc.yaml b/data/toc.yaml index c050ad616..f4998dba8 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -316,6 +316,16 @@ Reference: title: overview - path: /compose/environment-variables/envvars/ title: environment variables + - path: /engine/reference/commandline/compose_alpha/ + title: docker compose alpha + - path: /engine/reference/commandline/compose_alpha_dry-run/ + title: docker compose alpha dry-run + - path: /engine/reference/commandline/compose_alpha_publish/ + title: docker compose alpha publish + - path: /engine/reference/commandline/compose_alpha_scale/ + title: docker compose alpha scale + - path: /engine/reference/commandline/compose_alpha_viz/ + title: docker compose alpha viz - path: /engine/reference/commandline/compose/ title: docker compose - path: /engine/reference/commandline/compose_build/ @@ -370,6 +380,10 @@ Reference: title: docker compose up - path: /engine/reference/commandline/compose_version/ title: docker compose version + - path: /engine/reference/commandline/compose_wait/ + title: docker compose wait + - path: /engine/reference/commandline/compose_watch/ + title: docker compose watch - sectiontitle: docker config section: - path: /engine/reference/commandline/config/ @@ -1782,7 +1796,7 @@ Manuals: - path: /build/building/packaging/ title: Packaging your software - path: /build/building/context/ - title: Build context + title: Context - path: /build/building/multi-stage/ title: Multi-stage builds - path: /build/building/multi-platform/ diff --git a/go.mod b/go.mod index ed46c7078..c0a56190e 100644 --- a/go.mod +++ b/go.mod @@ -1,18 +1,23 @@ module github.com/docker/docs -go 1.20 +go 1.21 + +toolchain go1.21.1 require ( github.com/compose-spec/compose-spec v0.0.0-20230927132538-f223c5150d5d // indirect github.com/distribution/distribution v2.8.4-0.20231004140828-d607c6ccb937+incompatible // indirect github.com/distribution/reference v0.5.0 // indirect github.com/docker/buildx v0.11.2 // indirect - github.com/docker/cli v24.0.5+incompatible // indirect + github.com/docker/cli v24.0.6+incompatible // indirect github.com/docker/compose-cli v1.0.35 // indirect + github.com/docker/compose/v2 v2.22.0 // indirect github.com/docker/distribution v2.8.2+incompatible // indirect github.com/docker/scout-cli v1.0.2 // indirect - github.com/moby/buildkit v0.12.1-0.20230830200556-05eb7287534b // indirect + github.com/moby/buildkit v0.13.0-beta1.0.20231011101155-c444964c2e8f // indirect github.com/moby/moby v24.0.5+incompatible // indirect github.com/opencontainers/go-digest v1.0.0 // indirect github.com/opencontainers/image-spec v1.1.0-rc5 // indirect ) + +exclude github.com/cucumber/godog v0.0.0-00010101000000-000000000000 diff --git a/go.sum b/go.sum index 0058a14b0..4f023f9c7 100644 --- a/go.sum +++ b/go.sum @@ -54,8 +54,12 @@ github.com/docker/cli v24.0.4+incompatible h1:Y3bYF9ekNTm2VFz5U/0BlMdJy73D+Y1iAA github.com/docker/cli v24.0.4+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/cli v24.0.5+incompatible h1:WeBimjvS0eKdH4Ygx+ihVq1Q++xg36M/rMi4aXAvodc= github.com/docker/cli v24.0.5+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= +github.com/docker/cli v24.0.6+incompatible h1:fF+XCQCgJjjQNIMjzaSmiKJSCcfcXb3TWTcc7GAneOY= +github.com/docker/cli v24.0.6+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/compose-cli v1.0.35 h1:uZyEHLalfqBS2PiTpA1LAULyJmuQ+YtZg7nG4Xl3/Cc= github.com/docker/compose-cli v1.0.35/go.mod h1:mSXI4hFLpRU3EtI8NTo32bNwI0UXSr8jnq+/rYjGAUU= +github.com/docker/compose/v2 v2.22.0 h1:3rRz4L7tPU75wRsV8JZh2/aTgerQvPa1cpzZN+tHqUY= +github.com/docker/compose/v2 v2.22.0/go.mod h1:W+OVmnkJP0a62v8KnjtpXS0qrOdLnrxGJmKEU2dD4IQ= github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/go v1.5.1-1.0.20160303222718-d30aec9fd63c/go.mod h1:CADgU4DSXK5QUlFslkQu2yW2TKzFZcXq/leZfM0UH5Q= @@ -119,6 +123,10 @@ github.com/moby/buildkit v0.12.1 h1:vvMG7EZYCiQZpTtXQkvyeyj7HzT1JHhDWj+/aiGIzLM= github.com/moby/buildkit v0.12.1/go.mod h1:adB4y0SxxX8trnrY+oEulb48ODLqPO6pKMF0ppGcCoI= github.com/moby/buildkit v0.12.2 h1:B7guBgY6sfk4dBlv/ORUxyYlp0UojYaYyATgtNwSCXc= github.com/moby/buildkit v0.12.2/go.mod h1:adB4y0SxxX8trnrY+oEulb48ODLqPO6pKMF0ppGcCoI= +github.com/moby/buildkit v0.13.0-beta1.0.20231011042751-9ef1ed946118 h1:pqpcLt3wJTqBEY8Va3QQvd+taaBTEmK2+1kV7LKc69k= +github.com/moby/buildkit v0.13.0-beta1.0.20231011042751-9ef1ed946118/go.mod h1:oSHnUZH7sNtAFLyeN1syf46SuzMThKsCQaioNEqJVUk= +github.com/moby/buildkit v0.13.0-beta1.0.20231011101155-c444964c2e8f h1:CEiXZq08D7vLOnEDl7XY95zbupdWOJrRLb1VeZ+Hxq8= +github.com/moby/buildkit v0.13.0-beta1.0.20231011101155-c444964c2e8f/go.mod h1:oSHnUZH7sNtAFLyeN1syf46SuzMThKsCQaioNEqJVUk= github.com/moby/locker v1.0.1/go.mod h1:S7SDdo5zpBK84bzzVlKr2V0hz+7x9hWbYC/kq7oQppc= github.com/moby/moby v24.0.2+incompatible h1:yH+5dRHH1x3XRKzl1THA2aGTy6CHYnkt5N924ADMax8= github.com/moby/moby v24.0.2+incompatible/go.mod h1:fDXVQ6+S340veQPv35CzDahGBmHsiclFwfEygB/TWMc= diff --git a/hugo.yaml b/hugo.yaml index d72c834e8..ace61abb8 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -347,3 +347,8 @@ module: - source: develop.md target: content/compose/compose-file/develop.md + - path: github.com/docker/compose/v2 + mounts: + - source: docs/reference + target: data/compose-cli + includeFiles: "*.yaml" diff --git a/layouts/shortcodes/admin-users.html b/layouts/shortcodes/admin-users.html index fbfdc5946..20fa48c7b 100644 --- a/layouts/shortcodes/admin-users.html +++ b/layouts/shortcodes/admin-users.html @@ -5,6 +5,15 @@ {{ $product_link := "[Docker Hub](https://hub.docker.com)" }} {{ $update_role := "Select the role you want to assign, then select **Save**." }} {{ $role_mapping_link := "[SCIM for role mapping](docker-hub/scim.md#set-up-role-mapping)" }} +{{ $export_fields := `The CSV file for an organization contains the following fields: +* **Name**: The user's name. +* **Username**: The user's Docker ID. +* **Email**: The user's email address. +* **Type**: The type of user. For example, **Invitee** for users who have not accepted the organization's invite, + or **User** for users who are members of the organization. +* **Role**: The user's role in the organization. For example, **Member** or **Owner**. +* **Teams**: The teams where the user is a member. A team is not listed for invitees. +* **Date Joined**: The time and date when the user was invited to the organization.` }} {{ if eq (.Get "product") "admin" }} {{ $invite_button = "**Invite**" }} @@ -14,6 +23,13 @@ {{ $product_link = "[Docker Admin](https://admin.docker.com)" }} {{ $role_mapping_link = "[SCIM for role mapping](admin/organization/security-settings/scim.md#set-up-role-mapping)" }} {{ if eq (.Get "layer") "company" }} +{{ $export_fields = `The CSV file for a company contains the following fields: +* **Name**: The user's name. +* **Username**: The user's Docker ID. +* **Email**: The user's email address. +* **Member of Organizations**: All organizations the user is a member of within a company. +* **Invited to Organizations**: All organizations the user is an invitee of within a company. +* **Account Created**: The time and date when the user account was created.` }} {{ $member_navigation = "Select your company in the left navigation drop-down menu, and then select **Users**." }} {{ $remove_button = "**Remove user**" }} {{ $update_role = "Select their organization, select the role you want to assign, and then select **Save**." }} @@ -153,19 +169,7 @@ ## Export members Owners can export a CSV file containing all members. -The CSV file may contain the following fields: - -* **Name**: The user's name. -* **Username**: The user's Docker ID. -* **Email**: The user's email address. -* **Type**: The type of user. For example, **Invitee** for users who have not accepted the organization's invite, - or **User** for users who are members of the organization. -* **Permission**: The user's organization permissions. For example, **Member** or **Owner**. -* **Teams**: The teams where the user is a member. A team is not listed for invitees. -* **Date Joined**: The time and date when the user was invited to the organization. -* **Member of Organizations**: All organizations the user is a member of within a company. -* **Invited to Organizations**: All organizations the user is an invitee of within a company. -* **Account Created**: The time and date when the user account was created. +{{ $export_fields }} To export a CSV file of the members: