From 644eeb9f2952643de852479a54600c3ff85563c8 Mon Sep 17 00:00:00 2001 From: Nick Boldt Date: Tue, 28 Jan 2025 10:42:39 -0500 Subject: [PATCH 1/3] chore: release note updates: remove 5308 (dupe of 5319, affects 1.5); add rhidp-5734 for GKE support; Judy's copy update for RHIDP-5344; dedupe 5342 vs 5344; temporarily remove RHIDP-4695 as it's not quite done Signed-off-by: Nick Boldt --- .../ref-release-notes-breaking-changes.adoc | 58 +++++++++---------- ...ease-notes-deprecated-functionalities.adoc | 2 +- .../ref-release-notes-fixed-issues.adoc | 12 ---- .../ref-release-notes-known-issues.adoc | 35 ++--------- .../ref-release-notes-new-features.adoc | 38 +++++++----- 5 files changed, 57 insertions(+), 88 deletions(-) diff --git a/modules/release-notes/ref-release-notes-breaking-changes.adoc b/modules/release-notes/ref-release-notes-breaking-changes.adoc index 9879bceed0..e795ab36d0 100644 --- 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/{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 - +:_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 index 8ae8f9de16..ea21f38eb3 100644 --- a/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc +++ b/modules/release-notes/ref-release-notes-deprecated-functionalities.adoc @@ -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'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-fixed-issues.adoc b/modules/release-notes/ref-release-notes-fixed-issues.adoc index 7d3c1956bc..bbd42711e5 100644 --- a/modules/release-notes/ref-release-notes-fixed-issues.adoc +++ b/modules/release-notes/ref-release-notes-fixed-issues.adoc @@ -23,18 +23,6 @@ If plugin names or configuration requirements have been changed, you may need to * link:https://issues.redhat.com/browse/RHIDP-4687[RHIDP-4687] -[id="bug-fix-rhidp-5308"] -=== notification backend and catalog backend gitlab org failing to load with MODULE_NOT_FOUND - -In the previous version of {product-short}, the GitLab Org catalog backend plugin (`plugin-catalog-backend-module-gitlab-org`)and the Notification backend plugin (`plugin-notifications-backend`) fail to load when configured with a `MODULE_NOT_FOUND` error. This has been fixed by embedding the missing dependencies in the dynamic plugins. - -See similar issue https://issues.redhat.com/browse/RHIDP-5319 - - -.Additional resources -* link:https://issues.redhat.com/browse/RHIDP-5308[RHIDP-5308] - - [id="bug-fix-rhidp-5411"] === RHDH fails on table lock when deploying using RHDH Operator 1.4 diff --git a/modules/release-notes/ref-release-notes-known-issues.adoc b/modules/release-notes/ref-release-notes-known-issues.adoc index fa8a756742..03c6f49fec 100644 --- a/modules/release-notes/ref-release-notes-known-issues.adoc +++ b/modules/release-notes/ref-release-notes-known-issues.adoc @@ -7,45 +7,18 @@ This section lists known issues in {product} {product-version}. [id="known-issue-rhidp-5344"] == Multi-Attached error for Volume (PVC) -Currently, when deploying {product-short} using the Helm Chart, two replicas cannot run on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node. - -Possible workarounds for the upgrade include the following actions: -* Manually scale down the number of replicas to 0 before upgrading your Helm release. -* Manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime. -* Leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node. +Currently, when deploying {product-short} using the Helm Chart, two replicas cannot run on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node. + +A possible workaround for the upgrade is to manually scale down the number of replicas to 0 before upgrading your Helm release. Or manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime. You can also leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node. .Additional resources * link:https://issues.redhat.com/browse/RHIDP-5344[RHIDP-5344] -[id="known-issue-rhidp-5342"] -== [Helm] Cannot run two RHDH replicas on different nodes due to Multi-Attach errors on the dynamic plugins root PVC - -If you are deploying {product-short} using the Helm Chart, it is currently impossible to have 2 replicas running on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node. - -A possible workaround for the upgrade is to manually scale down the number of replicas to 0 before upgrading your Helm release. Or manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime. -You can also leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node. - - - -.Additional resources -* link:https://issues.redhat.com/browse/RHIDP-5342[RHIDP-5342] - -[id="known-issue-rhidp-4695"] -== [Doc] OIDC refresh token behavior - -When using {rhsso-brand-name} or {rhbk-brand-name} as an OIDC provider, the default access token lifespan is set to 5 minutes, which corresponds to the token refresh grace period set in {product-short}. This 5-minute grace period is the threshold used to trigger a new refresh token call. Since the token is always near expiration, frequent refresh token requests will cause performance issues. - -This issue will be resolved in the 1.5 release. To prevent the performance issues, increase the lifespan in the {rhsso-brand-name} or {rhbk-brand-name} server by setting *Configure > Realm Settings > Access Token Lifespan* to a value greater than five minutes (preferably 10 or 15 minutes). - - -.Additional resources -* link:https://issues.redhat.com/browse/RHIDP-4695[RHIDP-4695] - [id="known-issue-rhidp-3396"] == Topology plugin permission is not displayed in the RBAC front-end UI -Permissions associated only with front-end plugins do not appear in the UI because they require a backend plugin to expose the permission framework's well-known endpoint. As a workaround, you can apply these permissions by using a CSV file or directly calling the REST API of the RBAC backend plugin. Affected plugins include Topology (`topology.view.read`), Tekton (`tekton.view.read`), ArgoCD (`argocd.view.read`), and Quay (`quay.view.read`). +Permissions associated only with front-end plugins do not appear in the UI because they require a backend plugin to expose the permission framework's well-known endpoint. As a workaround, you can apply these permissions by using a CSV file or directly calling the REST API of the RBAC backend plugin. Affected plugins include Topology (`topology.view.read`), Tekton (`tekton.view.read`), ArgoCD (`argocd.view.read`), and Quay (`quay.view.read`). .Additional resources diff --git a/modules/release-notes/ref-release-notes-new-features.adoc b/modules/release-notes/ref-release-notes-new-features.adoc index b31efc1067..7abab44894 100644 --- a/modules/release-notes/ref-release-notes-new-features.adoc +++ b/modules/release-notes/ref-release-notes-new-features.adoc @@ -22,24 +22,24 @@ This update removes the `kube-rbac-proxy` sidecar container from the RHDH Operat [id="feature-rhidp-4414"] == Identifying Backstage flavor for plugins by using the `developerHub.flavor` field -With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example: - -.`app-config.yaml` fragment with the `developerhub.flavor` field - -[source,yaml,subs="+quotes"] ----- -developerHub: - flavor: ----- - -`flavor`:: +With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example: + +.`app-config.yaml` fragment with the `developerhub.flavor` field + +[source,yaml,subs="+quotes"] +---- +developerHub: + flavor: <flavor> +---- + +`flavor`:: Identify the flavor of Backstage that is running. Default value: `rhdh` [id="feature-rhidp-4419"] == Ability to manage Persistent Volume Claim (PVCs) in {product-very-short} Operator -You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring {product-very-short} Operator. -For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring/index#configuring-the-deployment[Configuring {product} deployment when using the Operator]. +You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring {product-very-short} Operator. +For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring/index#configuring-the-deployment[Configuring {product} deployment when using the Operator]. [id="feature-rhidp-4805"] @@ -50,8 +50,8 @@ With this update, you can use {rhbk-brand-name} as an authentication provider. T [id="feature-rhidp-4806"] == Ability to install third-party plugins in {product-very-short} -You can now install third-party plugins in {product} without rebuilding the {product-very-short} application. - +You can now install third-party plugins in {product} without rebuilding the {product-very-short} application. + For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in {product}]. [id="feature-rhidp-5156"] @@ -59,5 +59,13 @@ For more information, see link:https://docs.redhat.com/en/documentation/red_hat_ With this update, the `backstage-plugin-catalog-backend-module-logs` is enabled and converted to a static plugin improving performance and stability. The dynamic plugin was disabled in version `1.3`. +[id="feature-rhidp-5734"] +== Google Kubernetes Engine now supported + +Google Kubernetes Engine (Google GKE) is out of Developer Preview and is now fully supported as of RHDH 1.4. + +See the full list of supported platforms at https://access.redhat.com/support/policy/updates/developerhub + + From 13ccc52e5f0b9e4d89647b0c610392717fd3802f Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 29 Jan 2025 00:54:35 +0100 Subject: [PATCH 2/3] add rhidp-5734 for GKE support; Judy's copy update for RHIDP-5344; dedupe 5342 vs 5344; temporarily remove RHIDP-4695 as it's not quite done --- modules/release-notes/ref-release-notes-new-features.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/modules/release-notes/ref-release-notes-new-features.adoc b/modules/release-notes/ref-release-notes-new-features.adoc index 7abab44894..b54f94a456 100644 --- a/modules/release-notes/ref-release-notes-new-features.adoc +++ b/modules/release-notes/ref-release-notes-new-features.adoc @@ -60,12 +60,11 @@ For more information, see link:https://docs.redhat.com/en/documentation/red_hat_ With this update, the `backstage-plugin-catalog-backend-module-logs` is enabled and converted to a static plugin improving performance and stability. The dynamic plugin was disabled in version `1.3`. [id="feature-rhidp-5734"] -== Google Kubernetes Engine now supported +== {gke-brand-name} now supported -Google Kubernetes Engine (Google GKE) is out of Developer Preview and is now fully supported as of RHDH 1.4. +{gke-brand-name} ({gke-short}) is out of Developer Preview and is now fully supported as of {product-very-short} {product-version}. -See the full list of supported platforms at https://access.redhat.com/support/policy/updates/developerhub - +See the full list of supported platforms on the link:https://access.redhat.com/support/policy/updates/developerhub[Life Cycle page]. From cae0e8e0b0c36928046f9a18bc4bbf504bfd12e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 29 Jan 2025 11:20:34 +0100 Subject: [PATCH 3/3] Update modules/release-notes/ref-release-notes-breaking-changes.adoc --- .../ref-release-notes-breaking-changes.adoc | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/modules/release-notes/ref-release-notes-breaking-changes.adoc b/modules/release-notes/ref-release-notes-breaking-changes.adoc index e795ab36d0..d3aa8d6bbe 100644 --- a/modules/release-notes/ref-release-notes-breaking-changes.adoc +++ b/modules/release-notes/ref-release-notes-breaking-changes.adoc @@ -1,21 +1,21 @@ -:_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 - +:_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: @@ -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] + + +