Skip to content

[DOCS] Adds authorization info for CCR APIs #35557

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 3 commits into from
Nov 21, 2018
Merged

[DOCS] Adds authorization info for CCR APIs #35557

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f7844c
[DOCS] Adds authorization info for CCR APIs
lcawl Nov 14, 2018
c19f16e
[DOCS] Augments authorization details
lcawl Nov 15, 2018
c4f2076
[DOCS] Fix monitor privileges
lcawl Nov 19, 2018
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
8 changes: 8 additions & 0 deletions docs/reference/ccr/apis/follow/post-pause-follow.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/ccr/apis/follow/post-resume-follow.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ 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` index
privileges for the follower index and `read` index privileges for the leader
index. You must have `manage_ccr` and `monitor` cluster privileges on the
Copy link
Member

@martijnvg martijnvg Nov 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The monitor indices privilege in both clusters is needed instead of monitor cluster privilege.

Copy link
Contributor Author

@lcawl lcawl Nov 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've fixed those details

cluster that contains the follower index. You must also have `monitor` cluster
privileges on the cluster that contains the leader index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].

==== Example

This example resumes a follower index named `follower_index`:
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/ccr/apis/follow/put-follow.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@ PUT /<follower_index>/_ccr/follow

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

==== Authorization

If the {es} {security-features} are enabled, you must have `write` and
`manage_follow_index` index privileges for the follower index and `read` index
privileges for the leader index. You must have `manage_ccr` and `monitor`
Copy link
Member

@martijnvg martijnvg Nov 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

cluster privileges on the cluster that contains the follower index. You must
also have `monitor` cluster privileges on the cluster that contains the leader
index. For more information, see
{stack-ov}/security-privileges.html[Security privileges].

==== Example

This example creates a follower index named `follower_index`:
Expand Down