Add missing wait_for_nodes param in Cluster health Reference REST API #553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…T API Additional improvements: - The master_timeout is marked as deprecated and cluster_manager_timeout is suggested instead - A required permissions is also documented - The JSON example response is completed Closes: opensearch-project#552 Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
lukas-vlcek
commented
May 5, 2022
Naarcha-AWS
reviewed
May 18, 2022
| @@ -38,14 +38,20 @@ Parameter | Type | Description | |||
| :--- | :--- | :--- | |||
| expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. | |||
| level | Enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`. | |||
| <<<<<<< improve_cluster_health | |||
There was a problem hiding this comment.
Let's remove lines 41 - 44 in favor of the latest 2.0.0 change.
| local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false. | ||
| cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. | ||
| >>>>>>> main |
|
|
||
| If you use the security plugin, make sure you have the appropriate permissions: | ||
| `cluster:monitor/health` | ||
| {: .note } |
There was a problem hiding this comment.
Let's remove the note here.
| wait_for_events | Enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`. | ||
| wait_for_no_relocating_shards | Boolean | Whether to wait until there are no relocating shards in the cluster. Default is false. | ||
| wait_for_no_initializing_shards | Boolean | Whether to wait until there are no initializing shards in the cluster. Default is false. | ||
| wait_for_status | Enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`. | ||
| wait_for_status | Enum | Wait until the cluster health reaches specific status or better. Supported values are `green`, `yellow`, and `red`. |
There was a problem hiding this comment.
I do like the word status better here. However, instead of "specific", should we try something like, "Wait until the cluster health reaches the specified statues or better?"
|
I went ahead and took over this PR. See #599 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Document missing wait_for_nodes param in Cluster health Reference REST API
Additional improvements:
Issues Resolved
Closes: #552
Check List
Signed-off-by: Lukáš Vlček lukas.vlcek@aiven.io
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.