SwarmInitRequest

@Serializable
data class SwarmInitRequest(val listenAddr: String? = null, val advertiseAddr: String? = null, val dataPathAddr: String? = null, val dataPathPort: Int? = null, val defaultAddrPool: List<String>? = null, val forceNewCluster: Boolean? = null, val subnetSize: Int? = null, val spec: SwarmSpec? = null)

Parameters

listenAddr

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.

advertiseAddr

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

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.

dataPathPort

DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used.

defaultAddrPool

Default Address Pool specifies default subnet pools for global scope networks.

forceNewCluster

Force creation of a new swarm.

subnetSize

SubnetSize specifies the subnet size of the networks created from the default subnet pool.

spec

Constructors

Link copied to clipboard
constructor(listenAddr: String? = null, advertiseAddr: String? = null, dataPathAddr: String? = null, dataPathPort: Int? = null, defaultAddrPool: List<String>? = null, forceNewCluster: Boolean? = null, subnetSize: Int? = null, spec: SwarmSpec? = null)

Properties

Link copied to clipboard
@SerialName(value = "AdvertiseAddr")
val advertiseAddr: String?
Link copied to clipboard
@SerialName(value = "DataPathAddr")
val dataPathAddr: String?
Link copied to clipboard
@SerialName(value = "DataPathPort")
val dataPathPort: Int?
Link copied to clipboard
@SerialName(value = "DefaultAddrPool")
val defaultAddrPool: List<String>?
Link copied to clipboard
@SerialName(value = "ForceNewCluster")
val forceNewCluster: Boolean?
Link copied to clipboard
@SerialName(value = "ListenAddr")
val listenAddr: String?
Link copied to clipboard
@SerialName(value = "Spec")
val spec: SwarmSpec?
Link copied to clipboard
@SerialName(value = "SubnetSize")
val subnetSize: Int?