Skip to content

Commit 1f1ccc2

Browse files
jmagakGitHub Actions
and
GitHub Actions
authored
RHIDP-1848: Updates the setting up RBAC permission (redhat-developer#906)
* Updates the setting up RBAC permission * Update the setting up RBAC permission * Update the setting up RBAC permission * Update the setting up RBAC permission * Incorporate suggestions --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent 7200a92 commit 1f1ccc2

4 files changed

+71
-0
lines changed

assemblies/assembly-configuring-authorization-in-rhdh.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ include::assembly-managing-authorizations-by-using-the-rest-api.adoc[leveloffset
4141
include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffset=+1]
4242

4343

44+
include::assembly-configuring-guest-access-with-rbac-ui.adoc[leveloffset=+1]
45+
46+
4447
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
4548

4649

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[id="configuring-guest-access-with-rbac-ui_{context}"]
2+
= Configuring guest access with RBAC UI
3+
4+
Use guest access with the role-based access control (RBAC) front-end plugin to allow a user to test role and policy creation without the need to set up and configure an authentication provider.
5+
6+
[NOTE]
7+
====
8+
Guest access is not recommended for production.
9+
====
10+
11+
include::modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc[leveloffset=+1]
12+
13+
include::modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[id="configuring-the-rbac-backend-plugin_{context}"]
2+
= Configuring the RBAC backend plugin
3+
4+
You can configure the RBAC backend plugin by updating the `app-config.yaml` file to enable the permission framework.
5+
6+
.Prerequisites
7+
* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
8+
9+
.Procedure
10+
* Update the `app-config.yaml` file to enable the permission framework as shown:
11+
12+
[source,yaml,subs=+quotes]
13+
----
14+
permission
15+
enabled: true
16+
rbac:
17+
admin:
18+
users:
19+
- name: user:default/guest
20+
pluginsWithPermission:
21+
- catalog
22+
- permission
23+
- scaffolder
24+
----
25+
26+
[NOTE]
27+
====
28+
The `pluginsWithPermission` section of the `app-config.yaml` section includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions.
29+
====
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[id="setting-up-the-guest-authentication-provider_{context}"]
2+
= Setting up the guest authentication provider
3+
4+
You can enable guest authentication and use it alongside the RBAC frontend plugin.
5+
6+
.Prerequisites
7+
* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
8+
9+
.Procedure
10+
11+
* In the `app-config.yaml` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example:
12+
13+
[source,yaml,subs="+attributes,+quotes"]
14+
----
15+
auth:
16+
environment: development
17+
providers:
18+
guest:
19+
userEntityRef: user:default/guest
20+
dangerouslyAllowOutsideDevelopment: true
21+
----
22+
23+
[NOTE]
24+
====
25+
You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `app-config.yaml` file.
26+
====

0 commit comments

Comments
 (0)