Skip to content

Commit aba033d

Browse files
authored
RHIDP-8623 - [Doc] Create a quickstart for the developer persona (#1473)
* RHIDP-8623 - [Doc] Create a quickstart for the developer persona * RHIDP-8623 - [Doc] Create a quickstart for the developer persona * RHIDP-8623 - [Doc] Create a quickstart for the developer persona * Update con-using-rbac-with-quickstarts.adoc * RHIDP-8623 - [Doc] Create a quickstart for the developer persona * RHIDP-8623 - [Doc] Create a quickstart for the developer persona * RHIDP-8623 - [Doc] Create a quickstart for the developer persona
1 parent 4bfe8b9 commit aba033d

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

assemblies/assembly-configuring-the-quickstarts.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ include::modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc
1111
include::modules/configuring-the-quickstarts/proc-disabling-rhdh-quickstart.adoc[leveloffset=+2]
1212

1313
include::modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc[leveloffset=+1]
14+
15+
include::modules/configuring-the-quickstarts/con-using-rbac-with-quickstarts.adoc[leveloffset=+1]
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="using-rbac-with-quickstarts_{context}"]
4+
= About access to Quickstarts with Role-Based Access Control (RBAC)
5+
You can control user access to Quickstarts by using RBAC to define user roles that use the following logic in your RBAC configuration:
6+
7+
* If RBAC is enabled (`permission.enabled: true`), the system determines user roles based on permissions, as follows:
8+
** Users with `policy.entity.create` permission are assigned the admin role.
9+
** Users without this permission are assigned the developer role.
10+
11+
[NOTE]
12+
====
13+
If RBAC is disabled (`permission.enabled: false`) or not configured, users are assumed to be platform engineers setting up {product} ({product-very-short}) and are assigned the admin role.
14+
====
15+
16+
The following two roles are supported for defining access to Quickstarts:
17+
18+
admin:: Platform engineers, administrators, and users with elevated permissions
19+
developer:: Regular developers and users with standard permissions
20+
21+
The following behavior applies when you use RBAC to assign roles for your Quickstarts:
22+
23+
* Quickstart items without a `roles` property default to the admin role.
24+
* Items can specify multiple roles, for example, admin and developer.
25+
* Users see Quickstart items that match their assigned role.
26+
27+
.Example configuring RBAC for a Quickstart in your {my-app-config-file} file
28+
29+
[source,yaml]
30+
----
31+
permission:
32+
enabled: true
33+
34+
app:
35+
quickstart:
36+
- title: 'Platform Configuration'
37+
titleKey: steps.platformConfiguration.title
38+
roles: ['admin']
39+
# Only admins see this
40+
- title: 'Getting Started as Developer'
41+
titleKey: steps.gettingStarted.title
42+
roles: ['developer']
43+
# Only developers see this
44+
- title: 'Universal Welcome Guide'
45+
titleKey: steps.universalWelcome.title
46+
roles: ['admin', 'developer']
47+
# Both user roles see this
48+
----

modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,29 @@ app:
1818
- title: 'Welcome to {product-short}'
1919
description: 'Learn the basics of navigating the {product-short} interface'
2020
icon: 'home'
21+
roles: ['admin', 'developer'] # Show to both roles
2122
cta:
2223
text: 'Get Started'
2324
link: '/catalog'
2425
- title: 'Create Your First Component'
2526
description: 'Follow our guide to register your first software component'
2627
icon: 'code'
28+
roles: ['admin', 'developer'] # Show to both roles
2729
cta:
2830
text: 'Create Component'
2931
link: '/catalog-import'
3032
- title: 'Explore Templates'
3133
description: 'Discover available software templates to bootstrap new projects'
3234
icon: 'template'
35+
roles: ['admin', 'developer'] # Show to both roles
3336
cta:
3437
text: 'Browse Templates'
3538
link: '/create'
3639
----
3740
`title`:: Enter the display title for the quickstart step.
3841
`description`:: Enter the brief description of what the step covers.
3942
`icon`:: (Optional) Enter the icon identifier (supports Material UI icons).
43+
`roles`:: (Optional): Enter an array of user roles that should see this quickstart item. Supported values: `['admin', 'developer']`. If not specified, defaults to `['admin']`
4044
`cta`::
4145
`text`::: (Optional) Enter the CTA button text.
4246
`link`::: (Optional) Enter the CTA target URL or route.

0 commit comments

Comments
 (0)