Add documentation for cluster-level coordination setting changes #6336
Conversation
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
niyatiagg
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower and
dlvenable
as code owners
hdhalter
added
4 - Doc review
hdhalter
changed the title
There was a problem hiding this comment.
Thank you, @niyatiagg! A couple of changes and then we'll move the PR to editorial review.
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Niyati Aggarwal <121826855+niyatiagg@users.noreply.github.com>
Thank you for the suggestions! |
There was a problem hiding this comment.
Thanks @niyatiagg for the documentation. LGTM overall with few suggestions.
@jainankitk can you take another pass? And also do you think we should include a note saying changing the settings can cause the cluster to become unstable?
| OpenSearch supports the following cluster-level coordination settings. All settings in this list are dynamic: | ||
|
|
||
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the cluster manager during a leader check before deeming the check as a failure. |
There was a problem hiding this comment.
We should also mention the default timeout here.
There was a problem hiding this comment.
+1, let us mention the default and min/max values
There was a problem hiding this comment.
@niyatiagg you can include Changing this setting from the default value may cause an unstable cluster. as the last sentence here.
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the cluster manager during a leader check before deeming the check as a failure. | ||
|
|
||
| - `cluster.fault_detection.follower_check.timeout` (Time unit): Determines the amount of time the cluster manager waits for a response during a follower check before deeming the check as a failure. |
There was a problem hiding this comment.
Needs a default timeout here as well.
There was a problem hiding this comment.
+1, let us mention the default and min/max values
There was a problem hiding this comment.
Here as well Changing this setting from the default value may cause an unstable cluster. last sentence.
| OpenSearch supports the following cluster-level coordination settings. All settings in this list are dynamic: | ||
|
|
||
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the cluster manager during a leader check before deeming the check as a failure. |
There was a problem hiding this comment.
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the cluster manager during a leader check before deeming the check as a failure. | |
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the elected cluster manager during a leader check before deeming the check as a failure. |
| - `cluster.fault_detection.leader_check.timeout` (Time unit): Determines the amount of time a node waits for a response from the cluster manager during a leader check before deeming the check as a failure. | ||
|
|
||
| - `cluster.fault_detection.follower_check.timeout` (Time unit): Determines the amount of time the cluster manager waits for a response during a follower check before deeming the check as a failure. |
There was a problem hiding this comment.
| - `cluster.fault_detection.follower_check.timeout` (Time unit): Determines the amount of time the cluster manager waits for a response during a follower check before deeming the check as a failure. | |
| - `cluster.fault_detection.follower_check.timeout` (Time unit): Determines the amount of time the elected cluster manager waits for a response during a follower check before deeming the check as a failure. |
Agree with specifying default value.
Yeah, that can prevent customers from tweaking this unknowingly. |
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
Signed-off-by: Niyati Aggarwal <niyatiagg4641@gmail.com>
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
_install-and-configure/configuring-opensearch/cluster-settings.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
hdhalter
added
3 - Done
Description
Adds documentation for the Leader check timeout and follower check timeout to be set dynamically through cluster update API
Issues Resolved
Closes #5603
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.