honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 09:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Lisa Cawley 2018-11-20 16:23:01 -08:00 committed by GitHub
parent 84db1e42c0
commit 04a087fe2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/ccr/apis/follow/post-pause-follow.asciidoc
View File

@ -48,6 +48,14 @@ POST /<follower_index>/_ccr/pause_follow
`follower_index` (required)::
(string) the name of the follower index
==== 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 pauses a follower index named `follower_index`:

8
docs/reference/ccr/apis/follow/post-resume-follow.asciidoc
View File

@ -63,6 +63,14 @@ POST /<follower_index>/_ccr/resume_follow
==== Request Body
include::../follow-request-body.asciidoc[]
==== Authorization
If the {es} {security-features} are enabled, you must have `write` and `monitor`
index privileges for the follower index. You must have `read` and `monitor`
index privileges for the leader index. 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 resumes a follower index named `follower_index`:

9
docs/reference/ccr/apis/follow/put-follow.asciidoc
View File

@ -58,6 +58,15 @@ PUT /<follower_index>/_ccr/follow
include::../follow-request-body.asciidoc[]
==== Authorization
If the {es} {security-features} are enabled, you must have `write`, `monitor`,
and `manage_follow_index` index privileges for the follower index. You must have
`read` and `monitor` index privileges for the leader index. 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 a follower index named `follower_index`: