From 28f2f3dd02a2156af2599bf6122bbf00b69f9db0 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 29 Jan 2020 16:52:40 -0800 Subject: [PATCH] [DOCS] Minor fixes in transform documentation (#51633) --- .../transform/ecommerce-tutorial.asciidoc | 20 ++++++++--- .../authorization/built-in-roles.asciidoc | 34 +++++++++---------- 2 files changed, 31 insertions(+), 23 deletions(-) diff --git a/docs/reference/transform/ecommerce-tutorial.asciidoc b/docs/reference/transform/ecommerce-tutorial.asciidoc index 6f4653480f2..99391438aae 100644 --- a/docs/reference/transform/ecommerce-tutorial.asciidoc +++ b/docs/reference/transform/ecommerce-tutorial.asciidoc @@ -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]. If you prefer, you can use the -<>: +<>. +.API example +[%collapsible] +==== [source,console] -------------------------------------------------- POST _transform/_preview @@ -129,6 +132,7 @@ POST _transform/_preview } -------------------------------------------------- // TEST[skip:set up sample data] +==== -- . 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. If you prefer, you can use the -<>. For -example: +<>. +.API example +[%collapsible] +==== [source,console] -------------------------------------------------- PUT _transform/ecommerce-customer-transform @@ -209,6 +215,7 @@ PUT _transform/ecommerce-customer-transform } -------------------------------------------------- // TEST[skip:setup kibana sample data] +==== -- . Start the {transform}. @@ -227,14 +234,17 @@ image::images/manage-transforms.jpg["Managing {transforms} in {kib}"] Alternatively, you can use the <> and -<> APIs. For -example: +<> APIs. +.API example +[%collapsible] +==== [source,console] -------------------------------------------------- POST _transform/ecommerce-customer-transform/_start -------------------------------------------------- // TEST[skip:setup kibana sample data] +==== 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} diff --git a/x-pack/docs/en/security/authorization/built-in-roles.asciidoc b/x-pack/docs/en/security/authorization/built-in-roles.asciidoc index 60043e62f94..154864edf79 100644 --- a/x-pack/docs/en/security/authorization/built-in-roles.asciidoc +++ b/x-pack/docs/en/security/authorization/built-in-roles.asciidoc @@ -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` :: -(This role is deprecated, please use the -<> role instead.) Grants -`manage_data_frame_transforms` cluster privileges, which enable you to manage -{transforms}. This role also includes all +Grants `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}. +deprecated:[7.5.0,"Replaced by <>"]. [[built-in-roles-data-frame-transforms-user]] `data_frame_transforms_user` :: -(This role is deprecated, please use the -<> role instead.) Grants -`monitor_data_frame_transforms` cluster privileges, which enable you to use -{transforms}. This role also includes all +Grants `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}. +deprecated:[7.5.0,"Replaced by <>"]. [[built-in-roles-enrich-user]] `enrich_user` :: 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 <> any other user in the system. Due to the 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`:: Grants the privileges required to access the cluster through the Java Transport Client. The Java Transport Client fetches information about the nodes in the