generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 57
RHIDP-3972 RHIDP-3973 Enabling and giving access to the Role-Based Access Control (RBAC) feature #631
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
Gerry-Forde
merged 16 commits into
redhat-developer:main
from
themr0c:RHIDP-3972-chapter-1-enabling-the-rbac-plugin
Nov 4, 2024
Merged
RHIDP-3972 RHIDP-3973 Enabling and giving access to the Role-Based Access Control (RBAC) feature #631
Changes from 12 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
119ac1f
RHIDP-3972 enabling the rbac plugin
themr0c 364984e
RHIDP-3973 configuring policy administrators
themr0c 586fa6f
RHIDP-3973 configuring policy administrators
themr0c cc6177e
RHIDP-3973 configuring policy administrators
themr0c 5e26186
RHIDP-3973 configuring policy administrators
themr0c d1da68a
Update modules/authorization/proc-enabling-the-rbac-plugin.adoc
themr0c a77defc
Update modules/authorization/proc-enabling-the-rbac-plugin.adoc
themr0c edcf021
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
themr0c baec76f
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
hmanwani-rh 757df64
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
themr0c 74fb39c
Apply suggestions from code review
themr0c 7044b72
Update modules/authorization/proc-enabling-the-rbac-plugin.adoc
themr0c 63ba4ce
Apply suggestions from code review
themr0c a7f8f13
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
themr0c 235e9f2
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
themr0c 3b1bbc6
Merge branch 'main' into RHIDP-3972-chapter-1-enabling-the-rbac-plugin
Gerry-Forde 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
36 changes: 0 additions & 36 deletions
36
modules/authorization/con-rbac-config-permission-policies-admin.adoc
This file was deleted.
Oops, something went wrong.
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,53 @@ | ||
| [id='enabling-and-giving-access-to-rbac'] | ||
| = Enabling and giving access to the Role-Based Access Control (RBAC) feature | ||
|
|
||
| The Role-Based Access Control (RBAC) feature is disabled by default. | ||
| Enable the RBAC plugin and declare policy administrators to start using RBAC features. | ||
|
|
||
| The permission policies for users and groups in the {product-short} are managed by permission policy administrators. Only permission policy administrators can access the Role-Based Access Control REST API. | ||
|
|
||
| .Prerequisites | ||
| * You have link:{linkadminguide}#assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it. | ||
| * You have link:{authentication-book-title}[enabled an authentication provider]. | ||
|
|
||
| .Procedure | ||
| . The RBAC plugin is installed but disabled by default. | ||
| To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac` plugin, edit your `dynamic-plugins.yaml` with following content. | ||
| + | ||
| .`dynamic-plugins.yaml` fragment | ||
| [source,yaml] | ||
| ---- | ||
| plugins: | ||
| - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac | ||
| disabled: false | ||
| ---- | ||
| + | ||
| See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. | ||
|
|
||
| . Declare policy administrators to allow a certain limited number of authenticated users to configure RBAC policies by using the REST API or the Web UI, rather than editing the CSV file. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| The permissions can be defined in a separate CSV file that is referenced in the app-config-rhdh ConfigMap, or they can be created via REST API or Web UI. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| + | ||
| To declare users such as _<your_policy_administrator_name>_ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following lines to the `app-config-rhdh.yaml` content: | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| + | ||
| .`app-config.yaml` fragment | ||
| [source,yaml,subs=+quotes] | ||
| ---- | ||
| permission: | ||
| enabled: true | ||
| rbac: | ||
| admin: | ||
| users: | ||
| - name: user:default/__<your_policy_administrator_name>__ | ||
| ---- | ||
|
|
||
| .Verification | ||
| . Sign out from the existing {product} session and log in again using the declared policy administrator account. | ||
| . With RBAC enabled, most features are disabled by default. | ||
| .. Navigate to the Catalog page in {product-very-short}. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| The Create button is not visible. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| You cannot create new components. | ||
| .. Navigate to the API page. | ||
| The Register button is not visible. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| .Next steps | ||
| * Explicitly enable permissions to resources in {product-short}. | ||
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.