scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-02 03:27:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Raft index telemetry and docs (#17397)

Browse Source 
* add raft index to telemetry

* add definitions and defaults to both autopilot pages

* adjust messages

* Revert "add raft index to telemetry"

This reverts commit 010b091c7e35c1da677567746db90b490ca707ab.
This commit is contained in:
Josh Black
2022-10-04 11:46:11 -07:00
committed by GitHub
parent 26c370e5a5
commit 5b9be84648
2 changed files with 30 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
website/content/docs/commands/operator/raft.mdx
View File

@@ -319,23 +319,25 @@ Flags applicable to this command are the following:
- `cleanup-dead-servers` `(bool)` - Controls whether to remove dead servers from
the Raft peer list periodically or when a new server joins. This requires that
`min-quorum` is also set.
`min-quorum` is also set. Defaults to `false`.
- `last-contact-threshold` `(string)` - Limit on the amount of time a server can
go without leader contact before being considered unhealthy.
go without leader contact before being considered unhealthy. Defaults to `10s`.
- `dead-server-last-contact-threshold` `(string)` - Limit on the amount of time
a server can go without leader contact before being considered failed. This
takes effect only when `cleanup_dead_servers` is set.
takes effect only when `cleanup_dead_servers` is set. Defaults to `24h`.
- `max-trailing-logs` `(int)` - Amount of entries in the Raft Log that a server
can be behind before being considered unhealthy.
can be behind before being considered unhealthy. Defaults to `1000`.
- `min-quorum` `(int)` - Minimum number of servers allowed in a cluster before
autopilot can prune dead servers. This should at least be 3. Applicable only for
voting nodes.
- `min-quorum` `(int)` - Minimum number of servers that should always be present in a cluster.
Autopilot will not prune servers below this number. This should be set to the expected number
of voters in your cluster. There is no default.
- `server-stabilization-time` `(string)` - Minimum amount of time a server must be in a healthy state before it
can become a voter. Until that happens, it will be visible as a peer in the cluster, but as a non-voter, meaning it
won't contribute to quorum. Defaults to `10s`.
- `server-stabilization-time` `(string)` - Minimum amount of time a server must be in a stable, healthy state before it can become a voter. Until that happens, it will be visible as a peer in the cluster, but as a non-voter, meaning it won't contribute to quorum.
-
- `disable-upgrade-migration` `(bool)` - Controls whether to disable automated
upgrade migrations, an Enterprise-only feature. The default is `false`.
upgrade migrations, an Enterprise-only feature. Defaults to `false`.

20
website/content/docs/concepts/integrated-storage/autopilot.mdx
View File

@@ -55,17 +55,33 @@ API](/api-docs/system/storage/raftautopilot#set-configuration) to manage its
behavior. Autopilot gets initialized with the following default values.
- `cleanup_dead_servers` - `false`
- This controls whether to remove dead servers from
the Raft peer list periodically or when a new server joins. This requires that
`min-quorum` is also set.
- `dead_server_last_contact_threshold` - `24h`
- Limit on the amount of time
a server can go without leader contact before being considered failed. This
takes effect only when `cleanup_dead_servers` is set.
- `min_quorum` - This doesn't default to anything and will need to be set to at
least 3 when `cleanup_dead_servers` is set as `true`.
- `min_quorum` - This doesn't default to anything and should be set to the expected
number of voters in your cluster when `cleanup_dead_servers` is set as `true`.
- Minimum number of servers that should always be present in a cluster.
Autopilot will not prune servers below this number.
- `max_trailing_logs` - `1000`
- Amount of entries in the Raft Log that a server
can be behind before being considered unhealthy.
- `last_contact_threshold` - `10s`
- Limit on the amount of time a server can go without leader contact before being considered unhealthy.
- `server_stabilization_time` - `10s`
- Minimum amount of time a server must be in a healthy state before it can become a voter. Until that happens,
it will be visible as a peer in the cluster, but as a non-voter, meaning it won't contribute to quorum.
- `disable-upgrade-migration` - `false`
- Controls whether to disable automated upgrade migrations, an Enterprise-only feature.
~> **Note**: Autopilot in Vault does similar things to what autopilot does in
[Consul](https://www.consul.io/). However, the configuration in these 2 systems