Skip to content

Commit 2bd7a89

Browse files
authored
[DOCS] Updates remote cluster and ccr docs (#63517) (#63763)
* [DOCS] Updates remote cluster and ccr docs * [DOCS] Adds section on managing clusters and follower indices * [DOCS] Incorporates review comments
1 parent eb56bfe commit 2bd7a89

File tree

8 files changed

+100
-52
lines changed

8 files changed

+100
-52
lines changed

docs/images/add_remote_cluster.png

97.1 KB
Loading
84 KB
Loading
114 KB
Loading

docs/images/follower_indices.png

100644100755
28.3 KB
Loading
94.4 KB
Loading
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
[role="xpack"]
2+
[[managing-cross-cluster-replication]]
3+
== Cross-Cluster Replication
4+
5+
Use *Cross-Cluster Replication* to reproduce indices in
6+
remote clusters on a local cluster. {ref}/xpack-ccr.html[Cross-cluster replication]
7+
is commonly used to provide remote backups for disaster recovery and for
8+
geo-proximite copies of data.
9+
10+
To get started, go to *Management > Cross-Cluster Replication*.
11+
12+
[role="screenshot"]
13+
image::images/cross-cluster-replication-list-view.png[][Cross-cluster replication list view]
14+
15+
[float]
16+
=== Prerequisites
17+
18+
* You must have a {ref}/modules-remote-clusters.html[remote cluster].
19+
* Leader indices must meet {ref}/ccr-requirements.html[these requirements].
20+
* The Elasticsearch version of the local cluster must be the same as or newer than the remote cluster.
21+
Refer to {ref}/ccr-overview.html[this document] for more information.
22+
23+
[float]
24+
[[configure-replication]]
25+
=== Configure replication
26+
27+
Replication requires a leader index, the index being replicated, and a
28+
follower index, which will contain the leader index's replicated data.
29+
The follower index is passive in that it can read requests and searches,
30+
but cannot accept direct writes. Only the leader index is active for direct writes.
31+
32+
You can configure follower indices in two ways:
33+
34+
* Create specific follower indices
35+
* Create follower indices from an auto-follow pattern
36+
37+
[float]
38+
==== Create specific follower indices
39+
40+
To replicate data from existing indices, or set up local followers on a case-by-case basis,
41+
go to *Follower indices*. When you create the follower index, you must reference the
42+
remote cluster and the leader index that you created in the remote cluster.
43+
44+
[role="screenshot"]
45+
image::images/follower_indices.png[][UI for adding follower indices]
46+
47+
[float]
48+
==== Create follower indices from an auto-follow pattern
49+
50+
To automatically detect and follow new indices when they are created on a remote cluster,
51+
go to *Auto-follow patterns*. Creating an auto-follow pattern is useful when you have
52+
time series data, like event logs, on the remote cluster that is created or rolled over on a daily basis.
53+
54+
When creating the pattern, you must reference the remote cluster that you
55+
connected to your local cluster. You must also specify a collection of index patterns
56+
that match the indices you want to automatically follow.
57+
58+
Once you configure an
59+
auto-follow pattern, any time a new index with a name that matches the pattern is
60+
created in the remote cluster, a follower index is automatically configured in the local cluster.
61+
62+
[role="screenshot"]
63+
image::images/auto_follow_pattern.png[UI for adding an auto-follow pattern]
64+
65+
[float]
66+
[[manage-replication]]
67+
=== Manage replication
68+
69+
Use the list views in *Cross-Cluster Replication* to monitor whether the replication is active and
70+
pause and resume replication. You can also edit and remove the follower indices and auto-follow patterns.
71+
72+
For an example of cross-cluster replication,
73+
refer to https://www.elastic.co/blog/bi-directional-replication-with-elasticsearch-cross-cluster-replication-ccr[Bi-directional replication with Elasticsearch cross-cluster replication].
Lines changed: 22 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,39 @@
11
[[working-remote-clusters]]
22
== Remote Clusters
33

4-
{kib} *Management* provides user interfaces for working with data from remote
5-
clusters and managing the {ccr} process. You can replicate indices from a
6-
leader remote cluster to a follower index in a local cluster. The local follower indices
7-
can be used to provide remote backups for disaster recovery or for geo-proximite copies of data.
4+
Use *Remote Clusters* to establish a unidirectional
5+
connection from your cluster to other clusters. This functionality is
6+
required for {ref}/xpack-ccr.html[cross-cluster replication] and
7+
{ref}/modules-cross-cluster-search.html[cross-cluster search].
88

9-
Before using these features, you should be familiar with the following concepts:
9+
To get started, go to *Management > Remote Clusters*.
1010

11-
* {ref}/xpack-ccr.html[{ccr-cap}]
12-
* {ref}/modules-cross-cluster-search.html[{ccs-cap}]
13-
* {ref}/cross-cluster-configuring.html[Cross-cluster security requirements]
11+
[role="screenshot"]
12+
image::images/remote-clusters-list-view.png[Remote Clusters list view, including Add a remote cluster button]
1413

1514
[float]
1615
[[managing-remote-clusters]]
17-
== Managing remote clusters
18-
19-
*Remote clusters* helps you manage remote clusters for use with
20-
{ccs} and {ccr}. You can add and remove remote clusters and check their connectivity.
16+
=== Add a remote cluster
2117

22-
Before you use this feature, you should be familiar with the concept of
23-
{ref}/modules-remote-clusters.html[remote clusters].
18+
A {ref}/modules-remote-clusters.html[remote cluster] connection works by configuring a remote cluster and
19+
connecting to a limited number of nodes, called {ref}/modules-remote-clusters.html#sniff-mode[seed nodes],
20+
in that cluster.
21+
Alternatively, you can define a single proxy address for the remote cluster.
2422

25-
Go to *Management > Elasticsearch > Remote clusters* to create or manage your remotes.
23+
By default, a cross-cluster request, such as a cross-cluster search or
24+
replication request, fails if any cluster in the request is unavailable.
25+
To skip a cluster when its unavailable,
26+
set *Skip if unavailable* to true.
2627

27-
To set up a new remote, click *Add a remote cluster*. Give the cluster a unique name
28-
and define the seed nodes for cluster discovery. You can edit or remove your remote clusters
29-
from the *Remote clusters* list view.
28+
Once you add a remote cluster, you can configure <<managing-cross-cluster-replication, cross-cluster replication>>
29+
to reproduce indices in the remote cluster on a local cluster.
3030

3131
[role="screenshot"]
3232
image::images/add_remote_cluster.png[][UI for adding a remote cluster]
3333

34-
Once a remote cluster is registered, you can use the tools under *{ccr-cap}*
35-
to add and manage follower indices on the local cluster, and replicate data from
36-
indices on the remote cluster based on an auto-follow index pattern.
37-
3834
[float]
39-
[[managing-cross-cluster-replication]]
40-
== [xpack]#Managing {ccr}#
41-
42-
*{ccr-cap}* helps you create and manage the {ccr} process.
43-
If you want to replicate data from existing indices, or set up
44-
local followers on a case-by-case basis, go to *Follower indices*.
45-
If you want to automatically detect and follow new indices when they are created
46-
on a remote cluster, you can do so from *Auto-follow patterns*.
47-
48-
Creating an auto-follow pattern is useful when you have time-series data, like a logs index, on the
49-
remote cluster that is created or rolled over on a daily basis. Once you have configured an
50-
auto-follow pattern, any time a new index with a name that matches the pattern is
51-
created in the remote cluster, a follower index is automatically configured in the local cluster.
52-
53-
From the same view, you can also see a list of your saved auto-follow patterns for
54-
a given remote cluster, and monitor whether the replication is active.
35+
[[manage-remote-clusters]]
36+
=== Manage remote clusters
5537

56-
Before you use these features, you should be familiar with the following concepts:
57-
58-
* {ref}/ccr-requirements.html[Requirements for leader indices]
59-
* {ref}/ccr-auto-follow.html[Automatically following indices]
60-
61-
To get started, go to *Management > Elasticsearch > {ccr-cap}*.
62-
63-
[role="screenshot"]
64-
image::images/auto_follow_pattern.png[][UI for adding an auto-follow pattern]
65-
66-
[role="screenshot"]
67-
image::images/follower_indices.png[][UI for adding follower indices]
38+
From the *Remote Clusters* list view, you can drill down into each cluster and
39+
view its status. You can also edit and delete a cluster.

docs/user/management.asciidoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ indices, clusters, licenses, UI settings, index patterns, spaces, and more.
1313
[cols="50, 50"]
1414
|===
1515

16-
a| <<working-remote-clusters, *Cross-Cluster Replication*>>
16+
a| <<managing-cross-cluster-replication, *Cross-Cluster Replication*>>
1717

1818
Replicate indices on a remote cluster and copy them to a follower index on a local cluster.
1919
This is important for
@@ -85,7 +85,8 @@ set the timespan for notification messages, and much more.
8585

8686
| <<managing-alerts-and-actions, *Alerts and Actions*>>
8787

88-
Centrally manage your alerts from across {kib}. Create and manage re-usable connectors for triggering actions.
88+
Centrally manage your alerts across {kib}. Create and manage reusable
89+
connectors for triggering actions.
8990

9091
| <<managing-fields, *Index Patterns*>>
9192

@@ -125,6 +126,8 @@ include::{kib-repo-dir}/management/alerting/connector-management.asciidoc[]
125126

126127
include::{kib-repo-dir}/management/managing-beats.asciidoc[]
127128

129+
include::{kib-repo-dir}/management/managing-ccr.asciidoc[]
130+
128131
include::{kib-repo-dir}/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc[]
129132

130133
include::{kib-repo-dir}/management/index-lifecycle-policies/create-policy.asciidoc[]

0 commit comments

Comments
 (0)