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

65 lines
2.7 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[modules-gateway]]
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
== Local Gateway
The local gateway module stores the cluster state and shard data across full
cluster restarts.
[Docs] Fix wrong indent in gateway documentation (#26501) This changeset fixes a spurious indent that causes a code block to be generated instead of a regular paragraph.
2017-09-05 04:42:58 -04:00
The following _static_ settings, which must be set on every master node,
control how long a freshly elected master should wait before it tries to
recover the cluster state and the cluster's data:
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
`gateway.expected_nodes`::
Deprecate delaying state recovery for master nodes (#53646) It is useful to be able to delay state recovery until enough data nodes have joined the cluster, since this gives the shard allocator a decent opportunity to re-use as much existing data as possible. However we also have the option to delay state recovery until a certain number of master-eligible nodes have joined, and this is unnecessary: we require a majority of master-eligible nodes for state recovery, and there is no advantage in waiting for more. This commit deprecates the unnecessary settings in preparation for their removal. Relates #51806
2020-03-18 06:03:21 -04:00
deprecated:[7.7.0, This setting will be removed in 8.0. You should use `gateway.expected_data_nodes` instead.]
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
The number of (data or master) nodes that are expected to be in the cluster.
Recovery of local shards will start as soon as the expected number of
nodes have joined the cluster. Defaults to `0`
`gateway.expected_master_nodes`::
Deprecate delaying state recovery for master nodes (#53646) It is useful to be able to delay state recovery until enough data nodes have joined the cluster, since this gives the shard allocator a decent opportunity to re-use as much existing data as possible. However we also have the option to delay state recovery until a certain number of master-eligible nodes have joined, and this is unnecessary: we require a majority of master-eligible nodes for state recovery, and there is no advantage in waiting for more. This commit deprecates the unnecessary settings in preparation for their removal. Relates #51806
2020-03-18 06:03:21 -04:00
deprecated:[7.7.0, This setting will be removed in 8.0. You should use `gateway.expected_data_nodes` instead.]
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
The number of master nodes that are expected to be in the cluster.
Recovery of local shards will start as soon as the expected number of
master nodes have joined the cluster. Defaults to `0`
`gateway.expected_data_nodes`::
The number of data nodes that are expected to be in the cluster.
Recovery of local shards will start as soon as the expected number of
data nodes have joined the cluster. Defaults to `0`
`gateway.recover_after_time`::
If the expected number of nodes is not achieved, the recovery process waits
for the configured amount of time before trying to recover regardless.
Defaults to `5m` if one of the `expected_nodes` settings is configured.
Once the `recover_after_time` duration has timed out, recovery will start
as long as the following conditions are met:
`gateway.recover_after_nodes`::
Deprecate delaying state recovery for master nodes (#53646) It is useful to be able to delay state recovery until enough data nodes have joined the cluster, since this gives the shard allocator a decent opportunity to re-use as much existing data as possible. However we also have the option to delay state recovery until a certain number of master-eligible nodes have joined, and this is unnecessary: we require a majority of master-eligible nodes for state recovery, and there is no advantage in waiting for more. This commit deprecates the unnecessary settings in preparation for their removal. Relates #51806
2020-03-18 06:03:21 -04:00
deprecated:[7.7.0, This setting will be removed in 8.0. You should use `gateway.recover_after_data_nodes` instead.]
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
Recover as long as this many data or master nodes have joined the cluster.
`gateway.recover_after_master_nodes`::
Deprecate delaying state recovery for master nodes (#53646) It is useful to be able to delay state recovery until enough data nodes have joined the cluster, since this gives the shard allocator a decent opportunity to re-use as much existing data as possible. However we also have the option to delay state recovery until a certain number of master-eligible nodes have joined, and this is unnecessary: we require a majority of master-eligible nodes for state recovery, and there is no advantage in waiting for more. This commit deprecates the unnecessary settings in preparation for their removal. Relates #51806
2020-03-18 06:03:21 -04:00
deprecated:[7.7.0, This setting will be removed in 8.0. You should use `gateway.recover_after_data_nodes` instead.]
Docs: Refactored modules and index modules sections
2015-06-22 17:49:45 -04:00
Recover as long as this many master nodes have joined the cluster.
`gateway.recover_after_data_nodes`::
Recover as long as this many data nodes have joined the cluster.
NOTE: These settings only take effect on a full cluster restart.
Provide explanation of dangling indices, fixes #26008 (#26999) * Provide explanation of dangling indices, fixes #26008 Adjusted from PR review comments * updates to suggested wording and minor typo fix.
2018-01-22 03:39:21 -05:00
Add elasticsearch-node tool docs (#37812) This commit, mostly authored by @DaveCTurner, adds documentation for elasticsearch-node tool #37696. (cherry picked from commit 09425d5a5158c2d3fdad794411b3bbc4bba47b15)
2019-03-12 09:43:29 -04:00
[[modules-gateway-dangling-indices]]
Provide explanation of dangling indices, fixes #26008 (#26999) * Provide explanation of dangling indices, fixes #26008 Adjusted from PR review comments * updates to suggested wording and minor typo fix.
2018-01-22 03:39:21 -05:00
=== Dangling indices
[Docs] Remove repeating words (#33087)
2018-08-28 07:16:43 -04:00
When a node joins the cluster, any shards stored in its local data
Deprecate delaying state recovery for master nodes (#53646) It is useful to be able to delay state recovery until enough data nodes have joined the cluster, since this gives the shard allocator a decent opportunity to re-use as much existing data as possible. However we also have the option to delay state recovery until a certain number of master-eligible nodes have joined, and this is unnecessary: we require a majority of master-eligible nodes for state recovery, and there is no advantage in waiting for more. This commit deprecates the unnecessary settings in preparation for their removal. Relates #51806
2020-03-18 06:03:21 -04:00
directory which do not already exist in the cluster will be imported into the
cluster. This functionality is intended as a best effort to help users who
lose all master nodes. If a new master node is started which is unaware of
the other indices in the cluster, adding the old nodes will cause the old
Provide explanation of dangling indices, fixes #26008 (#26999) * Provide explanation of dangling indices, fixes #26008 Adjusted from PR review comments * updates to suggested wording and minor typo fix.
2018-01-22 03:39:21 -05:00
indices to be imported, instead of being deleted.