[docs] Document new role description field #108422
Merged
Conversation
This file contains 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
slobodanadamovic
added
>docs
|
Documentation preview: |
| + "as well as updating user profile data for the kibana-* namespace. " | ||
| + "Additionally, this role grants read access to the .monitoring-* indices " | ||
| + "and read and write access to the .reporting-* indices. " | ||
| + "Note: This role should not be assigned to users as the granted permissions may change between releases." |
There was a problem hiding this comment.
This is a verbatim copy of kibana_system role's description. The documentation seems to be outdated, since the permissions have changed quite a lot since the documentation was first written.
Not sure if we should cover them all. But I do think it's worth revisiting description to be more explicit in stating that this its intention is for system use by Kibana and that it should not be granted to regular users.
There was a problem hiding this comment.
Ah good catch! I can take this back to my team to discuss updates, but I think this is fine for now.
There was a problem hiding this comment.
Sounds good to me.
The superuser role is not 1-1 serialized when persisted as limited-by.
superuser role now has description which is not stored in API keys
| * would be inconsistent and require handling backwards compatibility. | ||
| * Hence why we have to remove them before create/update of API key roles. | ||
| */ | ||
| static Set<RoleDescriptor> removeUserRoleDescriptorDescriptions(Set<RoleDescriptor> userRoleDescriptors) { |
There was a problem hiding this comment.
Made package protected for testing.
slobodanadamovic
force-pushed
the
sa-role-description-docs
branch
from
7c4bddc
to
3440fbf
Compare
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-security (Team:Security) |
kc13greiner
approved these changes
May 10, 2024
| + "as well as updating user profile data for the kibana-* namespace. " | ||
| + "Additionally, this role grants read access to the .monitoring-* indices " | ||
| + "and read and write access to the .reporting-* indices. " | ||
| + "Note: This role should not be assigned to users as the granted permissions may change between releases." |
There was a problem hiding this comment.
Ah good catch! I can take this back to my team to discuss updates, but I think this is fine for now.
shainaraskas
approved these changes
May 10, 2024
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
slobodanadamovic
added a commit
that referenced
this pull request
May 16, 2024
This PR adds missing role description for the `transport_client role`, and a test to enforce that all reserved roles are described. The description also serves as self-documentation for roles, thus it is reasonable to make this a requirement for all reserved roles. Relates to #108422, which included descriptions for other reserved roles.
nicktindall
pushed a commit
to nicktindall/elasticsearch
that referenced
this pull request
May 17, 2024
…#108633) This PR adds missing role description for the `transport_client role`, and a test to enforce that all reserved roles are described. The description also serves as self-documentation for roles, thus it is reasonable to make this a requirement for all reserved roles. Relates to elastic#108422, which included descriptions for other reserved roles.
parkertimmins
pushed a commit
to parkertimmins/elasticsearch
that referenced
this pull request
May 17, 2024
…#108633) This PR adds missing role description for the `transport_client role`, and a test to enforce that all reserved roles are described. The description also serves as self-documentation for roles, thus it is reasonable to make this a requirement for all reserved roles. Relates to elastic#108422, which included descriptions for other reserved roles.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update API docs to include new
descriptionfield (introduced in #107088) and add descriptions for all built-in roles.