-
Notifications
You must be signed in to change notification settings - Fork 51
DOC-2123: Update Console ACL UI references for new atomic-ACL design #1689
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
10 commits
Select commit
Hold shift + click to select a range
46c2af3
DOC-2123: Update Console ACL UI references for new atomic-ACL design
micheleRP 440b6c7
DOC-2123: Fix Security page model — ACLs are per-principal, not stand…
micheleRP 34b3e82
DOC-2123: Add Permissions tab + split role-creation flow
micheleRP 215eb16
DOC-2123: Drop Edit/Update modal pattern from RBAC and GBAC partials
micheleRP 3966374
TEMP DOC-2123: point cloud-docs source at sibling PR branch
micheleRP 728cc7d
DOC-2123: Style cleanup — drop em dashes, tighten phrasing
micheleRP 5f030a0
Merge branch 'main' into DOC-2123-console-acl-ui-refresh
Feediver1 5812016
Merge branch 'main' into DOC-2123-console-acl-ui-refresh
Feediver1 6886e4e
Address review feedback on Console ACL/role docs
micheleRP ed65a41
Revert temporary cloud-docs playbook override
micheleRP 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
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
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 |
|---|---|---|
|
|
@@ -32,11 +32,26 @@ ACLs control access by defining: | |
|
|
||
| ACLs work with SASL/SCRAM and mTLS authentication methods to provide comprehensive security. | ||
|
|
||
| [[manage-acls]] | ||
| == Manage ACLs | ||
|
|
||
| You can create and manage ACLs in the following ways: | ||
|
|
||
| * *{ui}*: Select *Security* from the left navigation menu, select the *ACLs* tab. After the ACL is created, you can add users or roles to it. | ||
| [[create-first-acl]] | ||
| * *{ui}*: From *Security* in the left navigation menu, you can reach ACLs two ways: | ||
| + | ||
| ** *Permissions* tab: a unified, cluster-wide view of every principal that has at least one ACL, showing direct ACL counts and ACLs inherited from roles. A red badge marks any principal that has Deny rules. From this tab you can: | ||
| + | ||
| *** Expand a principal's row to see every ACL applied to it: direct rules first, then groups labeled *VIA ROLE: <role-name>* listing the ACLs inherited from each role. | ||
| *** Search across principals, resources, and roles to filter the list. | ||
| *** Click *Create ACL* to add a rule from scratch. | ||
| ** *Users* or *Roles* tab: open the principal you want to manage, and use the *ACLs* section on its detail page. | ||
| + | ||
| On a principal's detail page, the *ACLs* section shows one row per rule, with columns for type, resource, operation, permission, and host. It offers three actions: | ||
| + | ||
| ** Click *+ Add ACL* to define a single rule by specifying its resource type, pattern type, resource name, operation, permission, and host. | ||
| ** Click *Allow all operations* to grant full wildcard access across all resource types in a single step. Use this for testing only; it is too broad for production. | ||
| ** Select one or more rows with the checkboxes and click *Delete selected* to remove ACLs in bulk. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here, let me know if I'm looking at an outdated UI |
||
| * *Command Line*: Use the `rpk` command-line tool for programmatic management. | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| + | ||
| For example, suppose you want to create a user named `analytics-user` who can read from topics starting with `logs-` and write to a topic called `processed-data`: | ||
|
|
||
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
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 |
|---|---|---|
| @@ -1,21 +1,17 @@ | ||
| To assign a role to a principal, edit the role or edit the user. | ||
| You can assign a role from either side: open the role and add a principal, or open the user and assign the role. | ||
|
|
||
| Option 1: Edit the role | ||
| Option 1: From the role's detail page | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Roles* tab. | ||
|
|
||
| . Select the role you want to assign to one or more users/principals. | ||
| . Click the role you want to assign. | ||
|
|
||
| . Click *Edit*. | ||
| . Under *Principals*, use the *Add a principal* search to select one or more users (or `Group:<name>` entries for OIDC groups). Each selection takes effect immediately. | ||
|
|
||
| . Below the list of permissions, find the Principals section. You can add any number of users/principals to the role. After listing all new users/principals, click *Update*. | ||
|
|
||
| Option 2: Edit the user | ||
| Option 2: From the user's detail page | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Users* tab. | ||
|
|
||
| . Select the user you want to assign one or more roles to. | ||
|
|
||
| . In the *Assign roles* input field, select the roles you want to add to this user. | ||
| . Click the user you want to assign roles to. | ||
|
|
||
| . After adding all roles, click *Update*. | ||
| . Under *Roles*, use the *Assign a role* search to select one or more roles. Each selection takes effect immediately. |
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
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
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 |
|---|---|---|
| @@ -1,23 +1,17 @@ | ||
| There are two ways to remove a role from a principal: | ||
| You can remove a role assignment from either side: | ||
|
|
||
| Option 1: Edit the role | ||
| Option 1: From the role's detail page | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Roles* tab. | ||
|
|
||
| . Select the role you want to remove from one or more principals. | ||
| . Click the role you want to modify. | ||
|
|
||
| . Click *Edit*. | ||
| . Under *Principals*, click the trash icon next to each principal you want to remove. Each removal takes effect immediately. | ||
|
|
||
| . Below the list of permissions, find the Principals section. Click *x* beside the name of any principals you want to remove from the role. | ||
|
|
||
| . After you have removed all needed principals, click *Update*. | ||
|
|
||
| Option 2: Edit the user | ||
| Option 2: From the user's detail page | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Users* tab. | ||
|
|
||
| . Select the user you want to remove from one or more roles. | ||
|
|
||
| . Click *x* beside the name of any roles you want to remove this user from. | ||
| . Click the user you want to modify. | ||
|
|
||
| . After you have removed the user from all roles, click *Update*. | ||
| . Under *Roles*, click the trash icon next to each role you want to revoke. Each removal takes effect immediately. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't seem to find this (I'm checking the link that was provided in the Jira https://v0-security-page-refactor-hg49r29x7-redpanda-data.vercel.app/security/roles/admin, is there a different URL for the UI that I should look at)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That v0 link from the Jira is an early prototype. The live UI confirms Allow all operations and Delete selected on the principal's detail page.