Skip to content

Commit

Permalink
[DOCS] Updates remote cluster and ccr docs (#63517) (#63763)
Browse files Browse the repository at this point in the history
* [DOCS] Updates remote cluster and ccr docs

* [DOCS] Adds section on managing clusters and follower indices

* [DOCS] Incorporates review comments
  • Loading branch information
gchaps authored Apr 16, 2020
1 parent eb56bfe commit 2bd7a89
Show file tree
Hide file tree
Showing 8 changed files with 100 additions and 52 deletions.
Binary file modified docs/images/add_remote_cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/auto_follow_pattern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/follower_indices.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/remote-clusters-list-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions docs/management/managing-ccr.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
[role="xpack"]
[[managing-cross-cluster-replication]]
== Cross-Cluster Replication

Use *Cross-Cluster Replication* to reproduce indices in
remote clusters on a local cluster. {ref}/xpack-ccr.html[Cross-cluster replication]
is commonly used to provide remote backups for disaster recovery and for
geo-proximite copies of data.

To get started, go to *Management > Cross-Cluster Replication*.

[role="screenshot"]
image::images/cross-cluster-replication-list-view.png[][Cross-cluster replication list view]

[float]
=== Prerequisites

* You must have a {ref}/modules-remote-clusters.html[remote cluster].
* Leader indices must meet {ref}/ccr-requirements.html[these requirements].
* The Elasticsearch version of the local cluster must be the same as or newer than the remote cluster.
Refer to {ref}/ccr-overview.html[this document] for more information.

[float]
[[configure-replication]]
=== Configure replication

Replication requires a leader index, the index being replicated, and a
follower index, which will contain the leader index's replicated data.
The follower index is passive in that it can read requests and searches,
but cannot accept direct writes. Only the leader index is active for direct writes.

You can configure follower indices in two ways:

* Create specific follower indices
* Create follower indices from an auto-follow pattern

[float]
==== Create specific follower indices

To replicate data from existing indices, or set up local followers on a case-by-case basis,
go to *Follower indices*. When you create the follower index, you must reference the
remote cluster and the leader index that you created in the remote cluster.

[role="screenshot"]
image::images/follower_indices.png[][UI for adding follower indices]

[float]
==== Create follower indices from an auto-follow pattern

To automatically detect and follow new indices when they are created on a remote cluster,
go to *Auto-follow patterns*. Creating an auto-follow pattern is useful when you have
time series data, like event logs, on the remote cluster that is created or rolled over on a daily basis.

When creating the pattern, you must reference the remote cluster that you
connected to your local cluster. You must also specify a collection of index patterns
that match the indices you want to automatically follow.

Once you configure an
auto-follow pattern, any time a new index with a name that matches the pattern is
created in the remote cluster, a follower index is automatically configured in the local cluster.

[role="screenshot"]
image::images/auto_follow_pattern.png[UI for adding an auto-follow pattern]

[float]
[[manage-replication]]
=== Manage replication

Use the list views in *Cross-Cluster Replication* to monitor whether the replication is active and
pause and resume replication. You can also edit and remove the follower indices and auto-follow patterns.

For an example of cross-cluster replication,
refer to https://www.elastic.co/blog/bi-directional-replication-with-elasticsearch-cross-cluster-replication-ccr[Bi-directional replication with Elasticsearch cross-cluster replication].
72 changes: 22 additions & 50 deletions docs/management/managing-remote-clusters.asciidoc
Original file line number Diff line number Diff line change
@@ -1,67 +1,39 @@
[[working-remote-clusters]]
== Remote Clusters

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

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

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

[float]
[[managing-remote-clusters]]
== Managing remote clusters

*Remote clusters* helps you manage remote clusters for use with
{ccs} and {ccr}. You can add and remove remote clusters and check their connectivity.
=== Add a remote cluster

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

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

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

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

Once a remote cluster is registered, you can use the tools under *{ccr-cap}*
to add and manage follower indices on the local cluster, and replicate data from
indices on the remote cluster based on an auto-follow index pattern.

[float]
[[managing-cross-cluster-replication]]
== [xpack]#Managing {ccr}#

*{ccr-cap}* helps you create and manage the {ccr} process.
If you want to replicate data from existing indices, or set up
local followers on a case-by-case basis, go to *Follower indices*.
If you want to automatically detect and follow new indices when they are created
on a remote cluster, you can do so from *Auto-follow patterns*.

Creating an auto-follow pattern is useful when you have time-series data, like a logs index, on the
remote cluster that is created or rolled over on a daily basis. Once you have configured an
auto-follow pattern, any time a new index with a name that matches the pattern is
created in the remote cluster, a follower index is automatically configured in the local cluster.

From the same view, you can also see a list of your saved auto-follow patterns for
a given remote cluster, and monitor whether the replication is active.
[[manage-remote-clusters]]
=== Manage remote clusters

Before you use these features, you should be familiar with the following concepts:

* {ref}/ccr-requirements.html[Requirements for leader indices]
* {ref}/ccr-auto-follow.html[Automatically following indices]

To get started, go to *Management > Elasticsearch > {ccr-cap}*.

[role="screenshot"]
image::images/auto_follow_pattern.png[][UI for adding an auto-follow pattern]

[role="screenshot"]
image::images/follower_indices.png[][UI for adding follower indices]
From the *Remote Clusters* list view, you can drill down into each cluster and
view its status. You can also edit and delete a cluster.
7 changes: 5 additions & 2 deletions docs/user/management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ indices, clusters, licenses, UI settings, index patterns, spaces, and more.
[cols="50, 50"]
|===

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

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

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

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

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

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

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

include::{kib-repo-dir}/management/managing-ccr.asciidoc[]

include::{kib-repo-dir}/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc[]

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

0 comments on commit 2bd7a89

Please sign in to comment.