From c79c16910c0f3d6e88f2dc6ef609ecc3b02ccef9 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 4 Jul 2017 03:09:56 -0700 Subject: [PATCH] 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 --- api/swagger.yaml | 21 +++++++++++++++++++++ docs/api/version-history.md | 2 ++ 2 files changed, 23 insertions(+) diff --git a/api/swagger.yaml b/api/swagger.yaml index fd0c4c1715b7b..b9e6932994f3a 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -7394,6 +7394,16 @@ paths: AdvertiseAddr: 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." type: "string" + DataPathAddr: + description: | + Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, + or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` + is used. + + The `DataPathAddr` specifies the address that global scope network drivers will publish towards other + nodes in order to reach the containers running on this node. Using this parameter it is possible to + separate the container data traffic from the management traffic of the cluster. + type: "string" ForceNewCluster: description: "Force creation of a new swarm." type: "boolean" @@ -7442,6 +7452,17 @@ paths: type: "string" AdvertiseAddr: 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." + type: "string" + DataPathAddr: + description: | + Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, + or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` + is used. + + The `DataPathAddr` specifies the address that global scope network drivers will publish towards other + nodes in order to reach the containers running on this node. Using this parameter it is possible to + separate the container data traffic from the management traffic of the cluster. + type: "string" RemoteAddrs: description: "Addresses of manager nodes already participating in the swarm." diff --git a/docs/api/version-history.md b/docs/api/version-history.md index aa089ed0a1b9c..26f75858609d4 100644 --- a/docs/api/version-history.md +++ b/docs/api/version-history.md @@ -26,6 +26,8 @@ keywords: "API, Docker, rcli, REST, documentation" the daemon. This endpoint is experimental and only available if the daemon is started with experimental features enabled. * `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. +* `POST /swarm/init` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic +* `POST /swarm/join` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic ## v1.30 API changes