Skip to content

Commit 7aff11f

Browse files
authored
Merge branch 'main' into HACDOCS-975-jfrog-artifactory-plugin
2 parents 0250423 + 4e10f85 commit 7aff11f

31 files changed

+423
-527
lines changed

artifacts/attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
:openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
3636
:rhsso-brand-name: Red Hat Single-Sign On
3737
:rhsso: RHSSO
38+
:rhbk-brand-name: Red Hat Build of Keycloak
39+
:rhbk: RHBK
3840

3941
// Partner Platforms
4042
:aws-brand-name: Amazon Web Services

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,22 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
66
* Synchronization of Keycloak users in a realm.
77
* Synchronization of Keycloak groups and their users in a realm.
88

9+
[NOTE]
10+
====
11+
The supported Keycloak version is `18.x`.
12+
====
13+
914
== Installation
1015

1116
The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
1217

1318
[source,yaml]
1419
----
15-
global:
16-
dynamic:
17-
includes:
20+
global:
21+
dynamic:
22+
includes:
1823
- dynamic-plugins.default.yaml
19-
plugins:
24+
plugins:
2025
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
2126
disabled: false
2227
----
@@ -87,7 +92,7 @@ The following table describes the parameters that you can configure to enable th
8792
| Name | Description | Default Value | Required
8893

8994
| `baseUrl`
90-
| Location of the Keycloak server, such as `pass:c[https://localhost:8443/auth]`. Note that the newer versions of Keycloak omit the `/auth` context path.
95+
| Location of the Keycloak server, such as `pass:c[https://localhost:8443/auth]`.
9196
| ""
9297
| Yes
9398

assemblies/assembly-audit-log.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,3 @@ include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2]
4444
include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
4545

4646
include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2]
47-
48-
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[id="assembly-authenticating-with-rhbk"]
2+
= Authenticating with {rhbk-brand-name} ({rhbk})
3+
4+
[NOTE]
5+
====
6+
{rhsso} 7.6 is deprecated as an authentication provider. You can continue using {rhsso} until the end of its maintenance support. For more information, see link:https://access.redhat.com/support/policy/updates/jboss_notes#p_sso[{rhsso} lifecycle dates]. As an alternative, consider migrating to {rhbk-brand-name} ({rhbk}).
7+
====
8+
9+
To authenticate users with {rhbk-brand-name} ({rhbk}):
10+
11+
. xref:enabling-authentication-with-rhbk[Enable the OpenID Connect (OIDC) authentication provider in RHDH].
12+
. xref:provisioning-users-from-rhbk-to-the-software-catalog[Provision users from {rhbk-brand-name} ({rhbk}) to the software catalog].
13+
14+
include::modules/authentication/proc-enabling-authentication-with-rhbk.adoc[leveloffset=+1]
15+
16+
include::modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1]
17+
18+
include::modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1]

assemblies/assembly-authenticating-with-rhsso.adoc

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

assemblies/assembly-enabling-authentication.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Therefore, deleting users and groups by using {product-short} Web UI or REST API
5353
include::assembly-authenticating-with-the-guest-user.adoc[leveloffset=+1]
5454

5555

56-
include::assembly-authenticating-with-rhsso.adoc[leveloffset=+1]
56+
include::assembly-authenticating-with-rhbk.adoc[leveloffset=+1]
5757

5858

5959
include::assembly-authenticating-with-github.adoc[leveloffset=+1]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[id="assembly-monitoring-and-logging-aks"]
2+
= Monitoring and logging with Azure Kubernetes Services (AKS) in {product}
3+
:context: assembly-monitoring-and-logging-aks
4+
5+
Monitoring and logging are integral aspects of managing and maintaining Azure Kubernetes Services (AKS) in {product}. With features like Managed Prometheus Monitoring and Azure Monitor integration, administrators can efficiently monitor resource utilization, diagnose issues, and ensure the reliability of their containerized workloads.
6+
7+
// Azure monitor metrics
8+
include::modules/observe/proc-enabling-azure-monitor-metrics.adoc[leveloffset=+1]
9+
10+
// configure annotations
11+
include::modules/observe/proc-configure-annotations-for-aks-monitoring.adoc[leveloffset=+1]
12+
13+
// view logs
14+
include::modules/observe/proc-view-logs-aks.adoc[leveloffset=+1]
15+
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
[id="proc-mount-directories-pvcs_{context}"]
2+
= Mounting directories from pre-created PVCs
3+
4+
Starting from `v1alpha3`, you can mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field.
5+
6+
.Prerequisites
7+
* You have understanding of the mounting logic:
8+
** If `spec.application.extraFiles.pvcs[].mountPath` is defined, the PVC is mounted to the specified path.
9+
** If `spec.application.extraFiles.pvcs[].mountPath` is not defined, the PVC is mounted under the path specified in `spec.application.extraFiles.mountPath/`.
10+
** If `mountPath` is not defined, the PVC defaults to `/opt/app-root/src`, or you can use the {product-very-short} container's working directory if it is specified.
11+
12+
.Procedure
13+
. Define the PVCs using the following YAML example:
14+
+
15+
--
16+
.Example YAML file to define PVCs
17+
[source,yaml]
18+
----
19+
apiVersion: v1
20+
kind: PersistentVolumeClaim
21+
metadata:
22+
name: myclaim1
23+
spec:
24+
accessModes:
25+
- ReadWriteOnce
26+
resources:
27+
requests:
28+
storage: 2Gi
29+
---
30+
apiVersion: v1
31+
kind: PersistentVolumeClaim
32+
metadata:
33+
name: myclaim2
34+
spec:
35+
accessModes:
36+
- ReadWriteOnce
37+
resources:
38+
requests:
39+
storage: 2Gi
40+
----
41+
--
42+
43+
. Use the following configuration to specify how the PVCs are mounted in the container:
44+
+
45+
--
46+
.Example configuration for mounting PVCs in a container
47+
[source,yaml]
48+
----
49+
spec:
50+
application:
51+
extraFiles:
52+
mountPath: /my/path
53+
pvcs:
54+
- name: myclaim1
55+
- name: myclaim2
56+
mountPath: /vol/my/claim
57+
----
58+
--
59+
60+
.Verification
61+
Based on the configuration, the following directories are mounted in the container:
62+
63+
* `/my/path/myclaim1`
64+
* `/vol/my/claim`

modules/admin/proc-rhdh-deployment-config.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ spec:
4646
----
4747

4848
`volumes`::
49-
Add an additional volume named `my-volume` and mount it under `/my/path` in the {product-short} application container.
5049
+
50+
--
51+
Add an additional volume named `my-volume` and mount it under `/my/path` in the {product-short} application container.
52+
5153
.Example additional volume
5254
[source, yaml]
5355
----
@@ -73,9 +75,9 @@ spec:
7375
storageClassName: "special"
7476
name: my-volume
7577
----
76-
+
78+
7779
Replace the default `dynamic-plugins-root` volume with a persistent volume claim (PVC) named `dynamic-plugins-root`. Note the `$patch: replace` directive, otherwise a new volume will be added.
78-
+
80+
7981
.Example `dynamic-plugins-root` volume replacement
8082
[source, yaml]
8183
----
@@ -95,6 +97,7 @@ spec:
9597
persistentVolumeClaim:
9698
claimName: dynamic-plugins-root
9799
----
100+
--
98101

99102
`cpu` request::
100103

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
[id="creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog"]
2-
= Creating a custom transformer to provision users from {rhsso-brand-name} ({rhsso}) to the software catalog
1+
[id="creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog"]
2+
= Creating a custom transformer to provision users from {rhbk-brand-name} ({rhbk}) to the software catalog
33

4-
To customize how {rhsso} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
4+
To customize how {rhbk} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
55

66
.Prerequisites
7-
* You have xref:provisioning-users-from-rhsso-to-the-software-catalog[enabled provisioning users from {rhsso-brand-name} ({rhsso}) to the software catalog].
7+
* You have xref:provisioning-users-from-rhbk-to-the-software-catalog[enabled provisioning users from {rhbk-brand-name} ({rhbk}) to the software catalog].
88

99
.Procedure
1010
. Create a new backend module with the `yarn new` command.
@@ -85,8 +85,8 @@ Check the console logs to verify that the synchronization is completed.
8585

8686
* After the first import is complete, navigate to the *Catalog* page and select **User** to view the list of users.
8787

88-
* When you select a user, you see the information imported from {rhsso}.
88+
* When you select a user, you see the information imported from {rhbk}.
8989

90-
* You can select a group, view the list, and access or review the information imported from {rhsso}.
90+
* You can select a group, view the list, and access or review the information imported from {rhbk}.
9191

92-
* You can log in with an {rhsso} account.
92+
* You can log in with an {rhbk} account.

0 commit comments

Comments
 (0)