Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Minor fixes in transform documentation #51633

Merged
merged 2 commits into from
Jan 30, 2020
+31 −23
Merged

[DOCS] Minor fixes in transform documentation #51633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f549db0
[DOCS] Collapses API examples in transform tutorial
lcawl Jan 29, 2020
0185525
[DOCS] Fixes deprecation of built-in roles
lcawl Jan 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions docs/reference/transform/ecommerce-tutorial.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<<preview-transform,preview {transforms} API>>:
<<preview-transform,preview {transforms} API>>.

.API example
[%collapsible]
====
[source,console]
--------------------------------------------------
POST _transform/_preview
Expand Down Expand Up @@ -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
Expand All @@ -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
<<put-transform,create {transforms} API>>. For
example:
<<put-transform,create {transforms} API>>.

.API example
[%collapsible]
====
[source,console]
--------------------------------------------------
PUT _transform/ecommerce-customer-transform
Expand Down Expand Up @@ -209,6 +215,7 @@ PUT _transform/ecommerce-customer-transform
}
--------------------------------------------------
// TEST[skip:setup kibana sample data]
====
--

. Start the {transform}.
Expand All @@ -227,14 +234,17 @@ image::images/manage-transforms.jpg["Managing {transforms} in {kib}"]

Alternatively, you can use the
<<start-transform,start {transforms}>> and
<<stop-transform,stop {transforms}>> APIs. For
example:
<<stop-transform,stop {transforms}>> 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}
Expand Down
34 changes: 16 additions & 18 deletions x-pack/docs/en/security/authorization/built-in-roles.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<<built-in-roles-transform-admin,`transform_admin`>> 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-transform-admin,`transform_admin`>>"].

[[built-in-roles-data-frame-transforms-user]] `data_frame_transforms_user` ::
(This role is deprecated, please use the
<<built-in-roles-transform-user,`transform_user`>> 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-transform-user,`transform_user`>>"].

[[built-in-roles-enrich-user]] `enrich_user` ::
Grants access to manage *all* enrich indices (`.enrich-*`) and *all* operations on
Expand Down Expand Up @@ -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
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
Expand Down