-
Notifications
You must be signed in to change notification settings - Fork 63
[RHIDP-8584]: Document Extensions RBAC permissions for CSV file #2139
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
themr0c
merged 9 commits into
redhat-developer:main
from
themr0c:RHIDP-8584-extensions-rbac-csv
May 11, 2026
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
bb645ab
[RHIDP-8584]: Document Extensions RBAC permissions for CSV file
themr0c 708c24b
Merge branch 'main' into RHIDP-8584-extensions-rbac-csv
themr0c 4378a96
Merge branch 'main' into RHIDP-8584-extensions-rbac-csv
themr0c 4d0acd6
Merge branch 'main' into RHIDP-8584-extensions-rbac-csv
themr0c 50ee605
Apply suggestion from @PatAKnight
themr0c dabf06e
Apply suggestion from @themr0c
themr0c cadf59f
Merge branch 'main' into RHIDP-8584-extensions-rbac-csv
themr0c 5f3b3ef
Update modules/shared/proc-configure-rbac-for-extensions-by-using-the…
themr0c 3fcffaa
Merge branch 'main' into RHIDP-8584-extensions-rbac-csv
themr0c 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
78 changes: 78 additions & 0 deletions
78
modules/shared/proc-configure-rbac-for-extensions-by-using-the-rbac-csv-file.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 |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="configure-rbac-for-extensions-by-using-the-rbac-csv-file_{context}"] | ||
| = Configure RBAC for Extensions by using the RBAC CSV file | ||
|
|
||
| [role="_abstract"] | ||
| You can grant access to Extensions plugin management by adding permission policies to your RBAC CSV file. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have {authorization-book-link}#enabling-and-giving-access-to-rbac_title-authorization[enabled RBAC and assigned a policy administrator role]. | ||
| * You {authorization-book-link}#manage-authorizations-by-using-external-files_authorization-in-rhdh[manage authorizations by using external files]. | ||
| * You have added `extensions` to the list of authorized plugins under your `permission.rbac.pluginsWithPermission` configuration. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Add the following policies to your CSV file to allow users to view and manage plugins in Extensions: | ||
| + | ||
| [source,csv,subs="+quotes"] | ||
| ---- | ||
| g, user:default/_<YOUR_USERNAME>_, role:default/extensions-admin | ||
| p, role:default/extensions-admin, extensions.plugin.configuration.read, read, allow | ||
| p, role:default/extensions-admin, extensions.plugin.configuration.write, create, allow | ||
|
themr0c marked this conversation as resolved.
|
||
| p, role:default/extensions-admin, catalog.entity.read, read, allow | ||
| ---- | ||
| + | ||
| See xref:extensions-permissions_permission-policies-reference[Extensions permissions]. | ||
|
|
||
| . Optional: Restrict access to specific plugins by defining a conditional policy in the `rbac-conditional-policies.yaml` file as described in {authorization-book-link}#managing-authorizations-by-using-external-files[Defining conditional policies]: | ||
| + | ||
| [source,yaml,subs="+attributes,+quotes"] | ||
| ---- | ||
| result: CONDITIONAL | ||
| roleEntityRef: "role:default/extensions-admin" | ||
| pluginId: extensions | ||
| resourceType: extensions-plugin | ||
| permissionMapping: | ||
| - create | ||
| conditions: | ||
| rule: HAS_NAME | ||
| resourceType: extensions-plugin | ||
| params: | ||
| pluginNames: [_<your_plugin_name>_] | ||
| ---- | ||
| + | ||
| where: | ||
|
|
||
| `pluginNames`:: Enter the plugin name or title for user access. | ||
| + | ||
| This policy allows users to install or update only the specified plugins and restricts access to all other plugins. | ||
|
|
||
| . Optional: Restrict access by annotation by defining a conditional policy: | ||
| + | ||
| [source,yaml,subs="+attributes,+quotes"] | ||
| ---- | ||
| result: CONDITIONAL | ||
| roleEntityRef: "role:default/extensions-admin" | ||
| pluginId: extensions | ||
| resourceType: extensions-plugin | ||
| permissionMapping: | ||
| - create | ||
| conditions: | ||
| rule: HAS_ANNOTATION | ||
| resourceType: extensions-plugin | ||
| params: | ||
| annotation: "extensions.backstage.io/certified-by" | ||
| value: "Red Hat" | ||
| ---- | ||
| + | ||
| This policy allows users to install or update only the plugins that have the specified annotation. | ||
|
|
||
| .Verification | ||
|
|
||
| * Verify that the user can view and manage plugins in Extensions. | ||
|
|
||
| .Additional resources | ||
| * xref:extensions-permissions_permission-policies-reference[Extensions permissions] | ||
| * {installing-and-viewing-plugins-book-link}#configure-rbac-to-manage-extensions_extensions-in-rhdh[Configure RBAC to manage Extensions] | ||
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,25 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| [id="extensions-permissions_{context}"] | ||
| = Extensions permissions | ||
|
|
||
| [role="_abstract"] | ||
| Reference information about available Extensions permissions for reading and writing plugin configurations. | ||
|
|
||
| [cols="15%,25%,15%,45%", frame="all", options="header"] | ||
| |=== | ||
| |Name | ||
| |Resource type | ||
| |Policy | ||
| |Description | ||
|
|
||
| |`extensions.plugin.configuration.read` | ||
| |`extensions-plugin` | ||
| |`read` | ||
| |Enables a user or role to view plugin configurations in Extensions | ||
|
|
||
| |`extensions.plugin.configuration.write` | ||
| |`extensions-plugin` | ||
| |`create` | ||
| |Enables a user or role to install, update, enable, or disable plugins by using Extensions | ||
| |=== | ||
|
themr0c marked this conversation as resolved.
|
||
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.