Skip to content
On this page

Cluster Configuration Reference

Bondy configuration options controlling the cluster.

Listener options

cluster.peer_port  :: integer
Default = 18086Since v0.8.8

Defines the IP Port number to use for the cluster TCP connection. The default value is 18086.

cluster.parallelism  :: integer
Default = 1Since 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  :: on|off
Default = offSince 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  :: path
Default = '$(platform_etc_dir)/cacert.pem'Since v0.8.8

Default signing authority location for cluster TLS connection.

cluster.tls.certfile  :: path
Default = '$(platform_etc_dir)/cert.pem'Since v0.8.8

Default cert location for cluster TLS connection. The default value is $(platform_etc_dir)/cert.pem.

cluster.tls.keyfile  :: path
Default = '$(platform_etc_dir)/key.pem'Since N/A

Default key location for cluster TLS connection.

Peer Discovery / Automatic Join

cluster.peer_discovery.enabled  :: on|off
Default = offSince N/A

Defines whether Bondy should actively search for peer nodes using a defined strategy.

cluster.peer_discovery.type  :: string
Default = N/ASince 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  :: on|off
Default = offSince N/A

Defines whether Bondy will automatically join a discovered node forming a cluster.

cluster.peer_discovery.join_retry_interval  :: time_duration_units
Default = 5sSince N/A

Defines the time duration Bondy will wait between automatic join attempts.

cluster.peer_discovery.polling_interval  :: time_duration_units
Default = 10sSince N/A

Defines the time duration Bondy will wait between polling attempts.

cluster.peer_discovery.timeout  :: time_duration_units
Default = 5sSince N/A

Defines the time duration Bondy will wait for a response for a polling attempt.

cluster.peer_discovery.join_retry_interval  :: time_duration_units
Default = 5sSince 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  :: string
Default = N/ASince 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
1
2
cluster.peer_discovery.config.$name.$_  :: string
Default = N/ASince v1.0.0

The configuration for the selected strategy in cluster.peer_discovery.type. Refer to each strategy documentation.

Example: The selecte 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
1
2
3

Topology

cluster.topology  :: fullmesh|p2p
Default = fullmeshSince v1.0.0

WARNING

At the moment the only option is fullmesh.

Membership View Sync

cluster.lazy_tick_period  :: duration_time_units
Default = 1sSince v1.0.0
  • document
cluster.exchange_tick_period  :: duration_time_units
Default = 10sSince v1.0.0

Automatic leave

cluster.automatic_leave  :: on|off
Default = offSince v1.0.0

Defines whether a Bondy node should perform a cluster leave operation automatically when it is being shutdown.

Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-ShareAlike (CC-BY-SA) 4.0 International license.
Bondy and Leapsight are registered trademarks.