2018-10-26 11:23:35 -04:00
|
|
|
[role="xpack"]
|
|
|
|
|
[testenv="platinum"]
|
|
|
|
|
[[ccr-put-auto-follow-pattern]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Create auto-follow pattern API
|
2018-10-26 11:23:35 -04:00
|
|
|
++++
|
2018-12-20 13:23:28 -05:00
|
|
|
<titleabbrev>Create auto-follow pattern</titleabbrev>
|
2018-10-26 11:23:35 -04:00
|
|
|
++++
|
|
|
|
|
|
|
|
|
|
Creates an auto-follow pattern.
|
|
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-request]]
|
|
|
|
|
==== {api-request-title}
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2018-10-26 11:23:35 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
PUT /_ccr/auto_follow/<auto_follow_pattern_name>
|
|
|
|
|
{
|
|
|
|
|
"remote_cluster" : "<remote_cluster>",
|
|
|
|
|
"leader_index_patterns" :
|
|
|
|
|
[
|
|
|
|
|
"<leader_index_pattern>"
|
|
|
|
|
],
|
|
|
|
|
"follow_index_pattern" : "<follow_index_pattern>"
|
|
|
|
|
}
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// TEST[setup:remote_cluster]
|
|
|
|
|
// TEST[s/<auto_follow_pattern_name>/auto_follow_pattern_name/]
|
|
|
|
|
// TEST[s/<remote_cluster>/remote_cluster/]
|
|
|
|
|
// TEST[s/<leader_index_patterns>/leader_index*/]
|
|
|
|
|
// TEST[s/<follow_index_pattern>/{{leader_index}}-follower/]
|
|
|
|
|
|
|
|
|
|
//////////////////////////
|
|
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2018-10-26 11:23:35 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
DELETE /_ccr/auto_follow/auto_follow_pattern_name
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// TEST[continued]
|
|
|
|
|
|
|
|
|
|
//////////////////////////
|
|
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-prereqs]]
|
|
|
|
|
==== {api-prereq-title}
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
* If the {es} {security-features} are enabled, you must have `read` and `monitor`
|
|
|
|
|
index privileges for the leader index patterns. You must also have `manage_ccr`
|
|
|
|
|
cluster privileges on the cluster that contains the follower index. For more
|
2019-10-07 18:23:19 -04:00
|
|
|
information, see <<security-privileges>>.
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-desc]]
|
|
|
|
|
==== {api-description-title}
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
This API creates a new named collection of
|
2019-10-07 18:23:19 -04:00
|
|
|
<<ccr-auto-follow,auto-follow patterns>> against the remote cluster
|
2019-07-04 11:22:17 -04:00
|
|
|
specified in the request body. Newly created indices on the remote cluster
|
|
|
|
|
matching any of the specified patterns will be automatically configured as follower
|
|
|
|
|
indices.
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-path-parms]]
|
|
|
|
|
==== {api-path-parms-title}
|
2019-07-12 11:26:31 -04:00
|
|
|
`<auto_follow_pattern_name>`::
|
|
|
|
|
(Required, string) The name of the collection of auto-follow patterns.
|
2018-10-26 11:23:35 -04:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-request-body]]
|
|
|
|
|
==== {api-request-body-title}
|
2018-11-21 18:01:59 -05:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`remote_cluster`::
|
|
|
|
|
(Required, string) The <<modules-remote-clusters,remote cluster>> containing
|
|
|
|
|
the leader indices to match against.
|
2019-07-04 11:22:17 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`leader_index_patterns`::
|
|
|
|
|
(Optional, array) An array of simple index patterns to match against indices
|
|
|
|
|
in the remote cluster specified by the `remote_cluster` field.
|
2019-07-04 11:22:17 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`follow_index_pattern`::
|
|
|
|
|
(Optional, string) The name of follower index. The template `{{leader_index}}`
|
|
|
|
|
can be used to derive the name of the follower index from the name of the
|
|
|
|
|
leader index.
|
2019-07-04 11:22:17 -04:00
|
|
|
|
|
|
|
|
include::../follow-request-body.asciidoc[]
|
2018-11-21 18:01:59 -05:00
|
|
|
|
2019-07-04 11:22:17 -04:00
|
|
|
[[ccr-put-auto-follow-pattern-examples]]
|
|
|
|
|
==== {api-examples-title}
|
2018-10-26 11:23:35 -04:00
|
|
|
|
|
|
|
|
This example creates an auto-follow pattern named `my_auto_follow_pattern`:
|
|
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2018-10-26 11:23:35 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
PUT /_ccr/auto_follow/my_auto_follow_pattern
|
|
|
|
|
{
|
|
|
|
|
"remote_cluster" : "remote_cluster",
|
|
|
|
|
"leader_index_patterns" :
|
|
|
|
|
[
|
|
|
|
|
"leader_index*"
|
|
|
|
|
],
|
|
|
|
|
"follow_index_pattern" : "{{leader_index}}-follower",
|
Allow follower indices to override leader settings (#58103)
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.
2020-06-18 10:55:17 -04:00
|
|
|
"settings": {
|
|
|
|
|
"index.number_of_replicas": 0
|
|
|
|
|
},
|
2018-10-26 11:23:35 -04:00
|
|
|
"max_read_request_operation_count" : 1024,
|
|
|
|
|
"max_outstanding_read_requests" : 16,
|
|
|
|
|
"max_read_request_size" : "1024k",
|
|
|
|
|
"max_write_request_operation_count" : 32768,
|
|
|
|
|
"max_write_request_size" : "16k",
|
|
|
|
|
"max_outstanding_write_requests" : 8,
|
|
|
|
|
"max_write_buffer_count" : 512,
|
|
|
|
|
"max_write_buffer_size" : "512k",
|
|
|
|
|
"max_retry_delay" : "10s",
|
|
|
|
|
"read_poll_timeout" : "30s"
|
|
|
|
|
}
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// TEST[setup:remote_cluster]
|
|
|
|
|
|
|
|
|
|
The API returns the following result:
|
|
|
|
|
|
2019-09-06 09:22:08 -04:00
|
|
|
[source,console-result]
|
2018-10-26 11:23:35 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
{
|
|
|
|
|
"acknowledged" : true
|
|
|
|
|
}
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
|
|
|
|
//////////////////////////
|
|
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2018-10-26 11:23:35 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
DELETE /_ccr/auto_follow/my_auto_follow_pattern
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// TEST[continued]
|
|
|
|
|
|
|
|
|
|
//////////////////////////
|
