honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 02:14:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Retitle and relocate cross-cluster search docs (#45608)

Browse Source
This commit is contained in:
James Rodewig 2019-08-15 16:11:04 -04:00
parent ec4182590f
commit a635eca5f8
3 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/index.asciidoc
View File

@ -32,6 +32,8 @@ include::aggregations.asciidoc[]
include::query-dsl.asciidoc[]
include::modules/cross-cluster-search.asciidoc[]
include::scripting.asciidoc[]
include::mapping.asciidoc[]

2
docs/reference/modules.asciidoc
View File

@ -98,5 +98,3 @@ include::modules/threadpool.asciidoc[]
include::modules/transport.asciidoc[]
include::modules/remote-clusters.asciidoc[]
include::modules/cross-cluster-search.asciidoc[]

19
docs/reference/modules/cross-cluster-search.asciidoc
View File

@ -1,5 +1,6 @@
[chapter]
[[modules-cross-cluster-search]]
== {ccs-cap}
= Search across clusters
*{ccs-cap}* lets you run a single search request against one or more
<<modules-remote-clusters,remote clusters>>. For example, you can use a {ccs} to
@ -9,11 +10,11 @@ IMPORTANT: {ccs-cap} requires <<modules-remote-clusters, remote clusters>>.
[float]
[[ccs-example]]
=== {ccs-cap} examples
== {ccs-cap} examples
[float]
[[ccs-remote-cluster-setup]]
==== Remote cluster setup
=== Remote cluster setup
To perform a {ccs}, you must have at least one remote cluster configured.
@ -53,7 +54,7 @@ PUT _cluster/settings
[float]
[[ccs-search-remote-cluster]]
==== Search a single remote cluster
=== Search a single remote cluster
The following <<search,search>> API request searches the
`twitter` index on a single remote cluster, `cluster_one`.
@ -123,7 +124,7 @@ The API returns the following response:
[float]
[[ccs-search-multi-remote-cluster]]
==== Search multiple remote clusters
=== Search multiple remote clusters
The following <<search,search>> API request searches the `twitter` index on
three clusters:
@ -223,7 +224,7 @@ means the document came from the local cluster.
[float]
[[skip-unavailable-clusters]]
=== Skip unavailable clusters
== Skip unavailable clusters
By default, a {ccs} returns an error if *any* cluster in the request is
unavailable.
@ -251,7 +252,7 @@ include matching documents from that cluster in the final results.
[float]
[[ccs-works]]
=== How {ccs} works
== How {ccs} works
Because {ccs} involves sending requests to remote clusters, any network delays
can impact search speed. To avoid slow searches, {ccs} offers two options for
handling network delays:
@ -279,7 +280,7 @@ See <<ccs-unmin-roundtrips>> to learn how this option works.
[float]
[[ccs-min-roundtrips]]
==== Minimize network roundtrips
=== Minimize network roundtrips
Here's how {ccs} works when you minimize network roundtrips.
@ -304,7 +305,7 @@ image:images/ccs/ccs-min-roundtrip-client-response.png[]
[float]
[[ccs-unmin-roundtrips]]
==== Don't minimize network roundtrips
=== Don't minimize network roundtrips
Here's how {ccs} works when you don't minimize network roundtrips.