Skip to content

Commit

Permalink
fix serf_wan documentation (hashicorp#9289)
Browse files Browse the repository at this point in the history
WAN config is different than LAN config, source of truth is
https://github.com/hashicorp/memberlist/blob/f72d2042a81632f45a86ad548580c1bd8890dbf9/config.go#L315-L326
and now the docs are correct.
  • Loading branch information
hanshasselberg authored Nov 27, 2020
1 parent a164435 commit 44674bc
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions agent/config/runtime.go
Original file line number Diff line number Diff line change
Expand Up @@ -1226,7 +1226,7 @@ type RuntimeConfig struct {
// the cluster more quickly at the expense of increased bandwidth. This
// configuration only applies to WAN gossip communications
//
// The default is: 200ms
// The default is: 500ms
//
// hcl: gossip_wan { gossip_interval = duration}
GossipWANGossipInterval time.Duration
Expand All @@ -1236,7 +1236,7 @@ type RuntimeConfig struct {
// propagate across the cluster more quickly at the expense of increased
// bandwidth. This configuration only applies to WAN gossip communications
//
// The default is: 3
// The default is: 4
//
// hcl: gossip_wan { gossip_nodes = int }
GossipWANGossipNodes int
Expand All @@ -1246,7 +1246,7 @@ type RuntimeConfig struct {
// failed nodes more quickly at the expense of increased bandwidth usage.
// This configuration only applies to WAN gossip communications
//
// The default is: 1s
// The default is: 5s
//
// hcl: gossip_wan { probe_interval = duration }
GossipWANProbeInterval time.Duration
Expand All @@ -1256,7 +1256,7 @@ type RuntimeConfig struct {
// of RTT (round-trip time) on your network. This configuration
// only applies to the WAN gossip communications
//
// The default is: 500ms
// The default is: 3s
//
// hcl: gossip_wan { probe_timeout = duration }
GossipWANProbeTimeout time.Duration
Expand All @@ -1275,7 +1275,7 @@ type RuntimeConfig struct {
// it dead, giving that suspect node more time to refute if it is indeed
// still alive.
//
// The default is: 4
// The default is: 6
//
// hcl: gossip_wan { suspicion_mult = int }
GossipWANSuspicionMult int
Expand Down
10 changes: 5 additions & 5 deletions website/pages/docs/agent/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 messages to per gossip_interval. Increasing this number causes the gossip
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
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
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
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
is 1s.
is 5s.

- `probe_timeout` - The timeout to wait for an ack
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.

- `retransmit_mult` - The multiplier for the number
Expand All @@ -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
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
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
private key. The key is used with the certificate to verify the agent's authenticity.
Expand Down

0 comments on commit 44674bc

Please sign in to comment.