Change default raft threshold config values and add a section to upgrade notes

This commit is contained in:
Preetha Appan 2018-05-11 10:11:15 -05:00
parent 5d3b267787
commit 7400a78f8a
No known key found for this signature in database
GPG Key ID: 9F7C19990A50EAFC
2 changed files with 14 additions and 3 deletions

View File

@ -449,10 +449,10 @@ func DefaultConfig() *Config {
conf.RaftConfig.ShutdownOnRemove = false
// Check every 5 seconds to see if there are enough new entries for a snapshot, can be overridden
conf.RaftConfig.SnapshotInterval = 5 * time.Second
conf.RaftConfig.SnapshotInterval = 30 * time.Second
// Snapshots are created every 8192 entries by default, can be overridden
conf.RaftConfig.SnapshotThreshold = 8192
// Snapshots are created every 16384 entries by default, can be overridden
conf.RaftConfig.SnapshotThreshold = 16384
return conf
}

View File

@ -26,6 +26,17 @@ The following previously deprecated fields and config options have been removed:
- The [deprecated set of metric names](/docs/upgrade-specific.html#metric-names-updated) (beginning with `consul.consul.`) has been removed
along with the `enable_deprecated_names` option from the metrics configuration.
#### New defaults for Raft Snapshot Creation
Consul 1.0.1 (and earlier versions of Consul) checked for raft snapshots every
5 seconds, and created new snapshots for every 8192 writes. These defaults cause
constant disk IO in large busy clusters. Consul 1.1.0 increases these to larger values,
and makes them tunable via the [raft_snapshot_interval](/docs/agent/options.html#_raft_snapshot_interval) and
[raft_snapshot_threshold](/docs/agent/options.html#_raft_snapshot_threshold) parameters. We recommend
keeping the new defaults. However, operators can go back to the old defaults by changing their
config if they prefer more frequent snapshots. See the documentation for [raft_snapshot_interval](/docs/agent/options.html#_raft_snapshot_interval)
and [raft_snapshot_threshold](/docs/agent/options.html#_raft_snapshot_threshold) to understand the trade-offs
when tuning these.
## Consul 1.0.1
#### Carefully Check and Remove Stale Servers During Rolling Upgrades