honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Document dynamic discovery settings (#61420) (#62002)

This commit is contained in:
James Rodewig 2020-09-04 11:36:34 -04:00 committed by GitHub
parent 7e2903d888
commit 9f1f468cef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 139 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
docs/reference/modules/discovery/discovery-settings.asciidoc
View File

@ -7,6 +7,7 @@ following settings:
`discovery.seed_hosts`:: `discovery.seed_hosts`::
+ +
-- --
(<<static-cluster-setting,Static>>)
Provides a list of the addresses of the master-eligible nodes in the cluster. Provides a list of the addresses of the master-eligible nodes in the cluster.
May also be a single string containing the addresses separated by commas. Each May also be a single string containing the addresses separated by commas. Each
address has the format `host:port` or `host`. The `host` is either a host name address has the format `host:port` or `host`. The `host` is either a host name
@ -28,7 +29,7 @@ compatibility. Support for the old name will be removed in a future version.
-- --
`discovery.seed_providers`:: `discovery.seed_providers`::
(<<static-cluster-setting,Static>>)
Specifies which types of <<built-in-hosts-providers,seed hosts provider>> to Specifies which types of <<built-in-hosts-providers,seed hosts provider>> to
use to obtain the addresses of the seed nodes used to start the discovery use to obtain the addresses of the seed nodes used to start the discovery
process. By default, it is the process. By default, it is the
@ -39,7 +40,7 @@ compatibility. Support for the old name will be removed in a future version.
compatibility. Support for the old name will be removed in a future version. compatibility. Support for the old name will be removed in a future version.
`discovery.type`:: `discovery.type`::
(<<static-cluster-setting,Static>>)
Specifies whether {es} should form a multiple-node cluster. By default, {es} Specifies whether {es} should form a multiple-node cluster. By default, {es}
discovers other nodes when forming a cluster and allows other nodes to join discovers other nodes when forming a cluster and allows other nodes to join
the cluster later. If `discovery.type` is set to `single-node`, {es} forms a the cluster later. If `discovery.type` is set to `single-node`, {es} forms a
@ -48,10 +49,10 @@ compatibility. Support for the old name will be removed in a future version.
this setting, see <<single-node-discovery>>. this setting, see <<single-node-discovery>>.
`cluster.initial_master_nodes`:: `cluster.initial_master_nodes`::
(<<static-cluster-setting,Static>>)
Sets the initial set of master-eligible nodes in a brand-new cluster. By Sets the initial set of master-eligible nodes in a brand-new cluster. By default
default this list is empty, meaning that this node expects to join a cluster this list is empty, meaning that this node expects to join a cluster that has
that has already been bootstrapped. See <<initial_master_nodes>>. already been bootstrapped. See <<initial_master_nodes>>.
[discrete] [discrete]
==== Expert settings ==== Expert settings
@ -64,35 +65,35 @@ WARNING: If you adjust these settings then your cluster may not form correctly
or may become unstable or intolerant of certain failures. or may become unstable or intolerant of certain failures.
`discovery.cluster_formation_warning_timeout`:: `discovery.cluster_formation_warning_timeout`::
(<<static-cluster-setting,Static>>)
Sets how long a node will try to form a cluster before logging a warning Sets how long a node will try to form a cluster before logging a warning that
that the cluster did not form. Defaults to `10s`. If a cluster has not the cluster did not form. Defaults to `10s`. If a cluster has not formed after
formed after `discovery.cluster_formation_warning_timeout` has elapsed then `discovery.cluster_formation_warning_timeout` has elapsed then the node will log
the node will log a warning message that starts with the phrase `master not a warning message that starts with the phrase `master not discovered` which
discovered` which describes the current state of the discovery process. describes the current state of the discovery process.
`discovery.find_peers_interval`:: `discovery.find_peers_interval`::
(<<static-cluster-setting,Static>>)
Sets how long a node will wait before attempting another discovery round. Sets how long a node will wait before attempting another discovery round.
Defaults to `1s`. Defaults to `1s`.
`discovery.probe.connect_timeout`:: `discovery.probe.connect_timeout`::
(<<static-cluster-setting,Static>>)
Sets how long to wait when attempting to connect to each address. Defaults Sets how long to wait when attempting to connect to each address. Defaults to
to `3s`. `3s`.
`discovery.probe.handshake_timeout`:: `discovery.probe.handshake_timeout`::
(<<static-cluster-setting,Static>>)
Sets how long to wait when attempting to identify the remote node via a Sets how long to wait when attempting to identify the remote node via a
handshake. Defaults to `1s`. handshake. Defaults to `1s`.
`discovery.request_peers_timeout`:: `discovery.request_peers_timeout`::
(<<static-cluster-setting,Static>>)
Sets how long a node will wait after asking its peers again before Sets how long a node will wait after asking its peers again before considering
considering the request to have failed. Defaults to `3s`. the request to have failed. Defaults to `3s`.
`discovery.seed_resolver.max_concurrent_resolvers`:: `discovery.seed_resolver.max_concurrent_resolvers`::
(<<static-cluster-setting,Static>>)
Specifies how many concurrent DNS lookups to perform when resolving the Specifies how many concurrent DNS lookups to perform when resolving the
addresses of seed nodes. Defaults to `10`. This setting was previously addresses of seed nodes. Defaults to `10`. This setting was previously
known as `discovery.zen.ping.unicast.concurrent_connects`. Its old name is known as `discovery.zen.ping.unicast.concurrent_connects`. Its old name is
@ -101,7 +102,7 @@ or may become unstable or intolerant of certain failures.
version. version.
`discovery.seed_resolver.timeout`:: `discovery.seed_resolver.timeout`::
(<<static-cluster-setting,Static>>)
Specifies how long to wait for each DNS lookup performed when resolving the Specifies how long to wait for each DNS lookup performed when resolving the
addresses of seed nodes. Defaults to `5s`. This setting was previously addresses of seed nodes. Defaults to `5s`. This setting was previously
known as `discovery.zen.ping.unicast.hosts.resolve_timeout`. Its old name known as `discovery.zen.ping.unicast.hosts.resolve_timeout`. Its old name
@ -110,115 +111,112 @@ or may become unstable or intolerant of certain failures.
version. version.
`cluster.auto_shrink_voting_configuration`:: `cluster.auto_shrink_voting_configuration`::
(<<dynamic-cluster-setting,Dynamic>>)
Controls whether the <<modules-discovery-voting,voting configuration>> Controls whether the <<modules-discovery-voting,voting configuration>> sheds
sheds departed nodes automatically, as long as it still contains at least 3 departed nodes automatically, as long as it still contains at least 3 nodes. The
nodes. The default value is `true`. If set to `false`, the voting default value is `true`. If set to `false`, the voting configuration never
configuration never shrinks automatically and you must remove departed shrinks automatically and you must remove departed nodes manually with the
nodes manually with the <<voting-config-exclusions,voting configuration <<voting-config-exclusions,voting configuration exclusions API>>.
exclusions API>>.
[[master-election-settings]]`cluster.election.back_off_time`:: [[master-election-settings]]`cluster.election.back_off_time`::
(<<static-cluster-setting,Static>>)
Sets the amount to increase the upper bound on the wait before an election Sets the amount to increase the upper bound on the wait before an election on
on each election failure. Note that this is _linear_ backoff. This defaults each election failure. Note that this is _linear_ backoff. This defaults to
to `100ms`. Changing this setting from the default may cause your cluster `100ms`. Changing this setting from the default may cause your cluster to fail
to fail to elect a master node. to elect a master node.
`cluster.election.duration`:: `cluster.election.duration`::
(<<static-cluster-setting,Static>>)
Sets how long each election is allowed to take before a node considers it Sets how long each election is allowed to take before a node considers it to
to have failed and schedules a retry. This defaults to `500ms`. Changing have failed and schedules a retry. This defaults to `500ms`. Changing this
this setting from the default may cause your cluster to fail to elect a setting from the default may cause your cluster to fail to elect a master node.
master node.
`cluster.election.initial_timeout`:: `cluster.election.initial_timeout`::
(<<static-cluster-setting,Static>>)
Sets the upper bound on how long a node will wait initially, or after the Sets the upper bound on how long a node will wait initially, or after the
elected master fails, before attempting its first election. This defaults elected master fails, before attempting its first election. This defaults to
to `100ms`. Changing this setting from the default may cause your cluster `100ms`. Changing this setting from the default may cause your cluster to fail
to fail to elect a master node. to elect a master node.
`cluster.election.max_timeout`:: `cluster.election.max_timeout`::
(<<static-cluster-setting,Static>>)
Sets the maximum upper bound on how long a node will wait before attempting Sets the maximum upper bound on how long a node will wait before attempting an
an first election, so that an network partition that lasts for a long time first election, so that an network partition that lasts for a long time does not
does not result in excessively sparse elections. This defaults to `10s`. result in excessively sparse elections. This defaults to `10s`. Changing this
Changing this setting from the default may cause your cluster to fail to setting from the default may cause your cluster to fail to elect a master node.
elect a master node.
[[fault-detection-settings]]`cluster.fault_detection.follower_check.interval`:: [[fault-detection-settings]]`cluster.fault_detection.follower_check.interval`::
(<<static-cluster-setting,Static>>)
Sets how long the elected master waits between follower checks to each Sets how long the elected master waits between follower checks to each other
other node in the cluster. Defaults to `1s`. Changing this setting from the node in the cluster. Defaults to `1s`. Changing this setting from the default
default may cause your cluster to become unstable.
`cluster.fault_detection.follower_check.timeout`::
Sets how long the elected master waits for a response to a follower check
before considering it to have failed. Defaults to `10s`. Changing this
setting from the default may cause your cluster to become unstable.
`cluster.fault_detection.follower_check.retry_count`::
Sets how many consecutive follower check failures must occur to each node
before the elected master considers that node to be faulty and removes it
from the cluster. Defaults to `3`. Changing this setting from the default
may cause your cluster to become unstable. may cause your cluster to become unstable.
`cluster.fault_detection.leader_check.interval`:: `cluster.fault_detection.follower_check.timeout`::
(<<static-cluster-setting,Static>>)
Sets how long the elected master waits for a response to a follower check before
considering it to have failed. Defaults to `10s`. Changing this setting from the
default may cause your cluster to become unstable.
Sets how long each node waits between checks of the elected master. `cluster.fault_detection.follower_check.retry_count`::
Defaults to `1s`. Changing this setting from the default may cause your (<<static-cluster-setting,Static>>)
Sets how many consecutive follower check failures must occur to each node before
the elected master considers that node to be faulty and removes it from the
cluster. Defaults to `3`. Changing this setting from the default may cause your
cluster to become unstable. cluster to become unstable.
`cluster.fault_detection.leader_check.timeout`:: `cluster.fault_detection.leader_check.interval`::
(<<static-cluster-setting,Static>>)
Sets how long each node waits for a response to a leader check from the Sets how long each node waits between checks of the elected master. Defaults to
elected master before considering it to have failed. Defaults to `10s`. `1s`. Changing this setting from the default may cause your cluster to become
Changing this setting from the default may cause your cluster to become
unstable. unstable.
`cluster.fault_detection.leader_check.retry_count`:: `cluster.fault_detection.leader_check.timeout`::
(<<static-cluster-setting,Static>>)
Sets how long each node waits for a response to a leader check from the elected
master before considering it to have failed. Defaults to `10s`. Changing this
setting from the default may cause your cluster to become unstable.
`cluster.fault_detection.leader_check.retry_count`::
(<<static-cluster-setting,Static>>)
Sets how many consecutive leader check failures must occur before a node Sets how many consecutive leader check failures must occur before a node
considers the elected master to be faulty and attempts to find or elect a considers the elected master to be faulty and attempts to find or elect a new
new master. Defaults to `3`. Changing this setting from the default may master. Defaults to `3`. Changing this setting from the default may cause your
cause your cluster to become unstable. cluster to become unstable.
`cluster.follower_lag.timeout`:: `cluster.follower_lag.timeout`::
(<<static-cluster-setting,Static>>)
Sets how long the master node waits to receive acknowledgements for cluster Sets how long the master node waits to receive acknowledgements for cluster
state updates from lagging nodes. The default value is `90s`. If a node state updates from lagging nodes. The default value is `90s`. If a node does not
does not successfully apply the cluster state update within this period of successfully apply the cluster state update within this period of time, it is
time, it is considered to have failed and is removed from the cluster. See considered to have failed and is removed from the cluster. See
<<cluster-state-publishing>>. <<cluster-state-publishing>>.
`cluster.join.timeout`:: `cluster.join.timeout`::
(<<static-cluster-setting,Static>>)
deprecated[7.10, Has no effect in 7.x clusters] Sets how long a node will deprecated[7.10, Has no effect in 7.x clusters] Sets how long a node will
wait after sending a request to join a version 6.8 master before it wait after sending a request to join a version 6.8 master before it
considers the request to have failed and retries. Defaults to `60s`. considers the request to have failed and retries. Defaults to `60s`.
`cluster.max_voting_config_exclusions`:: `cluster.max_voting_config_exclusions`::
(<<dynamic-cluster-setting,Dynamic>>)
Sets a limit on the number of voting configuration exclusions at any one Sets a limit on the number of voting configuration exclusions at any one time.
time. The default value is `10`. See The default value is `10`. See <<modules-discovery-adding-removing-nodes>>.
<<modules-discovery-adding-removing-nodes>>.
`cluster.publish.info_timeout`:: `cluster.publish.info_timeout`::
(<<static-cluster-setting,Static>>)
Sets how long the master node waits for each cluster state update to be Sets how long the master node waits for each cluster state update to be
completely published to all nodes before logging a message indicating that completely published to all nodes before logging a message indicating that some
some nodes are responding slowly. The default value is `10s`. nodes are responding slowly. The default value is `10s`.
`cluster.publish.timeout`:: `cluster.publish.timeout`::
(<<static-cluster-setting,Static>>)
Sets how long the master node waits for each cluster state update to be Sets how long the master node waits for each cluster state update to be
completely published to all nodes, unless `discovery.type` is set to completely published to all nodes, unless `discovery.type` is set to
`single-node`. The default value is `30s`. See <<cluster-state-publishing>>. `single-node`. The default value is `30s`. See <<cluster-state-publishing>>.
[[no-master-block]]`cluster.no_master_block`:: [[no-master-block]]
`cluster.no_master_block`::
(<<dynamic-cluster-setting,Dynamic>>)
Specifies which operations are rejected when there is no active master in a Specifies which operations are rejected when there is no active master in a
cluster. This setting has three valid values: cluster. This setting has three valid values:
+ +
@ -253,20 +251,18 @@ earlier versions. The `discovery.zen.no_master_block` setting is ignored.
-- --
`monitor.fs.health.enabled`:: `monitor.fs.health.enabled`::
(<<dynamic-cluster-setting,Dynamic>>)
(<<cluster-update-settings,Dynamic>>, boolean) If `true`, the node runs If `true`, the node runs periodic
periodic <<cluster-fault-detection-filesystem-health,filesystem health <<cluster-fault-detection-filesystem-health,filesystem health checks>>. Defaults
checks>>. Defaults to `true`. to `true`.
`monitor.fs.health.refresh_interval`:: `monitor.fs.health.refresh_interval`::
(<<static-cluster-setting,Static>>)
(<<time-units, Time value>>) Interval between successive Interval between successive
<<cluster-fault-detection-filesystem-health,filesystem health checks>>. <<cluster-fault-detection-filesystem-health,filesystem health checks>>. Defaults
Defaults to `2m`. to `2m`.
`monitor.fs.health.slow_path_logging_threshold`:: `monitor.fs.health.slow_path_logging_threshold`::
(<<dynamic-cluster-setting,Dynamic>>)
(<<time-units, Time value>>) If a If a <<cluster-fault-detection-filesystem-health,filesystem health checks>>
<<cluster-fault-detection-filesystem-health,filesystem health checks>> takes longer than this threshold then {es} logs a warning. Defaults to `5s`.
takes longer than this threshold then {es} logs a warning. Defaults to
`5s`.