Skip to content

Commit

Permalink
Add documentation for cluster-level coordination setting changes (#6336)
Browse files Browse the repository at this point in the history
* Adding cluster level coordination changes

Signed-off-by: Niyati Aggarwal <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Niyati Aggarwal <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Niyati Aggarwal <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Niyati Aggarwal <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Niyati Aggarwal <[email protected]>

* Adding default, min and max values

Signed-off-by: Niyati Aggarwal <[email protected]>

* Added other changes

Signed-off-by: Niyati Aggarwal <[email protected]>

* Added other changes

Signed-off-by: Niyati Aggarwal <[email protected]>

* Added a few more changes

Signed-off-by: Niyati Aggarwal <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Signed-off-by: kolchfa-aws <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Signed-off-by: kolchfa-aws <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Signed-off-by: kolchfa-aws <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _install-and-configure/configuring-opensearch/cluster-settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Niyati Aggarwal <[email protected]>
Signed-off-by: Niyati Aggarwal <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
3 people authored Feb 2, 2024
1 parent 103bb96 commit 3a01797
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions _install-and-configure/configuring-opensearch/cluster-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ OpenSearch supports the following cluster-level shard, block, and task settings:

Default is `all`.

- `cluster.persistent_tasks.allocation.recheck_interval` (Time unit): The cluster manager automatically checks whether persistent tasks need to be assigned when the cluster state changes in a significant way. There are other factors, such as memory usage, that will affect whether persistent tasks are assigned to nodes but do not otherwise cause the cluster state to change. This setting defines how often assignment checks are performed in response to these factors. Default is `30 seconds`, with a minimum of `10 seconds` being required.
- `cluster.persistent_tasks.allocation.recheck_interval` (Time unit): The cluster manager automatically checks whether persistent tasks need to be assigned when the cluster state changes in a significant way. There are other factors, such as memory usage, that will affect whether persistent tasks are assigned to nodes but do not otherwise cause the cluster state to change. This setting defines how often assignment checks are performed in response to these factors. Default is `30 seconds`, with a minimum of `10 seconds` being required.

## Cluster-level slow log settings

Expand All @@ -132,4 +132,12 @@ For more information, see [Search request slow logs]({{site.url}}{{site.baseurl}

## Cluster-level index settings

For information about index-level index settings, see [Cluster-level index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/#cluster-level-index-settings).
For information about index-level index settings, see [Cluster-level index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/#cluster-level-index-settings).

## Cluster-level coordination settings

OpenSearch supports the following cluster-level coordination settings. All settings in this list are dynamic:

- `cluster.fault_detection.leader_check.timeout` (Time unit): The amount of time a node waits for a response from the elected cluster manager during a leader check before deeming the check a failure. Valid values are from `1ms` to `60s`, inclusive. Default is `10s`. Changing this setting to a value other than the default can result in an unstable cluster.

- `cluster.fault_detection.follower_check.timeout` (Time unit): The amount of time the elected cluster manager waits for a response during a follower check before deeming the check a failure. Valid values are from `1ms` to `60s`, inclusive. Default is `10s`. Changing this setting to a value other than the default can result in an unstable cluster.

0 comments on commit 3a01797

Please sign in to comment.