hb.relay

Minimal configlet:

[hb#1]
type = relay
relay = relaynode1

Minimal setup command:

om test/ccfg/foo set \
	--kw="type=relay" \
	--kw="relay=relaynode1"

insecure

required:    false
scopable:    false
default:     false
convert:     bool

Set to true to disable the relay SSL certificate verification.

This should only be enabled for testing.

interval

required:    false
scopable:    true
default:     5s
convert:     duration

The maximum interval between 2 heartbeat payload sends.

The actual interval is not fixed, because the daemon tries to send the message as soon as it has something to notify. A minimum interval protects the node from saturating the network and cpu with the daemon synchronization workload.

password

required:    false
scopable:    false
default:     system/sec/relay

The name of a sec object containing a password key, which value is used as password for log in the relay api.

relay

required:    true
scopable:    false

Example:

relay=relaynode1

The relay resolvable node name.

timeout

required:    false
scopable:    true
default:     15s
convert:     duration

The delay since the last received heartbeat from a node before considering this node is gone.

type

required:    true
scopable:    false
candidates:  unicast, multicast, disk, relay

The heartbeat driver name.

username

required:    false
scopable:    false
default:     relay

The username for login the relay api.