[ML] fix transform privilege requirements documentation (#85544)

This updates the privileges required when a retention_policy is configured.

See related PR: #85413
This commit is contained in:
Benjamin Trent 2022-03-31 09:41:26 -04:00 committed by GitHub
parent 6c9ffb6618
commit 463a3bb41e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 10 deletions

View file

@ -19,10 +19,11 @@ Updates certain properties of a {transform}.
Requires the following privileges:
* cluster: `manage_transform` (the `transform_admin` built-in role grants this
* cluster: `manage_transform` (the `transform_admin` built-in role grants this
privilege)
* source indices: `read`, `view_index_metadata`
* destination index: `read`, `index`.
* destination index: `read`, `index`. If a `retention_policy` is configured, `delete` index privilege is
also required.
[[update-transform-desc]]

View file

@ -24,7 +24,7 @@ To use {transforms}, you must have:
[[transform-privileges]]
== Security privileges
Assigning security privileges affects how users access {transforms}. Consider
Assigning security privileges affects how users access {transforms}. Consider
the two main categories:
* *<<transform-es-security-privileges>>*: uses an {es} client, cURL, or {kib}
@ -42,7 +42,8 @@ To _manage_ {transforms}, you must meet all of the following requirements:
* `transform_admin` built-in role or `manage_transform` cluster privileges,
* `read` and `view_index_metadata` index privileges on source indices, and
* `create_index`, `index`, `manage`, and `read` index privileges on destination
indices
indices. If a `retention_policy` is configured, `delete` index privilege is
also required on the destination index.
To view only the configuration and status of {transforms}, you must have:
@ -68,7 +69,8 @@ views already exist for your destination indices),
* data views for your source indices,
* `read` and `view_index_metadata` index privileges on source indices, and
* `create_index`, `index`, `manage`, and `read` index privileges on destination
indices
indices. Additionally, when using a `retention_policy`, `delete` index privilege is required
on destination indices.
* `read_pipeline` cluster privileges, if the {transform} uses an ingest pipeline
Within a {kib} space, for read-only access to {transforms}, you must meet all of
@ -81,7 +83,7 @@ the following requirements:
for at least one feature in the space,
* data views for your source and destination indices, and
* `read`, and `view_index_metadata` index privileges on source indices and
destination indices
destination indices
For more information and {kib} security features, see
{kibana-ref}/kibana-role-management.html[{kib} role management] and
@ -92,11 +94,11 @@ For more information and {kib} security features, see
[[transform-kib-spaces]]
== {kib} spaces
{kibana-ref}/xpack-spaces.html[Spaces] enable you to organize your source and
destination indices and other saved objects in {kib} and to see only the objects
that belong to your space. However, this limited scope does not apply to
{kibana-ref}/xpack-spaces.html[Spaces] enable you to organize your source and
destination indices and other saved objects in {kib} and to see only the objects
that belong to your space. However, this limited scope does not apply to
{transforms}; they are visible in all spaces.
To successfully create {transforms} in {kib}, you must be logged into a space
where the source indices are visible and the `Data View Management` and
`Stack Monitoring` features are visible.
`Stack Monitoring` features are visible.