Provide links to auto-follow docs (#35674)
This commit adds a link to the auto-follow docs from the CCR getting started docs and the relevant CCR APIs.
This commit is contained in:
parent
e012ac4649
commit
220c175484
|
@ -12,7 +12,8 @@ Delete auto-follow patterns.
|
||||||
|
|
||||||
==== Description
|
==== Description
|
||||||
|
|
||||||
This API deletes a configured auto-follow pattern collection.
|
This API deletes a configured collection of
|
||||||
|
{stack-ov}/ccr-auto-follow.html[auto-follow patterns].
|
||||||
|
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
|
|
|
@ -12,8 +12,8 @@ Get auto-follow patterns.
|
||||||
|
|
||||||
==== Description
|
==== Description
|
||||||
|
|
||||||
This API gets configured auto-follow patterns. This API will return the
|
This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns].
|
||||||
specified auto-follow pattern collection.
|
This API will return the specified auto-follow pattern collection.
|
||||||
|
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
|
|
|
@ -12,10 +12,11 @@ Creates an auto-follow pattern.
|
||||||
|
|
||||||
==== Description
|
==== Description
|
||||||
|
|
||||||
This API creates a new named collection of auto-follow patterns against the
|
This API creates a new named collection of
|
||||||
remote cluster specified in the request body. Newly created indices on the
|
{stack-ov}/ccr-auto-follow.html[auto-follow patterns] against the remote cluster
|
||||||
remote cluster matching any of the specified patterns will be automatically
|
specified in the request body. Newly created indices on the remote cluster
|
||||||
configured as follower indices.
|
matching any of the specified patterns will be automatically configured as follower
|
||||||
|
indices.
|
||||||
|
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="platinum"]
|
[testenv="platinum"]
|
||||||
[[ccr-overview-auto-follow]]
|
[[ccr-auto-follow]]
|
||||||
=== Automatically following indices
|
=== Automatically following indices
|
||||||
|
|
||||||
beta[]
|
beta[]
|
||||||
|
|
|
@ -274,11 +274,11 @@ POST /server-metrics-copy/_ccr/unfollow
|
||||||
[[ccr-getting-started-auto-follow]]
|
[[ccr-getting-started-auto-follow]]
|
||||||
=== Automatically create follower indices
|
=== Automatically create follower indices
|
||||||
|
|
||||||
The auto-follow feature in {ccr} helps for time series use cases where you want
|
The <<ccr-auto-follow,auto-follow>> feature in {ccr} helps for time series use
|
||||||
to follow new indices that are periodically created in the remote cluster
|
cases where you want to follow new indices that are periodically created in the
|
||||||
(such as daily Beats indices). Auto-following is configured using the
|
remote cluster (such as daily Beats indices). Auto-following is configured using
|
||||||
{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. With an
|
the {ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. With
|
||||||
auto-follow pattern, you reference the
|
an auto-follow pattern, you reference the
|
||||||
<<ccr-getting-started-remote-cluster,remote cluster>> that you connected your
|
<<ccr-getting-started-remote-cluster,remote cluster>> that you connected your
|
||||||
local cluster to. You must also specify a collection of patterns that match the
|
local cluster to. You must also specify a collection of patterns that match the
|
||||||
indices you want to automatically follow.
|
indices you want to automatically follow.
|
||||||
|
|
|
@ -9,7 +9,8 @@
|
||||||
beta[]
|
beta[]
|
||||||
|
|
||||||
The {ccr} (CCR) feature enables replication of indices in remote clusters to a
|
The {ccr} (CCR) feature enables replication of indices in remote clusters to a
|
||||||
local cluster. This functionality can be used in some common production use cases:
|
local cluster. This functionality can be used in some common production use
|
||||||
|
cases:
|
||||||
|
|
||||||
* Disaster recovery in case a primary cluster fails. A secondary cluster can
|
* Disaster recovery in case a primary cluster fails. A secondary cluster can
|
||||||
serve as a hot backup
|
serve as a hot backup
|
||||||
|
@ -19,7 +20,7 @@ This guide provides an overview of {ccr}:
|
||||||
|
|
||||||
* <<ccr-overview>>
|
* <<ccr-overview>>
|
||||||
* <<ccr-requirements>>
|
* <<ccr-requirements>>
|
||||||
* <<ccr-overview-auto-follow>>
|
* <<ccr-auto-follow>>
|
||||||
* <<ccr-getting-started>>
|
* <<ccr-getting-started>>
|
||||||
|
|
||||||
--
|
--
|
||||||
|
|
|
@ -27,7 +27,7 @@ Replication can be configured in two ways:
|
||||||
{ref}/ccr-put-follow.html[create follower API]
|
{ref}/ccr-put-follow.html[create follower API]
|
||||||
|
|
||||||
* Automatically using
|
* Automatically using
|
||||||
<<ccr-overview-auto-follow,auto-follow patterns>>
|
<<ccr-auto-follow,auto-follow patterns>>
|
||||||
|
|
||||||
NOTE: You must also <<ccr-requirements,configure the leader index>>.
|
NOTE: You must also <<ccr-requirements,configure the leader index>>.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue