-
Notifications
You must be signed in to change notification settings - Fork 500
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing wait_for_nodes param in Cluster health Reference REST API #553
Closed
lukas-vlcek
wants to merge
2
commits into
opensearch-project:main
from
lukas-vlcek:improve_cluster_health
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,13 +39,14 @@ Parameter | Type | Description | |
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. 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`. | ||
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false. | ||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds. | ||
cluster_manager_timeout<br>(deprecated `master_timeout`) | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. | ||
timeout | Time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds. | ||
wait_for_active_shards | String | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`. | ||
wait_for_nodes | String | Wait for N number of nodes. Use `12` for exact match, `>12` and `<12` for range. | ||
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`. | ||
|
||
<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and > | ||
# Not working properly when tested --> | ||
|
@@ -59,6 +60,7 @@ wait_for_status | Enum | Wait until the cluster is in a specific state or better | |
"timed_out" : false, | ||
"number_of_nodes" : 2, | ||
"number_of_data_nodes" : 2, | ||
"discovered_master" : true, | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"active_primary_shards" : 6, | ||
"active_shards" : 12, | ||
"relocating_shards" : 0, | ||
|
@@ -71,3 +73,9 @@ wait_for_status | Enum | Wait until the cluster is in a specific state or better | |
"active_shards_percent_as_number" : 100.0 | ||
} | ||
``` | ||
|
||
## Required permissions | ||
|
||
If you use the security plugin, make sure you have the appropriate permissions: | ||
`cluster:monitor/health` | ||
{: .note } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's remove the |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?"