Merge branch 'release-1.4' into RHIDP-5070-Compatibility-Matrix-in-RHDH-1.4

jmagak · web-flow · commit 15041ab45de2 · 2025-01-27T17:05:34.000+01:00
diff --git a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc
@@ -6,7 +6,7 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on
 [[installing-tekton-plugin]]
 == Installation
 
-.Prerequsites
+.Prerequisites
 * You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins.
 //For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[].
 //Cannot xref across titles. Convert xref to a link.
@@ -140,4 +140,4 @@ global:
       - package: ./dynamic-plugins/dist/backstage-community-plugin-tekton
         disabled: false
 ----
---
+--
diff --git a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc
@@ -8,7 +8,7 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on
 [[installing-tekton-plugin]]
 === Installation
 
-.Prerequsites
+.Prerequisites
 * You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins.
 //For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[].
 //Cannot xref across titles. Convert xref to a link.
diff --git a/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc
@@ -191,7 +191,7 @@ You can use the https://raw.githubusercontent.com/backstage/community-plugins/ma
 ====
 --
 
-* The following annotation is added to the entity's `catalog-info.yaml` file to identify whether an entitiy contains the Kubernetes resources:
+* The following annotation is added to the entity's `catalog-info.yaml` file to identify whether an entity contains the Kubernetes resources:
 +
 --
 [source,yaml]
diff --git a/modules/authentication/proc-enabling-authentication-with-rhbk.adoc b/modules/authentication/proc-enabling-authentication-with-rhbk.adoc
@@ -23,11 +23,6 @@ Save the value for the next step:
 * **Client ID**
 * **Client Secret**
 
-.. Configure your {rhbk} realm for performance and security:
-... Navigate to the **Configure** > **Realm Settings**.
-... Set the **Access Token Lifespan** to a value greater than five minutes (preferably 10 or 15 minutes) to prevent performance issues from frequent refresh token requests for every API call.
-... Enable the **Revoke Refresh Token** option to improve security by enabling the refresh token rotation strategy.
-
 .. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/24.0/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps.
 
 . To add your {rhsso} credentials to your {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
@@ -182,6 +177,13 @@ auth:
 
 --
 
+.Security consideration
+If multiple valid refresh tokens are issued due to frequent refresh token requests, older tokens will remain valid until they expire. To enhance security and prevent potential misuse of older tokens, enable a refresh token rotation strategy in your {rhbk} realm.
+
+. From the *Configure* section of the navigation menu, click *Realm Settings*.
+. From the *Realm Settings* page, click the *Tokens* tab.
+. From the *Refresh tokens* section of the *Tokens* tab, toggle the *Revoke Refresh Token* to the *Enabled* position.
+
 .Verification
 . Go to the {product-short} login page.
 . Your {product-short} sign-in page displays *Sign in using OIDC* and the Guest user sign-in is disabled.
diff --git a/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc b/modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc
@@ -1,5 +1,5 @@
 [id="mounting-additional-files-in-your-custom-configuration-using-rhdh-operator"]
-= Mounting additional files in your custom configuration using the {product} operator
+= Mounting additional files in your custom configuration using the {product} Operator
 
 You can use the {product-short} Operator to mount extra files, such as a ConfigMap or Secret, to the container in a preferred location.
 
diff --git a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc
@@ -148,7 +148,7 @@ spec:
 ----
 ====
 +
-.Inject the envvironment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
+.Inject the environment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
 ====
 [source,yaml,subs="+attributes,+quotes"]
 ----
diff --git a/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc b/modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc
@@ -28,7 +28,7 @@ spec:
 +
 [NOTE]
 ====
-Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret have the same name as the `ObjetBucketClaim` CR.
+Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret have the same name as the `ObjectBucketClaim` CR.
 ====
 
 After you create the `ObjectBucketClaim` CR, you can use the information stored in the config map and secret to make the information accessible to the {product-short} container as environment variables. Depending on the method that you used to install {product-short}, you add the access information to either the {product} Helm chart or Operator configuration.
diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc
@@ -113,7 +113,7 @@ dynamicPlugins:
 ----
 
 
-<1> The `default.` prefix identifes an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.<menu_group_parent_item_name>` in the previous example.
+<1> The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.<menu_group_parent_item_name>` in the previous example.
 
 [NOTE]
 ====
diff --git a/modules/dynamic-plugins/proc-create-plugin-tgz-file.adoc b/modules/dynamic-plugins/proc-create-plugin-tgz-file.adoc
@@ -50,7 +50,7 @@ To create a plugin registry using HTTP server on {ocp-short}, run the following
 .Example commands to build and deploy an HTTP server in {ocp-short}
 [source,terminal]
 ----
-oc project rhdh
+oc project {my-product-namespace}
 oc new-build httpd --name=plugin-registry --binary
 oc start-build plugin-registry --from-dir=dynamic-plugins-root --wait
 oc new-app --image-stream=plugin-registry
diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc
@@ -94,7 +94,7 @@ If an x509 error occurs, verify that you have link:https://access.redhat.com/sol
 +
 [source,terminal]
 ----
-oc get imagestream -n <project_name>
+oc get imagestream -n {my-product-namespace}
 ----
 
 . Enable local image lookup for both images by running the following commands:
diff --git a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc
@@ -14,7 +14,7 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}.
 * You have installed the Helm CLI tool.
 
 .Procedure
-. Create and activate the _<rhdh>_ {ocp-short} project:
+. Create and activate the _<{my-product-namespace}>_ {ocp-short} project:
 +
 [subs="quotes+"]
 ----
diff --git a/modules/installation/proc-rhdh-deploy-aks-helm.adoc b/modules/installation/proc-rhdh-deploy-aks-helm.adoc
@@ -16,7 +16,7 @@ You can deploy your {product-short} application on {aks-name} ({aks-short}) to a
 
 .Comparison of {aks-short} specifics with the base {product-short} deployment
 
-* *Permissions issue*: {product-short} containers might encounter permission-related errors, such as `Permission denied` when attempting certain operations. This error can be addresssed by adjusting the `fsGroup` in the `PodSpec.securityContext`.
+* *Permissions issue*: {product-short} containers might encounter permission-related errors, such as `Permission denied` when attempting certain operations. This error can be addressed by adjusting the `fsGroup` in the `PodSpec.securityContext`.
 
 * *Ingress configuration*: In AKS, configuring ingress is essential for accessing the installed {product-short} instance. Accessing the {product-short} instance requires enabling the Routing add-on, an NGINX-based Ingress Controller, using the following command:
 +
@@ -108,7 +108,7 @@ The previous command configures the Kubernetes client and sets the current conte
 helm repo add openshift-helm-charts https://charts.openshift.io/
 ----
 
-. Create and activate the _<rhdh>_ namespace:
+. Create and activate the _<{my-product-namespace}>_ namespace:
 +
 [source,terminal,subs="quotes+"]
 ----
diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc
@@ -56,13 +56,13 @@ kubectl -n <your_namespace> create secret docker-registry rhdh-pull-secret \
 . Create an Ingress manifest file, named `rhdh-ingress.yaml`, specifying your {product-short} service name as follows:
 +
 --
-[source,yaml]
+[source,yaml,subs="+attributes,+quotes"]
 ----
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
   name: rhdh-ingress
-  namespace: <your_namespace>
+  namespace: {my-product-namespace}
 spec:
   ingressClassName: webapprouting.kubernetes.azure.com
   rules:
@@ -153,18 +153,18 @@ spec:
 . Apply the CR manifest to your namespace:
 +
 --
-[source,terminal]
+[source,terminal,subs="+attributes,+quotes"]
 ----
-kubectl -n <your_namespace> apply -f rhdh.yaml
+kubectl -n {my-product-namespace} apply -f rhdh.yaml
 ----
 --
 
 . Access the deployed {product-short} using the URL: `https://<app_address>`, where <app_address> is the Ingress address obtained earlier (for example, `https://108.141.70.228`).
 . Optional: To delete the CR, run the following command:
 +
 --
-[source,terminal]
+[source,terminal,subs="+attributes,+quotes"]
 ----
-kubectl -n <your_namespace> delete -f rhdh.yaml
+kubectl -n {my-product-namespace} delete -f rhdh.yaml
 ----
 --
diff --git a/modules/installation/proc-rhdh-deploy-eks-operator.adoc b/modules/installation/proc-rhdh-deploy-eks-operator.adoc
@@ -6,7 +6,7 @@
 
 The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework.
 
-.Additonal resources
+.Additional resources
 * For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
 
 == Installing the {product-short} Operator with the OLM framework
diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc
@@ -20,20 +20,20 @@ Currently, the {product} Operator does not support creating a `ServiceMonitor` c
 
 . Create the `ServiceMonitor` CR as a YAML file:
 +
-[source,yaml]
+[source,yaml,subs="+attributes,+quotes"]
 ----
 apiVersion: monitoring.coreos.com/v1
 kind: ServiceMonitor
 metadata:
   name: <custom_resource_name> # <1>
-  namespace: <project_name> # <2>
+  namespace: {my-product-namespace} # <2>
   labels:
     app.kubernetes.io/instance: <custom_resource_name>
     app.kubernetes.io/name: backstage
 spec:
   namespaceSelector:
     matchNames:
-      - <project_name>
+      - {my-product-namespace}
   selector:
     matchLabels:
       rhdh.redhat.com/app: backstage-<custom_resource_name>
diff --git a/modules/observe/proc-forward-audit-log-splunk.adoc b/modules/observe/proc-forward-audit-log-splunk.adoc
@@ -82,14 +82,14 @@ serviceAccount:
 +
 --
 .Example `inputs` configuration
-[source,yaml]
+[source,yaml,subs="+attributes,+quotes"]
 ----
 inputs:
   - name: my-app-logs-input
     type: application
     application:
       includes:
-        - namespace: my-developer-hub-namespace
+        - namespace: {my-product-namespace}
       containerLimit:
         maxRecordsPerSecond: 100
 ----
diff --git a/modules/proc-create-plugin.adoc b/modules/proc-create-plugin.adoc
@@ -11,7 +11,7 @@ You can create a plugin for the {product-short} application.
 
 .Procedure
 
-. In the terminal application, run the following command from the root of your {product-short} project:
+. In the terminal application, run the following command from the root of your {my-product-namespace} project:
 +
 --
 [source,terminal]
diff --git a/modules/release-notes/ref-release-notes-breaking-changes.adoc b/modules/release-notes/ref-release-notes-breaking-changes.adoc
@@ -1,28 +1,28 @@
-:_content-type: REFERENCE
-[id="breaking-changes"]
-= Breaking changes
-
-This section lists breaking changes in {product} {product-version}.
-
-[id="removed-functionality-rhidp-4572"]
-== Updated monitoring and logging metrics
-
-Prom-client metrics have been removed and replaced with OpenTelemetry metrics. As a result, the metrics port has changed from `7007` to `9464`. Deprecated metrics have also been removed. If you had dependencies on these, ensure your prometheus queries are updated. For further information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html-single/monitoring_and_logging/index#assembly-rhdh-observability[Monitoring and logging]
-
-
-.Additional resources
-* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]
-
-[id="removed-functionality-rhidp-4853"]
-==  Plugins with updated scope
-
+:_content-type: REFERENCE
+[id="breaking-changes"]
+= Breaking changes
+
+This section lists breaking changes in {product} {product-version}.
+
+[id="removed-functionality-rhidp-4572"]
+== Updated monitoring and logging metrics
+
+Prom-client metrics have been removed and replaced with OpenTelemetry metrics. As a result, the metrics port has changed from `7007` to `9464`. Deprecated metrics have also been removed. If you had dependencies on these, ensure your prometheus queries are updated. For further information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index[Monitoring and logging]
+
+
+.Additional resources
+* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]
+
+[id="removed-functionality-rhidp-4853"]
+==  Plugins with updated scope
+
 To upgrade from {product-very-short} 1.3 to 1.4, you must update your configuration to use the latest versions of the following plugins from the new scope.
 
 With this update, the following plugins, previously under the `@janus-idp` scope, have now been moved to the `@backstage-community` scope:
 
 [cols=2,%header]
 |===
-| *RHDH 1.3 Plugin Name* 
+| *RHDH 1.3 Plugin Name*
 | *RHDH 1.4 Plugin Name*
 |`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
 |`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
@@ -45,7 +45,7 @@ With this update, the following plugins, previously under the `@janus-idp` scope
 The following plugins, previously under the `@backstage` scope, have now been moved to the `@backstage-community` scope:
 [cols=2,%header]
 |===
-| *RHDH 1.3 Plugin Name* 
+| *RHDH 1.3 Plugin Name*
 | *RHDH 1.4 Plugin Name*
 |`@backstage/plugin-azure-devops`|`@backstage-community/plugin-azure-devops`
 |`@backstage/plugin-azure-devops-backend`|`@backstage-community/plugin-azure-devops-backend`
@@ -64,7 +64,7 @@ Two plugins previously under the `@janus-idp` scope have moved to `@red-hat-deve
 
 [cols=2,%header]
 |===
-| *RHDH 1.3 Plugin Name* 
+| *RHDH 1.3 Plugin Name*
 | *RHDH 1.4 Plugin Name*
 
 | `@janus-idp/backstage-plugin-bulk-import`
@@ -88,11 +88,11 @@ With the update to the plugin scope, the dynamic plugin configuration has also b
 [NOTE]
 ====
 In addition to the previously provided tables, you can compare the link:https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.4/modules/dynamic-plugins/rhdh-supported-plugins.csv[RHDH 1.4 CSV file] with the link:https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.3/modules/dynamic-plugins/rhdh-supported-plugins.csv[RHDH 1.3 CSV file] to identify the changes in dynamic plugins.
-====
-
-
-.Additional resources
-* link:https://issues.redhat.com/browse/RHIDP-4853[RHIDP-4853]
-
-
-
+====
+
+
+.Additional resources
+* link:https://issues.redhat.com/browse/RHIDP-4853[RHIDP-4853]
+
+
+
diff --git a/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc b/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc
@@ -7,7 +7,7 @@ This section lists deprecated functionalities in {product} {product-version}.
 [id="deprecated-functionality-rhidp-3545"]
 == `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin is deprecated
 
-The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin has been deprecated and will be removed in the next release. You can link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[use Ansible plug-ins for {product-very-short}] instead.
+The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin has been deprecated and will be removed in the next release. You can link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[use Ansible plug-ins for {product}] instead.
 
 
 .Additional resources
@@ -16,7 +16,7 @@ The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plug
 [id="deprecated-functionality-rhidp-4913"]
 == Audit log rotation is deprecated
 
-With this update, you can evaluate your platform&#39;s log forwarding solutions to align with your security and compliance needs. Most of these solutions offer configurable options to minimize the loss of logs in the event of an outage.
+With this update, you can evaluate your platform's log forwarding solutions to align with your security and compliance needs. Most of these solutions offer configurable options to minimize the loss of logs in the event of an outage.
 
 
 .Additional resources
diff --git a/modules/release-notes/ref-release-notes-known-issues.adoc b/modules/release-notes/ref-release-notes-known-issues.adoc
diff --git a/modules/release-notes/ref-release-notes-new-features.adoc b/modules/release-notes/ref-release-notes-new-features.adoc
diff --git a/modules/upgrade/proc-upgrade-rhdh-helm.adoc b/modules/upgrade/proc-upgrade-rhdh-helm.adoc

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ You can use the https://raw.githubusercontent.com/backstage/community-plugins/ma`
`191`	`191`	`====`
`192`	`192`	`--`
`193`	`193`
`194`		-* The following annotation is added to the entity's `catalog-info.yaml` file to identify whether an entitiy contains the Kubernetes resources:
	`194`	+* The following annotation is added to the entity's `catalog-info.yaml` file to identify whether an entity contains the Kubernetes resources:
`195`	`195`	`+`
`196`	`196`	`--`
`197`	`197`	`[source,yaml]`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ spec:`
`148`	`148`	`----`
`149`	`149`	`====`
`150`	`150`	`+`
`151`		-.Inject the envvironment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
	`151`	+.Inject the environment variables in the `{my-product-secrets}` and `{my-product-database-secrets}` secrets
`152`	`152`	`====`
`153`	`153`	`[source,yaml,subs="+attributes,+quotes"]`
`154`	`154`	`----`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ spec:`
`28`	`28`	`+`
`29`	`29`	`[NOTE]`
`30`	`30`	`====`
`31`		-Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret have the same name as the `ObjetBucketClaim` CR.
	`31`	+Creating the {product-short} `ObjectBucketClaim` CR automatically creates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret have the same name as the `ObjectBucketClaim` CR.
`32`	`32`	`====`
`33`	`33`
`34`	`34`	After you create the `ObjectBucketClaim` CR, you can use the information stored in the config map and secret to make the information accessible to the {product-short} container as environment variables. Depending on the method that you used to install {product-short}, you add the access information to either the {product} Helm chart or Operator configuration.
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ If an x509 error occurs, verify that you have link:https://access.redhat.com/sol`
`94`	`94`	`+`
`95`	`95`	`[source,terminal]`
`96`	`96`	`----`
`97`		`-oc get imagestream -n <project_name>`
	`97`	`+oc get imagestream -n {my-product-namespace}`
`98`	`98`	`----`
`99`	`99`
`100`	`100`	`. Enable local image lookup for both images by running the following commands:`