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

[DOCS] Collapse nested objects in cluster reroute docs (#54851)

This commit is contained in:
Vishal Patel 2020-04-09 14:56:37 -04:00 committed by James Rodewig
parent 12f056b833
commit 51cb0c5c7b
1 changed files with 30 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/reference/cluster/reroute.asciidoc
View File

@ -12,7 +12,6 @@ Changes the allocation of shards in a cluster.
`POST /_cluster/reroute` `POST /_cluster/reroute`
[[cluster-reroute-api-desc]] [[cluster-reroute-api-desc]]
==== {api-description-title} ==== {api-description-title}
@ -55,6 +54,7 @@ query parameter, which will attempt a single retry round for these shards.
[[cluster-reroute-api-query-params]] [[cluster-reroute-api-query-params]]
[role="child_attributes"]
==== {api-query-parms-title} ==== {api-query-parms-title}
`dry_run`:: `dry_run`::
@ -70,7 +70,9 @@ query parameter, which will attempt a single retry round for these shards.
Defaults to all but metadata The following options are available: Defaults to all but metadata The following options are available:
+ +
-- .Options for `metric`
[%collapsible%open]
======
`_all`:: `_all`::
Shows all metrics. Shows all metrics.
@ -93,7 +95,8 @@ query parameter, which will attempt a single retry round for these shards.
`version`:: `version`::
Shows the cluster state version. Shows the cluster state version.
-- ======
`retry_failed`:: `retry_failed`::
(Optional, boolean) If `true`, then retries allocation of shards that are (Optional, boolean) If `true`, then retries allocation of shards that are
@ -101,15 +104,18 @@ query parameter, which will attempt a single retry round for these shards.
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[cluster-reroute-api-request-body]] [[cluster-reroute-api-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`commands`:: `commands`::
(Required, object) Defines the commands to perform. Supported commands are: (Required, array of objects) Defines the commands to perform. Supported commands are:
+ +
-- .Properties of `commands`
[%collapsible%open]
======
`move`:: `move`::
Move a started shard from one node to another node. Accepts `index` and Move a started shard from one node to another node. Accepts `index` and
`shard` for index name and shard number, `from_node` for the node to move `shard` for index name and shard number, `from_node` for the node to move
@ -129,7 +135,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
Allocate an unassigned replica shard to a node. Accepts `index` and `shard` Allocate an unassigned replica shard to a node. Accepts `index` and `shard`
for index name and shard number, and `node` to allocate the shard to. Takes for index name and shard number, and `node` to allocate the shard to. Takes
<<modules-cluster,allocation deciders>> into account. <<modules-cluster,allocation deciders>> into account.
--
Two more commands are available that allow the allocation of a primary shard to Two more commands are available that allow the allocation of a primary shard to
a node. These commands should however be used with extreme care, as primary a node. These commands should however be used with extreme care, as primary
@ -169,7 +174,7 @@ will be deleted or overwritten.
data rejoins the cluster later on, that data will be deleted. To ensure data rejoins the cluster later on, that data will be deleted. To ensure
that these implications are well-understood, this command requires the flag that these implications are well-understood, this command requires the flag
`accept_data_loss` to be explicitly set to `true`. `accept_data_loss` to be explicitly set to `true`.
======
[[cluster-reroute-api-example]] [[cluster-reroute-api-example]]
==== {api-examples-title} ==== {api-examples-title}