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

[8.17] Update Fleet docs for new 'read' access roles (backport #1697) #1702

Merged
merged 1 commit into from
Feb 25, 2025
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,57 @@ Assigning the {kib} feature privileges `Fleet` and `Integrations` grants access

`all`:: Grants full read-write access.
`read`:: Grants read-only access.
`none`:: No access is granted.

Take advantage of these privilege settings by:

* <<fleet-roles-and-privileges-built-in,Using an {es} built-in role>>
* <<fleet-roles-and-privileges-create,Creating a new role>>

[discrete]
[[fleet-roles-and-privileges-built-in]]
== Built-in roles

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

`editor`::
The built-in `editor` role grants the following privileges, supporting full read-write access to {fleet} and Integrations:

* {Fleet}: `All`
* Integrations: `All`
* {Fleet}: `all`
* Integrations: `all`

`viewer`::
The built-in `viewer` role grants the following privileges, supporting read-only access to {fleet} and Integrations:

* {Fleet}:: `None`
* Integrations:: `Read`
* {Fleet}: `read`
* Integrations: `read`

You can also create a new role that can be assigned to a user to grant access to {fleet} and Integrations.
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.

[discrete]
[[fleet-roles-and-privileges-create]]
== Create a role for {fleet}

To create a new role with full access to use and manage {fleet} and Integrations:
To create a new role with access to {fleet} and Integrations:

. In {kib}, go to **Management -> Stack Management**.
. In the **Security** section, select **Roles**.
. Select **Create role**.
. Specify a name for the role.
. Leave the {es} settings at their defaults, or refer to {ref}/security-privileges.html[Security privileges] for descriptions of the available settings.
. In the {kib} section, select **Add Kibana privilege**.
. In the **Spaces** menu, select *** All Spaces**. Since many Integrations assets are shared across spaces, the users needs the {kib} privileges in all spaces.
. In the {kib} section, select **Assign to space**.
. In the **Spaces** menu, select *** All Spaces**. Since many Integrations assets are shared across spaces, the users need the {kib} privileges in all spaces.
. Expand the **Management** section.
. Set **Fleet** privileges to **All**.
. Set **Integrations** privileges to **All**.
. Choose the access level that you'd like the role to have with respect to {fleet} and integrations:

.. To grant the role full access to use and manage {fleet} and integrations, set both the **Fleet** and **Integrations** privileges to `All`.
+
[role="screenshot"]
image::images/kibana-fleet-privileges.png[Kibana privileges flyout showing Fleet and Integrations set to All]
image::images/kibana-fleet-privileges-all.png[Kibana privileges flyout showing Fleet and Integrations set to All]

To create a read-only user for Integrations, follow the same steps as above but set the **Fleet** privileges to **None** and the **Integrations** privileges to **Read**.
.. Similarly, to create a read-only user for {fleet} and Integrations, set both the **Fleet** and **Integrations** privileges to `Read`.
+
[role="screenshot"]
image::images/kibana-fleet-privileges-read.png[Kibana privileges flyout showing Fleet and Integrations set to All]

Read-only access to {fleet} is not currently supported but is planned for development in a later release.
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}.