Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/reference/cluster/allocation-explain.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ node.
====== Maximum number of retries exceeded

The following response contains an allocation explanation for an unassigned
primary shard that has reached the maximum number of allocation retry attempts.
primary shard that has reached the maximum number of allocation retry attempts.

[source,js]
----
Expand Down Expand Up @@ -204,9 +204,10 @@ primary shard that has reached the maximum number of allocation retry attempts.
----
// NOTCONSOLE

If decider message indicates a transient allocation issue, use
<<cluster-reroute,the cluster reroute API>> to retry allocation.
If decider message indicates a transient allocation issue, use
the <<cluster-reroute,cluster reroute>> API to retry allocation.

[[no-valid-shard-copy]]
====== No valid shard copy

The following response contains an allocation explanation for an unassigned
Expand Down Expand Up @@ -334,7 +335,7 @@ queued to allocate but currently waiting on other queued shards.
----
// NOTCONSOLE

This is a transient message that might appear when a large amount of shards are allocating.
This is a transient message that might appear when a large amount of shards are allocating.

===== Assigned shard

Expand Down Expand Up @@ -437,7 +438,7 @@ cluster balance.
===== No arguments

If you call the API with no arguments, {es} retrieves an allocation explanation
for an arbitrary unassigned primary or replica shard, returning any unassigned primary shards first.
for an arbitrary unassigned primary or replica shard, returning any unassigned primary shards first.

[source,console]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public static final class Allocation {
public static final String NO_COPIES = """
Elasticsearch can't allocate this shard because there are no copies of its data in the cluster. Elasticsearch will allocate \
this shard when a node holding a good copy of its data joins the cluster. If no such node is available, restore this index \
from a recent snapshot.""";
from a recent snapshot. For more information, see\s""" + org.elasticsearch.common.ReferenceDocs.ALLOCATION_EXPLAIN_NO_COPIES;

public static final String DELAYED_WITH_ALTERNATIVE = """
The node containing this shard copy recently left the cluster. Elasticsearch is waiting for it to return. If the node does not \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public enum ReferenceDocs {
X_OPAQUE_ID,
FORMING_SINGLE_NODE_CLUSTERS,
CIRCUIT_BREAKER_ERRORS,
ALLOCATION_EXPLAIN_NO_COPIES,
// this comment keeps the ';' on the next line so every entry above has a trailing ',' which makes the diff for adding new links cleaner
;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,5 @@ MAX_SHARDS_PER_NODE size-your-shards
FLOOD_STAGE_WATERMARK fix-watermark-errors.html
X_OPAQUE_ID api-conventions.html#x-opaque-id
FORMING_SINGLE_NODE_CLUSTERS modules-discovery-bootstrap-cluster.html#modules-discovery-bootstrap-cluster-joining
CIRCUIT_BREAKER_ERRORS circuit-breaker-errors.html
CIRCUIT_BREAKER_ERRORS circuit-breaker-errors.html
ALLOCATION_EXPLAIN_NO_COPIES cluster-allocation-explain.html#no-valid-shard-copy