Initialize a new swarm

curl --location --request POST '/v1.33/swarm/init' \ --header 'Content-Type: application/json' \ --data-raw '{ "AdvertiseAddr": "192.168.1.1:2377", "ForceNewCluster": false, "ListenAddr": "0.0.0.0:2377", "Spec": { "CAConfig": {}, "Dispatcher": {}, "EncryptionConfig": { "AutoLockManagers": false }, "Orchestration": {}, "Raft": {} } }'

Request

Body Params application/json

AdvertiseAddr

string

optional

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.

DataPathAddr

string

optional

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.

ForceNewCluster

boolean

optional

Force creation of a new swarm.

ListenAddr

string

optional

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.

Spec

object (SwarmSpec)

optional

User modifiable swarm configuration.

CAConfig

object | null

optional

CA configuration.

Dispatcher

object | null

optional

Dispatcher configuration.

EncryptionConfig

object

optional

Parameters related to encryption-at-rest.

Labels

object

optional

User-defined key/value metadata.

Example:

{"com.example.corp.department":"engineering","com.example.corp.type":"production"}

Name

string

optional

Name of the swarm.

Example:

default

Orchestration

object | null

optional

Orchestration configuration.

Raft

object

optional

Raft configuration.

TaskDefaults

object

optional

Defaults for creating tasks in this cluster.

Examples

Request

Responses