elasticsearch/docs/reference/cluster
David Turner 02f38e3da9
Make allocation explanations more actionable (#83983)
The cluster allocation explain API includes a top-level status
indicating to the user whether the shard can be assigned/rebalanced/etc
or not. Today this status is fairly terse and experience shows that
users sometimes struggle to understand how to interpret it and to decide
on follow-up actions.

This commit makes the top-level explanation more detailed and
actionable. For instance, in the cases like `THROTTLED` where the status
is transient we instruct the user to wait; if a shard is lost we say to
restore it from a snapshot; if a shard cannot be assigned we say to
choose a specific node where its assignment is expected and to address
the obstacles.

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2022-02-22 09:23:01 +00:00
..
allocation-explain.asciidoc Make allocation explanations more actionable (#83983) 2022-02-22 09:23:01 +00:00
delete-desired-nodes.asciidoc Fix documentation snippet tests 2022-02-02 13:29:02 -08:00
get-desired-nodes.asciidoc Fix documentation snippet tests 2022-02-02 13:29:02 -08:00
get-settings.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
health.asciidoc Revert "Return 200 OK response code for a cluster health timeout (#78968)" (#80821) 2021-11-18 19:55:16 +01:00
nodes-hot-threads.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
nodes-info.asciidoc Add tests/fix docs for nodes info API (#79223) 2021-10-15 15:57:52 +01:00
nodes-reload-secure-settings.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
nodes-stats.asciidoc [docs] clarify purged http stats (#82123) 2022-01-04 09:51:41 -06:00
nodes-usage.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
pending.asciidoc Adding priority list and executing description to the pending tasks doc (#74456) (#78259) 2021-09-23 11:17:18 -04:00
remote-info.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
reroute.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
state.asciidoc Clarify cluster state API docs (#82930) 2022-01-24 10:09:45 -05:00
stats.asciidoc [DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
tasks.asciidoc Identify cancelled tasks in list tasks API (#72931) 2021-05-17 11:02:50 +01:00
update-desired-nodes.asciidoc Fix documentation snippet tests 2022-02-02 13:29:02 -08:00
update-settings.asciidoc [DOCS] Re-add cluster settings precedence (#82738) 2022-01-18 12:32:43 -05:00
voting-exclusions.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00