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.

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: remove apm_user #98401

Merged
merged 2 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
87 changes: 54 additions & 33 deletions docs/apm/apm-app-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<titleabbrev>Users and privileges</titleabbrev>
++++

You can use role-based access control to grant users access to secured
Use role-based access control to grant users access to secured
resources. The roles that you set up depend on your organization's security
requirements and the minimum privileges required to use specific features.

Expand All @@ -24,6 +24,13 @@ In general, there are three types of privileges you'll work with:
* **Elasticsearch index privileges**: Control access to the data in specific indices your cluster.
* **Kibana space privileges**: Grant users write or read access to features and apps within Kibana.

Select your use-case to get started:

* <<apm-app-reader>>
* <<apm-app-annotation-user-create>>
* <<apm-app-central-config-user>>
* <<apm-app-api-user>>

////
*********************************** ***********************************
////
Expand All @@ -36,13 +43,25 @@ In general, there are three types of privileges you'll work with:
<titleabbrev>Create an APM reader user</titleabbrev>
++++

APM reader users typically need to view the APM app and dashboards and visualizations that use APM data.
These users might also need to create and edit dashboards, visualizations, and machine learning jobs.

[[apm-app-reader-full]]
==== Full APM reader
==== APM reader

APM reader users typically need to view the APM app, dashboards, and visualizations that contain APM data.
These users might also need to create and edit dashboards, visualizations, and machine learning jobs.
To create an APM reader user:

. Create a new role, named something like `read-apm`, and assign the following privileges:
+
--
include::./tab-widgets/apm-app-reader/widget.asciidoc[]
--
+
TIP: Using the {apm-server-ref-v}/apm-integration.html[APM integration for Elastic Agent]?
Add the privileges under the **Data streams** tab.

. Assign the following built-in roles:
. Assign the `read-apm` role created in the previous step, and the following built-in roles to
any APM reader users:
+
[options="header"]
|====
Expand All @@ -51,9 +70,6 @@ These users might also need to create and edit dashboards, visualizations, and m
|`kibana_admin`
|Grants access to all features in Kibana.

|`apm_user`
|Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices

|`machine_learning_admin`
|Grants the privileges required to create, update, and view machine learning jobs
|====
Expand All @@ -63,14 +79,14 @@ These users might also need to create and edit dashboards, visualizations, and m

In some instances, you may wish to restrict certain Kibana apps that a user has access to.

. Assign the following built in roles:
. Create a new role, named something like `read-apm-partial`, and assign the following privileges:
+
[options="header"]
|====
|Role | Purpose
|`apm_user`
|Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices
|====
--
include::./tab-widgets/apm-app-reader/widget.asciidoc[]
--
+
TIP: Using the {apm-server-ref-v}/apm-integration.html[APM integration for Elastic Agent]?
Add the privileges under the **Data streams** tab.

. Assign space privileges to any Kibana space that the user needs access to.
Here are two examples:
Expand Down Expand Up @@ -98,6 +114,8 @@ Here are two examples:
|Grants the privileges required to create, update, and view machine learning jobs
|====

include::./tab-widgets/code.asciidoc[]

////
*********************************** ***********************************
////
Expand Down Expand Up @@ -138,7 +156,7 @@ and assign the following privileges:
^1^ +\{ANNOTATION_INDEX\}+ should be the index name you've defined in
<<apm-settings-kb,`xpack.observability.annotations.index`>>.

. Assign the `annotation_user` created previously, and the built-in roles necessary to create
. Assign the `annotation_user` created previously, and the roles and privileges necessary to create
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view annotations in the APM app

[[apm-app-annotation-api]]
Expand All @@ -163,17 +181,17 @@ See <<apm-app-api-user>>.

Central configuration users need to be able to view, create, update, and delete Agent configurations.

. Assign the following built-in roles:
. Create a new role, named something like `central-config-manager`, and assign the following privileges:
+
[options="header"]
|====
|Role | Purpose

|`apm_user`
|Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices
|====
--
include::./tab-widgets/central-config-users/widget.asciidoc[]
--
+
TIP: Using the {apm-server-ref-v}/apm-integration.html[APM integration for Elastic Agent]?
Add the privileges under the **Data streams** tab.

. Assign the following Kibana space privileges:
. Assign the `central-config-manager` role created in the previous step, and the following Kibana space privileges to
anyone who needs to manage central configurations:
+
[options="header"]
|====
Expand All @@ -190,16 +208,17 @@ Central configuration users need to be able to view, create, update, and delete
In some instances, you may wish to create a user that can only read central configurations,
but not create, update, or delete them.

. Assign the following built-in roles:
. Create a new role, named something like `central-config-reader`, and assign the following privileges:
+
[options="header"]
|====
|Role | Purpose
|`apm_user`
|Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices
|====
--
include::./tab-widgets/central-config-users/widget.asciidoc[]
--
+
TIP: Using the {apm-server-ref-v}/apm-integration.html[APM integration for Elastic Agent]?
Add the privileges under the **Data streams** tab.

. Assign the following Kibana space privileges:
. Assign the `central-config-reader` role created in the previous step, and the following Kibana space privileges to
anyone who needs to read central configurations:
+
[options="header"]
|====
Expand All @@ -215,6 +234,8 @@ but not create, update, or delete them.

See <<apm-app-api-user>>.

include::./tab-widgets/code.asciidoc[]

////
*********************************** ***********************************
////
Expand Down
45 changes: 45 additions & 0 deletions docs/apm/tab-widgets/apm-app-reader/content.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// tag::classic-indices[]
[options="header"]
|====
|Type |Privilege |Purpose

|Index
|`read` on `apm-*`
|Read-only access to `apm-*` data

|Index
|`view_index_metadata` on `apm-*`
|Read-only access to `apm-*` index metadata
|====
// end::classic-indices[]

// tag::data-streams[]
[options="header"]
|====
|Type |Privilege |Purpose

|Index
|`read` on `logs-apm*`
|Read-only access to `logs-apm*` data

|Index
|`view_index_metadata` on `logs-apm*`
|Read-only access to `logs-apm*` index metadata

|Index
|`read` on `metrics-apm*`
|Read-only access to `metrics-apm*` data

|Index
|`view_index_metadata` on `metrics-apm*`
|Read-only access to `metrics-apm*` index metadata

|Index
|`read` on `traces-apm*`
|Read-only access to `traces-apm*` data

|Index
|`view_index_metadata` on `traces-apm*`
|Read-only access to `traces-apm*` index metadata
|====
// end::data-streams[]
40 changes: 40 additions & 0 deletions docs/apm/tab-widgets/apm-app-reader/widget.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
++++
<div class="tabs" data-tab-group="apm-app-reader">
<div role="tablist" aria-label="APM app reader">
<button role="tab"
aria-selected="true"
aria-controls="classic-indices-tab"
id="classic-indices">
Classic APM indices
</button>
<button role="tab"
aria-selected="false"
aria-controls="data-streams-tab"
id="data-streams"
tabindex="-1">
Data streams
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices">
++++

include::content.asciidoc[tag=classic-indices]

++++
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams"
hidden="">
++++

include::content.asciidoc[tag=data-streams]

++++
</div>
</div>
++++
53 changes: 53 additions & 0 deletions docs/apm/tab-widgets/central-config-users/content.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// tag::classic-indices[]
[options="header"]
|====
|Type |Privilege |Purpose

|Index
|`read` on `apm-*`
|Read-only access to `apm-*` data

|Index
|`view_index_metadata` on `apm-*`
|Read-only access to `apm-*` index metadata
|====
// end::classic-indices[]

// tag::data-streams[]
[options="header"]
|====
|Type |Privilege |Purpose

|Index
|`read` on `apm-agent-configuration`
|Read-only access to `apm-agent-configuration` data

|Index
|`view_index_metadata` on `apm-agent-configuration`
|Read-only access to `apm-agent-configuration` index metadata

|Index
|`read` on `logs-apm*`
|Read-only access to `logs-apm*` data

|Index
|`view_index_metadata` on `logs-apm*`
|Read-only access to `logs-apm*` index metadata

|Index
|`read` on `metrics-apm*`
|Read-only access to `metrics-apm*` data

|Index
|`view_index_metadata` on `metrics-apm*`
|Read-only access to `metrics-apm*` index metadata

|Index
|`read` on `traces-apm*`
|Read-only access to `traces-apm*` data

|Index
|`view_index_metadata` on `traces-apm*`
|Read-only access to `traces-apm*` index metadata
|====
// end::data-streams[]
40 changes: 40 additions & 0 deletions docs/apm/tab-widgets/central-config-users/widget.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
++++
<div class="tabs" data-tab-group="central-config-manager">
<div role="tablist" aria-label="Central config manager">
<button role="tab"
aria-selected="true"
aria-controls="classic-indices-tab"
id="classic-indices">
Classic APM indices
</button>
<button role="tab"
aria-selected="false"
aria-controls="data-streams-tab"
id="data-streams"
tabindex="-1">
Data streams
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices">
++++

include::content.asciidoc[tag=classic-indices]

++++
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams"
hidden="">
++++

include::content.asciidoc[tag=data-streams]

++++
</div>
</div>
++++
Loading