Skip to content
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

[DOCS] Adds read_ccr and manage_ccr privileges #149

Merged
merged 4 commits into from
Nov 15, 2018
Merged

[DOCS] Adds read_ccr and manage_ccr privileges #149

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec6d225
[DOCS] Adds read_ccr and manage_ccr privileges
lcawl Nov 13, 2018
e3bc667
[DOCS] Adds manage_follow_index privilege
lcawl Nov 13, 2018
7859d38
[DOCS] Adds details for CCR privileges
lcawl Nov 13, 2018
84efa9b
[DOCS] Augments privilege descriptions
lcawl Nov 14, 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
17 changes: 17 additions & 0 deletions docs/en/stack/security/authorization/privileges.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ This includes snapshotting, updating settings, and rerouting. It also includes
obtaining snapshot and restore status. This privilege does not include the
ability to manage security.

`manage_ccr`::
All {ccr} operations related to managing follower indices and auto-follow
Copy link
Member

Choose a reason for hiding this comment

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

I would highlight that this cluster level privilege only needs to be configured in the follower cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I've added that info too!

patterns. It also includes the authority to grant the privileges necessary to
manage follower indices and auto-follow patterns. This privilege is necessary
only on clusters that contain follower indices.

`manage_index_templates`::
All operations on index templates.

Expand Down Expand Up @@ -62,6 +68,12 @@ who created or updated them.

--

`read_ccr`::
All read only {ccr} operations, such as getting information about indices and
Copy link
Member

Choose a reason for hiding this comment

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

I would highlight that this cluster level privilege only needs to be configured in the leader cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I've added that info in this PR.

metadata for leader indices in the cluster. It also includes the authority to
check whether users have the appropriate privileges to follow leader indices.
This privilege is necessary only on clusters that contain leader indices.

`transport_client`::
All privileges necessary for a transport client to connect. Required by the remote
cluster to enable <<cross-cluster-configuring,Cross Cluster Search>>.
Expand All @@ -82,6 +94,11 @@ All `monitor` privileges plus index administration (aliases, analyze, cache clea
close, delete, exists, flush, mapping, open, force merge, refresh, settings,
search shards, templates, validate).

`manage_follow_index`::
All actions that are required to manage the lifecycle of a follower index, which
includes creating a follower index, closing it, and converting it to a regular
index. This privilege is necessary only on clusters that contain follower indices.

`view_index_metadata`::
Read-only access to index metadata (aliases, aliases exists, get index, exists, field mappings,
mappings, search shards, type exists, validate, warmers, settings). This
Expand Down