From 7f2f0b7620ff2f3d21a4e80ba5d8036323998765 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 12 Jun 2019 10:13:04 -0700 Subject: [PATCH] [DOCS] Adds dataframe authorization details (#43009) --- docs/build.gradle | 9 +++++++++ .../data-frames/apis/delete-transform.asciidoc | 14 ++++++++++++-- .../apis/get-transform-stats.asciidoc | 10 +++++++++- .../data-frames/apis/get-transform.asciidoc | 10 +++++++++- .../data-frames/apis/preview-transform.asciidoc | 12 +++++++++++- .../data-frames/apis/put-transform.asciidoc | 16 +++++++++++++--- .../data-frames/apis/start-transform.asciidoc | 11 ++++++++++- .../data-frames/apis/stop-transform.asciidoc | 10 +++++++++- 8 files changed, 82 insertions(+), 10 deletions(-) diff --git a/docs/build.gradle b/docs/build.gradle index feda444301e..08cb2de9713 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -1137,3 +1137,12 @@ buildRestTests.setups['seats'] = ''' {"theatre": "Graye", "cost": 33, "row": 2, "number": 6, "sold": false} {"index":{"_id": "4"}} {"theatre": "Skyline", "cost": 20, "row": 5, "number": 2, "sold": false}''' +buildRestTests.setups['kibana_sample_data_ecommerce'] = ''' + - do: + indices.create: + index: kibana_sample_data_ecommerce + body: + settings: + number_of_shards: 1 + number_of_replicas: 0 +''' diff --git a/docs/reference/data-frames/apis/delete-transform.asciidoc b/docs/reference/data-frames/apis/delete-transform.asciidoc index 9fb3d8558c0..77c74b95c43 100644 --- a/docs/reference/data-frames/apis/delete-transform.asciidoc +++ b/docs/reference/data-frames/apis/delete-transform.asciidoc @@ -8,6 +8,8 @@ Delete {dataframe-transforms} ++++ +beta[] + Deletes an existing {dataframe-transform}. @@ -15,14 +17,22 @@ Deletes an existing {dataframe-transform}. `DELETE _data_frame/transforms/` -//==== Description +==== Description + +NOTE: Before you can delete the {dataframe-transform}, you must stop it. ==== Path Parameters `data_frame_transform_id` (required):: (string) Identifier for the {dataframe-transform}. -//===== Authorization +==== Authorization + +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 {stack-ov}/security-privileges.html[Security privileges] and +{stack-ov}/built-in-roles.html[Built-in roles]. ==== Examples diff --git a/docs/reference/data-frames/apis/get-transform-stats.asciidoc b/docs/reference/data-frames/apis/get-transform-stats.asciidoc index 09c383f2494..822d2fa63c8 100644 --- a/docs/reference/data-frames/apis/get-transform-stats.asciidoc +++ b/docs/reference/data-frames/apis/get-transform-stats.asciidoc @@ -8,6 +8,8 @@ Get {dataframe-transform} statistics ++++ +beta[] + Retrieves usage information for {dataframe-transforms}. @@ -42,7 +44,13 @@ The API returns the following information: `transforms`:: (array) An array of statistics objects for {dataframe-transforms}. -//==== Authorization +==== Authorization + +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 {stack-ov}/security-privileges.html[Security privileges] and +{stack-ov}/built-in-roles.html[Built-in roles]. ==== Examples diff --git a/docs/reference/data-frames/apis/get-transform.asciidoc b/docs/reference/data-frames/apis/get-transform.asciidoc index e2b5c5eccb7..75f4eaf7a26 100644 --- a/docs/reference/data-frames/apis/get-transform.asciidoc +++ b/docs/reference/data-frames/apis/get-transform.asciidoc @@ -8,6 +8,8 @@ Get {dataframe-transforms} ++++ +beta[] + Retrieves configuration information for {dataframe-transforms}. @@ -53,7 +55,13 @@ The API returns the following information: `transforms`:: (array) An array of transform resources. -//==== Authorization +==== Authorization + +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 {stack-ov}/security-privileges.html[Security privileges] and +{stack-ov}/built-in-roles.html[Built-in roles]. ==== Examples diff --git a/docs/reference/data-frames/apis/preview-transform.asciidoc b/docs/reference/data-frames/apis/preview-transform.asciidoc index cf3f3cb96f9..dd8fb6d74d3 100644 --- a/docs/reference/data-frames/apis/preview-transform.asciidoc +++ b/docs/reference/data-frames/apis/preview-transform.asciidoc @@ -8,6 +8,8 @@ Preview {dataframe-transforms} ++++ +beta[] + Previews a {dataframe-transform}. @@ -17,7 +19,6 @@ Previews a {dataframe-transform}. //==== Description //==== Path Parameters -//==== Authorization ==== Request Body @@ -26,6 +27,15 @@ Previews a {dataframe-transform}. `pivot`:: Defines the pivot function `group by` fields and the aggregation to reduce the data. +==== Authorization + +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 +{dataframe-transform}. For more information, see +{stack-ov}/security-privileges.html[Security privileges] and +{stack-ov}/built-in-roles.html[Built-in roles]. ==== Examples diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index fcc86fa3237..428321aa030 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -8,6 +8,8 @@ Create {dataframe-transforms} ++++ +beta[] + Instantiates a {dataframe-transform}. @@ -44,7 +46,15 @@ reduce the data. See <Start {dataframe-transforms} ++++ +beta[] + Starts one or more {dataframe-transforms}. ==== Request @@ -24,7 +26,14 @@ Starts one or more {dataframe-transforms}. must start and end with alphanumeric characters. //==== Request Body -//==== Authorization +==== Authorization + +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 +{dataframe-transform}. For more information, see +{stack-ov}/security-privileges.html[Security privileges] and +{stack-ov}/built-in-roles.html[Built-in roles]. ==== Examples diff --git a/docs/reference/data-frames/apis/stop-transform.asciidoc b/docs/reference/data-frames/apis/stop-transform.asciidoc index 9a39d184d8c..f3e342441b0 100644 --- a/docs/reference/data-frames/apis/stop-transform.asciidoc +++ b/docs/reference/data-frames/apis/stop-transform.asciidoc @@ -8,6 +8,8 @@ Stop {dataframe-transforms} ++++ +beta[] + Stops one or more {dataframe-transforms}. ==== Request @@ -44,7 +46,13 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the `