Skip to content

[DOCS] Reformat CCR APIs to use new API format #43952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 2 commits into from
Jul 4, 2019
Merged

[DOCS] Reformat CCR APIs to use new API format #43952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca6b837
[DOCS] Reformat CCR APIs to use new API reference format
lcawl Jul 3, 2019
0c33f41
[DOCS] More minor edits
lcawl Jul 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@

Delete auto-follow patterns.

==== Description

This API deletes a configured collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns].

==== Request
[[ccr-delete-auto-follow-pattern-request]]
==== {api-request-title}

//////////////////////////

Expand Down Expand Up @@ -42,17 +38,28 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
// CONSOLE
// TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]

==== Path Parameters
`auto_follow_pattern_name` (required)::
(string) specifies the auto-follow pattern collection to delete

==== Authorization
[[ccr-delete-auto-follow-pattern-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].

==== Example
[[ccr-delete-auto-follow-pattern-desc]]
==== {api-description-title}

This API deletes a configured collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns].

[[ccr-delete-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}

`<auto_follow_pattern_name>` (Required)::
(string) Specifies the auto-follow pattern collection to delete.


[[ccr-delete-auto-follow-pattern-examples]]
==== {api-examples-title}

This example deletes an auto-follow pattern collection named
`my_auto_follow_pattern`:
Expand Down
36 changes: 21 additions & 15 deletions docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@

Get auto-follow patterns.

==== Description

This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns].
This API will return the specified auto-follow pattern collection.

==== Request
[[ccr-get-auto-follow-pattern-request]]
==== {api-request-title}

//////////////////////////

Expand Down Expand Up @@ -56,19 +52,29 @@ GET /_ccr/auto_follow/<auto_follow_pattern_name>
// CONSOLE
// TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/]

==== Path Parameters
`auto_follow_pattern_name`::
(string) specifies the auto-follow pattern collection that you want to
retrieve; if you do not specify a name, the API returns information for all
collections

==== Authorization
[[ccr-get-auto-follow-pattern-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].

==== Example
[[ccr-get-auto-follow-pattern-desc]]
==== {api-description-title}

This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns].
This API will return the specified auto-follow pattern collection.

[[ccr-get-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}

`<auto_follow_pattern_name>` (Optional)::
(string) Specifies the auto-follow pattern collection that you want to
retrieve. If you do not specify a name, the API returns information for all
collections.

[[ccr-get-auto-follow-pattern-examples]]
==== {api-examples-title}

This example retrieves information about an auto-follow pattern collection
named `my_auto_follow_pattern`:
Expand Down
69 changes: 38 additions & 31 deletions docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,8 @@

Creates an auto-follow pattern.

==== Description

This API creates a new named collection of
{stack-ov}/ccr-auto-follow.html[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.

==== Request
[[ccr-put-auto-follow-pattern-request]]
==== {api-request-title}

[source,js]
--------------------------------------------------
Expand Down Expand Up @@ -48,35 +41,49 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name

//////////////////////////

==== Path Parameters
`auto_follow_pattern_name` (required)::
(string) name of the collection of auto-follow patterns
[[ccr-put-auto-follow-pattern-prereqs]]
==== {api-prereq-title}

==== Request Body
`remote_cluster`::
(required string) the <<modules-remote-clusters,remote cluster>> containing the
leader indices to match against
* 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
information, see
{stack-ov}/security-privileges.html[Security privileges].

`leader_index_patterns`::
(array) an array of simple index patterns to match against indices in the
remote cluster specified by the `remote_cluster` field
[[ccr-put-auto-follow-pattern-desc]]
==== {api-description-title}

`follow_index_pattern`::
(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
This API creates a new named collection of
{stack-ov}/ccr-auto-follow.html[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.

include::../follow-request-body.asciidoc[]
[[ccr-put-auto-follow-pattern-path-parms]]
==== {api-path-parms-title}
`<auto_follow_pattern_name>` (Required)::
(string) The name of the collection of auto-follow patterns.

==== Authorization
[[ccr-put-auto-follow-pattern-request-body]]
==== {api-request-body-title}

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
information, see
{stack-ov}/security-privileges.html[Security privileges].
`remote_cluster` (Required)::
(string) The <<modules-remote-clusters,remote cluster>> containing the
leader indices to match against.

`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.

`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.

include::../follow-request-body.asciidoc[]

==== Example
[[ccr-put-auto-follow-pattern-examples]]
==== {api-examples-title}

This example creates an auto-follow pattern named `my_auto_follow_pattern`:

Expand Down
51 changes: 26 additions & 25 deletions docs/reference/ccr/apis/follow-request-body.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,49 @@
[testenv="platinum"]
`max_read_request_operation_count`::
(integer) the maximum number of operations to pull per read from the remote
cluster
(integer) The maximum number of operations to pull per read from the remote
cluster.

`max_outstanding_read_requests`::
(long) the maximum number of outstanding reads requests from the remote
cluster
(long) The maximum number of outstanding reads requests 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
(<<byte-units,byte value>>) The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.

`max_write_request_operation_count`::
(integer) the maximum number of operations per bulk write request executed on
the follower
(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
(<<byte-units,byte value>>) The maximum total bytes of operations per bulk write request
executed on the follower.

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

`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 will be deferred
until the number of queued operations goes below the limit
(integer) The maximum number of operations that can be queued for writing.
When this limit is reached, reads from the remote cluster will be 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 will be
deferred until the total bytes of queued operations goes below the limit
(<<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 will be
deferred until the total bytes of queued operations goes below the limit.

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

`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 will return to the
follower so that it can update some statistics, and then the follower will
immediately attempt to read from the leader again
(<<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 will return to the
follower so that it can update some statistics. Then the follower will
immediately attempt to read from the leader again.

===== Default values

Expand Down
Loading