mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
[DOCS] Create top-level "Search your data" page (#56058)
* [DOCS] Create top-level "Search your data" page **Goal** Create a top-level search section. This will let us clean up our search API reference docs, particularly content from [`Request body search`][0]. **Changes** * Creates a top-level `Search your data` page. This page is designed to house concept and tutorial docs related to search. * Creates a `Run a search` page under `Search your data`. For now, This contains a basic search tutorial. The goal is to add content from [`Request body search`][0] to this in the future. * Relocates `Long-running searches` and `Search across clusters` under `Search your data`. Increments several headings in that content. * Reorders the top-level TOC to move `Search your data` higher. Also moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately after. Relates to #48194 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
This commit is contained in:
parent
e3e1e3ee89
commit
a73fef3d62
5 changed files with 345 additions and 20 deletions
|
@ -1,6 +1,5 @@
|
|||
[chapter]
|
||||
[[modules-cross-cluster-search]]
|
||||
= Search across clusters
|
||||
== 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
|
||||
|
@ -10,7 +9,7 @@ IMPORTANT: {ccs-cap} requires <<modules-remote-clusters, remote clusters>>.
|
|||
|
||||
[float]
|
||||
[[ccs-supported-apis]]
|
||||
== Supported APIs
|
||||
=== Supported APIs
|
||||
|
||||
The following APIs support {ccs}:
|
||||
|
||||
|
@ -21,11 +20,11 @@ The following APIs support {ccs}:
|
|||
|
||||
[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.
|
||||
|
||||
|
@ -64,7 +63,7 @@ PUT _cluster/settings
|
|||
|
||||
[float]
|
||||
[[ccs-search-remote-cluster]]
|
||||
=== Search a single remote cluster
|
||||
==== Search a single remote cluster
|
||||
|
||||
The following <<search-search,search>> API request searches the
|
||||
`twitter` index on a single remote cluster, `cluster_one`.
|
||||
|
@ -132,7 +131,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:
|
||||
|
@ -228,7 +227,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.
|
||||
|
@ -255,7 +254,7 @@ include matching documents from that cluster in the final results.
|
|||
|
||||
[discrete]
|
||||
[[ccs-gateway-seed-nodes]]
|
||||
== Selecting gateway and seed nodes in sniff mode
|
||||
=== Selecting gateway and seed nodes in sniff mode
|
||||
|
||||
For remote clusters using the <<sniff-mode,sniff connection>> mode, gateway and
|
||||
seed nodes need to be accessible from the local cluster via your network.
|
||||
|
@ -270,7 +269,7 @@ wanted, the seed nodes for a cluster can be a subset of these gateway nodes.
|
|||
|
||||
[discrete]
|
||||
[[ccs-proxy-mode]]
|
||||
== {ccs} in proxy mode
|
||||
=== {ccs} in proxy mode
|
||||
|
||||
<<proxy-mode,Proxy mode>> remote cluster connections support {ccs}. All remote
|
||||
connections connect to the configured `proxy_address`. Any desired connection
|
||||
|
@ -279,7 +278,7 @@ be implemented by the intermediate proxy at this configured address.
|
|||
|
||||
[discrete]
|
||||
[[ccs-network-delays]]
|
||||
== How {ccs} handles network delays
|
||||
=== How {ccs} handles network delays
|
||||
|
||||
Because {ccs} involves sending requests to remote clusters, any network delays
|
||||
can impact search speed. To avoid slow searches, {ccs} offers two options for
|
||||
|
@ -305,7 +304,7 @@ See <<ccs-unmin-roundtrips>> to learn how this option works.
|
|||
|
||||
[discrete]
|
||||
[[ccs-min-roundtrips]]
|
||||
=== Minimize network roundtrips
|
||||
==== Minimize network roundtrips
|
||||
|
||||
Here's how {ccs} works when you minimize network roundtrips.
|
||||
|
||||
|
@ -331,7 +330,7 @@ image:images/ccs/ccs-min-roundtrip-client-response.svg[]
|
|||
|
||||
[discrete]
|
||||
[[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.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue