github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Docs]Adds docs for Follower indices UI (#31928)

Browse source
This commit is contained in:
Sarah Hersh 2019-02-27 10:43:04 -05:00 • committed by Sarah Hersh
parent 38d1cf3a05
commit a5d0e82581
2 changed files with 55 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/images/follower_indices.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 182 KiB

68
docs/management/managing-remote-clusters.asciidoc
View file

@ -1,26 +1,68 @@
[[working-remote-clusters]]
== Working with remote clusters
{kib} *Management* provides user interfaces for working with data from remote
clusters and managing the cross cluster replication 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.
Before using these features, you should be familiar with the following concepts:
* {xpack-ref}/xpack-ccr.html[Cross cluster replication]
* {ref}/modules-cross-cluster-search.html[Cross cluster search]
* {xpack-ref}/cross-cluster-configuring.html[Cross cluster security requirements]
[float]
[[managing-remote-clusters]]
== Managing Remote Clusters
== Managing remote clusters
{kib} *Management* provides two user interfaces for working with data from remote
clusters.
*Remote Clusters* helps you manage remote clusters for use with
{ref}/modules-cross-cluster-search.html[cross cluster search] and
{xpack-ref}/xpack-ccr.html[cross cluster replication]. You can add and remove remote
*Remote clusters* helps you manage remote clusters for use with
cross cluster search and cross cluster replication. You can add and remove remote
clusters and check their connectivity.
Go to *Management > Elasticsearch > Remote Clusters* to get started.
Before you use this feature, you should be familiar with the concept of
{ref}/modules-remote-clusters.html[remote clusters].
Go to *Management > Elasticsearch > Remote clusters* to create or manage your remotes.
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.
[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 *Cross Cluster Replication*
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.
*Cross Cluster Replication* includes tools to help you create and manage the remote
replication process. You can follow an index pattern on the remote cluster for
auto-discovery and then replicate new indices in the local cluster that match the
auto-follow pattern.
[float]
[[managing-cross-cluster-replication]]
== Managing cross cluster replication
*Cross Cluster Replication* helps you create and manage the cross cluster
replication 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*.
Go to *Management > Elasticsearch > Cross Cluster Replication* to get started.
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.
Before you use these features, you should be familiar with the following concepts:
* {xpack-ref}/ccr-requirements.html[Requirements for leader indices]
* {xpack-ref}/ccr-auto-follow.html[Automatically following indices]
To get started, go to *Management > Elasticsearch > Cross Cluster Replication*.
[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]