From 7dc1ba4273a79856e09832cc1076c417cf5ae43e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 6 Apr 2020 17:06:22 +0200 Subject: [PATCH] [DOCS] Updates transform prerequisites (#54804) --- .../transform/apis/delete-transform.asciidoc | 13 +++++++++---- .../apis/get-transform-stats.asciidoc | 12 ++++++++---- .../transform/apis/get-transform.asciidoc | 12 ++++++++---- .../transform/apis/preview-transform.asciidoc | 15 ++++++++++----- .../transform/apis/put-transform.asciidoc | 18 ++++++++++++------ .../transform/apis/start-transform.asciidoc | 12 ++++++++---- .../transform/apis/stop-transform.asciidoc | 12 ++++++++---- .../transform/apis/update-transform.asciidoc | 17 +++++++++++------ 8 files changed, 74 insertions(+), 37 deletions(-) diff --git a/docs/reference/transform/apis/delete-transform.asciidoc b/docs/reference/transform/apis/delete-transform.asciidoc index 32db7cf0428..9f304fc66c7 100644 --- a/docs/reference/transform/apis/delete-transform.asciidoc +++ b/docs/reference/transform/apis/delete-transform.asciidoc @@ -19,10 +19,15 @@ Deletes an existing {transform}. ==== {api-prereq-title} * 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 -these privileges. For more information, see <> and -<>. + +If the {es} {security-features} are enabled, you must have the following +privileges: + +* `manage_transform` + +The built-in `transform_admin` role has this privilege. + +For more information, see <> and <>. [[delete-transform-path-parms]] diff --git a/docs/reference/transform/apis/get-transform-stats.asciidoc b/docs/reference/transform/apis/get-transform-stats.asciidoc index 6c421d58187..f30cf385f57 100644 --- a/docs/reference/transform/apis/get-transform-stats.asciidoc +++ b/docs/reference/transform/apis/get-transform-stats.asciidoc @@ -28,10 +28,14 @@ Retrieves usage information for {transforms}. [[get-transform-stats-prereqs]] ==== {api-prereq-title} -* 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 <> and -<>. +If the {es} {security-features} are enabled, you must have the following +privileges: + +* `monitor_transform` + +The built-in `transform_user` role has this privilege. + +For more information, see <> and <>. [[get-transform-stats-desc]] diff --git a/docs/reference/transform/apis/get-transform.asciidoc b/docs/reference/transform/apis/get-transform.asciidoc index fe0bb68d85e..50ec3b36344 100644 --- a/docs/reference/transform/apis/get-transform.asciidoc +++ b/docs/reference/transform/apis/get-transform.asciidoc @@ -26,10 +26,14 @@ Retrieves configuration information for {transforms}. [[get-transform-prereqs]] ==== {api-prereq-title} -* 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 <> and -<>. +If the {es} {security-features} are enabled, you must have the following +privileges: + +* `monitor_transform` + +The built-in `transform_user` role has this privilege. + +For more information, see <> and <>. [[get-transform-desc]] ==== {api-description-title} diff --git a/docs/reference/transform/apis/preview-transform.asciidoc b/docs/reference/transform/apis/preview-transform.asciidoc index e06199169c1..f764d9ecee8 100644 --- a/docs/reference/transform/apis/preview-transform.asciidoc +++ b/docs/reference/transform/apis/preview-transform.asciidoc @@ -18,11 +18,16 @@ Previews a {transform}. [[preview-transform-prereq]] ==== {api-prereq-title} -* 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 -<> and <>. +If the {es} {security-features} are enabled, you must have the following +privileges: + +* `manage_transform` +* source index: `read`, `view_index_metadata` + +The built-in `transform_admin` role has the `manage_transform` privilege. + +For more information, see <> and <>. + [[preview-transform-desc]] ==== {api-description-title} diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index 4192b08e449..1a042559e17 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -18,12 +18,18 @@ Instantiates a {transform}. [[put-transform-prereqs]] ==== {api-prereq-title} -* 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 <> and -<>. +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: + +* `transform_admin` +* `kibana_admin` (UI only) + +* source index: `read`, `view_index_metadata` +* destination index: `read`, `create_index`, `manage` and `index` +* cluster: `monitor` (UI only) + +For more information, see <> and <>. + [[put-transform-desc]] ==== {api-description-title} diff --git a/docs/reference/transform/apis/start-transform.asciidoc b/docs/reference/transform/apis/start-transform.asciidoc index c2d3b9dc4a7..7b404203c3c 100644 --- a/docs/reference/transform/apis/start-transform.asciidoc +++ b/docs/reference/transform/apis/start-transform.asciidoc @@ -18,10 +18,14 @@ Starts one or more {transforms}. [[start-transform-prereqs]] ==== {api-prereq-title} -* 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 -<> and <>. +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: + +* `manage_transform` +* source index: `view_index_metadata` + +For more information, see <> and <>. + [[start-transform-desc]] ==== {api-description-title} diff --git a/docs/reference/transform/apis/stop-transform.asciidoc b/docs/reference/transform/apis/stop-transform.asciidoc index 1e0f2b01cd2..33f9a7b3720 100644 --- a/docs/reference/transform/apis/stop-transform.asciidoc +++ b/docs/reference/transform/apis/stop-transform.asciidoc @@ -24,10 +24,14 @@ Stops one or more {transforms}. [[stop-transform-prereq]] ==== {api-prereq-title} -* 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 <> and -<>. +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: + +* `manage_transform` + +The built-in `transform_admin` role has this privilege. + +For more information, see <> and <>. [[stop-transform-desc]] diff --git a/docs/reference/transform/apis/update-transform.asciidoc b/docs/reference/transform/apis/update-transform.asciidoc index afe7e9b549b..331bb9acc8b 100644 --- a/docs/reference/transform/apis/update-transform.asciidoc +++ b/docs/reference/transform/apis/update-transform.asciidoc @@ -18,12 +18,17 @@ Updates certain properties of a {transform}. [[update-transform-prereqs]] ==== {api-prereq-title} -* 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 -<> and <>. +If the {es} {security-features} are enabled, you must have the following +built-in roles and privileges: + +* `transform_admin` + +* `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 <> and <>. + [[update-transform-desc]] ==== {api-description-title}