Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

compose-file: add some options that were missing in changes #10680

Merged
merged 1 commit into from
Apr 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions compose/compose-file/compose-file-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,14 @@ build:
network: custom_network_1
```

Use `none` to disable networking during build:

```yaml
build:
context: .
network: none
```

#### shm_size

> Added in [version 2.3](compose-versioning.md#version-23) file format
Expand Down
34 changes: 29 additions & 5 deletions compose/compose-file/compose-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,16 @@ Introduces the following additional parameters:
- [`link_local_ips`](compose-file-v2.md#link_local_ips)
- [`isolation`](compose-file-v2.md#isolation) in build configurations and
service definitions
- `labels` for [volumes](compose-file-v2.md#volume-configuration-reference) and
[networks](compose-file-v2.md#network-configuration-reference)
- `labels` for [volumes](compose-file-v2.md#volume-configuration-reference),
[networks](compose-file-v2.md#network-configuration-reference), and
[build](index.md#build)
- `name` for [volumes](compose-file-v2.md#volume-configuration-reference)
- [`userns_mode`](compose-file-v2.md#userns_mode)
- [`healthcheck`](compose-file-v2.md#healthcheck)
- [`sysctls`](compose-file-v2.md#sysctls)
- [`pids_limit`](compose-file-v2.md#pids_limit)
- [`oom_kill_disable`](compose-file-v2.md#cpu-and-other-resources)
- [`cpu_period`](compose-file-v2.md)
- [`cpu_period`](compose-file-v2.md#cpu-and-other-resources)

### Version 2.2

Expand All @@ -239,6 +240,7 @@ Introduces the following additional parameters:
- [`init`](compose-file-v2.md#init)
- [`scale`](compose-file-v2.md#scale)
- [`cpu_rt_runtime` and `cpu_rt_period`](compose-file-v2.md#cpu_rt_runtime-cpu_rt_period)
- [`network`](compose-file-v2.md#network) for [build configurations](compose-file-v2.md#build)

### Version 2.3

Expand Down Expand Up @@ -295,6 +297,28 @@ the [upgrading](#upgrading) guide for how to migrate away from these.
> version: "3.0"
> ```

### Version 3.1

An upgrade of [version 3](#version-3) that introduces new parameters only
available with Docker Engine version **1.13.1+**, and higher.

Introduces the following additional parameters:

- [`secrets`](index.md#secrets)

### Version 3.2

An upgrade of [version 3](#version-3) that introduces new parameters only
available with Docker Engine version **17.04.0+**, and higher.

Introduces the following additional parameters:

- [`cache_from`](index.md#cache_from) in [build configurations](index.md#build)
- Long syntax for [ports](index.md#ports) and [volume mounts](index.md#volumes)
- [`attachable`](index.md#attachable) network driver option
- [deploy `endpoint_mode`](index.md#endpoint_mode)
- [deploy placement `preference`](index.md#placement)

### Version 3.3

An upgrade of [version 3](#version-3) that introduces new parameters only
Expand All @@ -305,7 +329,6 @@ Introduces the following additional parameters:
- [build `labels`](index.md#build)
- [`credential_spec`](index.md#credential_spec)
- [`configs`](index.md#configs)
- [deploy `endpoint_mode`](index.md#endpoint_mode)

### Version 3.4

Expand All @@ -314,7 +337,8 @@ only available with Docker Engine version **17.09.0** and higher.

Introduces the following additional parameters:

- `target` and `network` in [build configurations](index.md#build)
- [`target`](index.md#target) and [`network`](index.md#network) in
[build configurations](index.md#build)
- `start_period` for [`healthchecks`](index.md#healthcheck)
- `order` for [update configurations](index.md#update_config)
- `name` for [volumes](index.md#volume-configuration-reference)
Expand Down
34 changes: 32 additions & 2 deletions compose/compose-file/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,33 @@ build:
- "com.example.label-with-empty-value"
```

#### network

> Added in [version 3.4](compose-versioning.md#version-34) file format

Set the network containers connect to for the `RUN` instructions during
build.

```yaml
build:
context: .
network: host
```

```yaml
build:
context: .
network: custom_network_1
```

Use `none` to disable networking during build:

```yaml
build:
context: .
network: none
```

#### shm_size

> Added in [version 3.5](compose-versioning.md#version-35) file format
Expand Down Expand Up @@ -656,7 +683,7 @@ Several sub-options are available:

#### endpoint_mode

> Added in [version 3.3](compose-versioning.md#version-33) file format.
> Added in [version 3.2](compose-versioning.md#version-32) file format.

Specify a service discovery method for external clients connecting to a swarm.

Expand Down Expand Up @@ -762,7 +789,10 @@ services:

#### placement

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).
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: "{{ site.compose_file_v3 }}"
Expand Down