[DOCS] Adds overview and API ref for cluster voting configurations #36954
Conversation
lcawl
added
>docs
|
Pinging @elastic/es-distributed |
- add more side-conditions on when the voting configuration shrinks - add TOC entries for voting (and omitted fault-detection) sections - add link to voting section from quorum section to define 'voting configuration' - move 'Setting the initial quorum' into voting config section - minor rewording/whitespace fixes
| [[voting-config-exclusions]] | ||
| == Voting configuration exclusions API | ||
| ++++ | ||
| <titleabbrev>Voting Configuration Exclusions</titleabbrev> |
There was a problem hiding this comment.
I changed the capitalisation of this title to match the other sections under 'Cluster APIs'.
| This section describes how {es} uses a quorum-based voting mechanism to | ||
| make decisions even if some nodes are unavailable. | ||
|
|
||
| <<modules-discovery-voting>>:: |
| @@ -40,26 +50,27 @@ module. This module is divided into the following sections: | |||
| Cluster state publishing is the process by which the elected master node | |||
| updates the cluster state on all the other nodes in the cluster. | |||
|
|
|||
| <<modules-discovery-quorums>>:: | |||
| <<cluster-fault-detection>>:: | |||
There was a problem hiding this comment.
I think this should be here, for completeness.
| [float] | ||
| === Description | ||
|
|
||
| If the <<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` |
There was a problem hiding this comment.
I'm concerned that mentioning this setting so prominently here will encourage too many users to fiddle with it. It should be left set to the default of true in the overwhelming majority of clusters. We need it to be configurable to support some very unusual resilience requirements, but it's only part of the story for those cases.
I think it'd be better to word most of this description as if the setting is set to the default of true.
There was a problem hiding this comment.
Thanks for the feedback! I've updated the API description to downplay that setting.
…piration * elastic/master: Removing unused methods in Numbers (elastic#37186) Fix setting by time unit (elastic#37192) [DOCS] Cleans up xpackml attributes ML: fix delayed data annotations on secured cluster (elastic#37193) Update version in SearchRequest and related test [DOCS] Adds overview and API ref for cluster voting configurations (elastic#36954) ML: changing JobResultsProvider.getForecastRequestStats to support > 1 index (elastic#37157) Separate out validation of groups of settings (elastic#34184)
Related to #34714
Adds an overview page for cluster voting configurations and a reference page for the API that manages the exclusion list.