[DOCS] Minor fixes in transform documentation (#51633)

This commit is contained in:
Lisa Cawley 2020-01-29 16:52:40 -08:00 committed by lcawl
parent cf5a2269a5
commit 28f2f3dd02
2 changed files with 31 additions and 23 deletions

View File

@ -79,8 +79,11 @@ If you want to use more complex queries, you can create your {dataframe} from a
{kibana-ref}/save-open-search.html[saved search]. {kibana-ref}/save-open-search.html[saved search].
If you prefer, you can use the If you prefer, you can use the
<<preview-transform,preview {transforms} API>>: <<preview-transform,preview {transforms} API>>.
.API example
[%collapsible]
====
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
POST _transform/_preview POST _transform/_preview
@ -129,6 +132,7 @@ POST _transform/_preview
} }
-------------------------------------------------- --------------------------------------------------
// TEST[skip:set up sample data] // TEST[skip:set up sample data]
====
-- --
. When you are satisfied with what you see in the preview, create the . When you are satisfied with what you see in the preview, create the
@ -151,9 +155,11 @@ entities have changed. In general, it's a good idea to use the ingest timestamp
field. In this example, however, you can use the `order_date` field. field. In this example, however, you can use the `order_date` field.
If you prefer, you can use the If you prefer, you can use the
<<put-transform,create {transforms} API>>. For <<put-transform,create {transforms} API>>.
example:
.API example
[%collapsible]
====
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
PUT _transform/ecommerce-customer-transform PUT _transform/ecommerce-customer-transform
@ -209,6 +215,7 @@ PUT _transform/ecommerce-customer-transform
} }
-------------------------------------------------- --------------------------------------------------
// TEST[skip:setup kibana sample data] // TEST[skip:setup kibana sample data]
====
-- --
. Start the {transform}. . Start the {transform}.
@ -227,14 +234,17 @@ image::images/manage-transforms.jpg["Managing {transforms} in {kib}"]
Alternatively, you can use the Alternatively, you can use the
<<start-transform,start {transforms}>> and <<start-transform,start {transforms}>> and
<<stop-transform,stop {transforms}>> APIs. For <<stop-transform,stop {transforms}>> APIs.
example:
.API example
[%collapsible]
====
[source,console] [source,console]
-------------------------------------------------- --------------------------------------------------
POST _transform/ecommerce-customer-transform/_start POST _transform/ecommerce-customer-transform/_start
-------------------------------------------------- --------------------------------------------------
// TEST[skip:setup kibana sample data] // TEST[skip:setup kibana sample data]
====
TIP: If you chose a batch {transform}, it is a single operation that has a TIP: If you chose a batch {transform}, it is a single operation that has a
single checkpoint. You cannot restart it when it's complete. {ctransforms-cap} single checkpoint. You cannot restart it when it's complete. {ctransforms-cap}

View File

@ -37,29 +37,17 @@ 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` :: [[built-in-roles-data-frame-transforms-admin]] `data_frame_transforms_admin` ::
(This role is deprecated, please use the Grants `manage_data_frame_transforms` cluster privileges, which enable you to
<<built-in-roles-transform-admin,`transform_admin`>> role instead.) Grants manage {transforms}. This role also includes all
`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}. {kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.
deprecated:[7.5.0,"Replaced by <<built-in-roles-transform-admin,`transform_admin`>>"].
[[built-in-roles-data-frame-transforms-user]] `data_frame_transforms_user` :: [[built-in-roles-data-frame-transforms-user]] `data_frame_transforms_user` ::
(This role is deprecated, please use the Grants `monitor_data_frame_transforms` cluster privileges, which enable you to
<<built-in-roles-transform-user,`transform_user`>> role instead.) Grants use {transforms}. This role also includes all
`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}. {kibana-ref}/kibana-privileges.html[Kibana privileges] for the {ml-features}.
deprecated:[7.5.0,"Replaced by <<built-in-roles-transform-user,`transform_user`>>"].
[[built-in-roles-enrich-user]] `enrich_user` :: [[built-in-roles-enrich-user]] `enrich_user` ::
Grants access to manage *all* enrich indices (`.enrich-*`) and *all* operations on Grants access to manage *all* enrich indices (`.enrich-*`) and *all* operations on
@ -167,6 +155,16 @@ the `superuser` role can also manage users and roles and
<<run-as-privilege, impersonate>> any other user in the system. Due to the <<run-as-privilege, impersonate>> any other user in the system. Due to the
permissive nature of this role, take extra care when assigning it to a user. permissive nature of this role, take extra care when assigning it to a user.
[[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-transport-client]] `transport_client`:: [[built-in-roles-transport-client]] `transport_client`::
Grants the privileges required to access the cluster through the Java Transport Grants the privileges required to access the cluster through the Java Transport
Client. The Java Transport Client fetches information about the nodes in the Client. The Java Transport Client fetches information about the nodes in the