From 78209188bcc77ad8685fbc161ea391984f8b0fee Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 21 Nov 2018 15:01:59 -0800 Subject: [PATCH] [DOCS] Adds more authorization info for CCR APIs (#35606) --- .../apis/auto-follow/delete-auto-follow-pattern.asciidoc | 6 ++++++ .../ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc | 6 ++++++ .../ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc | 8 ++++++++ docs/reference/ccr/apis/follow/get-follow-stats.asciidoc | 6 ++++++ docs/reference/ccr/apis/follow/post-unfollow.asciidoc | 6 ++++++ docs/reference/ccr/apis/get-ccr-stats.asciidoc | 6 ++++++ 6 files changed, 38 insertions(+) diff --git a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc index 911f0801cb3..ce843f332c6 100644 --- a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc @@ -48,6 +48,12 @@ DELETE /_ccr/auto_follow/ `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 diff --git a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc index 253087776dc..b154f6b907e 100644 --- a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc @@ -64,6 +64,12 @@ GET /_ccr/auto_follow/ 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 diff --git a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc index f84c36be853..0b81fa57a40 100644 --- a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc @@ -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`: diff --git a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc index e484b9d3d1c..a2f9a22881d 100644 --- a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc @@ -179,6 +179,12 @@ Continuing with the fields from `shards`: task; in this situation, the following task must be resumed manually with the <> +==== 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: diff --git a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc index 1687b9e7b41..1bc2c3ef288 100644 --- a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc @@ -54,6 +54,12 @@ POST //_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 diff --git a/docs/reference/ccr/apis/get-ccr-stats.asciidoc b/docs/reference/ccr/apis/get-ccr-stats.asciidoc index 2a452e2befd..df4451bfcfb 100644 --- a/docs/reference/ccr/apis/get-ccr-stats.asciidoc +++ b/docs/reference/ccr/apis/get-ccr-stats.asciidoc @@ -80,6 +80,12 @@ This object consists of the following fields: to the details of the response in the <> +==== 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: