Skip to content

Commit 5c24b3c

Browse files
karenzonekilfoyle
andauthored
Space Awareness: Update Fleet roles and privileges UI docs (#1751)
Co-authored-by: David Kilfoyle <[email protected]>
1 parent ab73b90 commit 5c24b3c

8 files changed

+121
-10
lines changed

reference/fleet/fleet-roles-privileges.md

Lines changed: 121 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ products:
66
- id: elastic-agent
77
---
88

9-
# Required roles and privileges [fleet-roles-and-privileges]
9+
# Roles and privileges [fleet-roles-and-privileges]
1010

11-
Assigning the {{kib}} feature privileges `Fleet` and `Integrations` grants access to use {{fleet}} and Integrations.
11+
Use {{kib}} roles and privileges to grant users access to {{fleet}} and Integrations.
12+
{{fleet}} and integrations privileges can be set to:
1213

1314
`all`
1415
: Grants full read-write access.
@@ -19,30 +20,35 @@ Assigning the {{kib}} feature privileges `Fleet` and `Integrations` grants acces
1920
`none`
2021
: No access is granted.
2122

22-
Take advantage of these privilege settings by:
23+
You can take advantage of these privilege settings by:
2324

2425
* [Using an {{es}} built-in role](#fleet-roles-and-privileges-built-in)
25-
* [Creating a new role](#fleet-roles-and-privileges-create)
26+
* [Creating a new role](#fleet-roles-and-privileges-create).
27+
28+
To configure access at a more granular level, select a custom set of privileges for individual {{fleet}} features:
29+
30+
* [Customize sub-feature privileges for {{fleet}}](#fleet-roles-and-privileges-sub-features) {applies_to}`stack: ga 9.1`
31+
2632

2733
## Built-in roles [fleet-roles-and-privileges-built-in]
2834

2935
{{es}} comes with built-in roles that include default privileges.
3036

3137
`editor`
32-
: The built-in `editor` role grants the following privileges, supporting full read-write access to {{fleet}} and Integrations:
38+
: The built-in `editor` role grants these privileges, supporting full read-write access to {{fleet}} and Integrations:
3339
* {{Fleet}}: `all`
3440
* Integrations: `all`
3541

3642
`viewer`
37-
: The built-in `viewer` role grants the following privileges, supporting read-only access to {{fleet}} and Integrations:
43+
: The built-in `viewer` role grants these privileges, supporting read-only access to {{fleet}} and Integrations:
3844

3945
* {{Fleet}}:: `read`
4046
* Integrations:: `read`
4147

4248
You can also create a new role that can be assigned to a user, in order to grant more specific levels of access to {{fleet}} and Integrations.
4349

4450

45-
## Create a role for {{fleet}} [fleet-roles-and-privileges-create]
51+
## Create a new role for {{fleet}} [fleet-roles-and-privileges-create]
4652

4753
To create a new role with access to {{fleet}} and Integrations:
4854

@@ -52,7 +58,8 @@ To create a new role with access to {{fleet}} and Integrations:
5258
4. Specify a name for the role.
5359
5. Leave the {{es}} settings at their defaults, or refer to [Security privileges](elasticsearch://reference/elasticsearch/security-privileges.md) for descriptions of the available settings.
5460
6. In the {{kib}} section, select **Assign to space**.
55-
7. In the **Spaces** menu, select **All Spaces**. Since many Integrations assets are shared across spaces, the users need the {{kib}} privileges in all spaces.
61+
7. In the **Spaces** menu, select **All Spaces**.
62+
Because many Integrations assets are shared across spaces, users need the {{kib}} privileges in all spaces.
5663
8. Expand the **Management** section.
5764
9. Set **Fleet** privileges to **All**.
5865
10. Choose the access level that you'd like the role to have with respect to {{fleet}} and integrations:
@@ -61,10 +68,114 @@ To create a new role with access to {{fleet}} and Integrations:
6168
:alt: Kibana privileges flyout showing Fleet and Integrations access set to All
6269
:screenshot:
6370
:::
64-
2. Similarly, to create a read-only user for {{fleet}} and Integrations, set both the **Fleet** and **Integrations** privileges to `Read`.
71+
2. To create a read-only user for {{fleet}} and Integrations, set both the **Fleet** and **Integrations** privileges to `Read`.
6572
:::{image} images/kibana-fleet-privileges-read.png
6673
:alt: Kibana privileges flyout showing Fleet and Integrations access set to All
6774
:screenshot:
6875
:::
76+
3. If you'd like to define more specialized access to {{fleet}} based on individual components, expand the **Fleet** menu and enable **Customize sub-feature privileges**.
77+
:::{image} images/kibana-fleet-privileges-enable.png
78+
:alt: Kibana customize sub-feature privileges UI
79+
:screenshot:
80+
:::
81+
<br>
82+
Any setting for individual {{fleet}} components that you specify here takes precedence over the general `All`, `Read`, or `None` privilege set for {{fleet}}.
83+
84+
Based on your selections, access to features in the {{fleet}} UI are enabled or disabled for the role.
85+
Those details are covered in the next section: [Customize access to {{fleet}} features](#fleet-roles-and-privileges-sub-features).
86+
87+
After you've created a new role, you can assign it to any {{es}} user.
88+
You can edit the role at any time by returning to the **Roles** page in {{kib}}.
89+
90+
## Customize sub-feature privileges for {{fleet}}[fleet-roles-and-privileges-sub-features]
91+
92+
```{applies_to}
93+
stack: ga 9.1
94+
```
95+
96+
Beginning with {{stack}} version 9.1, you have more granular control when [creating a new role](#fleet-roles-and-privileges-create) or editing it. This is useful when people in your organization access {{fleet}} for different purposes, and you need to fine-tune the components that they can view and the actions that they can perform.
97+
98+
The {{fleet}} UI varies depending on the privileges granted to the role.
99+
100+
### Example 1: Read access for {{agents}}[fleet-roles-and-privileges-sub-features-example1]
101+
102+
Set `Read` access for {{agents}} only:
103+
104+
* Agents: `Read`
105+
* Agent policies: `None`
106+
* Settings: `None`
107+
108+
With these privileges, the {{fleet}} UI shows only the **Agents** and **Data streams** tabs.
109+
The **Agent policies**, **Enrollment tokens**, **Uninstall tokens**, and **Settings** tabs are unavailable.
110+
111+
The set of actions available for an agent are limited to viewing the agent and requesting a diagnostics bundle.
112+
113+
:::{image} images/kibana-fleet-privileges-agents-view.png
114+
:alt: Fleet UI showing only the Agents and Data streams tabs
115+
:screenshot:
116+
:::
117+
118+
Change the **Agents** privilege to `All` to enable the role to perform the [full set of available actions](/reference/fleet/manage-agents.md) on {{agents}}.
119+
120+
### Example 2: Read access for all {{fleet}} features[fleet-roles-and-privileges-sub-features-example2]
121+
122+
Set `Read` access for {{agents}}, agent policies, and {{fleet}} settings:
123+
124+
* Agents: `Read`
125+
* Agent policies: `Read`
126+
* Settings: `Read`
127+
128+
With these privileges, the {{fleet}} UI shows the **Agents**, **Agent policies**, **Data streams**, and **Settings** tabs.
129+
The **Enrollment tokens** and **Uninstall tokens** tabs are unavailable.
130+
131+
The set of actions available for an agent are limited to viewing the agent and requesting a diagnostics bundle.
132+
133+
You can view agent policies, but you cannot create a new policy.
134+
135+
:::{image} images/kibana-fleet-privileges-all-view.png
136+
:alt: Fleet UI showing four tabs available
137+
:screenshot:
138+
:::
139+
140+
You can view {{fleet}} settings, but they are not editable.
141+
142+
:::{image} images/kibana-fleet-privileges-view-settings.png
143+
:alt: Fleet UI showing settings are non-editable
144+
:screenshot:
145+
:::
146+
147+
### Example 3: All access for {{agents}}[fleet-roles-and-privileges-sub-features-example3]
148+
149+
Set `All` access for {{agents}} only:
150+
151+
* Agents: `All`
152+
* Agent policies: `Read`
153+
* Settings: `Read`
154+
155+
With these privileges, the {{fleet}} UI shows all tabs.
156+
157+
All {{agent}} actions can be performed and new agents can be created. Enrollment tokens and uninstall tokens are both available.
158+
159+
:::{image} images/kibana-fleet-privileges-agent-all.png
160+
:alt: Fleet UI showing all tabs available
161+
:screenshot:
162+
:::
163+
164+
Access to {{fleet}} settings is still read-only.
165+
To enable actions such as creating a new {{fleet-server}}, set the **Fleet Settings** privilege to `All`.
166+
167+
168+
## {{fleet}} privileges and available actions [fleet-roles-and-privileges-sub-features-table]
169+
170+
```{applies_to}
171+
stack: ga 9.1
172+
```
173+
174+
175+
This table shows the set of available actions for the `read` or `all` privilege for each {{fleet}} feature.
69176

70-
Once you've created a new role you can assign it to any {{es}} user. You can edit the role at any time by returning to the **Roles** page in {{kib}}.
177+
|Component |`read` privilege |`all` privilege |
178+
| --- | --- | --- |
179+
| Agents | View-only access to {{agents}}, including:<br><br>* [View a list of all agents and their status](/reference/fleet/monitor-elastic-agent.md#view-agent-status)<br>* [Request agent diagnostic packages](/reference/fleet/monitor-elastic-agent.md#collect-agent-diagnostics) |Full access to manage {{agents}}, including:<br><br>* [Perform upgrades](/reference/fleet/upgrade-elastic-agent.md)<br>* [Configure monitoring](/reference/fleet/monitor-elastic-agent.md)<br>* [Migrate agents to a new cluster](/reference/fleet/migrate-elastic-agent.md)<br>* [Unenroll agents from {{fleet}}](/reference/fleet/unenroll-elastic-agent.md)<br>* [Set the inactivity timeout](/reference/fleet/set-inactivity-timeout.md)<br>* [Create and revoke enrollment tokens](/reference/fleet/fleet-enrollment-tokens.md) |
180+
| Agent policies | View-only access, including:<br><br>* Agent policies and settings<br>* The integrations associated with a policy | Full access to manage agent policies, including:<br><br>* [Create a policy](/reference/fleet/agent-policy.md#create-a-policy)<br>* [Add an integration to a policy](/reference/fleet/agent-policy.md#add-integration)<br>* [Apply a policy](/reference/fleet/agent-policy.md#apply-a-policy)<br>* [Edit or delete an integration](/reference/fleet/agent-policy.md#policy-edit-or-delete)<br>* [Copy a policy](/reference/fleet/agent-policy.md#copy-policy)<br>* [Edit or delete a policy](/reference/fleet/agent-policy.md#policy-main-settings)<br>* [Change the output of a policy](/reference/fleet/agent-policy.md#change-policy-output) |
181+
| Fleet settings | View-only access, including:<br><br>* Configured {{fleet}} hosts<br>* {{fleet}} output settings<br>* The location to download agent binaries | Full access to manage {{fleet}} settings, including:<br><br>* [Editing hosts](/reference/fleet/fleet-settings.md#fleet-server-hosts-setting)<br>* [Adding or editing outputs](/reference/fleet/fleet-settings.md#output-settings)<br>* [Update the location for downloading agent binaries](/reference/fleet/fleet-settings.md#fleet-agent-binary-download-settings) |
104 KB
Loading
106 KB
Loading
75.7 KB
Loading
-137 KB
Loading
24.9 KB
Loading
226 KB
Loading
85.5 KB
Loading

0 commit comments

Comments
 (0)