Skip to content

Commit c589327

Browse files
themr0cdzemanovhmanwani-rhjmagakGerry-Forde
authored
RHIDP-3972 RHIDP-3973 Enabling and giving access to the Role-Based Access Control (RBAC) feature (#631)
* RHIDP-3972 enabling the rbac plugin Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-3973 configuring policy administrators Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-3973 configuring policy administrators Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-3973 configuring policy administrators Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-3973 configuring policy administrators Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/authorization/proc-enabling-the-rbac-plugin.adoc * Update modules/authorization/proc-enabling-the-rbac-plugin.adoc Co-authored-by: Dominika Zemanovicova <[email protected]> * Apply suggestions from code review Co-authored-by: jmagak <[email protected]> * Update modules/authorization/proc-enabling-the-rbac-plugin.adoc * Apply suggestions from code review Co-authored-by: Heena Manwani <[email protected]> --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Dominika Zemanovicova <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: jmagak <[email protected]> Co-authored-by: Gerry-Forde <[email protected]>
1 parent f1a9cbf commit c589327

File tree

3 files changed

+56
-39
lines changed

3 files changed

+56
-39
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ To apply RBAC in {product-short}:
2727
.. Assign the roles to users and groups
2828

2929

30-
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
30+
include::modules/authorization/proc-enabling-the-rbac-plugin.adoc[leveloffset=+1]
3131

3232

33-
include::modules/authorization/con-rbac-config-permission-policies.adoc[leveloffset=+2]
33+
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
3434

3535

36-
include::modules/authorization/con-rbac-config-permission-policies-admin.adoc[leveloffset=+3]
36+
include::modules/authorization/con-rbac-config-permission-policies.adoc[leveloffset=+2]
3737

3838

3939
include::modules/authorization/con-rbac-config-permission-policies-external-file.adoc[leveloffset=+3]

modules/authorization/con-rbac-config-permission-policies-admin.adoc

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
[id='enabling-and-giving-access-to-rbac']
2+
= Enabling and giving access to the Role-Based Access Control (RBAC) feature
3+
4+
The Role-Based Access Control (RBAC) feature is disabled by default.
5+
Enable the RBAC plugin and declare policy administrators to start using RBAC features.
6+
7+
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.
8+
9+
.Prerequisites
10+
* 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.
11+
* You have link:{authentication-book-title}[enabled an authentication provider].
12+
13+
.Procedure
14+
. The RBAC plugin is installed but disabled by default.
15+
To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac` plugin, edit your `dynamic-plugins.yaml` with the following content.
16+
+
17+
.`dynamic-plugins.yaml` fragment
18+
[source,yaml]
19+
----
20+
plugins:
21+
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac
22+
disabled: false
23+
----
24+
+
25+
See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
26+
27+
. Declare policy administrators to enable a select number of authenticated users to configure RBAC policies through the REST API or Web UI, instead of modifying the CSV file directly.
28+
The permissions can be specified in a separate CSV file referenced in the `app-config-rhdh` ConfigMap, or permissions can be created using the REST API or Web UI.
29+
+
30+
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 code to the `app-config-rhdh.yaml` content:
31+
+
32+
.`app-config.yaml` fragment
33+
[source,yaml,subs=+quotes]
34+
----
35+
permission:
36+
enabled: true
37+
rbac:
38+
admin:
39+
users:
40+
- name: user:default/__<your_policy_administrator_name>__
41+
----
42+
43+
.Verification
44+
. Sign out from the existing {product} session and log in again using the declared policy administrator account.
45+
. With RBAC enabled, most features are disabled by default.
46+
.. Navigate to the *Catalog* page in {product-very-short}.
47+
The *Create* button is not visible.
48+
You cannot create new components.
49+
.. Navigate to the API page.
50+
The *Register* button is not visible.
51+
52+
.Next steps
53+
* Explicitly enable permissions to resources in {product-short}.

0 commit comments

Comments
 (0)