Skip to content

[DOCS] Reformats voting configuration exclusion API #45644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szabosteve merged 1 commit into from
Aug 16, 2019
Merged

[DOCS] Reformats voting configuration exclusion API #45644

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 32 additions & 22 deletions docs/reference/cluster/voting-exclusions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,17 @@
Adds or removes master-eligible nodes from the
<<modules-discovery-voting,voting configuration exclusion list>>.

[float]
==== Request

`POST _cluster/voting_config_exclusions/<node_name>` +
[[voting-config-exclusions-api-request]]
==== {api-request-title}

`DELETE _cluster/voting_config_exclusions`
`POST _cluster/voting_config_exclusions/{node_name}` +

[float]
==== Path parameters
`DELETE _cluster/voting_config_exclusions`

`node_name`::
A <<cluster-nodes,node filter>> that identifies {es} nodes.

[float]
==== Description
[[voting-config-exclusions-api-desc]]
==== {api-description-title}

By default, if there are more than three master-eligible nodes in the cluster
and you remove fewer than half of the master-eligible nodes in the cluster at
Expand All @@ -44,31 +40,45 @@ master-eligible nodes from a cluster in a short time period. They are not
required when removing master-ineligible nodes or fewer than half of the
master-eligible nodes.

The <<modules-discovery-settings,`cluster.max_voting_config_exclusions`
setting>> limits the size of the voting configuration exclusion list. The
default value is `10`. Since voting configuration exclusions are persistent and
limited in number, you must clear the voting config exclusions list once the
exclusions are no longer required.
For more information, see <<modules-discovery-removing-nodes>>.


There is also a
<<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` setting>>,
which is set to true by default. If it is set to false, you must use this API to
maintain the voting configuration.
[[voting-config-exclusions-api-path-params]]
==== {api-path-parms-title}

`{node_name}`::
A <<cluster-nodes,node filter>> that identifies {es} nodes.

For more information, see <<modules-discovery-removing-nodes>>.

[float]
==== Examples
[[voting-config-exclusions-api-query-params]]
==== {api-query-parms-title}

`cluster.auto_shrink_voting_configuration`::
(Optional, boolean) If `false`, you must use this API to maintain the voting
configuration. Defaults to `true`.

`cluster.max_voting_config_exclusions`::
(Optional, integer) Limits the size of the voting configuration exclusion
list. The default value is `10`. Since voting configuration exclusions are
persistent and limited in number, you must clear the voting config
exclusions list once the exclusions are no longer required.


[[voting-config-exclusions-api-example]]
==== {api-examples-title}

Add `nodeId1` to the voting configuration exclusions list:

[source,js]
--------------------------------------------------
POST /_cluster/voting_config_exclusions/nodeId1
--------------------------------------------------
// CONSOLE
// TEST[catch:bad_request]


Remove all exclusions from the list:

[source,js]
--------------------------------------------------
DELETE /_cluster/voting_config_exclusions
Expand Down