Skip to content

Commit

Permalink
[DOCS] Collapse nested objects in CCR APIs (elastic#54697)
Browse files Browse the repository at this point in the history
lcawl authored Apr 3, 2020
1 parent 93f26b4 commit da531f4
Showing 3 changed files with 212 additions and 198 deletions.
141 changes: 74 additions & 67 deletions docs/reference/ccr/apis/follow/get-follow-info.asciidoc
Original file line number Diff line number Diff line change
@@ -57,77 +57,84 @@ replication options and whether the follower indices are active or paused.
`<index>`::
(Required, string) A comma-delimited list of follower index patterns.

[role="child_attributes"]
[[ccr-get-follow-info-response-body]]
==== {api-response-body-title}

This API returns the following information:

//Begin follower_indices
`follower_indices`::
(array) An array of follower index statistics.

The `indices` array consists of objects containing several fields:

`indices[].follower_index`::
(string) The name of the follower index.

`indices[].remote_cluster`::
(string) The <<modules-remote-clusters,remote cluster>> that contains the
leader index.

`indices[].leader_index`::
(string) The name of the index in the leader cluster that is followed.

`indices[].status`::
(string) Whether index following is `active` or `paused`.

`indices[].parameters`::
(object) An object that encapsulates {ccr} parameters.

The `parameters` contains the following fields:

`indices[].parameters.max_read_request_operation_count`::
(integer) The maximum number of operations to pull per read from the remote
cluster.

`indices[].parameters.max_outstanding_read_requests`::
(long) The maximum number of outstanding read requests from the remote cluster.

`indices[].parameters.max_read_request_size`::
(<<byte-units,byte value>>) The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.

`indices[].parameters.max_write_request_operation_count`::
(integer) The maximum number of operations per bulk write request executed on
the follower.

`indices[].parameters.max_write_request_size`::
(<<byte-units,byte value>>) The maximum total bytes of operations per bulk
write request executed on the follower.

`indices[].parameters.max_outstanding_write_requests`::
(integer) The maximum number of outstanding write requests on the follower.

`indices[].parameters.max_write_buffer_count`::
(integer) The maximum number of operations that can be queued for writing.
When this limit is reached, reads from the remote cluster are deferred until
the number of queued operations goes below the limit.

`indices[].parameters.max_write_buffer_size`::
(<<byte-units,byte value>>) The maximum total bytes of operations that can be
queued for writing. When this limit is reached, reads from the remote cluster
are deferred until the total bytes of queued operations goes below the limit.

`indices[].parameters.max_retry_delay`::
(<<time-units,time value>>) The maximum time to wait before retrying an
operation that failed exceptionally. An exponential backoff strategy is
employed when retrying.

`indices[].parameters.read_poll_timeout`::
(<<time-units,time value>>) The maximum time to wait for new operations on the
remote cluster when the follower index is synchronized with the leader index.
When the timeout has elapsed, the poll for operations returns to the follower
so that it can update some statistics, then the follower immediately attempts
to read from the leader again.
(array) An array of follower index statistics.
+
.Properties of objects in `follower_indices`
[%collapsible%open]
====
`follower_index`::
(string) The name of the follower index.
`leader_index`::
(string) The name of the index in the leader cluster that is followed.
//Begin parameters
`parameters`::
(object) An object that encapsulates {ccr} parameters.
+
.Properties of `parameters`
[%collapsible%open]
=====
`max_outstanding_read_requests`::
(long) The maximum number of outstanding read requests from the remote cluster.

`max_outstanding_write_requests`::
(integer) The maximum number of outstanding write requests on the follower.

`max_read_request_operation_count`::
(integer) The maximum number of operations to pull per read from the remote
cluster.

`max_read_request_size`::
(<<byte-units,byte value>>) The maximum size in bytes of per read of a batch of
operations pulled from the remote cluster.

`max_retry_delay`::
(<<time-units,time value>>) The maximum time to wait before retrying an
operation that failed exceptionally. An exponential backoff strategy is employed
when retrying.

`max_write_buffer_count`::
(integer) The maximum number of operations that can be queued for writing. When
this limit is reached, reads from the remote cluster are deferred until the
number of queued operations goes below the limit.

`max_write_buffer_size`::
(<<byte-units,byte value>>) The maximum total bytes of operations that can be
queued for writing. When this limit is reached, reads from the remote cluster
are deferred until the total bytes of queued operations goes below the limit.

`max_write_request_operation_count`::
(integer) The maximum number of operations per bulk write request executed on
the follower.

`max_write_request_size`::
(<<byte-units,byte value>>) The maximum total bytes of operations per bulk write
request executed on the follower.

`read_poll_timeout`::
(<<time-units,time value>>) The maximum time to wait for new operations on the
remote cluster when the follower index is synchronized with the leader index.
When the timeout has elapsed, the poll for operations returns to the follower so
that it can update some statistics, then the follower immediately attempts
to read from the leader again.
=====
//End parameters
`remote_cluster`::
(string) The <<modules-remote-clusters,remote cluster>> that contains the
leader index.
`status`::
(string) Whether index following is `active` or `paused`.
====
//End follower_indices

[[ccr-get-follow-info-examples]]
==== {api-examples-title}
Loading

0 comments on commit da531f4

Please sign in to comment.