Skip to content

Commit

Permalink
[DOCS] Applies rename of transform related roles and privileges (elas…
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Oct 17, 2019
1 parent e905af1 commit e5af8bb
Show file tree
Hide file tree
Showing 11 changed files with 60 additions and 48 deletions.
8 changes: 4 additions & 4 deletions docs/reference/transform/apis/delete-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ beta[]
==== {api-prereq-title}

* Before you can delete the {transform}, you must stop it.
* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>.


[[delete-transform-path-parms]]
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/transform/apis/get-transform-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ beta[]
[[get-transform-stats-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_user` role has these privileges. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `monitor_transform`
cluster privileges to use this API. The built-in `transform_user` role has these
privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>.


[[get-transform-stats-desc]]
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/transform/apis/get-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ beta[]
[[get-transform-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_user` role has these privileges. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `monitor_transform`
cluster privileges to use this API. The built-in `transform_user` role has these
privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>.

[[get-transform-desc]]
==== {api-description-title}
Expand Down
11 changes: 5 additions & 6 deletions docs/reference/transform/apis/preview-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,11 @@ beta[]
[[preview-transform-prereq]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. You must also have
`read` and `view_index_metadata` privileges on the source index for the
{transform}. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. You must also have `read` and `view_index_metadata` privileges
on the source index for the {transform}. For more information, see
<<security-privileges>> and <<built-in-roles>>.

[[preview-transform-desc]]
==== {api-description-title}
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/transform/apis/put-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ beta[]
[[put-transform-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. You must also
have `read` and `view_index_metadata` privileges on the source index and `read`,
`create_index`, and `index` privileges on the destination index. For more
information, see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. You must also have `read` and `view_index_metadata` privileges
on the source index and `read`, `create_index`, and `index` privileges on the
destination index. For more information, see <<security-privileges>> and
<<built-in-roles>>.

[[put-transform-desc]]
==== {api-description-title}
Expand Down
9 changes: 4 additions & 5 deletions docs/reference/transform/apis/start-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@ beta[]
[[start-transform-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. You must also
have `view_index_metadata` privileges on the source index for the
{transform}. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. You must also have `view_index_metadata`
privileges on the source index for the {transform}. For more information, see
<<security-privileges>> and <<built-in-roles>>.

[[start-transform-desc]]
==== {api-description-title}
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/transform/apis/stop-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ beta[]
[[stop-transform-prereq]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. For more information,
see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>.


[[stop-transform-desc]]
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/transform/apis/update-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ beta[]
[[update-transform-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_admin` role has these privileges. You must also
have `read` and `view_index_metadata` privileges on the source index and `read`,
`create_index`, and `index` privileges on the destination index. For more
information, see <<security-privileges>> and <<built-in-roles>>.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. You must also have `read` and `view_index_metadata`
privileges on the source index and `read`, `create_index`, and `index`
privileges on the destination index. For more information, see
<<security-privileges>> and <<built-in-roles>>.

[[update-transform-desc]]
==== {api-description-title}
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/transform/ecommerce-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ pivot and summarize your data with {transforms}.
privileges to complete these steps.
+
--
You need `manage_data_frame_transforms` cluster privileges to preview and create
{transforms}. Members of the built-in `data_frame_transforms_admin`
role have these privileges.
You need `manage_transform` cluster privileges to preview and create
{transforms}. Members of the built-in `transform_admin` role have these
privileges.

You also need `read` and `view_index_metadata` index privileges on the source
index and `read`, `create_index`, and `index` privileges on the destination
Expand Down
22 changes: 18 additions & 4 deletions x-pack/docs/en/security/authorization/built-in-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,28 @@ suitable for writing beats output to {es}.

--

[[built-in-roles-transform-admin]] `transform_admin` ::
Grants `manage_transform` cluster privileges, which enable you to manage
{transforms}. This role also includes all
{kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.

[[built-in-roles-transform-user]] `transform_user` ::
Grants `monitor_transform` cluster privileges, which enable you to use
{transforms}. This role also includes all
{kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.

[[built-in-roles-data-frame-transforms-admin]] `data_frame_transforms_admin` ::
Grants `manage_data_frame_transforms` cluster privileges, which enable you to
manage {transforms}. This role also includes all
(This role is deprecated, please use the
<<built-in-roles-transform-admin,`transform_admin`>> role instead.) Grants
`manage_data_frame_transforms` cluster privileges, which enable you to manage
{transforms}. This role also includes all
{kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.

[[built-in-roles-data-frame-transforms-user]] `data_frame_transforms_user` ::
Grants `monitor_data_fram_transforms` cluster privileges, which enable you to
use {transforms}. This role also includes all
(This role is deprecated, please use the
<<built-in-roles-transform-user,`transform_user`>> role instead.) Grants
`monitor_data_frame_transforms` cluster privileges, which enable you to use
{transforms}. This role also includes all
{kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.

[[built-in-roles-enrich-user]] `enrich_user` ::
Expand Down
4 changes: 2 additions & 2 deletions x-pack/docs/en/security/authorization/privileges.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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_data_frame_transforms`::
`manage_transform`::
All operations related to managing {transforms}.

`manage_ilm`::
Expand Down Expand Up @@ -119,7 +119,7 @@ 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_data_frame_transforms`::
`monitor_transform`::
All read-only operations related to {transforms}.

`monitor_ml`::
Expand Down

0 comments on commit e5af8bb

Please sign in to comment.