mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-13 00:15:47 +00:00
be08268562
Today when creating a follower index via the put follow API, or via an auto-follow pattern, it is not possible to specify settings overrides for the follower index. Instead, we copy all of the leader index settings to the follower. Yet, there are cases where a user would want some different settings on the follower index such as the number of replicas, or allocation settings. This commit addresses this by allowing the user to specify settings overrides when creating follower index via manual put follower calls, or via auto-follow patterns. Note that not all settings can be overrode (e.g., index.number_of_shards) so we also have detection that prevents attempting to override settings that must be equal between the leader and follow index. Note that we do not even allow specifying such settings in the overrides, even if they are specified to be equal between the leader and the follower index. Instead, the must be implicitly copied from the leader index, not explicitly set by the user.
39 lines
1.2 KiB
Plaintext
39 lines
1.2 KiB
Plaintext
--
|
|
:api: ccr-put-auto-follow-pattern
|
|
:request: PutAutoFollowPatternRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Put Auto Follow Pattern API
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Put Auto Follow Pattern API allows you to store auto follow patterns in order
|
|
to automatically follow leader indices in a remote clusters matching certain
|
|
index name patterns.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The name of the auto follow pattern.
|
|
<2> The name of the remote cluster.
|
|
<3> The leader index patterns.
|
|
<4> The pattern used to create the follower index
|
|
<5> The settings overrides for the follower index
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ indicates if the put auto follow pattern request was received.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> Whether or not the put auto follow pattern request was acknowledged.
|
|
|
|
include::../execution.asciidoc[]
|