-
Notifications
You must be signed in to change notification settings - Fork 109
Add custom roles page #30
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2b1be52
Add custom roles page
lcawl 980c9ef
Add Elasticsearch and Kibana privileges
lcawl b1ffc03
Comment out feature flags
lcawl e25a2f0
Temporarily comment out all feature flags
lcawl 88a106c
Remove subscription comment
lcawl b16dd3c
Clarify default Cloud privileges
lcawl 59e1902
Update serverless/pages/custom-roles.mdx
lcawl 003095b
Update serverless/pages/custom-roles.mdx
lcawl 21b851f
Remove comments
lcawl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
--- | ||
slug: /serverless/custom-roles | ||
title: Custom roles | ||
description: Create and manage roles that grant privileges within your project. | ||
tags: [ 'serverless', 'Elasticsearch', 'Observability', 'Security' ] | ||
--- | ||
|
||
<DocIf condition={"((serverlessCustomRoles))" === "false"}> | ||
<DocBadgeComingSoon>Coming soon</DocBadgeComingSoon> | ||
</DocIf> | ||
|
||
<DocIf condition={"((serverlessCustomRoles))" === "true"}> | ||
<DocBadge template="technical preview" /> | ||
This content applies to: <DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" /> <DocBadge template="observability" slug="/serverless/observability/what-is-observability-serverless" /> <DocBadge template="security" slug="/serverless/security/what-is-security-serverless" /> | ||
|
||
The built-in <DocLink slug="/serverless/general/assign-user-roles" section="organization-level-roles">organization-level roles</DocLink> and <DocLink slug="/serverless/general/assign-user-roles" section="instance-access-roles">instance access roles</DocLink> are great for getting started with ((serverless-full)), and for system administrators who do not need more restrictive access. | ||
|
||
As an administrator, however, you have the ability to create your own roles to describe exactly the kind of access your users should have within a specific project. | ||
For example, you might create a marketing_user role, which you then assign to all users in your marketing department. | ||
This role would grant access to all of the necessary data and features for this team to be successful, without granting them access they don't require. | ||
{/* Derived from https://www.elastic.co/guide/en/kibana/current/tutorial-secure-access-to-kibana.html */} | ||
|
||
All custom roles grant the same access as the `Viewer` instance access role with regards to ((ecloud)) privileges. | ||
To grant more ((ecloud)) privileges, assign more roles. | ||
Users receive a union of all their roles' privileges. | ||
|
||
You can manage custom roles in **((project-settings)) → ((manage-app)) →((custom-roles-app))**. | ||
To create a new custom role, click the **Create role** button. | ||
To clone, delete, or edit a role, open the actions menu: | ||
|
||
 | ||
{/* TO-DO: This screenshot needs to be refreshed and automated. */} | ||
|
||
Roles are a collection of privileges that enable users to access project features and data. | ||
For example, when you create a custom role, you can assign ((es)) cluster and index privileges and ((kib)) privileges. | ||
|
||
<DocCallOut> | ||
You cannot assign [run as privileges](((ref))/security-privileges.html#_run_as_privilege) in ((serverless-full)) custom roles. | ||
</DocCallOut> | ||
|
||
## ((es)) cluster privileges | ||
|
||
Cluster privileges grant access to monitoring and management features in ((es)). | ||
They also enable some ((stack-manage-app)) capabilities in your project. | ||
|
||
 | ||
{/* TO-DO: This screenshot needs to be refreshed and automated. */} | ||
|
||
Refer to [cluster privileges](((ref))/security-privileges.html#privileges-list-cluster) for a complete description of available options. | ||
|
||
## ((es)) index privileges | ||
|
||
Each role can grant access to multiple data indices, and each index can have a different set of privileges. | ||
Typically, you will grant the `read` and `view_index_metadata` privileges to each index that you expect your users to work with. | ||
For example, grant access to indices that match an `acme-marketing-*` pattern: | ||
|
||
 | ||
{/* TO-DO: This screenshot needs to be refreshed and automated. */} | ||
|
||
Refer to [index privileges](((ref))/security-privileges.html#privileges-list-indices) for a complete description of available options. | ||
|
||
Document-level and field-level security affords you even more granularity when it comes to granting access to your data. | ||
With document-level security (DLS), you can write an ((es)) query to describe which documents this role grants access to. | ||
With field-level security (FLS), you can instruct ((es)) to grant or deny access to specific fields within each document. | ||
{/* Derived from https://www.elastic.co/guide/en/kibana/current/kibana-role-management.html#adding_cluster_privileges */} | ||
|
||
## ((kib)) privileges | ||
|
||
When you create a custom role, click **Add Kibana privilege** to grant access to specific features. | ||
The features that are available vary depending on the project type. | ||
For example, in ((es-serverless)): | ||
|
||
 | ||
{/* TO-DO: This screenshot needs to be refreshed and automated. */} | ||
|
||
Open the **Spaces** selection control to specify whether to grant the role access to all spaces or one or more individual spaces. | ||
When using the **Customize by feature** option, you can choose either **All**, **Read** or **None** for access to each feature. | ||
|
||
All | ||
: Grants full read-write access. | ||
|
||
Read | ||
: Grants read-only access. | ||
|
||
None | ||
: Does not grant any access. | ||
|
||
Some features have finer access control and you can optionally enable sub-feature privileges. | ||
|
||
<DocCallOut title="New features"> | ||
As new features are added to ((serverless-full)), roles that use the custom option do not automatically get access to the new features. You must manually update the roles. | ||
</DocCallOut> | ||
|
||
After your roles are set up, the next step to securing access is to assign roles to your users. | ||
{/* Click the **Assign roles** link... */} | ||
Learn more in <DocLink slug="/serverless/general/assign-user-roles" /> | ||
</DocIf> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.