Skip to content

Commit acf7457

Browse files
openshift-cherrypick-robotjmagakhmanwani-rhnickboldt
authored
[1.3.x] Fix: Added archived module (#528)
Co-authored-by: jmagak <jmagak@redhat.com> Co-authored-by: Heena Manwani <hmanwani@redhat.com> Co-authored-by: Nick Boldt <nboldt@redhat.com>
1 parent 6dd9bc4 commit acf7457

10 files changed

+148
-58
lines changed

‎archive/proc-customize-rhdh-branding.adoc‎

Lines changed: 0 additions & 55 deletions
This file was deleted.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ include::modules/admin/proc-rbac-ui-edit-role.adoc[leveloffset=+2]
4141
include::modules/admin/proc-rbac-ui-delete-role.adoc[leveloffset=+2]
4242

4343

44+
include::modules/admin/con-user-stats-rhdh.adoc[leveloffset=+1]
45+
46+
47+
include::modules/admin/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
48+
49+
4450
include::modules/admin/con-rbac-rest-api.adoc[leveloffset=+1]
4551

4652

‎assemblies/assembly-customize-rhdh-theme.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ You can also customize some components from the {product-short} GUI, such as the
2121

2222
include::modules/customization/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1]
2323

24-
include::modules/customization/proc-customize-rhdh-sidebar-logo.adoc[leveloffset=+1]
24+
include::modules/customization/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]
25+
26+
//include::modules/customization/proc-customize-rhdh-sidebar-logo.adoc[leveloffset=+1]//commented since the section has been merged with proc-customize-rhdh-branding-logo.adoc in PR #514
2527

2628
include::modules/customization/proc-customize-rhdh-tab-tooltip.adoc[leveloffset=+1]
2729

‎modules/admin/con-rbac-rest-api.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Base URL::
3939
--
4040

4141
The base URL for RBAC REST API requests is `pass:c[http://SERVER:PORT/api/permission/policies]`, such as `pass:c[http://localhost:7007/api/permission/policies]`.
42+
4243
--
4344

4445
Endpoints::

‎modules/admin/con-user-stats-rhdh.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[id='con-user-stats-rhdh_{context}']
2+
= User statistics in {product}
3+
4+
In {product}, the `licensed-users-info-backend` plugin provides statistical information about the logged-in users using the Web UI or REST API endpoints.
5+
6+
The `licensed-users-info-backend` plugin enables administrators to monitor the number of active users on {product-short}. Using this feature, organizations can compare their actual usage with the number of licenses they have purchased. Additionally, you can share the user metrics with {company-name} for transparency and accurate licensing.
7+
8+
The `licensed-users-info-backend` plugin is enabled by default. This plugin enables a *Download User List* link at the bottom of the *Administration -> RBAC* tab.

‎modules/admin/proc-download-user-stats-rhdh.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[id='proc-download-user-stats-rhdh_{context}']
2+
= Downloading active users list in {product}
3+
4+
You can download the list of users in CSV format using the {product-short} web interface.
5+
6+
.Prerequisites
7+
8+
* RBAC plugins (`@janus-idp/backstage-plugin-rbac` and `@janus-idp/backstage-plugin-rbac-backend`) must be enabled in {product}.
9+
* An administrator role must be assigned.
10+
11+
.Procedure
12+
13+
. In {product}, navigate to *Administration* and select the *RBAC* tab.
14+
. At the bottom of the *RBAC* page, click *Download User List*.
15+
. Optional: Modify the file name in the *Save as* field and click *Save*.
16+
. To access the downloaded users list, go to the *Downloads* folder on your local machine and open the CSV file.

‎modules/admin/ref-rbac-rest-api-endpoints.adoc‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -975,3 +975,80 @@ Deletes a conditional policy for the specified ID.
975975
----
976976
--
977977

978+
== User statistics
979+
980+
The `licensed-users-info-backend` plugin exposes various REST API endpoints to retrieve data related to logged-in users.
981+
982+
No additional configuration is required for the `licensed-users-info-backend` plugin. If the RBAC backend plugin is enabled, then an administrator role must be assigned to access the endpoints, as the endpoints are protected by the `policy.entity.read` permission.
983+
984+
The base URL for user statistics endpoints is `pass:c[http://SERVER:PORT/api/licensed-users-info]`, such as `pass:c[http://localhost:7007/api/licensed-users-info]`.
985+
986+
[GET] /users/quantity::
987+
+
988+
--
989+
Returns the total number of logged-in users.
990+
991+
.Example request
992+
[source,bash]
993+
----
994+
curl -X GET "http://localhost:7007/api/licensed-users-info/users/quantity" \
995+
-H "Content-Type: application/json" \
996+
-H "Authorization: Bearer $token"
997+
----
998+
999+
.Example response
1000+
[source,json]
1001+
----
1002+
{ "quantity": "2" }
1003+
----
1004+
--
1005+
1006+
[GET] /users::
1007+
+
1008+
--
1009+
Returns a list of logged-in users with their details.
1010+
1011+
.Example request
1012+
[source,bash]
1013+
----
1014+
curl -X GET "http://localhost:7007/api/licensed-users-info/users" \
1015+
-H "Content-Type: application/json" \
1016+
-H "Authorization: Bearer $token"
1017+
----
1018+
1019+
.Example response
1020+
[source,json]
1021+
----
1022+
[
1023+
{
1024+
"userEntityRef": "user:default/dev",
1025+
"lastTimeLogin": "Thu, 22 Aug 2024 16:27:41 GMT",
1026+
"displayName": "John Leavy",
1027+
"email": "dev@redhat.com"
1028+
}
1029+
]
1030+
----
1031+
--
1032+
1033+
[GET] /users::
1034+
+
1035+
--
1036+
Returns a list of logged-in users in CSV format.
1037+
1038+
.Example request
1039+
[source,bash]
1040+
----
1041+
curl -X GET "http://localhost:7007/api/licensed-users-info/users" \
1042+
-H "Content-Type: text/csv" \
1043+
-H "Authorization: Bearer $token"
1044+
----
1045+
1046+
.Example response
1047+
[source,csv]
1048+
----
1049+
userEntityRef,displayName,email,lastTimeLogin
1050+
user:default/dev,John Leavy,dev@redhat.com,"Thu, 22 Aug 2024 16:27:41 GMT"
1051+
----
1052+
--
1053+
1054+

‎modules/customization/proc-customize-rhdh-branding-logo.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
// assembly-customize-rhdh-theme.adoc
3+
//restored module as per slack thread: https://redhat-internal.slack.com/archives/C04CUSD4JSG/p1726856912238529
4+
5+
[id="proc-customize-rhdh-branding-logo_{context}"]
6+
= Customizing the branding logo of your {product-short} instance
7+
8+
You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `app-config-rhdh.yaml` file, as shown in the following example:
9+
10+
[source,yaml]
11+
----
12+
app:
13+
branding:
14+
fullLogo: ${BASE64_EMBEDDED_FULL_LOGO} <1>
15+
iconLogo: ${BASE64_EMBEDDED_ICON_LOGO} <2>
16+
----
17+
18+
where:
19+
20+
<1> `fullLogo` is the logo on the expanded (pinned) sidebar and expects a base64 encoded image.
21+
<2> `iconLogo` is the logo on the collapsed (unpinned) sidebar and expects a base64 encoded image.
22+
23+
You can also customize the width of the branding logo by setting a value for the `fullLogoWidth` field in the `branding` section, as shown in the following example:
24+
25+
[source,yaml]
26+
----
27+
app:
28+
branding:
29+
fullLogoWidth: 110px <1>
30+
# ...
31+
----
32+
33+
<1> The default value for the logo width is `110px`. The following units are supported: `integer`, `px`, `em`, `rem`, percentage.
34+

‎modules/customization/proc-customize-rhdh-sidebar-logo.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
2-
// assembly-customize-rhdh-theme.adoc
2+
// None
3+
//Archived since the section has been merged with proc-customize-rhdh-branding-logo.adoc in PR #514
34

45
[id="proc-customize-rhdh-sidebar-logo_{context}"]
56
= Customizing the sidebar logo width for your {product-short} instance

‎modules/getting-started/proc-add-source-control-rhdh-catalog.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id='proc-add-source-control-rhdh-catalog_{context}']
22
= Adding source control for Catalog in {product}
33

4-
To populate the Catalog in {product}, you need to add software templates, and to add the templates, you must enable a source control such as GitHub, GitLab, or BitBucket.
4+
To populate the Catalog in {product}, you need to add software templates, and to add the templates, you must enable a supported source control such as GitHub.
55

66
.Prerequisites
77

0 commit comments

Comments
 (0)