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

[DOCS] Edits the remote clusters documentation (#38996)

Browse Source
This commit is contained in:
Lisa Cawley 2019-02-19 11:53:35 -08:00 committed by lcawl
parent f1c8aa816f
commit d74e25a778
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/reference/modules/remote-clusters.asciidoc
View File

@ -2,25 +2,25 @@
== Remote clusters == Remote clusters
ifndef::include-xpack[] ifndef::include-xpack[]
The _remote clusters_ module allows establishing uni-directional connections to The _remote clusters_ module enables you to establish uni-directional
a remote cluster. This functionality is used in connections to a remote cluster. This functionality is used in
<<modules-cross-cluster-search,cross-cluster search>>. <<modules-cross-cluster-search,cross-cluster search>>.
endif::[] endif::[]
ifdef::include-xpack[] ifdef::include-xpack[]
The _remote clusters_ module allows establishing uni-directional connections to The _remote clusters_ module enables you to establish uni-directional
a remote cluster. This functionality is used in cross-cluster replication, and connections to a remote cluster. This functionality is used in
{stack-ov}/xpack-ccr.html[cross-cluster replication] and
<<modules-cross-cluster-search,cross-cluster search>>. <<modules-cross-cluster-search,cross-cluster search>>.
endif::[] endif::[]
Remote cluster connections work by configuring a remote cluster and connecting Remote cluster connections work by configuring a remote cluster and connecting
only to a limited number of nodes in the remote cluster. Each remote cluster is only to a limited number of nodes in the remote cluster. Each remote cluster is
referenced by a name and a list of seed nodes. When a remote cluster is referenced by a name and a list of seed nodes. When a remote cluster is
registered, its cluster state is retrieved from one of the seed nodes so that by registered, its cluster state is retrieved from one of the seed nodes so that by
default up to three _gateway nodes_ are selected to be connected to as part of default up to three _gateway nodes_ are selected to be connected to as part of
remote cluster requests. Remote cluster connections consist of uni-directional remote cluster requests. Remote cluster connections consist of uni-directional
connections from the coordinating node to the previously selected remote nodes connections from the coordinating node to the previously selected remote nodes
only. It is possible to tag which nodes should be selected through node only. You can tag which nodes should be selected by using node attributes (see <<remote-cluster-settings>>).
attributes (see <<remote-cluster-settings>>).
Each node in a cluster that has remote clusters configured connects to one or Each node in a cluster that has remote clusters configured connects to one or
more _gateway nodes_ and uses them to federate requests to the remote cluster. more _gateway nodes_ and uses them to federate requests to the remote cluster.
@ -173,6 +173,6 @@ PUT _cluster/settings
[[retrieve-remote-clusters-info]] [[retrieve-remote-clusters-info]]
=== Retrieving remote clusters info === Retrieving remote clusters info
The <<cluster-remote-info, Remote Cluster Info API>> allows to retrieve You can use the <<cluster-remote-info, remote cluster info API>> to retrieve
information about the configured remote clusters, as well as the remote nodes information about the configured remote clusters, as well as the remote nodes
that the node is connected to. that the node is connected to.