[DOCS] Adds authorization info for CCR APIs #35557
Conversation
lcawl
added
>docs
|
Pinging @elastic/es-distributed |
martijnvg
left a comment
martijnvg
left a comment
There was a problem hiding this comment.
I left two comments - LGTM otherwise.
|
|
||
| ==== Authorization | ||
|
|
||
| If the {es} {security-features} are enabled, to use this API you must have |
There was a problem hiding this comment.
Also the monitor privilege is needed in both clusters.
|
|
||
| ==== Authorization | ||
|
|
||
| If the {es} {security-features} are enabled, to use this API you must have |
There was a problem hiding this comment.
Sorry, I should have better described my comment in the other PR, but in the case of pause follow, only manage_ccr is needed. The reason is that it just stops the follow tasks. (resume follow is different as it start shard following and then uses the privileges of the user that invoked resume follow api to read from leader and write in into follower)
|
@lcawl I just realized that it would be good if |
|
@martijnvg I've updated the authorization text (and added it for put-follow.asciidoc). When you have a moment, can you take another look? |
martijnvg
left a comment
martijnvg
left a comment
There was a problem hiding this comment.
I left a small note. Otherwise 👍 and thanks for documenting this!
|
|
||
| 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 |
There was a problem hiding this comment.
The monitor indices privilege in both clusters is needed instead of monitor cluster privilege.
There was a problem hiding this comment.
Thanks! I've fixed those details
|
|
||
| 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` |
|
retest this please |
|
Verified successful gradlew checks |
4 participants
Related to elastic/stack-docs#149 (comment)
This PR adds an "Authorization" section to two cross-cluster replication APIs, similar to what exists for other X-Pack APIs. The other CCR APIs can be augmented in subsequent PRs.