mirror of https://github.com/status-im/consul.git
fix serf_wan documentation (#9289)
WAN config is different than LAN config, source of truth is
f72d2042a8/config.go (L315-L326)
and now the docs are correct.
This commit is contained in:
parent
c441d98475
commit
b3a0b8edd9
|
@ -1226,7 +1226,7 @@ type RuntimeConfig struct {
|
||||||
// the cluster more quickly at the expense of increased bandwidth. This
|
// the cluster more quickly at the expense of increased bandwidth. This
|
||||||
// configuration only applies to WAN gossip communications
|
// configuration only applies to WAN gossip communications
|
||||||
//
|
//
|
||||||
// The default is: 200ms
|
// The default is: 500ms
|
||||||
//
|
//
|
||||||
// hcl: gossip_wan { gossip_interval = duration}
|
// hcl: gossip_wan { gossip_interval = duration}
|
||||||
GossipWANGossipInterval time.Duration
|
GossipWANGossipInterval time.Duration
|
||||||
|
@ -1236,7 +1236,7 @@ type RuntimeConfig struct {
|
||||||
// propagate across the cluster more quickly at the expense of increased
|
// propagate across the cluster more quickly at the expense of increased
|
||||||
// bandwidth. This configuration only applies to WAN gossip communications
|
// bandwidth. This configuration only applies to WAN gossip communications
|
||||||
//
|
//
|
||||||
// The default is: 3
|
// The default is: 4
|
||||||
//
|
//
|
||||||
// hcl: gossip_wan { gossip_nodes = int }
|
// hcl: gossip_wan { gossip_nodes = int }
|
||||||
GossipWANGossipNodes int
|
GossipWANGossipNodes int
|
||||||
|
@ -1246,7 +1246,7 @@ type RuntimeConfig struct {
|
||||||
// failed nodes more quickly at the expense of increased bandwidth usage.
|
// failed nodes more quickly at the expense of increased bandwidth usage.
|
||||||
// This configuration only applies to WAN gossip communications
|
// This configuration only applies to WAN gossip communications
|
||||||
//
|
//
|
||||||
// The default is: 1s
|
// The default is: 5s
|
||||||
//
|
//
|
||||||
// hcl: gossip_wan { probe_interval = duration }
|
// hcl: gossip_wan { probe_interval = duration }
|
||||||
GossipWANProbeInterval time.Duration
|
GossipWANProbeInterval time.Duration
|
||||||
|
@ -1256,7 +1256,7 @@ type RuntimeConfig struct {
|
||||||
// of RTT (round-trip time) on your network. This configuration
|
// of RTT (round-trip time) on your network. This configuration
|
||||||
// only applies to the WAN gossip communications
|
// only applies to the WAN gossip communications
|
||||||
//
|
//
|
||||||
// The default is: 500ms
|
// The default is: 3s
|
||||||
//
|
//
|
||||||
// hcl: gossip_wan { probe_timeout = duration }
|
// hcl: gossip_wan { probe_timeout = duration }
|
||||||
GossipWANProbeTimeout time.Duration
|
GossipWANProbeTimeout time.Duration
|
||||||
|
@ -1275,7 +1275,7 @@ type RuntimeConfig struct {
|
||||||
// it dead, giving that suspect node more time to refute if it is indeed
|
// it dead, giving that suspect node more time to refute if it is indeed
|
||||||
// still alive.
|
// still alive.
|
||||||
//
|
//
|
||||||
// The default is: 4
|
// The default is: 6
|
||||||
//
|
//
|
||||||
// hcl: gossip_wan { suspicion_mult = int }
|
// hcl: gossip_wan { suspicion_mult = int }
|
||||||
GossipWANSuspicionMult int
|
GossipWANSuspicionMult int
|
||||||
|
|
|
@ -1561,22 +1561,22 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
- `gossip_nodes` - The number of random nodes to send
|
- `gossip_nodes` - The number of random nodes to send
|
||||||
gossip messages to per gossip_interval. Increasing this number causes the gossip
|
gossip messages to per gossip_interval. Increasing this number causes the gossip
|
||||||
messages to propagate across the cluster more quickly at the expense of increased
|
messages to propagate across the cluster more quickly at the expense of increased
|
||||||
bandwidth. The default is 3.
|
bandwidth. The default is 4.
|
||||||
|
|
||||||
- `gossip_interval` - The interval between sending
|
- `gossip_interval` - The interval between sending
|
||||||
messages that need to be gossiped that haven't been able to piggyback on probing
|
messages that need to be gossiped that haven't been able to piggyback on probing
|
||||||
messages. If this is set to zero, non-piggyback gossip is disabled. By lowering
|
messages. If this is set to zero, non-piggyback gossip is disabled. By lowering
|
||||||
this value (more frequent) gossip messages are propagated across the cluster
|
this value (more frequent) gossip messages are propagated across the cluster
|
||||||
more quickly at the expense of increased bandwidth. The default is 200ms.
|
more quickly at the expense of increased bandwidth. The default is 500ms.
|
||||||
|
|
||||||
- `probe_interval` - The interval between random
|
- `probe_interval` - The interval between random
|
||||||
node probes. Setting this lower (more frequent) will cause the cluster to detect
|
node probes. Setting this lower (more frequent) will cause the cluster to detect
|
||||||
failed nodes more quickly at the expense of increased bandwidth usage. The default
|
failed nodes more quickly at the expense of increased bandwidth usage. The default
|
||||||
is 1s.
|
is 5s.
|
||||||
|
|
||||||
- `probe_timeout` - The timeout to wait for an ack
|
- `probe_timeout` - The timeout to wait for an ack
|
||||||
from a probed node before assuming it is unhealthy. This should be at least the
|
from a probed node before assuming it is unhealthy. This should be at least the
|
||||||
99-percentile of RTT (round-trip time) on your network. The default is 500ms
|
99-percentile of RTT (round-trip time) on your network. The default is 3s
|
||||||
and is a conservative value suitable for almost all realistic deployments.
|
and is a conservative value suitable for almost all realistic deployments.
|
||||||
|
|
||||||
- `retransmit_mult` - The multiplier for the number
|
- `retransmit_mult` - The multiplier for the number
|
||||||
|
@ -1591,7 +1591,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
the timeout to scale properly with expected propagation delay with a larger cluster
|
the timeout to scale properly with expected propagation delay with a larger cluster
|
||||||
size. The higher the multiplier, the longer an inaccessible node is considered
|
size. The higher the multiplier, the longer an inaccessible node is considered
|
||||||
part of the cluster before declaring it dead, giving that suspect node more time
|
part of the cluster before declaring it dead, giving that suspect node more time
|
||||||
to refute if it is indeed still alive. The default is 4.
|
to refute if it is indeed still alive. The default is 6.
|
||||||
|
|
||||||
- `key_file` This provides a the file path to a PEM-encoded
|
- `key_file` This provides a the file path to a PEM-encoded
|
||||||
private key. The key is used with the certificate to verify the agent's authenticity.
|
private key. The key is used with the certificate to verify the agent's authenticity.
|
||||||
|
|
Loading…
Reference in New Issue