Skip to content

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

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 more authorization info for CCR APIs #35606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f273830
[DOCS] Drafts authorization info for CCR APIs
lcawl Nov 15, 2018
2fa49d9
[DOCS] Updated authorization details
lcawl Nov 21, 2018
6b30429
[DOCS] More edits to authorization
lcawl Nov 21, 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
6 changes: 6 additions & 0 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 @@ -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
Expand Down
6 changes: 6 additions & 0 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 @@ -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
Expand Down
8 changes: 8 additions & 0 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 @@ -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`:
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/ccr/apis/follow/get-follow-stats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/ccr/apis/follow/post-unfollow.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Copy link
Member

@martijnvg martijnvg Nov 21, 2018

Choose a reason for hiding this comment

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

only manage_follow_index is needed in the follower cluster.

Copy link
Contributor Author

@lcawl lcawl Nov 21, 2018

Choose a reason for hiding this comment

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

Done, thanks!

index privileges for the follower index. For more information, see
{stack-ov}/security-privileges.html[Security privileges].

==== Example

Expand Down
8 changes: 7 additions & 1 deletion docs/reference/ccr/apis/get-ccr-stats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[[ccr-get-stats]]
=== Get Cross-Cluster Replication Stats API
++++
<titleabbrev>Get Follower Stats</titleabbrev>
<titleabbrev>Get CCR Stats</titleabbrev>
++++

beta[]
Expand Down Expand Up @@ -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:
Expand Down