Skip to content

Commit e959dba

Browse files
committed
Revert "Revert "Documented default values for index follow request parameters. (#37917)""
This reverts commit 7205833.
1 parent 7205833 commit e959dba

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

docs/reference/ccr/apis/follow-request-body.asciidoc

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="platinum"]
13
`max_read_request_operation_count`::
24
(integer) the maximum number of operations to pull per read from the remote
35
cluster
@@ -41,4 +43,62 @@
4143
remote cluster when the follower index is synchronized with the leader index;
4244
when the timeout has elapsed, the poll for operations will return to the
4345
follower so that it can update some statistics, and then the follower will
44-
immediately attempt to read from the leader again
46+
immediately attempt to read from the leader again
47+
48+
===== Default values
49+
50+
//////////////////////////
51+
52+
[source,js]
53+
--------------------------------------------------
54+
PUT /follower_index/_ccr/follow
55+
{
56+
"remote_cluster" : "remote_cluster",
57+
"leader_index" : "leader_index"
58+
}
59+
--------------------------------------------------
60+
// CONSOLE
61+
// TESTSETUP
62+
// TEST[setup:remote_cluster_and_leader_index]
63+
64+
[source,js]
65+
--------------------------------------------------
66+
POST /follower_index/_ccr/pause_follow
67+
--------------------------------------------------
68+
// CONSOLE
69+
// TEARDOWN
70+
71+
[source,js]
72+
--------------------------------------------------
73+
GET /follower_index/_ccr/info?filter_path=follower_indices.parameters
74+
--------------------------------------------------
75+
// CONSOLE
76+
77+
//////////////////////////
78+
79+
The following output from the follow info api describes all the default
80+
values for the above described index follow request parameters:
81+
82+
[source,js]
83+
--------------------------------------------------
84+
{
85+
"follower_indices" : [
86+
{
87+
"parameters" : {
88+
"max_read_request_operation_count" : 5120,
89+
"max_read_request_size" : "32mb",
90+
"max_outstanding_read_requests" : 12,
91+
"max_write_request_operation_count" : 5120,
92+
"max_write_request_size" : "9223372036854775807b",
93+
"max_outstanding_write_requests" : 9,
94+
"max_write_buffer_count" : 2147483647,
95+
"max_write_buffer_size" : "512mb",
96+
"max_retry_delay" : "500ms",
97+
"read_poll_timeout" : "1m"
98+
}
99+
}
100+
]
101+
}
102+
103+
--------------------------------------------------
104+
// TESTRESPONSE

0 commit comments

Comments
 (0)