From 1e6b46b700e175136db0ab44739aa4fcf8f21882 Mon Sep 17 00:00:00 2001 From: Tim Smid Date: Wed, 4 Jan 2017 11:39:44 +0100 Subject: [PATCH] Add notice for ignored Compose file options when deploying a stack. --- compose/compose-file.md | 60 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/compose/compose-file.md b/compose/compose-file.md index 4bb33a0088..01deaa9e30 100644 --- a/compose/compose-file.md +++ b/compose/compose-file.md @@ -68,6 +68,10 @@ This will result in an image named `webapp` and tagged `tag`, built from `./dir` > 2. Using `build` together with `image` is not allowed. Attempting to do so > results in an error. +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + #### context > [Version 2 file format](compose-file.md#version-2) and up. In version 1, just use @@ -159,6 +163,10 @@ See `man 7 capabilities` for a full list. - NET_ADMIN - SYS_ADMIN +> **Note:** These options are ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### command Override the default command. @@ -176,6 +184,10 @@ Specify an optional parent cgroup for the container. cgroup_parent: m-executor-abcd +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### container_name Specify a custom container name, rather than a generated default name. @@ -312,6 +324,10 @@ client create option. devices: - "/dev/ttyUSB0:/dev/ttyUSB0" +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### depends_on Express dependency between services, which has two effects: @@ -381,6 +397,10 @@ Custom DNS servers. Can be a single value or a list. - 8.8.8.8 - 9.9.9.9 +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### dns_search Custom DNS search domains. Can be a single value or a list. @@ -390,6 +410,10 @@ Custom DNS search domains. Can be a single value or a list. - dc1.example.com - dc2.example.com +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### tmpfs > [Version 2 file format](compose-file.md#version-2) and up. @@ -401,6 +425,10 @@ Mount a temporary file system inside the container. Can be a single value or a l - /run - /tmp +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### entrypoint Override the default entrypoint. @@ -532,6 +560,10 @@ container name and the link alias (`CONTAINER:ALIAS`). > externally-created containers must be connected to at least one of the same > networks as the service which is linking to them. +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### extra_hosts Add hostname mappings. Use the same values as the docker client `--add-host` parameter. @@ -671,6 +703,10 @@ Links also express dependency between services in the same way as > links between them must share at least one network in common in order to > communicate. +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### logging > [Version 2 file format](compose-file.md#version-2) and up. In version 1, use @@ -751,6 +787,10 @@ the special form `service:[service name]`. network_mode: "service:[service name]" network_mode: "container:[container name/id]" +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### networks > [Version 2 file format](compose-file.md#version-2) and up. In version 1, use [net](compose-file.md#net). @@ -906,6 +946,10 @@ Override the default labeling scheme for each container. - label:user:USER - label:role:ROLE +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### stop_grace_period > [Added in version 2 file format](compose-file.md#version-2) @@ -929,6 +973,10 @@ SIGTERM. Setting an alternative signal using `stop_signal` will cause stop_signal: SIGUSR1 +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### sysctls > [Added in version 2.1 file format](compose-file.md#version-21). @@ -944,6 +992,10 @@ dictionary. - net.core.somaxconn=1024 - net.ipv4.tcp_syncookies=0 +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ### ulimits Override the default ulimits for a container. You can either specify a single @@ -966,6 +1018,9 @@ Disables the user namespace for this service, if Docker daemon is configured wit See [dockerd](/engine/reference/commandline/dockerd.md#disable-user-namespace-for-a-container) for more information. +> **Note:** This option is ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. ### volumes, volume\_driver @@ -1093,6 +1148,11 @@ Each of these is a single value, analogous to its > [version 2](compose-file.md#version-2) and up: > * `oom_score_adj` +> **Note:** The `domainname`, `ipc`, `mac_address`, `privileged`, `read_only`, +> `restart` and `shm_size` options are ignored when +> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md) +> with a (version 3) Compose file. + ## Specifying durations