honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Use same index in Cluster Allocation Explain docs (#50936) 

Updates several example snippets in the Cluster Allocation Explain API
docs to consistently use the `my_index` index.

Previously, the snippets switches from `my_index` to `idx`, which could
confuse users.

Co-authored-by: Emmanuel DEMEY <demey.emmanuel@gmail.com>

Co-authored-by: Emmanuel DEMEY <demey.emmanuel@gmail.com>
This commit is contained in:
James Rodewig 2020-01-16 09:13:31 -05:00
parent fb65ef3f2d
commit 1211772f6a
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/reference/cluster/allocation-explain.asciidoc
View File

@ -103,14 +103,21 @@ GET /_cluster/allocation/explain
===== Examples of unassigned primary shard explanations
//////
[source,console]
--------------------------------------------------
DELETE myindex
--------------------------------------------------
//////
[source,console]
--------------------------------------------------
PUT /idx?master_timeout=1s&timeout=1s
PUT /my_index?master_timeout=1s&timeout=1s
{"settings": {"index.routing.allocation.include._name": "non_existent_node"} }
GET /_cluster/allocation/explain
{
"index": "idx",
"index": "my_index",
"shard": 0,
"primary": true
}
@ -122,7 +129,7 @@ The API returns the following response for an unassigned primary shard:
[source,console-result]
--------------------------------------------------
{
"index" : "idx",
"index" : "my_index",
"shard" : 0,
"primary" : true,
"current_state" : "unassigned", <1>
@ -171,7 +178,7 @@ allocated to a node in the cluster:
[source,js]
--------------------------------------------------
{
"index" : "idx",
"index" : "my_index",
"shard" : 0,
"primary" : true,
"current_state" : "unassigned",
@ -196,7 +203,7 @@ allocation:
[source,js]
--------------------------------------------------
{
"index" : "idx",
"index" : "my_index",
"shard" : 0,
"primary" : false,
"current_state" : "unassigned",
@ -232,7 +239,7 @@ allocation:
{
"decider" : "same_shard",
"decision" : "NO",
"explanation" : "the shard cannot be allocated to the same node on which a copy of the shard already exists [[idx][0], node[3sULLVJrRneSg0EfBB-2Ew], [P], s[STARTED], a[id=eV9P8BN1QPqRc3B4PLx6cg]]"
"explanation" : "the shard cannot be allocated to the same node on which a copy of the shard already exists [[my_index][0], node[3sULLVJrRneSg0EfBB-2Ew], [P], s[STARTED], a[id=eV9P8BN1QPqRc3B4PLx6cg]]"
}
]
}
@ -253,7 +260,7 @@ its current node and is required to move:
[source,js]
--------------------------------------------------
{
"index" : "idx",
"index" : "my_index",
"shard" : 0,
"primary" : true,
"current_state" : "started",
@ -302,7 +309,7 @@ because moving the shard to another node does not form a better cluster balance:
[source,js]
--------------------------------------------------
{
"index" : "idx",
"index" : "my_index",
"shard" : 0,
"primary" : true,
"current_state" : "started",