Skip to content

Commit caf996e

Browse files
committed
Fixing docs tests after API changes
1 parent 843ae8f commit caf996e

10 files changed

+146
-129
lines changed

docs/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1082,15 +1082,15 @@ buildRestTests.setups['calendar_outages_addevent'] = buildRestTests.setups['cale
10821082
]}
10831083
'''
10841084

1085-
buildRestTests.setups['leader_cluster'] = buildRestTests.setups['host'] + '''
1085+
buildRestTests.setups['remote_cluster'] = buildRestTests.setups['host'] + '''
10861086
- do:
10871087
cluster.put_settings:
10881088
body:
10891089
persistent:
1090-
cluster.remote.leader_cluster.seeds: $transport_host
1090+
cluster.remote.remote_cluster.seeds: $transport_host
10911091
'''
10921092

1093-
buildRestTests.setups['leader_cluster_and_leader_index'] = buildRestTests.setups['leader_cluster'] + '''
1093+
buildRestTests.setups['remote_cluster_and_leader_index'] = buildRestTests.setups['remote_cluster'] + '''
10941094
- do:
10951095
indices.create:
10961096
index: leader_index

docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This API deletes a configured auto-follow pattern collection.
2020
--------------------------------------------------
2121
PUT /_ccr/auto_follow/my_auto_follow_pattern
2222
{
23-
"leader_cluster" : "leader_cluster",
23+
"remote_cluster" : "remote_cluster",
2424
"leader_index_patterns" :
2525
[
2626
"leader_index"
@@ -29,7 +29,7 @@ PUT /_ccr/auto_follow/my_auto_follow_pattern
2929
}
3030
--------------------------------------------------
3131
// CONSOLE
32-
// TEST[setup:leader_cluster]
32+
// TEST[setup:remote_cluster]
3333
// TESTSETUP
3434
3535
//////////////////////////
@@ -55,7 +55,7 @@ This example deletes an auto-follow pattern collection named
5555
DELETE /_ccr/auto_follow/my_auto_follow_pattern
5656
--------------------------------------------------
5757
// CONSOLE
58-
// TEST[setup:leader_cluster]
58+
// TEST[setup:remote_cluster]
5959

6060
The API returns the following result:
6161

docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ specified auto-follow pattern collection.
2121
--------------------------------------------------
2222
PUT /_ccr/auto_follow/my_auto_follow_pattern
2323
{
24-
"leader_cluster" : "leader_cluster",
24+
"remote_cluster" : "remote_cluster",
2525
"leader_index_patterns" :
2626
[
2727
"leader_index*"
@@ -30,7 +30,7 @@ PUT /_ccr/auto_follow/my_auto_follow_pattern
3030
}
3131
--------------------------------------------------
3232
// CONSOLE
33-
// TEST[setup:leader_cluster]
33+
// TEST[setup:remote_cluster]
3434
// TESTSETUP
3535
3636
[source,js]
@@ -72,7 +72,7 @@ named `my_auto_follow_pattern`:
7272
GET /_ccr/auto_follow/my_auto_follow_pattern
7373
--------------------------------------------------
7474
// CONSOLE
75-
// TEST[setup:leader_cluster]
75+
// TEST[setup:remote_cluster]
7676

7777
The API returns the following result:
7878

@@ -81,7 +81,7 @@ The API returns the following result:
8181
{
8282
"my_auto_follow_pattern" :
8383
{
84-
"leader_cluster" : "leader_cluster",
84+
"remote_cluster" : "remote_cluster",
8585
"leader_index_patterns" :
8686
[
8787
"leader_index*"

docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ configured as follower indices.
2121
--------------------------------------------------
2222
PUT /_ccr/auto_follow/<auto_follow_pattern_name>
2323
{
24-
"leader_cluster" : "<leader_cluster>",
24+
"remote_cluster" : "<remote_cluster>",
2525
"leader_index_patterns" :
2626
[
2727
"<leader_index_pattern>"
@@ -30,9 +30,9 @@ PUT /_ccr/auto_follow/<auto_follow_pattern_name>
3030
}
3131
--------------------------------------------------
3232
// CONSOLE
33-
// TEST[setup:leader_cluster]
33+
// TEST[setup:remote_cluster]
3434
// TEST[s/<auto_follow_pattern_name>/auto_follow_pattern_name/]
35-
// TEST[s/<leader_cluster>/leader_cluster/]
35+
// TEST[s/<remote_cluster>/remote_cluster/]
3636
// TEST[s/<leader_index_patterns>/leader_index*/]
3737
// TEST[s/<follow_index_pattern>/{{leader_index}}-follower/]
3838

@@ -52,13 +52,13 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
5252
(string) name of the collection of auto-follow patterns
5353

5454
==== Request Body
55-
`leader_cluster`::
55+
`remote_cluster`::
5656
(required string) the <<modules-remote-clusters,remote cluster>> containing the
5757
leader indices to match against
5858

5959
`leader_index_patterns`::
6060
(array) an array of simple index patterns to match against indices in the
61-
remote cluster specified by the `leader_cluster` field
61+
remote cluster specified by the `remote_cluster` field
6262

6363
`follow_index_pattern`::
6464
(string) the name of follower index; the template `{{leader_index}}` can be
@@ -75,7 +75,7 @@ This example creates an auto-follow pattern named `my_auto_follow_pattern`:
7575
--------------------------------------------------
7676
PUT /_ccr/auto_follow/my_auto_follow_pattern
7777
{
78-
"leader_cluster" : "leader_cluster",
78+
"remote_cluster" : "remote_cluster",
7979
"leader_index_patterns" :
8080
[
8181
"leader_index*"
@@ -84,7 +84,7 @@ PUT /_ccr/auto_follow/my_auto_follow_pattern
8484
}
8585
--------------------------------------------------
8686
// CONSOLE
87-
// TEST[setup:leader_cluster]
87+
// TEST[setup:remote_cluster]
8888

8989
The API returns the following result:
9090

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,44 @@
1-
`max_batch_operation_count`::
2-
(integer) the maximum number of operations to pull per fetch from the remote
1+
`max_read_request_operation_count`::
2+
(integer) the maximum number of operations to pull per read from the remote
33
cluster
44

5-
`max_concurrent_read_batches`::
6-
(long) the maximum number of concurrent fetches from the remote cluster
5+
`max_outstanding_read_requests`::
6+
(long) the maximum number of outstanding reads requests from the remote
7+
cluster
78

8-
`max_batch_size`::
9-
(<<byte-units,byte value>>) the maximum size in bytes of batches pulled per
10-
fetch from the remote cluster
9+
`max_read_request_size`::
10+
(<<byte-units,byte value>>) the maximum size in bytes of per read of a batch
11+
of operations pulled from the remote cluster
1112

12-
`max_concurrent_write_batches`::
13-
(integer) the maximum number of concurrent writes on the following index
13+
`max_write_request_operation_count`::
14+
(integer) the maximum number of operations per bulk write request executed on
15+
the follower
1416

15-
`max_write_buffer_size`::
17+
`max_write_request_size`::
18+
(integer) the maximum total bytes of operations per bulk write request
19+
executed on the follower
20+
21+
`max_outstanding_write_requests`::
22+
(integer) the maximum number of outstanding write requests on the follower
23+
24+
`max_write_buffer_count`::
1625
(integer) the maximum number of operations that can be queued for writing;
17-
when this limit is reached, fetches from the remote cluster will be
18-
deferred until the number of queued operations goes below the limit
26+
when this limit is reached, reads from the remote cluster will be deferred
27+
until the number of queued operations goes below the limit
28+
29+
`max_write_buffer_size`::
30+
(integer) the maximum total bytes of operations that can be queued for
31+
writing; when this limit is reached, reads from the remote cluster will be
32+
deferred until the total bytes of queued operations goes below the limit
1933

2034
`max_retry_delay`::
2135
(<<time-units,time value>>) the maximum time to wait before retrying an
2236
operation that failed exceptionally; an exponential backoff strategy is
2337
employed when retrying
2438

25-
`poll_timeout`::
39+
`read_poll_timeout`::
2640
(<<time-units,time value>>) the maximum time to wait for new operations on the
2741
remote cluster when the follower index is synchronized with the leader index;
2842
when the timeout has elapsed, the poll for operations will return to the
2943
follower so that it can update some statistics, and then the follower will
30-
immediately attempt to fetch from the leader again
44+
immediately attempt to read from the leader again

0 commit comments

Comments
 (0)