Skip to content

Commit

Permalink
[DOCS] Relocate "Remote Clusters" page (#55172) (#57422)
Browse files Browse the repository at this point in the history
Relocates the "Remote Clusters" documentation from the "Modules" section to the "Set up Elasticsearch" section.

Supporting changes:
* Reorders the "Bootstrap checks for X-Pack" section to immediately follow the "Bootstrap checks"chapter.
* Removes an outdated X-Pack `idef` from the "Remote Clusters" intro.
  • Loading branch information
jrodewig authored Jun 1, 2020
1 parent 8c0e7c8 commit de5de4b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 20 deletions.
7 changes: 0 additions & 7 deletions docs/reference/modules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,6 @@ The modules in this section are:
Configure the transport networking layer, used internally by Elasticsearch
to communicate between nodes.

<<modules-remote-clusters, Remote clusters>>::

Remote clusters are used in features that work by connecting across clusters
on the transport layer.

<<modules-cross-cluster-search, {ccs-cap}>>::

{ccs-cap} enables executing search requests across more than one cluster
Expand All @@ -82,5 +77,3 @@ include::modules/node.asciidoc[]
include::modules/threadpool.asciidoc[]

include::modules/transport.asciidoc[]

include::modules/remote-clusters.asciidoc[]
14 changes: 3 additions & 11 deletions docs/reference/modules/remote-clusters.asciidoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
[[modules-remote-clusters]]
== Remote clusters

ifndef::include-xpack[]
The _remote clusters_ module enables you to establish uni-directional
connections to a remote cluster. This functionality is used in
<<modules-cross-cluster-search,{ccs}>>.
endif::[]
ifdef::include-xpack[]
The _remote clusters_ module enables you to establish uni-directional
connections to a remote cluster. This functionality is used in
<<xpack-ccr,{ccr}>> and
<<modules-cross-cluster-search,{ccs}>>.
endif::[]
The _remote clusters_ functionality enables you to establish unidirectional
connections to a remote cluster. Remote clusters are required for
<<xpack-ccr,{ccr}>> and <<modules-cross-cluster-search,{ccs}>>.

Remote cluster connections work by configuring a remote cluster and connecting
to a limited number of nodes in that remote cluster. There are two modes for
Expand Down
6 changes: 4 additions & 2 deletions docs/reference/setup.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ include::setup/sysconfig.asciidoc[]

include::setup/bootstrap-checks.asciidoc[]

include::setup/bootstrap-checks-xes.asciidoc[]

include::setup/starting.asciidoc[]

include::setup/stopping.asciidoc[]
Expand All @@ -97,10 +99,10 @@ include::setup/add-nodes.asciidoc[]

include::setup/restart-cluster.asciidoc[]

include::modules/remote-clusters.asciidoc[]

include::setup/setup-xes.asciidoc[]

include::setup/setup-xclient.asciidoc[]

include::setup/bootstrap-checks-xes.asciidoc[]

include::modules/plugins.asciidoc[]

0 comments on commit de5de4b

Please sign in to comment.