OpenSearch/docs/reference/cluster
Luca Cavanna 29450de7b5
Cross Cluster Search: make remote clusters optional (#27182)
Today Cross Cluster Search requires at least one node in each remote cluster to be up once the cross cluster search is run. Otherwise the whole search request fails despite some of the data (either local and/or remote) is available. This happens when performing the _search/shards calls to find out which remote shards the query has to be executed on. This scenario is different from shard failures that may happen later on when the query is actually executed, in case e.g. remote shards are missing, which is not going to fail the whole request but rather yield partial results, and the _shards section in the response will indicate that.

This commit introduces a boolean setting per cluster called search.remote.$cluster_alias.skip_if_disconnected, set to false by default, which allows to skip certain clusters if they are down when trying to reach them through a cross cluster search requests. By default all clusters are mandatory.

Scroll requests support such setting too when they are first initiated (first search request with scroll parameter), but subsequent scroll rounds (_search/scroll endpoint) will fail if some of the remote clusters went down meanwhile.

The search API response contains now a new _clusters section, similar to the _shards section, that gets returned whenever one or more clusters were disconnected and got skipped:

"_clusters" : {
    "total" : 3,
    "successful" : 2,
    "skipped" : 1
}
Such section won't be part of the response if no clusters have been skipped.

The per cluster skip_unavailable setting value has also been added to the output of the remote/info API.
2017-11-21 11:41:47 +01:00
..
allocation-explain.asciidoc [Docs] Convert remaining code snippets in docs (#26422) 2017-08-30 12:11:10 +02:00
health.asciidoc [TEST] Fix incorrect test cluster name in cluster health doc tests 2017-02-22 17:18:11 -07:00
nodes-hot-threads.asciidoc Core: ignore known idle threads by default in /_nodes/hot_threads 2014-12-17 11:59:31 -05:00
nodes-info.asciidoc [Docs] Convert more doc snippets (#26359) 2017-08-28 11:23:09 +02:00
nodes-stats.asciidoc Add cgroup memory usage/limit to OS stats on Linux (#26166) 2017-10-03 12:08:36 +01:00
nodes-usage.asciidoc Adds nodes usage API to monitor usages of actions (#24169) 2017-06-02 08:46:38 +01:00
pending.asciidoc [Docs] Convert more doc snippets (#26404) 2017-08-30 09:30:36 +02:00
remote-info.asciidoc Cross Cluster Search: make remote clusters optional (#27182) 2017-11-21 11:41:47 +01:00
reroute.asciidoc TCorrecting api name (#24924) 2017-05-29 13:58:31 +02:00
state.asciidoc [Docs] Convert more doc snippets (#26359) 2017-08-28 11:23:09 +02:00
stats.asciidoc [Docs] Convert more doc snippets (#26359) 2017-08-28 11:23:09 +02:00
tasks.asciidoc [Docs] Convert more doc snippets (#26404) 2017-08-30 09:30:36 +02:00
update-settings.asciidoc Docs: Consoleify cluster and indices settings docs (#23030) 2017-02-10 14:57:43 -08:00