Browse code

Add missing API documentatoin for DataPathAddr

COmmit 0307fe1a0bcdc02583a24add41eb783c117bad8c added
a new `DataPathAddr` property to the swarm/init and swarm/join
endpoints. This property was not yet added to the
documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2017/07/04 19:09:56
Showing 2 changed files
... ...
@@ -7394,6 +7394,16 @@ paths:
7394 7394
               AdvertiseAddr:
7395 7395
                 description: "Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible."
7396 7396
                 type: "string"
7397
+              DataPathAddr:
7398
+                description: |
7399
+                  Address or interface to use for data path traffic (format: `<ip|interface>`), for example,  `192.168.1.1`,
7400
+                  or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr`
7401
+                  is used.
7402
+
7403
+                  The `DataPathAddr` specifies the address that global scope network drivers will publish towards other
7404
+                  nodes in order to reach the containers running on this node. Using this parameter it is possible to
7405
+                  separate the container data traffic from the management traffic of the cluster.
7406
+                type: "string"
7397 7407
               ForceNewCluster:
7398 7408
                 description: "Force creation of a new swarm."
7399 7409
                 type: "boolean"
... ...
@@ -7443,6 +7453,17 @@ paths:
7443 7443
               AdvertiseAddr:
7444 7444
                 description: "Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible."
7445 7445
                 type: "string"
7446
+              DataPathAddr:
7447
+                description: |
7448
+                  Address or interface to use for data path traffic (format: `<ip|interface>`), for example,  `192.168.1.1`,
7449
+                  or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr`
7450
+                  is used.
7451
+
7452
+                  The `DataPathAddr` specifies the address that global scope network drivers will publish towards other
7453
+                  nodes in order to reach the containers running on this node. Using this parameter it is possible to
7454
+                  separate the container data traffic from the management traffic of the cluster.
7455
+
7456
+                type: "string"
7446 7457
               RemoteAddrs:
7447 7458
                 description: "Addresses of manager nodes already participating in the swarm."
7448 7459
                 type: "string"
... ...
@@ -26,6 +26,8 @@ keywords: "API, Docker, rcli, REST, documentation"
26 26
   the daemon. This endpoint is experimental and only available if the daemon is started with experimental features
27 27
   enabled.
28 28
 * `GET /images/(name)/get` now includes an `ImageMetadata` field which contains image metadata that is local to the engine and not part of the image config.
29
+* `POST /swarm/init` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic
30
+* `POST /swarm/join` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic
29 31
 
30 32
 ## v1.30 API changes
31 33