-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
@@ -182,7 +182,7 @@ Configuration options that are applied at build time.
context:
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
webapp:
build: ./dir
@@ -192,7 +192,7 @@ Or, as an object with the path specified under [context](#context) and
optionally [Dockerfile](#dockerfile) and [args](#args):
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
webapp:
build:
@@ -447,7 +447,7 @@ the stack deployment fails with a `config not found` error.
> of the compose file format.
```yaml
-version: "3.3"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:latest
@@ -489,7 +489,7 @@ to `103`. The `redis` service does not have access to the `my_other_config`
config.
```yaml
-version: "3.3"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:latest
@@ -573,7 +573,7 @@ behaviors:
Simple example:
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
web:
build: .
@@ -609,7 +609,7 @@ only takes effect when deploying to a [swarm](/engine/swarm/index.md) with
ignored by `docker-compose up` and `docker-compose run`.
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:alpine
@@ -645,7 +645,7 @@ in cases where you want to use your own load balancer, or for Hybrid
Windows and Linux applications.
```yaml
-version: "3.3"
+version: "{{ site.compose_file_v3 }}"
services:
wordpress:
@@ -694,7 +694,7 @@ Specify labels for the service. These labels are *only* set on the service,
and *not* on any containers for the service.
```yaml
-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
web:
image: web
@@ -706,7 +706,7 @@ services:
To set labels on containers instead, use the `labels` key outside of `deploy`:
```yaml
-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
web:
image: web
@@ -724,7 +724,7 @@ in the [swarm](/engine/swarm/) topics.)
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
worker:
image: dockersamples/examplevotingapp_worker
@@ -737,7 +737,7 @@ services:
Specify placement of constraints and preferences. See the docker service create documentation for a full description of the syntax and available types of [constraints](/engine/reference/commandline/service_create.md#specify-service-constraints-constraint) and [preferences](/engine/reference/commandline/service_create.md#specify-service-placement-preferences-placement-pref).
```yaml
-version: '3.3'
+version: "{{ site.compose_file_v3 }}"
services:
db:
image: postgres
@@ -756,7 +756,7 @@ If the service is `replicated` (which is the default), specify the number of
containers that should be running at any given time.
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
worker:
image: dockersamples/examplevotingapp_worker
@@ -785,7 +785,7 @@ In this general example, the `redis` service is constrained to use no more than
and has `20M` of memory and `0.25` CPU time reserved (as always available to it).
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:alpine
@@ -841,7 +841,7 @@ Configures if and how to restart containers when they exit. Replaces
decide immediately).
```yaml
-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:alpine
@@ -884,7 +884,7 @@ updates.
file format.
```yaml
-version: '3.4'
+version: "{{ site.compose_file_v3 }}"
services:
vote:
image: dockersamples/examplevotingapp_vote:before
@@ -954,7 +954,7 @@ behaviors:
Simple example:
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
web:
build: .
@@ -986,6 +986,9 @@ Custom DNS servers. Can be a single value or a list.
```yaml
dns: 8.8.8.8
+```
+
+```yaml
dns:
- 8.8.8.8
- 9.9.9.9
@@ -1256,7 +1259,7 @@ Either set a boolean value to use the default `init`, or specify a path to
a custom one.
```yaml
-version: '3.7'
+version: "{{ site.compose_file_v3 }}"
services:
web:
image: alpine:latest
@@ -1393,7 +1396,7 @@ files are removed to allow storage of new logs.
Here is an example `docker-compose.yml` file that limits logging storage:
```yaml
-version: '3.7'
+version: "{{ site.compose_file_v3 }}"
services:
some-service:
image: some-service
@@ -1474,16 +1477,16 @@ the hostname `db` or `database` on the `new` network, and at `db` or `mysql` on
the `legacy` network.
```yaml
-version: '2'
+version: "{{ site.compose_file_v3 }}"
services:
web:
- build: ./web
+ image: "nginx:alpine"
networks:
- new
worker:
- build: ./worker
+ image: "my-worker-image:latest"
networks:
- legacy
@@ -1508,21 +1511,20 @@ Specify a static IP address for containers for this service when joining the net
The corresponding network configuration in the
[top-level networks section](#network-configuration-reference) must have an
-`ipam` block with subnet configurations covering each static address. If IPv6
-addressing is desired, the [`enable_ipv6`](#enableipv6) option must be set, and
-you must use a version 2.x Compose file, such as the one below.
+`ipam` block with subnet configurations covering each static address.
-> **Note**: These options do not currently work in swarm mode.
+> If IPv6 addressing is desired, the [`enable_ipv6`](compose-file-v2.md##enable_ipv6)
+> option must be set, and you must use a [version 2.x Compose file](compose-file-v2.md#ipv4_address-ipv6_address).
+> _IPv6 options do not currently work in swarm mode_.
An example:
```yaml
-version: '2.1'
+version: "{{ site.compose_file_v3 }}"
services:
app:
- image: busybox
- command: ifconfig
+ image: nginx:alpine
networks:
app_net:
ipv4_address: 172.16.238.10
@@ -1530,15 +1532,11 @@ services:
networks:
app_net:
- driver: bridge
- enable_ipv6: true
ipam:
driver: default
config:
- -
- subnet: 172.16.238.0/24
- -
- subnet: 2001:3984:3989::/64
+ - subnet: "172.16.238.0/24"
+ - subnet: "2001:3984:3989::/64"
```
### pid
@@ -1642,7 +1640,7 @@ command or by another stack deployment. If the external secret does not exist,
the stack deployment fails with a `secret not found` error.
```yaml
-version: "3.1"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:latest
@@ -1685,7 +1683,7 @@ to `103`. The `redis` service does not have access to the `my_other_secret`
secret.
```yaml
-version: "3.1"
+version: "{{ site.compose_file_v3 }}"
services:
redis:
image: redis:latest
@@ -1850,7 +1848,7 @@ for mounting a named volume. Named volumes must be listed under the top-level
`volumes` key, as shown.
```yaml
-version: "3.2"
+version: "{{ site.compose_file_v3 }}"
services:
web:
image: nginx:alpine
@@ -1927,7 +1925,7 @@ expressed in the short form.
- `consistency`: the consistency requirements of the mount, one of `consistent` (host and container have identical view), `cached` (read cache, host view is authoritative) or `delegated` (read-write cache, container's view is authoritative)
```yaml
-version: "3.2"
+version: "{{ site.compose_file_v3 }}"
services:
web:
image: nginx:alpine
@@ -1975,7 +1973,7 @@ configured as a named volume to persist the data on the swarm,
_and_ is constrained to run only on `manager` nodes. Here is the relevant snip-it from that file:
```yaml
-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
db:
image: postgres:9.4
@@ -2011,7 +2009,7 @@ are visible on the host.
Here is an example of configuring a volume as `cached`:
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
php:
image: php:7.1-fpm
@@ -2096,7 +2094,7 @@ shared with another service as a volume so that it can be periodically backed
up:
```yaml
-version: "3"
+version: "{{ site.compose_file_v3 }}"
services:
db:
@@ -2158,7 +2156,7 @@ In the example below, instead of attempting to create a volume called
called `data` and mount it into the `db` service's containers.
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
db:
@@ -2227,7 +2225,7 @@ volumes that contain special characters. The name is used as is
and will **not** be scoped with the stack name.
```yaml
-version: '3.4'
+version: "{{ site.compose_file_v3 }}"
volumes:
data:
name: my-app-data
@@ -2236,7 +2234,7 @@ volumes:
It can also be used in conjunction with the `external` property:
```yaml
-version: '3.4'
+version: "{{ site.compose_file_v3 }}"
volumes:
data:
external: true
@@ -2306,7 +2304,7 @@ Docker has already created automatically) and an alias that Compose can use
network using the alias.
```yaml
-version: '3.7'
+version: "{{ site.compose_file_v3 }}"
services:
web:
networks:
@@ -2448,7 +2446,7 @@ looks for an existing network simply called `outside` and connect the `proxy`
service's containers to it.
```yaml
-version: '3'
+version: "{{ site.compose_file_v3 }}"
services:
proxy:
@@ -2473,7 +2471,7 @@ You can also specify the name of the network separately from the name used to
refer to it within the Compose file:
```yaml
-version: '3.5'
+version: "{{ site.compose_file_v3 }}"
networks:
outside:
external:
@@ -2489,7 +2487,7 @@ networks which contain special characters. The name is used as is
and will **not** be scoped with the stack name.
```yaml
-version: '3.5'
+version: "{{ site.compose_file_v3 }}"
networks:
network1:
name: my-app-net
@@ -2498,7 +2496,7 @@ networks:
It can also be used in conjunction with the `external` property:
```yaml
-version: '3.5'
+version: "{{ site.compose_file_v3 }}"
networks:
network1:
external: true