Skip to content

Commit

Permalink
Fix manage/monitor_enrich documentation (elastic#100781)
Browse files Browse the repository at this point in the history
manage_enrich is a cluster privilege, not a built in role.
manage_enrich is already documented as a cluster privilege.
This commit remove manage_enrich from the role documentation.
This commit also makes mention of the monitor_enrich introduced in elastic#99646.

related: elastic#85877
(cherry picked from commit 1eaa907)
  • Loading branch information
jakelandis committed Oct 13, 2023
1 parent 2d69302 commit 9ba473d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
9 changes: 2 additions & 7 deletions docs/reference/security/authorization/built-in-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,6 @@ read access to the `.ml-notifications` and `.ml-anomalies*` indices
{ml-cap} users also need index privileges for source and destination
indices and roles that grant access to {kib}. See {ml-docs-setup-privileges}.

[[built-in-roles-manage-enrich]] `manage_enrich`::
Grants privileges to access and use all of the {ref}/enrich-apis.html[enrich APIs].
Users with this role can manage enrich policies that add data from your existing
indices to incoming documents during ingest.

[[built-in-roles-monitoring-user]] `monitoring_user`::
Grants the minimum privileges required for any user of {monitoring} other than those
required to use {kib}. This role grants access to the monitoring indices and grants
Expand All @@ -171,10 +166,10 @@ Reporting users should also be assigned additional roles that grant
access to the <<roles-indices-priv,indices>> that will be used to generate reports.

[[built-in-roles-rollup-admin]] `rollup_admin`::
Grants `manage_rollup` cluster privileges, which enable you to manage and execute all rollup actions.
Grants `manage_rollup` cluster privileges, which enable you to manage and execute all rollup actions.

[[built-in-roles-rollup-user]] `rollup_user`::
Grants `monitor_rollup` cluster privileges, which enable you to perform read-only operations related to rollups.
Grants `monitor_rollup` cluster privileges, which enable you to perform read-only operations related to rollups.

[[built-in-roles-snapshot-user]] `snapshot_user`::
Grants the necessary privileges to create snapshots of **all** the indices and
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/security/authorization/privileges.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,9 @@ security roles of the user who created or updated them.
All cluster read-only operations, like cluster health and state, hot threads,
node info, node and cluster stats, and pending cluster tasks.

`monitor_enrich`::
All read-only operations related to managing and executing enrich policies.

`monitor_ml`::
All read-only {ml} operations, such as getting information about {dfeeds}, jobs,
model snapshots, or results.
Expand Down

0 comments on commit 9ba473d

Please sign in to comment.