Cluster Configuration Reference
Bondy configuration options controlling the cluster.
Listener options
cluster.peer_port
Since v0.8.8
Defines the IP Port number to use for the cluster TCP connection. The default value is 18086
.
cluster.parallelism
Since v0.8.8
Defines the number of TCP connections for the cluster TCP stack. If a value higher than 1
is used, then the cluster connection will use a pool with size equal to the defined value for every named channel.
WARNING
At the moment there are 3 named channels so defining a value of 4
will create a pool of 12 connections. We recommend using a value of 1
until Bondy allows to selectively assign parallelism for each named channel.
cluster.tls.enabled
Since v0.8.8
If enabled then the cluster connection will be established over TLS (making the remaining TLS options mandatory). Otherwise, it will be established over TCP/IP. The default value is off
.
TIP
We recommend enabling this option for production use.
cluster.tls.cacertfile
Since v0.8.8
Default signing authority location for cluster TLS connection.
cluster.tls.certfile
Since v0.8.8
Default cert location for cluster TLS connection. The default value is $(platform_etc_dir)/cert.pem
.
cluster.tls.keyfile
Since N/A
Default key location for cluster TLS connection.
Peer Discovery / Automatic Join
cluster.peer_discovery.enabled
Since N/A
Defines whether Bondy should actively search for peer nodes using a defined strategy.
cluster.peer_discovery.type
Since N/A
Defines the module responsible for implementing the node discovery strategy. At the moment only options is bondy_peer_discovery_dns_agent
.
cluster.peer_discovery.automatic_join
Since N/A
Defines whether Bondy will automatically join a discovered node forming a cluster.
cluster.peer_discovery.join_retry_interval
Since N/A
Defines the time duration Bondy will wait between automatic join attempts.
cluster.peer_discovery.polling_interval
Since N/A
Defines the time duration Bondy will wait between polling attempts.
cluster.peer_discovery.timeout
Since N/A
Defines the time duration Bondy will wait for a response for a polling attempt.
cluster.peer_discovery.join_retry_interval
Since v1.0.0
The time the agent will wait to initiate the next join attempt. For this to take effect cluster.peer_discovery.automatic_join needs to be on.
cluster.peer_discovery.config.$name
Since v1.0.0
The configuration for the selected strategy in cluster.peer_discovery.type
. Refer to each strategy documentation.
Example: The selected type requires two params keyA
and keyB
.
cluster.peer_discovery.config.keyA = valueA
cluster.peer_discovery.config.keyB = valueB
cluster.peer_discovery.config.$name.$_
Since v1.0.0
The configuration for the selected strategy in cluster.peer_discovery.type
. Refer to each strategy documentation.
Example: The selected type requires two params keyA
and keyB
where the latter takes an array of values.
cluster.peer_discovery.config.keyA = value1
cluster.peer_discovery.config.keyB._ = value2
cluster.peer_discovery.config.keyB._ = value3
Topology
cluster.topology
Since v1.0.0
WARNING
At the moment the only option is fullmesh
.
Membership View Sync
cluster.lazy_tick_period
Since v1.0.0
- document
cluster.exchange_tick_period
Since v1.0.0
Automatic leave
cluster.automatic_leave
Since v1.0.0
Defines whether a Bondy node should perform a cluster leave operation automatically when it is being shutdown.