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 93df51ea4d..92f4f39074 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 ae733592d0..f290045471 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 e9a671c279..5737bb3dc5 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 0000000000..052124bbe5 --- /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 0000000000..34485d7def --- /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 0000000000..a66ed5340f --- /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 0000000000..056d211b0e --- /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 0000000000..3cda50e206 --- /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 0000000000..04bffc0b83 --- /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 0000000000..aa8130e7a0 --- /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 0000000000..1eaec63e83 --- /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 0000000000..15612ea33b --- /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 0000000000..9be79443af --- /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 0000000000..0efcc90173 --- /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 0000000000..92d10389df --- /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 0000000000..3c231fbc42 --- /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 0000000000..7c5f7d6a4f --- /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 0000000000..02a8f57ec4 --- /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 0000000000..2e79d806e9 --- /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 0000000000..58f56ed09c --- /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 0000000000..50a13d96f0 --- /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 0000000000..334c82f184 --- /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 0000000000..ffd3d8eb53 --- /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 0000000000..15c7b1b691 --- /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 0000000000..e68328fa73 --- /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 0000000000..90a4fef245 --- /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 0000000000..973851ab5c --- /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 0000000000..cbd8e50f60 --- /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 0000000000..3eea660e53 --- /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 0000000000..5cf5830e28 --- /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 0000000000..b525347f7e --- /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 0000000000..e7cf92a80f --- /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 0000000000..9aff0ce71f --- /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 0000000000..0df10a9924 --- /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 0000000000..8f7428e054 --- /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 0000000000..66081d65ec --- /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 0000000000..9c9ff6f1cf --- /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 0000000000..0687046188 --- /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 4f74166765..b6f5d76c50 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 2598c0e881..43994d80cd 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 0000000000..ba01e166a7 --- /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 6a3f5d52e3..cc381493fa 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 0000000000..e8a7d9845a --- /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 0e3e77d6e4..b7821e7752 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 a8c76c3ca3..d51d0ac969 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 757f31be6f..5d2886afa9 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 0000000000..9391441f26 --- /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 042e2b4914..9515ebe32e 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 0000000000..8cb20b1d43 --- /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/modules.txt b/_vendor/modules.txt index cd44b0dc8c..31de5ca8ae 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -2,7 +2,8 @@ # 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/engine/reference/commandline/compose_watch.md b/content/engine/reference/commandline/compose_watch.md new file mode 100644 index 0000000000..659277ffe5 --- /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/data/toc.yaml b/data/toc.yaml index d753af9ecf..0e35e0bc87 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -370,6 +370,8 @@ Reference: title: docker compose up - path: /engine/reference/commandline/compose_version/ title: docker compose version + - path: /engine/reference/commandline/compose_watch/ + title: docker compose watch - sectiontitle: docker config section: - path: /engine/reference/commandline/config/ diff --git a/go.mod b/go.mod index bcf6f6aeda..c0a56190e0 100644 --- a/go.mod +++ b/go.mod @@ -1,14 +1,17 @@ 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.13.0-beta1.0.20231011101155-c444964c2e8f // indirect @@ -16,3 +19,5 @@ require ( 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 a8f74d91e4..4f023f9c73 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= diff --git a/hugo.yaml b/hugo.yaml index d72c834e8b..ace61abb82 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"