Creates an auto-follow pattern.
This API creates a new named collection of auto-follow patterns against the remote cluster 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.
PUT /_ccr/auto_follow/<auto_follow_pattern_name> { "remote_cluster" : "<remote_cluster>", "leader_index_patterns" : [ "<leader_index_pattern>" ], "follow_index_pattern" : "<follow_index_pattern>" }
auto_follow_pattern_name
(required)
remote_cluster
leader_index_patterns
remote_cluster
field
follow_index_pattern
{{leader_index}}
can be
used to derive the name of the follower index from the name of the leader
index
max_read_request_operation_count
max_outstanding_read_requests
max_read_request_size
max_write_request_operation_count
max_write_request_size
max_outstanding_write_requests
max_write_buffer_count
max_write_buffer_size
max_retry_delay
read_poll_timeout
The following output from the follow info api describes all the default values for the above described index follow request parameters:
{ "follower_indices" : [ { "parameters" : { "max_read_request_operation_count" : 5120, "max_read_request_size" : "32mb", "max_outstanding_read_requests" : 12, "max_write_request_operation_count" : 5120, "max_write_request_size" : "9223372036854775807b", "max_outstanding_write_requests" : 9, "max_write_buffer_count" : 2147483647, "max_write_buffer_size" : "512mb", "max_retry_delay" : "500ms", "read_poll_timeout" : "1m" } } ] }
If the Elasticsearch 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
information, see
Security privileges.
This example creates an auto-follow pattern named my_auto_follow_pattern
:
PUT /_ccr/auto_follow/my_auto_follow_pattern { "remote_cluster" : "remote_cluster", "leader_index_patterns" : [ "leader_index*" ], "follow_index_pattern" : "{{leader_index}}-follower", "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" }
The API returns the following result:
{ "acknowledged" : true }