Sign in

v1

latestOpenAPI 3.0.02026-07-1410578280.2 KB
Swarm

Initialize a new swarm

post/swarm/init

Request body

AdvertiseAddrstring

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.

DataPathAddrstring

Address or interface to use for data path traffic (format: <ip|interface>), 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.

ForceNewClusterboolean

Force creation of a new swarm.

ListenAddrstring

Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). 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 default swarm listening port is used.

Example request

{
  "AdvertiseAddr": "192.168.1.1:2377",
  "ForceNewCluster": false,
  "ListenAddr": "0.0.0.0:2377",
  "Spec": {
    "CAConfig": {},
    "Dispatcher": {},
    "EncryptionConfig": {
      "AutoLockManagers": false
    },
    "Orchestration": {},
    "Raft": {}
  }
}

Response

no error

string required

The node ID

Example response

"7v2t30z9blmxuhnyo6s4cpenp"