OpenSearch/docs/reference
Lee Hinman e53a43800e Add `explain` flag support to the reroute API
By specifying the `explain` flag, an explanation for the reason a
command can or cannot be executed is returned. No allocation commands
are actually performed.

Returns a response similar to:

{
  "state": {...cluster state...},
  "acknowledged": true,
  "explanations" : [ {
    "command" : "cancel",
      "parameters" : {
        "index" : "decide",
        "shard" : 0,
        "node" : "IvpoKRdtRiGrQ_WKtt4_4w",
        "allow_primary" : false
      },
      "decisions" : [ {
        "decider" : "cancel_allocation_command",
        "decision" : "YES",
        "explanation" : "..."
        } ]
     }, {
      "command" : "move",
      "parameters" : {
        "index" : "decide",
        "shard" : 0,
        "from_node" : "IvpoKRdtRiGrQ_WKtt4_4w",
        "to_node" : "IvpoKRdtRiGrQ_WKtt4_4w"
       },
       "decisions" : [ {
         "decider" : "same_shard",
         "decision" : "NO",
         "explanation" : "shard cannot be allocated on same node [IvpoKRdtRiGrQ_WKtt4_4w] it already exists on"
       },
       etc
       ]
  }]
}

also removes AllocationExplanation from cluster state

Closes #2483
Closes #5169
2014-02-27 09:48:51 -07:00
..
analysis Expose `filler_token` via ShingleTokenFilterFactory 2014-02-26 22:21:10 +01:00
cat [TEST] fixed typo in _cat/thread_pool docs 2014-02-10 16:20:03 +01:00
cluster Add `explain` flag support to the reroute API 2014-02-27 09:48:51 -07:00
docs [DOCS] improved get docs 2014-02-14 13:11:10 +01:00
images add docs on new service.bat facility 2013-09-23 18:24:31 +03:00
index-modules Fix typo in similarity docs 2014-02-13 07:45:30 -08:00
indices [DOCS] Added note about dely in clearing filter cache. 2014-02-24 11:36:22 +01:00
mapping fixed markup and typo 2014-02-13 10:33:15 +01:00
migration [DOCS] Included the `_percolator` index breaking change to migration docs. 2014-02-20 16:43:06 +01:00
modules [DOCS] add DynamoDB river plugin 2014-02-13 10:38:04 +01:00
query-dsl [DOCS] Updated memory considerations for p/c queries and filters. 2014-02-26 22:16:51 +01:00
search Fixed multi term queries support in postings highlighter for non top-level queries 2014-02-21 21:43:40 +01:00
setup [DOCS] Fix wrong explanation in configuration.asciidoc 2014-02-24 11:29:50 +01:00
testing [DOCS]: fixed added / coming tags in docs 2014-01-22 12:02:37 +01:00
analysis.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
api-conventions.asciidoc Added the `DistanceUnit.NAUTICALMILES` enumeration 2014-02-14 19:48:58 +09:00
cat.asciidoc Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) 2014-01-29 13:25:06 +01:00
cluster.asciidoc [DOCS] Fix HTTP endpoints after stats API changes 2014-01-09 11:30:28 +01:00
docs.asciidoc [DOCS] Moved termvector and mtermvectors from search to docs 2014-01-22 14:10:26 +01:00
glossary.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
index-modules.asciidoc Removed 0.90.* deprecation and addition notifications 2014-02-07 20:52:49 +01:00
index.asciidoc [DOCS] Added breaking changes in 1.0 2014-01-15 17:50:24 +01:00
indices.asciidoc Add a GetFieldMapping API 2013-10-30 16:16:36 +01:00
mapping.asciidoc [DOCS] Moved multi fields documentation into the core-types page 2014-01-22 10:05:58 +01:00
modules.asciidoc [DOCS] Fixed link to tribe.asciidoc 2014-01-13 22:01:12 +01:00
query-dsl.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
search.asciidoc [DOCS] Moved termvector and mtermvectors from search to docs 2014-01-22 14:10:26 +01:00
setup.asciidoc [DOCS] Make apt/yum repos more visible 2014-02-06 17:04:37 +01:00
testing.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00