[DOCS] Adds dataframe authorization details (#43009)

This commit is contained in:
Lisa Cawley 2019-06-12 10:13:04 -07:00 committed by lcawl
parent 597ae5c7b8
commit 7f2f0b7620
8 changed files with 82 additions and 10 deletions

View File

@ -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
'''

View File

@ -8,6 +8,8 @@
<titleabbrev>Delete {dataframe-transforms}</titleabbrev>
++++
beta[]
Deletes an existing {dataframe-transform}.
@ -15,14 +17,22 @@ Deletes an existing {dataframe-transform}.
`DELETE _data_frame/transforms/<data_frame_transform_id>`
//==== 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

View File

@ -8,6 +8,8 @@
<titleabbrev>Get {dataframe-transform} statistics</titleabbrev>
++++
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

View File

@ -8,6 +8,8 @@
<titleabbrev>Get {dataframe-transforms}</titleabbrev>
++++
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

View File

@ -8,6 +8,8 @@
<titleabbrev>Preview {dataframe-transforms}</titleabbrev>
++++
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

View File

@ -8,6 +8,8 @@
<titleabbrev>Create {dataframe-transforms}</titleabbrev>
++++
beta[]
Instantiates a {dataframe-transform}.
@ -44,7 +46,15 @@ reduce the data. See <<data-frame-transform-pivot, data frame transform pivot ob
`description`:: Optional free text description of the data frame 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. 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 {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].
==== Examples
@ -88,7 +98,7 @@ PUT _data_frame/transforms/ecommerce_transform
}
--------------------------------------------------
// CONSOLE
// TEST[skip:add sample kibana data]
// TEST[setup:kibana_sample_data_ecommerce]
When the transform is created, you receive the following results:
[source,js]
@ -97,4 +107,4 @@ When the transform is created, you receive the following results:
"acknowledged" : true
}
----
// NOTCONSOLE
// TESTRESPONSE

View File

@ -8,6 +8,8 @@
<titleabbrev>Start {dataframe-transforms}</titleabbrev>
++++
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

View File

@ -8,6 +8,8 @@
<titleabbrev>Stop {dataframe-transforms}</titleabbrev>
++++
beta[]
Stops one or more {dataframe-transforms}.
==== Request
@ -44,7 +46,13 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the `<data_f
eventually moves the job to `STOPPED`. The timeout simply means the API call itself timed out while waiting for the status change. Defaults to `30s`
//==== Request Body
//==== 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