[DOCS] Redirects CCR and Remote Clusters docs to ES reference (#77909)

* [DOCS] Redirects CRR and Remote Clusters docs to ES reference

* [DOCS] Updates link for remote clusters
This commit is contained in:
gchaps 2020-09-23 11:52:04 -07:00 committed by GitHub
parent 0db3159a9f
commit 792db1726a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 14 additions and 136 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 267 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

View file

@ -1,80 +0,0 @@
[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, open the menu, then go to *Stack Management > Data > 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]
=== Required permissions
The `manage` and `manage_ccr` cluster privileges are required to access *Cross-Cluster Replication*.
You can add these privileges in *Stack Management > Security > Roles*.
[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].

View file

@ -1,50 +0,0 @@
[[working-remote-clusters]]
== Remote Clusters
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].
To get started, open the menu, then go to *Stack Management > Data > Remote Clusters*.
[role="screenshot"]
image::images/remote-clusters-list-view.png[Remote Clusters list view, including Add a remote cluster button]
[float]
=== Required permissions
The `manage` cluster privilege is required to access *Remote Clusters*.
You can add this privilege in *Stack Management > Security > Roles*.
[float]
[[managing-remote-clusters]]
=== Add a remote cluster
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.
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.
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]
To create an index pattern to search across clusters,
use the same syntax that youd use in a raw cross-cluster search request in {es}: <cluster-names>:<pattern>.
See <<management-cross-cluster-search, Creating an index pattern>> for examples.
[float]
[[manage-remote-clusters]]
=== Manage remote clusters
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.

View file

@ -100,3 +100,15 @@ This content has moved to the <<development-rbac, Security>> page.
== TSVB
This page was deleted. See <<tsvb>>.
[role="exclude",id="managing-cross-cluster-replication"]
== Cross-Cluster Replication
This content has moved. See
{ref}/ccr-getting-started.html[Set up cross-cluster replication].
[role="exclude",id="working-remote-clusters"]
== Remote clusters
This content has moved. See
{ref}/ccr-getting-started.html#ccr-getting-started-remote-cluster[Connect to a remote cluster].

View file

@ -58,12 +58,12 @@ years of historical data in combination with your raw data.
| {ref}/transforms.html[Transforms]
|Use transforms to pivot existing {es} indices into summarized or entity-centric indices.
| <<managing-cross-cluster-replication, Cross-Cluster Replication>>
| {ref}/ccr-getting-started.html[Cross-Cluster Replication]
|Replicate indices on a remote cluster and copy them to a follower index on a local cluster.
This is important for
disaster recovery. It also keeps data local for faster queries.
| <<working-remote-clusters, Remote Clusters>>
| {ref}/ccr-getting-started.html#ccr-getting-started-remote-cluster[Remote Clusters]
|Manage your remote clusters for use with cross-cluster search and cross-cluster replication.
You can add and remove remote clusters, and check their connectivity.
|===
@ -180,8 +180,6 @@ 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[]
@ -200,8 +198,6 @@ include::{kib-repo-dir}/management/managing-licenses.asciidoc[]
include::{kib-repo-dir}/management/numeral.asciidoc[]
include::{kib-repo-dir}/management/managing-remote-clusters.asciidoc[]
include::{kib-repo-dir}/management/rollups/create_and_manage_rollups.asciidoc[]
include::{kib-repo-dir}/management/managing-saved-objects.asciidoc[]