Skip to content

Commit

Permalink
[DOCS] Clarifies machine learning built-in roles (#51504)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Feb 12, 2020
1 parent 5e0ced5 commit a3cfa5a
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions x-pack/docs/en/security/authorization/built-in-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,22 @@ suitable for use within a Logstash pipeline.
--

[[built-in-roles-ml-admin]] `machine_learning_admin`::
Grants `manage_ml` cluster privileges, read access to `.ml-anomalies*`,
`.ml-notifications*`, `.ml-state*`, `.ml-meta*` indices and write access to
`.ml-annotations*` indices. This role also includes all
{kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.
Provides all of the privileges of the `machine_learning_user` role plus the full
use of the {ml} APIs. Grants `manage_ml` cluster privileges, read access to
`.ml-anomalies*`, `.ml-notifications*`, `.ml-state*`, `.ml-meta*` indices and
write access to `.ml-annotations*` indices. {ml-cap} administrators also need
index privileges for source and destination indices and roles that grant
access to {kib}.
See {ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges].

[[built-in-roles-ml-user]] `machine_learning_user`::
Grants the minimum privileges required to view {ml} configuration,
status, and work with results. This role grants `monitor_ml` cluster privileges,
read access to the `.ml-notifications` and `.ml-anomalies*` indices
(which store {ml} results), and write access to `.ml-annotations*` indices.
This role also includes all {kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.
{ml-cap} users also need index privileges for source and destination
indices and roles that grant access to {kib}. See
{ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges].

[[built-in-roles-monitoring-user]] `monitoring_user`::
Grants the minimum privileges required for any user of {monitoring} other than those
Expand Down

0 comments on commit a3cfa5a

Please sign in to comment.