Skip to content

Commit b7b65c7

Browse files
jmagakGitHub Actions
andauthored
Fix release notes links (#843)
Co-authored-by: GitHub Actions <[email protected]>
1 parent ac94b25 commit b7b65c7

File tree

4 files changed

+40
-58
lines changed

4 files changed

+40
-58
lines changed

modules/release-notes/ref-release-notes-breaking-changes.adoc

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
:_content-type: REFERENCE
2-
[id="breaking-changes"]
3-
= Breaking changes
4-
5-
This section lists breaking changes in {product} {product-version}.
6-
7-
[id="removed-functionality-rhidp-4572"]
8-
== Updated monitoring and logging metrics
9-
10-
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]
11-
12-
13-
.Additional resources
14-
* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]
15-
16-
[id="removed-functionality-rhidp-4853"]
17-
== Plugins with updated scope
18-
1+
:_content-type: REFERENCE
2+
[id="breaking-changes"]
3+
= Breaking changes
4+
5+
This section lists breaking changes in {product} {product-version}.
6+
7+
[id="removed-functionality-rhidp-4572"]
8+
== Updated monitoring and logging metrics
9+
10+
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]
11+
12+
13+
.Additional resources
14+
* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]
15+
16+
[id="removed-functionality-rhidp-4853"]
17+
== Plugins with updated scope
18+
1919
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.
2020

2121
With this update, the following plugins, previously under the `@janus-idp` scope, have now been moved to the `@backstage-community` scope:
2222

2323
[cols=2,%header]
2424
|===
25-
| *RHDH 1.3 Plugin Name*
25+
| *RHDH 1.3 Plugin Name*
2626
| *RHDH 1.4 Plugin Name*
2727
|`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
2828
|`@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
4545
The following plugins, previously under the `@backstage` scope, have now been moved to the `@backstage-community` scope:
4646
[cols=2,%header]
4747
|===
48-
| *RHDH 1.3 Plugin Name*
48+
| *RHDH 1.3 Plugin Name*
4949
| *RHDH 1.4 Plugin Name*
5050
|`@backstage/plugin-azure-devops`|`@backstage-community/plugin-azure-devops`
5151
|`@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
6464

6565
[cols=2,%header]
6666
|===
67-
| *RHDH 1.3 Plugin Name*
67+
| *RHDH 1.3 Plugin Name*
6868
| *RHDH 1.4 Plugin Name*
6969

7070
| `@janus-idp/backstage-plugin-bulk-import`
@@ -88,11 +88,11 @@ With the update to the plugin scope, the dynamic plugin configuration has also b
8888
[NOTE]
8989
====
9090
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.
91-
====
92-
93-
94-
.Additional resources
95-
* link:https://issues.redhat.com/browse/RHIDP-4853[RHIDP-4853]
96-
97-
98-
91+
====
92+
93+
94+
.Additional resources
95+
* link:https://issues.redhat.com/browse/RHIDP-4853[RHIDP-4853]
96+
97+
98+

modules/release-notes/ref-release-notes-deprecated-functionalities.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section lists deprecated functionalities in {product} {product-version}.
77
[id="deprecated-functionality-rhidp-3545"]
88
== `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin is deprecated
99

10-
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.
10+
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.
1111

1212

1313
.Additional resources
@@ -16,7 +16,7 @@ The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plug
1616
[id="deprecated-functionality-rhidp-4913"]
1717
== Audit log rotation is deprecated
1818

19-
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.
19+
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.
2020

2121

2222
.Additional resources

modules/release-notes/ref-release-notes-known-issues.adoc

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,18 @@ This section lists known issues in {product} {product-version}.
77
[id="known-issue-rhidp-5344"]
88
== Multi-Attached error for Volume (PVC)
99

10-
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.
11-
10+
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.
11+
1212
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.
1313

1414

1515
.Additional resources
1616
* link:https://issues.redhat.com/browse/RHIDP-5344[RHIDP-5344]
1717

18-
[id="known-issue-rhidp-5342"]
19-
== [Helm] Cannot run two RHDH replicas on different nodes due to Multi-Attach errors on the dynamic plugins root PVC
20-
21-
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.
22-
23-
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.
24-
You can also leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node.
25-
26-
27-
28-
.Additional resources
29-
* link:https://issues.redhat.com/browse/RHIDP-5342[RHIDP-5342]
30-
3118
[id="known-issue-rhidp-3396"]
3219
== Topology plugin permission is not displayed in the RBAC front-end UI
3320

34-
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`).
21+
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`).
3522

3623

3724
.Additional resources

modules/release-notes/ref-release-notes-new-features.adoc

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ This update adds an individual `mountPath` for link:{configuring-book-url}#proc-
1414

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

17-
[id="feature-rhidp-3817"]
18-
== Added Configuration Profiles
19-
20-
With this update, there are additional link:https://github.com/redhat-developer/rhdh-operator/blob/main/docs/profiles.md[configuration profiles].
21-
2217
[id="enhancement-rhidp-4384"]
2318
== Enhanced use of `kube-rbac-proxy`
2419

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

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

43-
4438
[id="feature-rhidp-4419"]
45-
== Ability to manage PVCs in RHDH Operator
39+
== Ability to manage Persistent Volume Claim (PVCs) in {product-very-short} Operator
4640

4741
You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring {product-very-short} Operator.
42+
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].
4843

4944

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

53-
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}].
48+
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}].
5449

5550
[id="feature-rhidp-4806"]
56-
== Ability to install third-party plugins in RHDH
51+
== Ability to install third-party plugins in {product-very-short}
5752

5853
You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
5954

60-
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].
55+
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}].
6156

6257
[id="feature-rhidp-5156"]
6358
== The catalog backend module logs plugin is enabled

0 commit comments

Comments
 (0)