OpenSearch/docs/reference
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
..
aggregations #26800: Fix docs rendering 2017-11-20 08:41:02 +01:00
analysis Add limits for ngram and shingle settings (#27211) 2017-11-07 08:14:55 -05:00
cat Add docs on full_id parameter in cat nodes API 2017-10-13 13:49:25 -04:00
cluster Cross Cluster Search: make remote clusters optional (#27182) 2017-11-21 11:41:47 +01:00
docs Standardize underscore requirements in parameters (#27414) 2017-11-17 15:31:52 -05:00
how-to Add documentation about disabling `_field_names`. (#26813) 2017-10-06 16:49:15 +02:00
images Docs/windows installer (#27369) 2017-11-15 21:35:54 +11:00
index-modules Logging: Unify log rotation for index/search slow log (#27298) 2017-11-15 10:01:32 +01:00
indices Add ability to split shards (#26931) 2017-11-06 11:37:55 +01:00
ingest add json-processor support for non-map json types (#27335) 2017-11-13 10:28:19 -08:00
mapping [Docs] Restore section about multi-level parent/child relation in parent-join (#27392) 2017-11-16 11:29:16 +01:00
migration Standardize underscore requirements in parameters (#27414) 2017-11-17 15:31:52 -05:00
modules Cross Cluster Search: make remote clusters optional (#27182) 2017-11-21 11:41:47 +01:00
query-dsl Make fields optional in multi_match query and rely on index.query.default_field by default (#27380) 2017-11-17 10:25:21 +01:00
release-notes Migrate migration docs from 6.0 to 7.0 (#26227) 2017-08-16 13:12:44 -06:00
search Fix profiling naming issues (#27133) 2017-11-06 16:37:33 -05:00
setup Remove config prompting for secrets and text (#27216) 2017-11-19 22:33:17 -06:00
testing Docs: Replace deprecated pluginList with Arrays.asList (#24270) 2017-04-24 13:30:37 +02:00
aggregations.asciidoc Update aggregation.asciidoc (#24042) 2017-04-11 09:02:38 -04:00
analysis.asciidoc Add the ability to set an analyzer on keyword fields. (#21919) 2016-12-30 09:36:10 +01:00
api-conventions.asciidoc [Docs] Fix minor paragraph indentation error for multiple Indices params (#25535) 2017-11-06 10:20:20 +01:00
cat.asciidoc Enforce that responses in docs are valid json (#26249) 2017-08-17 09:02:10 -04:00
cluster.asciidoc [docs] include two cluster doc pages missing from index (#25180) 2017-06-12 12:33:56 -07:00
docs.asciidoc Inclusion of link to Multi Delete (#22619) 2017-01-16 12:58:59 +01:00
getting-started.asciidoc Correct usage of "an" to "a" in getting started docs 2017-11-18 07:36:43 -05:00
glossary.asciidoc Remove usage of multi-types from the docs and added a page explaining type removal (#25543) 2017-07-05 12:30:19 +02:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-modules.asciidoc Add limits for ngram and shingle settings (#27211) 2017-11-07 08:14:55 -05:00
index-shared1.asciidoc [DOCS] Split index-shared.asciidoc into multiple smaller files (#25302) 2017-06-19 15:14:53 -07:00
index-shared2.asciidoc [DOCS] Added index-shared4 and index-shared5.asciidoc 2017-09-20 10:54:26 -07:00
index-shared3.asciidoc [DOCS] Added index-shared4 and index-shared5.asciidoc 2017-09-20 10:54:26 -07:00
index-shared4.asciidoc [DOCS] Added index-shared4 and index-shared5.asciidoc 2017-09-20 10:54:26 -07:00
index-shared5.asciidoc [DOCS] Added index-shared4 and index-shared5.asciidoc 2017-09-20 10:54:26 -07:00
index.asciidoc [DOCS] Added index-shared4 and index-shared5.asciidoc 2017-09-20 10:54:26 -07:00
indices.asciidoc add split index reference in indices.asciidoc 2017-11-06 12:55:41 +01:00
ingest.asciidoc [Docs] Update ingest.asciidoc (#26599) 2017-09-15 11:15:31 +02:00
mapping.asciidoc Remove the _all metadata field (#26356) 2017-08-28 17:43:59 +02:00
modules.asciidoc [DOCS] Remove edit link from ML node 2017-09-14 16:18:29 -07:00
query-dsl.asciidoc
redirects.asciidoc Mark filtered query example as not to be used (#25661) 2017-07-14 11:45:21 +02:00
release-notes.asciidoc Migrate migration docs from 6.0 to 7.0 (#26227) 2017-08-16 13:12:44 -06:00
search.asciidoc Enable adaptive replica selection by default (#26522) 2017-09-07 09:25:05 -06:00
setup.asciidoc Reorganised setup docs into better order 2017-07-21 11:24:46 +02:00
testing.asciidoc