Skip to content

Commit

Permalink
Fix release notes links (#843)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Actions <[email protected]>
  • Loading branch information
jmagak and GitHub Actions authored Jan 27, 2025
1 parent ac94b25 commit b7b65c7
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 58 deletions.
58 changes: 29 additions & 29 deletions modules/release-notes/ref-release-notes-breaking-changes.adoc
Original file line number Diff line number Diff line change
@@ -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`
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -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]



Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
19 changes: 3 additions & 16 deletions modules/release-notes/ref-release-notes-known-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +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.

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-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&#39;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
Expand Down
17 changes: 6 additions & 11 deletions modules/release-notes/ref-release-notes-new-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ This update adds an individual `mountPath` for link:{configuring-book-url}#proc-

With this update, link:https://github.com/redhat-developer/rhdh-operator/blob/main/docs/configuration.md#persistentvolumeclaims[`PersistentVolumeClaims` (PVC)] support is available.

[id="feature-rhidp-3817"]
== Added Configuration Profiles

With this update, there are additional link:https://github.com/redhat-developer/rhdh-operator/blob/main/docs/profiles.md[configuration profiles].

[id="enhancement-rhidp-4384"]
== Enhanced use of `kube-rbac-proxy`

Expand All @@ -34,30 +29,30 @@ With this update, you can use the `developerHub.flavor` field to identify whethe
[source,yaml,subs="+quotes"]
----
developerHub:
flavor: &lt;flavor&gt;;
flavor: <flavor>
----

`flavor`::
Identify the flavor of Backstage that is running. Default value: `rhdh`


[id="feature-rhidp-4419"]
== Ability to manage PVCs in RHDH Operator
== 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].


[id="feature-rhidp-4805"]
== Authenticating with {rhbk-brand-name}

With this update, you can use {rhbk-brand-name} as an authentication provider. The Keycloak plugin will now support ingesting users and groups with {rhbk-brand-name}. For more details, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/getting_started_guide/index#getting-started-zip-start-red-hat-build-of-keycloak[Authentication with {rhbk-brand-name}].
With this update, you can use {rhbk-brand-name} as an authentication provider. The Keycloak plugin will now support ingesting users and groups with {rhbk-brand-name}. For more details, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/authentication/index#assembly-authenticating-with-rhbk[Authenticating with {rhbk-brand-name}].

[id="feature-rhidp-4806"]
== Ability to install third-party plugins in RHDH
== 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.

For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/introduction_to_plugins/index[Third party plugins].
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"]
== The catalog backend module logs plugin is enabled
Expand Down

0 comments on commit b7b65c7

Please sign in to comment.