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

Allow roles to have an optional description #174724

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kalabro
Copy link
Contributor

@kalabro kalabro commented Jan 11, 2024

Summary

Implements a proof of concept for #173570

  • Stores Kibana role description in the Elasticsearch role metadata (assuming the underlying Elasticsearch endpoint will stay as is)
  • Allows specifying the role on the Role Edit/Create page in UI
  • Shows role descriptions on the Role Listing Page

Pending questions

  1. Confirm the approach with the Elasticsearch role metadata as storage for role descriptions
    1.1. Are there ways to use a system key, i.e. _kibana_description, to protect the property from external overrides?
  2. Validate UI changes
  3. Extend affected integration/E2E tests (I would appreciate help setting up necessary tests)
  4. Do we want to make roles searchable by description in UI? Currently, they are searchable by role name only.
  5. Update affected documentation
kibana-role-descriptions.mov

Alternative UI options to consider

Two-column layout

kibana-role-description-ui-1

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant