summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoffrey F <f.joffrey@gmail.com>2016-09-22 11:58:29 -0700
committerGitHub <noreply@github.com>2016-09-22 11:58:29 -0700
commitf65f89ad8c26684a314d9099fe35bcea07dbe5dc (patch)
treeb8815612ec3f0ed793170a2cc191fb30f05cd056 /docs
parent5b27389571f5cf2a4aa14bdd49f28959831f6bb4 (diff)
parent33424189d43ce7ec0a55abdd709d08af8840e7e5 (diff)
Merge pull request #3653 from shin-/3637-link-local-ips
Add support for link-local IPs in service.networks definition
Diffstat (limited to 'docs')
-rw-r--r--docs/compose-file.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/compose-file.md b/docs/compose-file.md
index 384649b1..cfc242ce 100644
--- a/docs/compose-file.md
+++ b/docs/compose-file.md
@@ -621,6 +621,31 @@ An example:
- subnet: 2001:3984:3989::/64
gateway: 2001:3984:3989::1
+#### link_local_ips
+
+> [Added in version 2.1 file format](#version-21).
+
+Specify a list of link-local IPs. Link-local IPs are special IPs which belong
+to a well known subnet and are purely managed by the operator, usually
+dependent on the architecture where they are deployed. Therefore they are not
+managed by docker (IPAM driver).
+
+Example usage:
+
+ version: '2.1'
+ services:
+ app:
+ image: busybox
+ command: top
+ networks:
+ app_net:
+ link_local_ips:
+ - 57.123.22.11
+ - 57.123.22.13
+ networks:
+ app_net:
+ driver: bridge
+
### pid
pid: "host"
@@ -1054,6 +1079,15 @@ A more extended example, defining volumes and networks:
back-tier:
driver: bridge
+### Version 2.1
+
+An upgrade of [version 2](#version-2) that introduces new parameters only
+available with Docker Engine version **1.12.0+**
+
+Introduces:
+
+- [`link_local_ips`](#link_local_ips)
+- ...
### Upgrading