Skip to content

Commit a0cd389

Browse files
Add link to NO_COPIES allocation explain message (#113656)
* tweaked no-valid-shard-copies message * untweaked misformatting in allocation explain asciidoc
1 parent 3358071 commit a0cd389

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

docs/reference/cluster/allocation-explain.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ node.
162162
====== Maximum number of retries exceeded
163163

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

167167
[source,js]
168168
----
@@ -204,9 +204,10 @@ primary shard that has reached the maximum number of allocation retry attempts.
204204
----
205205
// NOTCONSOLE
206206

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

210+
[[no-valid-shard-copy]]
210211
====== No valid shard copy
211212

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

337-
This is a transient message that might appear when a large amount of shards are allocating.
338+
This is a transient message that might appear when a large amount of shards are allocating.
338339

339340
===== Assigned shard
340341

@@ -437,7 +438,7 @@ cluster balance.
437438
===== No arguments
438439

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

442443
[source,console]
443444
----

server/src/main/java/org/elasticsearch/cluster/routing/allocation/Explanations.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public static final class Allocation {
3232
public static final String NO_COPIES = """
3333
Elasticsearch can't allocate this shard because there are no copies of its data in the cluster. Elasticsearch will allocate \
3434
this shard when a node holding a good copy of its data joins the cluster. If no such node is available, restore this index \
35-
from a recent snapshot.""";
35+
from a recent snapshot. For more information, see\s""" + org.elasticsearch.common.ReferenceDocs.ALLOCATION_EXPLAIN_NO_COPIES;
3636

3737
public static final String DELAYED_WITH_ALTERNATIVE = """
3838
The node containing this shard copy recently left the cluster. Elasticsearch is waiting for it to return. If the node does not \

server/src/main/java/org/elasticsearch/common/ReferenceDocs.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ public enum ReferenceDocs {
8181
X_OPAQUE_ID,
8282
FORMING_SINGLE_NODE_CLUSTERS,
8383
CIRCUIT_BREAKER_ERRORS,
84+
ALLOCATION_EXPLAIN_NO_COPIES,
8485
// this comment keeps the ';' on the next line so every entry above has a trailing ',' which makes the diff for adding new links cleaner
8586
;
8687

server/src/main/resources/org/elasticsearch/common/reference-docs-links.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ MAX_SHARDS_PER_NODE size-your-shards
4242
FLOOD_STAGE_WATERMARK fix-watermark-errors.html
4343
X_OPAQUE_ID api-conventions.html#x-opaque-id
4444
FORMING_SINGLE_NODE_CLUSTERS modules-discovery-bootstrap-cluster.html#modules-discovery-bootstrap-cluster-joining
45-
CIRCUIT_BREAKER_ERRORS circuit-breaker-errors.html
45+
CIRCUIT_BREAKER_ERRORS circuit-breaker-errors.html
46+
ALLOCATION_EXPLAIN_NO_COPIES cluster-allocation-explain.html#no-valid-shard-copy

0 commit comments

Comments
 (0)