-
Notifications
You must be signed in to change notification settings - Fork 49
GBAC #1584
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
GBAC #1584
Changes from all commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
8197505
security: add gbac docs
paulohtb6 dc2dae6
add prop reference
paulohtb6 33fd2a8
add what's new
paulohtb6 29c73fc
fix
paulohtb6 ee85e23
address revieww comments
paulohtb6 bd663d0
add diagram
paulohtb6 948da37
Adjust naming
paulohtb6 191344f
Apply suggestions from SME review
kbatuigas cc0d637
Move conceptual sections and add Admin v2 links
kbatuigas 7787674
Increase default width for Mermaid diagram
kbatuigas 5cf510c
Add GBAC info on audit logging
kbatuigas edc9719
Add troubleshooting section
kbatuigas 4718f66
Apply suggestions from code review
kbatuigas a3e34e7
Apply suggestions from doc review
kbatuigas 98721b0
Some listed limitations are actually more behavioral notes
kbatuigas 262720a
Replace Suggested reading with Next steps
kbatuigas 220dff9
Rephrase intro to clarify user goal/outcome
kbatuigas fb19416
Minor style edits
kbatuigas f0a6edc
Incorporate audit logging examples from SME
kbatuigas 0f03d84
Apply suggestions from latest SME review
kbatuigas 3b36697
Begin adding and conditionalizing for Cloud UI and API content
kbatuigas 6d216dd
Require group claim setup in IdP
kbatuigas 55d4b82
Point local playbook to GBAC branch in Cloud
kbatuigas 4547d22
Fill out Cloud API steps
kbatuigas 0940dc7
Incorporate rpk changes
kbatuigas ec98020
Retrigger Netlify build
micheleRP fe1cc7a
Add GBAC examples to rpk reference
kbatuigas 7e751bc
Fix examples that used --print-groups
kbatuigas 5282667
Conditionalize Cloud xrefs
kbatuigas 3291dd6
Apply suggestions from doc review
kbatuigas 324320e
Remove k8s
kbatuigas c6c849f
Standardize rpk formatting
kbatuigas b444e90
Add Cloud UI instructions for groups registration and OIDC claims setup
kbatuigas ed186b1
Merge branch 'v-WIP/26.1' into gbac
kbatuigas 772bb24
Change ordering per SME suggestion
kbatuigas 9ae4d69
Update local-antora-playbook.yml
kbatuigas c2263bf
Superuser not available in Cloud
kbatuigas 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
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,17 @@ | ||
| = Configure Group-Based Access Control | ||
| :description: Manage Redpanda permissions at scale using your identity provider's groups. Define access once per group and let your IdP control membership, with no per-user configuration in Redpanda. | ||
| :page-topic-type: how-to | ||
| :page-categories: Management, Security | ||
| :personas: security_engineer, platform_engineer | ||
| :learning-objective-1: Configure the cluster properties that enable GBAC | ||
| :learning-objective-2: Assign an OIDC group to an RBAC role | ||
| :learning-objective-3: Create a group-based ACL using the Group: principal prefix | ||
|
|
||
| ifndef::env-cloud[] | ||
| [NOTE] | ||
| ==== | ||
| include::shared:partial$enterprise-license.adoc[] | ||
| ==== | ||
| endif::[] | ||
|
|
||
| include::manage:partial$gbac-dp.adoc[] |
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,8 +1,8 @@ | ||
| = Configure Authorization | ||
| :description: Redpanda provides two mechanisms for controlling user permissions. | ||
| :description: Redpanda provides mechanisms for controlling user permissions, including ACLs, role-based access control, and group-based access control. | ||
| :page-aliases: security:authorization/index.adoc, manage:security/authorization.adoc | ||
| :page-categories: Management, Security | ||
| :page-layout: index | ||
|
|
||
|
|
||
| Authorization works in tandem with xref:security/authentication.adoc[authentication]. Authentication grants permission to interact with Redpanda resources while authorization controls what a principal is permitted to do once authenticated. | ||
| Authorization works in tandem with xref:security/authentication.adoc[authentication]. Authentication verifies who a principal is. Authorization controls what that principal can do once authenticated. |
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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| To assign a group to a role in {ui}: | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Roles* tab. | ||
|
|
||
| . Select the role you want to assign the group to. | ||
|
|
||
| . Click *Edit*. | ||
|
|
||
| . In the *Principals* section, enter the group name using the `Group:<name>` format. For example, `Group:engineering`. | ||
|
|
||
| . Click *Update*. | ||
|
|
||
| To remove a group from a role: | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Roles* tab. | ||
|
|
||
| . Select the role that has the group assignment you want to remove. | ||
|
|
||
| . Click *Edit*. | ||
|
|
||
| . In the *Principals* section, remove the `Group:<name>` entry. | ||
|
|
||
| . Click *Update*. |
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,13 @@ | ||
| In {ui}, group-based ACLs are managed through roles. To create an ACL for an OIDC group: | ||
|
|
||
| . From *Security* on the left navigation menu, select the *Roles* tab. | ||
|
|
||
| . Click *Create role* to open the role creation form, or select an existing role and click *Edit*. | ||
|
|
||
| . In the *Principals* field, enter the group principal using the `Group:<name>` format. For example, `Group:engineering`. | ||
|
|
||
| . Define the permissions (ACLs) you want to grant to users in the group. You can configure ACLs for clusters, topics, consumer groups, transactional IDs, Schema Registry subjects, and Schema Registry operations. | ||
|
|
||
| . Click *Create* (or *Update* if editing an existing role). | ||
|
|
||
| NOTE: {ui} assigns ACLs through roles. To grant permissions to a group, create a role for that group, add the group as a principal, and define the ACLs on the role. To create ACLs with a `Group:` principal directly (without creating a role), use `rpk`. | ||
Oops, something went wrong.
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.
Not sure how this will look?

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'm not able to validate this right now, so we'll have to come back to this and confirm how this is finalized in Cloud