honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-22 12:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Adds more authorization info for CCR APIs (#35606)

Browse Source
This commit is contained in:
Lisa Cawley 2018-11-21 15:01:59 -08:00 committed by GitHub
parent 927b2425b6
commit 78209188bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -48,6 +48,12 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
`auto_follow_pattern_name` (required)::
(string) specifies the auto-follow pattern collection to delete
==== Authorization
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
This example deletes an auto-follow pattern collection named

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

@ -64,6 +64,12 @@ GET /_ccr/auto_follow/<auto_follow_pattern_name>
retrieve; if you do not specify a name, the API returns information for all
collections
==== Authorization
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
This example retrieves information about an auto-follow pattern collection

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

@ -70,6 +70,14 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
include::../follow-request-body.asciidoc[]
==== Authorization
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].
==== Example
This example creates an auto-follow pattern named `my_auto_follow_pattern`:

6
docs/reference/ccr/apis/follow/get-follow-stats.asciidoc
View File

@ -179,6 +179,12 @@ Continuing with the fields from `shards`:
task; in this situation, the following task must be resumed manually with the
<<ccr-post-resume-follow,resume follower API>>
==== Authorization
If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
==== Example
This example retrieves follower stats:

6
docs/reference/ccr/apis/follow/post-unfollow.asciidoc
View File

@ -54,6 +54,12 @@ POST /<follower_index>/_ccr/unfollow
`follower_index` (required)::
(string) the name of the follower index
==== Authorization
If the {es} {security-features} are enabled, you must have `manage_follow_index`
index privileges for the follower index. For more information, see
{stack-ov}/security-privileges.html[Security privileges].
==== Example

6
docs/reference/ccr/apis/get-ccr-stats.asciidoc
View File

@ -80,6 +80,12 @@ This object consists of the following fields:
to the details of the response in the
<<ccr-get-follow-stats,get follower stats API>>
==== Authorization
If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
==== Example
This example retrieves {ccr} stats: