[DOCS] Updates data frame security details (#39009)

This commit is contained in:
Lisa Cawley 2019-06-14 11:33:45 -07:00 committed by GitHub
parent b7d94b8b4c
commit c1a88c6d85
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -18,20 +18,29 @@ Once you have created the pivot, add a job ID and define the index for the
transformed data (_target index_). If the target index does not exist, it will be
created automatically. You can optionally select to create a {kib} index pattern
for the target index. At the end of the process, a {dataframe} job is created as
a result. After you create {dataframe} jobs, you can start, stop, and delete them
and explore their progress and statistics from the jobs list.
a result.
[role="screenshot"]
image::ml/images/ml-jobid.jpg["Job ID and target index"]
After you create {dataframe} jobs, you can start, stop, and delete them
and explore their progress and statistics from the jobs list.
[NOTE]
===============================
If you want to use the {dataframe-transforms} feature, you must have the required
user roles and permissions:
If {stack} {security-features} are enabled, you must have appropriate authority
to work with {dataframes}. For example, there are built-in
`data_frame_transforms_admin` and `data_frame_transforms_user` roles that have
`manage_data_frame_transforms` and `monitor_data_frame_transforms` cluster
privileges respectively. See
{stack-ov}/built-in-roles.html[Built-in roles] and
{stack-ov}/security-privileges.html[Security privileges].
Depending on what tasks you perform, you might require additional privileges.
For example, to create a {dataframe-transform} and generate new target index,
you need `manage_data_frame_transforms` cluster privileges, `read` and
`view_index_metadata` privileges on the source index, and `read`, `create_index`,
and `index` privileges on the target index. For more information, see the
authorization details for each {ref}/data-frame-apis.html[{dataframe} API].
* `data_frame_transforms_user`: to get transforms and transforms stats,
* `data_frame_transforms_admin`: to create/start/stop/delete transforms,
* read permissions and `view_index_metadata` on the source indices,
* index and read permissions on the target index (if the target index does not
exist, you need permission to create the index as well).
===============================