Skip to content

Commit 645ec54

Browse files
aevesdockerscopfbukevineguerlainmdelapenya
authored
publish updates from main (#22137)
Automated pull request for publishing docs updates. --------- Co-authored-by: Ville Skyttä <ville.skytta@iki.fi> Co-authored-by: Veck Hsiao <fbukevin@gmail.com> Co-authored-by: Etienne Guerlain <32822018+eguerlain@users.noreply.github.com> Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com> Co-authored-by: aevesdocker <allie.sadler@docker.com> Co-authored-by: Veesh Goldman <rabbiveesh@gmail.com>
2 parents 4c4a1c7 + 006608d commit 645ec54

File tree

40 files changed

+151
-54
lines changed

40 files changed

+151
-54
lines changed

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Intune
5555
JFrog
5656
Jamf
5757
JetBrains
58+
JUnit
5859
Kerberos
5960
Kitematic
6061
Kubeadm
@@ -80,6 +81,7 @@ Paketo
8081
Postgres
8182
PowerShell
8283
Python
84+
Ryuk
8385
S3
8486
SQLite
8587
Slack

content/guides/genai-leveraging-rag/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The system operates as follows:
3838
3. The found information gets added to the original question before passed to LLM
3939
4. The LLM generates responses that blend the model's inherent knowledge with the this extra information.
4040

41-
To hold this vector information in a efficient manner, we need a special type of database.
41+
To hold this vector information in an efficient manner, we need a special type of database.
4242

4343
## Introduction to Graph databases
4444

content/guides/python/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ In these Kubernetes YAML file, there are various objects, separated by the `---`
161161
your Python application](configure-ci-cd.md).
162162
- A Service, which will define how the ports are mapped in the containers.
163163
- A PersistentVolumeClaim, to define a storage that will be persistent through restarts for the database.
164-
- A Secret, Keeping the database password as a example using secret kubernetes resource.
164+
- A Secret, Keeping the database password as an example using secret kubernetes resource.
165165
- A NodePort service, which will route traffic from port 30001 on your host to
166166
port 8001 inside the pods it routes to, allowing you to reach your app
167167
from the network.

content/guides/ruby/develop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ $ docker compose watch
176176

177177
Any changes to the application's source files on your local machine will now be immediately reflected in the running container.
178178

179-
Open `docker-ruby-on-rails/app/views/whales/index.html.erb` in an IDE or text editor and update the `Whales` string by adding a exclamation marks.
179+
Open `docker-ruby-on-rails/app/views/whales/index.html.erb` in an IDE or text editor and update the `Whales` string by adding an exclamation mark.
180180

181181
```diff
182182
- <h1>Whales</h1>

content/manuals/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ params:
2626
description: Define and run multi-container applications.
2727
icon: /assets/icons/Compose.svg
2828
link: /compose/
29+
- title: Testcontainers OSS
30+
description: Run containers programmatically in your preferred programming language.
31+
icon: /assets/icons/Testcontainers.svg
32+
link: /testcontainers/
2933
products:
3034
- title: Docker Desktop
3135
description: Your command center for container development.

content/manuals/build/bake/compose-file.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Bake supports the [Compose file format](/reference/compose-file/_index.md)
1010
to parse a Compose file and translate each service to a [target](reference.md#target).
1111

1212
```yaml
13-
# docker-compose.yml
13+
# compose.yaml
1414
services:
1515
webapp-dev:
1616
build: &build-dev
@@ -106,7 +106,7 @@ where the command is executed and applied to compose definitions passed
106106
with `-f`.
107107

108108
```yaml
109-
# docker-compose.yml
109+
# compose.yaml
110110
services:
111111
webapp:
112112
image: docker.io/username/webapp:${TAG:-v1.0.0}
@@ -152,7 +152,7 @@ the [special extension](/reference/compose-file/extension.md) field
152152
`x-bake` in your compose file to evaluate extra fields:
153153

154154
```yaml
155-
# docker-compose.yml
155+
# compose.yaml
156156
services:
157157
addon:
158158
image: ct-addon:bar

content/manuals/compose/how-tos/environment-variables/envvars-precedence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In the following example, a different value for the same environment variable in
3030
$ cat ./webapp.env
3131
NODE_ENV=test
3232

33-
$ cat compose.yml
33+
$ cat compose.yaml
3434
services:
3535
webapp:
3636
image: 'webapp'

content/manuals/compose/how-tos/environment-variables/envvars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Specifies the path to a Compose file. Specifying multiple Compose files is suppo
7474
For example:
7575

7676
```console
77-
COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml
77+
COMPOSE_FILE=compose.yaml:compose.prod.yaml
7878
```
7979
The path separator can also be customized using [`COMPOSE_PATH_SEPARATOR`](#compose_path_separator).
8080

content/manuals/compose/how-tos/environment-variables/set-environment-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A container's environment is not set until there's an explicit entry in the serv
2020
## Use the `environment` attribute
2121

2222
You can set environment variables directly in your container's environment with the
23-
[`environment` attribute](/reference/compose-file/services.md#environment) in your `compose.yml`.
23+
[`environment` attribute](/reference/compose-file/services.md#environment) in your `compose.yaml`.
2424

2525
It supports both list and mapping syntax:
2626

@@ -74,7 +74,7 @@ It can also help you keep your environment variables separate from your main con
7474

7575
The [`env_file` attribute](/reference/compose-file/services.md#env_file) also lets you use multiple `.env` files in your Compose application.
7676

77-
The paths to your `.env` file, specified in the `env_file` attribute, are relative to the location of your `compose.yml` file.
77+
The paths to your `.env` file, specified in the `env_file` attribute, are relative to the location of your `compose.yaml` file.
7878

7979
> [!IMPORTANT]
8080
>

content/manuals/compose/how-tos/environment-variables/variable-interpolation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Below is a simple example:
2121
```console
2222
$ cat .env
2323
TAG=v1.5
24-
$ cat compose.yml
24+
$ cat compose.yaml
2525
services:
2626
web:
2727
image: "webapp:${TAG}"
@@ -98,7 +98,7 @@ services:
9898

9999
#### Additional information
100100

101-
- If you define a variable in your `.env` file, you can reference it directly in your `compose.yml` with the [`environment` attribute](/reference/compose-file/services.md#environment). For example, if your `.env` file contains the environment variable `DEBUG=1` and your `compose.yml` file looks like this:
101+
- If you define a variable in your `.env` file, you can reference it directly in your `compose.yaml` with the [`environment` attribute](/reference/compose-file/services.md#environment). For example, if your `.env` file contains the environment variable `DEBUG=1` and your `compose.yaml` file looks like this:
102102
```yaml
103103
services:
104104
webapp:
@@ -163,14 +163,14 @@ $ docker compose --env-file ./config/.env.dev up
163163

164164
#### Additional information
165165

166-
- This method is useful if you want to temporarily override an `.env` file that is already referenced in your `compose.yml` file. For example you may have different `.env` files for production ( `.env.prod`) and testing (`.env.test`).
166+
- This method is useful if you want to temporarily override an `.env` file that is already referenced in your `compose.yaml` file. For example you may have different `.env` files for production ( `.env.prod`) and testing (`.env.test`).
167167
In the following example, there are two environment files, `.env` and `.env.dev`. Both have different values set for `TAG`.
168168
```console
169169
$ cat .env
170170
TAG=v1.5
171171
$ cat ./config/.env.dev
172172
TAG=v1.6
173-
$ cat compose.yml
173+
$ cat compose.yaml
174174
services:
175175
web:
176176
image: "webapp:${TAG}"

content/manuals/compose/how-tos/gpu-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can use either `docker-compose` or `docker compose` commands. For more infor
1515

1616
## Enabling GPU access to service containers
1717

18-
GPUs are referenced in a `compose.yml` file using the [device](/reference/compose-file/deploy.md#devices) attribute from the Compose Deploy specification, within your services that need them.
18+
GPUs are referenced in a `compose.yaml` file using the [device](/reference/compose-file/deploy.md#devices) attribute from the Compose Deploy specification, within your services that need them.
1919

2020
This provides more granular control over a GPU reservation as custom values can be set for the following device properties:
2121

content/manuals/compose/how-tos/multiple-compose-files/extends.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ services:
5959
- "/data"
6060
```
6161
You get exactly the same result as if you wrote
62-
`docker-compose.yml` with the same `build`, `ports`, and `volumes` configuration
62+
`compose.yaml` with the same `build`, `ports`, and `volumes` configuration
6363
values defined directly under `web`.
6464

6565
To include the service `webapp` in the final project when extending services from another file, you need to explicitly include both services in your current Compose file. For example (note this is a non-normative example):
@@ -133,7 +133,7 @@ services:
133133
cpu_shares: 5
134134
```
135135

136-
The `docker-compose.yaml` defines the concrete services which use the common
136+
The `compose.yaml` defines the concrete services which use the common
137137
configuration:
138138

139139
```yaml

content/manuals/compose/how-tos/networking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ other containers on that network, and discoverable by the service's name.
2222
> project name with either the [`--project-name` flag](/reference/cli/docker/compose.md)
2323
> or the [`COMPOSE_PROJECT_NAME` environment variable](environment-variables/envvars.md#compose_project_name).
2424
25-
For example, suppose your app is in a directory called `myapp`, and your `compose.yml` looks like this:
25+
For example, suppose your app is in a directory called `myapp`, and your `compose.yaml` looks like this:
2626

2727
```yaml
2828
services:

content/manuals/compose/how-tos/production.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ production. These changes might include:
2929
- Adding extra services such as a log aggregator
3030

3131
For this reason, consider defining an additional Compose file, for example
32-
`production.yml`, which specifies production-appropriate
32+
`compose.production.yaml`, which specifies production-appropriate
3333
configuration. This configuration file only needs to include the changes you want to make from the original Compose file. The additional Compose file
34-
is then applied over the original `compose.yml` to create a new configuration.
34+
is then applied over the original `compose.yaml` to create a new configuration.
3535

3636
Once you have a second configuration file, you can use it with the
3737
`-f` option:
3838

3939
```console
40-
$ docker compose -f compose.yml -f production.yml up -d
40+
$ docker compose -f compose.yaml -f compose.production.yaml up -d
4141
```
4242

4343
See [Using multiple compose files](multiple-compose-files/_index.md) for a more complete example, and other options.

content/manuals/compose/how-tos/profiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ $ COMPOSE_PROFILES=debug docker compose up
6161
```
6262

6363
Both commands start the services with the `debug` profile enabled.
64-
In the previous `compose.yml` file, this starts the services
64+
In the previous `compose.yaml` file, this starts the services
6565
`db`, `backend` and `phpmyadmin`.
6666

6767
### Start multiple profiles
@@ -187,7 +187,7 @@ $ docker compose --profile debug down
187187
$ COMPOSE_PROFILES=debug docker compose down
188188
```
189189

190-
Both commands stop and remove services with the `debug` profile. In the following `compose.yml` file, this stops the services `db` and `phpmyadmin`.
190+
Both commands stop and remove services with the `debug` profile. In the following `compose.yaml` file, this stops the services `db` and `phpmyadmin`.
191191

192192
```yaml
193193
services:

content/manuals/compose/intro/history.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ It also provides a quick snapshot of the differences in file formats, command-li
2424
### Docker Compose CLI versioning
2525

2626
Version one of the Docker Compose command-line binary was first released in 2014. It was written in Python, and is invoked with `docker-compose`.
27-
Typically, Compose V1 projects include a top-level `version` element in the `compose.yml` file, with values ranging from `2.0` to `3.8`, which refer to the specific [file formats](#compose-file-format-versioning).
27+
Typically, Compose V1 projects include a top-level `version` element in the `compose.yaml` file, with values ranging from `2.0` to `3.8`, which refer to the specific [file formats](#compose-file-format-versioning).
2828

2929
Version two of the Docker Compose command-line binary was announced in 2020, is written in Go, and is invoked with `docker compose`.
30-
Compose V2 ignores the `version` top-level element in the `compose.yml` file.
30+
Compose V2 ignores the `version` top-level element in the `compose.yaml` file.
3131

3232
### Compose file format versioning
3333

content/manuals/compose/releases/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ For more detailed information, see the [release notes in the Compose repo](https
289289

290290
- Fixed the docs on `docker compose kill` usage.
291291
- Fixed redundant condition from `toAPIBuildOptions` in build.go.
292-
- Fixed initial Watch `sync` after Compose restarts with introduction of `x-initSync`.
292+
- Fixed initial Watch `sync` after Compose restarts with introduction of `x-initialSync`.
293293
- Fixed an issue which stopped the Compose process for a single container on `sync-restart` Watch action.
294294

295295
## 2.29.1

content/manuals/compose/support-and-feedback/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ aliases:
1111

1212
### What is the difference between `docker compose` and `docker-compose`
1313

14-
Version one of the Docker Compose command-line binary was first released in 2014. It was written in Python, and is invoked with `docker-compose`. Typically, Compose V1 projects include a top-level version element in the compose.yml file, with values ranging from 2.0 to 3.8, which refer to the specific file formats.
14+
Version one of the Docker Compose command-line binary was first released in 2014. It was written in Python, and is invoked with `docker-compose`. Typically, Compose V1 projects include a top-level version element in the compose.yaml file, with values ranging from 2.0 to 3.8, which refer to the specific file formats.
1515

16-
Version two of the Docker Compose command-line binary was announced in 2020, is written in Go, and is invoked with `docker compose`. Compose V2 ignores the version top-level element in the compose.yml file.
16+
Version two of the Docker Compose command-line binary was announced in 2020, is written in Go, and is invoked with `docker compose`. Compose V2 ignores the version top-level element in the compose.yaml file.
1717

1818
For further information, see [History and development of Compose](/manuals/compose/intro/history.md).
1919

2020
### What's the difference between `up`, `run`, and `start`?
2121

2222
Typically, you want `docker compose up`. Use `up` to start or restart all the
23-
services defined in a `compose.yml`. In the default "attached"
23+
services defined in a `compose.yaml`. In the default "attached"
2424
mode, you see all the logs from all the containers. In "detached" mode (`-d`),
2525
Compose exits after starting the containers, but the containers continue to run
2626
in the background.

content/manuals/compose/support-and-feedback/samples-for-compose.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ if you have not already done so.
1717
The samples should help you to:
1818

1919
- Define services based on Docker images using
20-
[Compose files](/reference/compose-file/_index.md): `compose.yml` and
20+
[Compose files](/reference/compose-file/_index.md): `compose.yaml` and
2121
`docker-stack.yml`
22-
- Understand the relationship between `compose.yml` and
22+
- Understand the relationship between `compose.yaml` and
2323
[Dockerfiles](/reference/dockerfile/)
2424
- Learn how to make calls to your application services from Compose files
2525
- Learn how to deploy applications and services to a [swarm](/manuals/engine/swarm/_index.md)

content/manuals/desktop/features/dev-environments/set-up.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ aliases:
1818
1919
To set up a dev environment, there are additional configuration steps to tell Docker Desktop how to build, start, and use the right image for your services.
2020

21-
Dev Environments use an `compose-dev.yaml` file located at the root of your project. This file allows you to define the image required for a dedicated service, the ports you'd like to expose, along with additional configuration options.
21+
Dev Environments use a `compose-dev.yaml` file located at the root of your project. This file allows you to define the image required for a dedicated service, the ports you'd like to expose, along with additional configuration options.
2222

2323
The following is an example `compose-dev.yaml` file.
2424

content/manuals/desktop/use-desktop/volumes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ To empty a volume:
119119

120120
## Export a volume
121121

122-
You can export the content of a volume to a local file, a local image, an to an
122+
You can export the content of a volume to a local file, a local image, and to an
123123
image in Docker Hub, or to a supported cloud provider. When exporting content
124124
from a volume used by one or more running containers, the containers are
125125
temporarily stopped while Docker exports the content, and then restarted when

content/manuals/engine/cli/otel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The following Docker Compose file bootstraps a set of services to get started wi
6363
It includes an OpenTelemetry collector that the CLI can send metrics to,
6464
and a Prometheus backend that scrapes the metrics off the collector.
6565

66-
```yaml {collapse=true,title=compose.yml}
66+
```yaml {collapse=true,title=compose.yaml}
6767
name: cli-otel
6868
services:
6969
prometheus:
@@ -95,7 +95,7 @@ volumes:
9595
```
9696
9797
This service assumes that the following two configuration files exist alongside
98-
`compose.yml`:
98+
`compose.yaml`:
9999

100100
- ```yaml {collapse=true,title=otelcol.yml}
101101
# Receive signals over gRPC and HTTP

content/manuals/engine/logging/drivers/gelf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The `gelf` logging driver supports the following options:
6666
| `gelf-address` | required | The address of the GELF server. `tcp` and `udp` are the only supported URI specifier and you must specify the port. | `--log-opt gelf-address=udp://192.168.0.42:12201` |
6767
| `gelf-compression-type` | optional | `UDP Only` The type of compression the GELF driver uses to compress each log message. Allowed values are `gzip`, `zlib` and `none`. The default is `gzip`. Note that enabled compression leads to excessive CPU usage, so it's highly recommended to set this to `none`. | `--log-opt gelf-compression-type=gzip` |
6868
| `gelf-compression-level` | optional | `UDP Only` The level of compression when `gzip` or `zlib` is the `gelf-compression-type`. An integer in the range of `-1` to `9` (BestCompression). Default value is 1 (BestSpeed). Higher levels provide more compression at lower speed. Either `-1` or `0` disables compression. | `--log-opt gelf-compression-level=2` |
69-
| `gelf-tcp-max-reconnect` | optional | `TCP Only` The maximum number of reconnection attempts when the connection drop. An positive integer. Default value is 3. | `--log-opt gelf-tcp-max-reconnect=3` |
69+
| `gelf-tcp-max-reconnect` | optional | `TCP Only` The maximum number of reconnection attempts when the connection drop. A positive integer. Default value is 3. | `--log-opt gelf-tcp-max-reconnect=3` |
7070
| `gelf-tcp-reconnect-delay` | optional | `TCP Only` The number of seconds to wait between reconnection attempts. A positive integer. Default value is 1. | `--log-opt gelf-tcp-reconnect-delay=1` |
7171
| `tag` | optional | A string that's appended to the `APP-NAME` in the `gelf` message. By default, Docker uses the first 12 characters of the container ID to tag log messages. Refer to the [log tag option documentation](log_tags.md) for customizing the log tag format. | `--log-opt tag=mailer` |
7272
| `labels` | optional | Applies when starting the Docker daemon. A comma-separated list of logging-related labels this daemon accepts. Adds additional key on the `extra` fields, prefixed by an underscore (`_`). Used for advanced [log tag options](log_tags.md). | `--log-opt labels=production_status,geo` |

content/manuals/engine/release-notes/28.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,6 @@ For a full list of pull requests and changes in this release, refer to the relev
317317
- `api/types/system/Commit.Expected` field is deprecated and should no longer be used. [moby/moby#48478](https://github.com/moby/moby/pull/48478)
318318
- `daemon/graphdriver`: Deprecate `GetDriver()` [moby/moby#48079](https://github.com/moby/moby/pull/48079)
319319
- `libnetwork/iptables`: Deprecate `Passthrough`. This function was only used internally, and will be removed in the next release. [moby/moby#49115](https://github.com/moby/moby/pull/49115)
320-
- `pkg/directory.Size()` function is deprecated, an will be removed in the next release. [moby/moby#48057](https://github.com/moby/moby/pull/48057)
320+
- `pkg/directory.Size()` function is deprecated, and will be removed in the next release. [moby/moby#48057](https://github.com/moby/moby/pull/48057)
321321
- `registry`: Deprecate `APIEndpoint.TrimHostName`; hostname is now trimmed unconditionally for remote names. This field will be removed in the next release. [moby/moby#49005](https://github.com/moby/moby/pull/49005)
322322
- `allow-nondistributable-artifacts` field in `daemon.json`. Setting either option will no longer take effect, but a deprecation warning log is added to raise awareness about the deprecation. This warning is planned to become an error in the next release. [moby/moby#49065](https://github.com/moby/moby/pull/49065)

0 commit comments

Comments
 (0)