[DOCS] Updates transform prerequisites (#54804)

This commit is contained in:
István Zoltán Szabó 2020-04-06 17:06:22 +02:00
parent def519ea70
commit 7dc1ba4273
8 changed files with 74 additions and 37 deletions

View File

@ -19,10 +19,15 @@ Deletes an existing {transform}.
==== {api-prereq-title} ==== {api-prereq-title}
* Before you can delete the {transform}, you must stop it. * Before you can delete the {transform}, you must stop it.
* 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 If the {es} {security-features} are enabled, you must have the following
these privileges. For more information, see <<security-privileges>> and privileges:
<<built-in-roles>>.
* `manage_transform`
The built-in `transform_admin` role has this privilege.
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[delete-transform-path-parms]] [[delete-transform-path-parms]]

View File

@ -28,10 +28,14 @@ Retrieves usage information for {transforms}.
[[get-transform-stats-prereqs]] [[get-transform-stats-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `monitor_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_user` role has these privileges:
privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>. * `monitor_transform`
The built-in `transform_user` role has this privilege.
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[get-transform-stats-desc]] [[get-transform-stats-desc]]

View File

@ -26,10 +26,14 @@ Retrieves configuration information for {transforms}.
[[get-transform-prereqs]] [[get-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `monitor_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_user` role has these privileges:
privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>. * `monitor_transform`
The built-in `transform_user` role has this privilege.
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[get-transform-desc]] [[get-transform-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,11 +18,16 @@ Previews a {transform}.
[[preview-transform-prereq]] [[preview-transform-prereq]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_admin` role has privileges:
these privileges. You must also have `read` and `view_index_metadata` privileges
on the source index for the {transform}. For more information, see * `manage_transform`
<<security-privileges>> and <<built-in-roles>>. * source index: `read`, `view_index_metadata`
The built-in `transform_admin` role has the `manage_transform` privilege.
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[preview-transform-desc]] [[preview-transform-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,12 +18,18 @@ Instantiates a {transform}.
[[put-transform-prereqs]] [[put-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_admin` role has built-in roles and privileges:
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 * `transform_admin`
destination index. For more information, see <<security-privileges>> and * `kibana_admin` (UI only)
<<built-in-roles>>.
* source index: `read`, `view_index_metadata`
* destination index: `read`, `create_index`, `manage` and `index`
* cluster: `monitor` (UI only)
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[put-transform-desc]] [[put-transform-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,10 +18,14 @@ Starts one or more {transforms}.
[[start-transform-prereqs]] [[start-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. You must also have `view_index_metadata` built-in roles and privileges:
privileges on the source index for the {transform}. For more information, see
<<security-privileges>> and <<built-in-roles>>. * `manage_transform`
* source index: `view_index_metadata`
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[start-transform-desc]] [[start-transform-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -24,10 +24,14 @@ Stops one or more {transforms}.
[[stop-transform-prereq]] [[stop-transform-prereq]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_admin` role has built-in roles and privileges:
these privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>. * `manage_transform`
The built-in `transform_admin` role has this privilege.
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[stop-transform-desc]] [[stop-transform-desc]]

View File

@ -18,12 +18,17 @@ Updates certain properties of a {transform}.
[[update-transform-prereqs]] [[update-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_transform` If the {es} {security-features} are enabled, you must have the following
cluster privileges to use this API. The built-in `transform_admin` role has built-in roles and privileges:
these privileges. You must also have `read` and `view_index_metadata`
privileges on the source index and `read`, `create_index`, and `index` * `transform_admin`
privileges on the destination index. For more information, see
<<security-privileges>> and <<built-in-roles>>. * `manage_transform` (the built-in `transform_admin` role has this privilege)
* source index: `read`, `view_index_metadata`
* destination index: `read`, `create_index`, `index`
For more information, see <<security-privileges>> and <<built-in-roles>>.
[[update-transform-desc]] [[update-transform-desc]]
==== {api-description-title} ==== {api-description-title}