Skip to content

Commit 7bc00d6

Browse files
committed
refreshed from Jira
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 1f6edf1 commit 7bc00d6

6 files changed

+57
-64
lines changed

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
This section lists breaking changes in {product} {product-version}.
66

77
[id="removed-functionality-rhidp-4572"]
8-
== [Docs] Metrics: Document the support for exposing metrics for customers related to critical functionalities in RHDH
9-
10-
Breaking change.
11-
12-
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 &lt;link to observability/monitoring and logging docs&gt;
13-
8+
== Updated monitoring and logging metrics
149

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]
1511
.Additional resources
1612
* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]
1713

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@
55
This section lists deprecated functionalities in {product} {product-version}.
66

77
[id="deprecated-functionality-rhidp-3545"]
8-
== Deprecation of aap plugin
8+
== `./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 [using Ansible plug-ins for {RHDH}] 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-very-short}] instead.
1111
.Additional resources
1212
* link:https://issues.redhat.com/browse/RHIDP-3545[RHIDP-3545]
1313

1414
[id="deprecated-functionality-rhidp-4913"]
15-
== [Docs] Deprecate Audit Log PVC
15+
== Audit log rotation is deprecated
1616

17-
Audit Log Rotation is deprecated.
1817
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.
1918
.Additional resources
2019
* link:https://issues.redhat.com/browse/RHIDP-4913[RHIDP-4913]

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section lists issues fixed in {product} {product-version}.
77
== Fixed issues in 1.4
88

99
[id="bug-fix-rhidp-2727"]
10-
=== [backstage/community-plugins] Github issues plugin does not allow usage of multiple github hosts
10+
=== GitHub issues plugin supports multiple GitHub integration hosts
1111

1212
Previously, the GitHub issues plugin defaulted to using the first GitHub integration it detected for all components. This behavior made it incompatible with setups involving multiple GitHub integration hosts.
1313

@@ -18,7 +18,7 @@ Now, GitHub issues plugin supports multiple GitHub integration hosts. It uses th
1818

1919

2020
[id="bug-fix-rhidp-2903"]
21-
=== [janus-idp/backstage-plugins] 3scale backend plugin - Only first spec gets imported
21+
=== All API documentation is defined in the 3scale backend plugin
2222

2323
Previously, some API documentation defined in the 3scale backend plugin was not accessible in {product-very-short}.
2424

@@ -28,7 +28,7 @@ With this update, all API documentation defined in the 3scale backend plugin is
2828

2929

3030
[id="bug-fix-rhidp-3115"]
31-
=== RHDH helm chart deployment throws NotAllowedError due to origin mismatch
31+
=== {product-very-short} helm chart deployment throws `NotAllowedError`
3232

3333
Previously, when deploying with the Helm Chart, there could be a mismatch between the Route hostname and the `baseUrl` fields added to the generated app-config ConfigMap. This could sometimes cause failure to authenticate against some providers due to an origin mismatch.
3434

@@ -38,7 +38,7 @@ This update fixes this issue by ensuring no mismatch between those values.
3838

3939

4040
[id="bug-fix-rhidp-3849"]
41-
=== Prevent the creation of permission policies and roles when disabled
41+
=== Disable the creation of permission policies and roles when disabling the RBAC backend plugin
4242

4343
Previously, disabling the RBAC backend plugin created roles and permission policies, whether the permission framework was enabled or not.
4444

@@ -48,9 +48,9 @@ With this update, disabling the RBAC backend plugin no longer creates roles and
4848

4949

5050
[id="bug-fix-rhidp-3931"]
51-
=== Entities of repositories under a configured org in catalog-backend-module-github-org plugin are not deleted from the catalog when the imported repository is deleted from bulk imports
51+
=== Added alert on the deletion icon during bulk imports
5252

53-
Before this update, repositories were added to {product-short} from various sources, such as `app-config` files or GitHub discovery. The Bulk Import plugin only tracked repositories accessible using the configured GitHub integrations. When both plugins were enabled, repositories discovered by GitHub Discovery appeared on Bulk Import pages. However, deleting these repositories from Bulk Import Jobs had no effect, as entities from discovery or `app-config.yaml` file remained in the {product-short} catalog.
53+
Before this update, repositories were added to the {product-short} from various sources, such as `app-config` files or GitHub discovery. The Bulk Import plugin only tracked repositories accessible using the configured GitHub integrations. When both plugins were enabled, repositories discovered by GitHub Discovery appeared on Bulk Import pages. However, deleting these repositories from Bulk Import Jobs had no effect, as entities from discovery or `app-config.yaml` file remained in the {product-short} catalog.
5454

5555
With this update, an alert on the deletion icon notifies the user to modify the source (either the `catalog-info` within the repository or the `app-config.yaml` file if the file originates from there) to remove the catalog entity.
5656

@@ -59,7 +59,7 @@ With this update, an alert on the deletion icon notifies the user to modify the
5959

6060

6161
[id="bug-fix-rhidp-4240"]
62-
=== [Topology] RHDH users can see tekton warnings even if they haven&#39;t configured the custom resources in k8s
62+
=== Removed the pre-configured custom resources from the Kubernetes configuration
6363

6464
Before this update, the custom resources in Kubernetes configuration were pre-configured. As a result, users could see Tekton warnings without configuring the custom resources in Kubernetes.
6565

@@ -69,27 +69,27 @@ This update removes the pre-configured custom resources from the Kubernetes conf
6969

7070

7171
[id="bug-fix-rhidp-4241"]
72-
=== RBAC Plugin is broken with latest Backstage version (1.31)
72+
=== RBAC Plugin is broken with latest Backstage version (`1.31`)
7373

74-
Before this update, RBAC backend plugin broke in Backstage 1.31 with an error.
74+
Before this update, RBAC backend plugin broke in Backstage `1.31` with an error.
7575

76-
This update resolves compatibility issues with RBAC backend plugin on Backstage versions 1.31 and 1.32 without displaying any errors.
76+
This update resolves compatibility issues with RBAC backend plugin on Backstage versions `1.31` and `1.32` without displaying any errors.
7777
.Additional resources
7878
* link:https://issues.redhat.com/browse/RHIDP-4241[RHIDP-4241]
7979

8080

8181
[id="bug-fix-rhidp-4732"]
82-
=== Bug after RBAC Backend upgrade to 5.1.0
82+
=== The backstage instance always failed to start in version `5.1.0`
8383

84-
Before this update, the backstage instance failed to start in version 5.1.0, showing an error.
84+
Before this update, the backstage instance failed to start in version `5.1.0`, showing an error.
8585

86-
With this update, the RBAC Backend plugin now starts successfully in version 5.1.0 without displaying any errors.
86+
With this update, the RBAC Backend plugin now starts successfully in version `5.1.0` without displaying any errors.
8787
.Additional resources
8888
* link:https://issues.redhat.com/browse/RHIDP-4732[RHIDP-4732]
8989

9090

9191
[id="bug-fix-rhidp-4734"]
92-
=== When scaling the deployment to 3 pods + redis cache, RBAC roles are not synced
92+
=== Resolved RBAC API inconsistency when scaling deployments to more than one pod
9393

9494
Before this update, scaling the deployment to more than one pod caused RBAC roles to remain unsynced, allowing only the pod that created the resource to serve it.
9595

@@ -109,7 +109,7 @@ This update changes the parent directory that the {{require}} uses from the mono
109109

110110

111111
[id="bug-fix-rhidp-5062"]
112-
=== Error migrating techdocs-backend wrapper to export-dynamic-plugin embed-as-dependencies method
112+
=== `suppress-native-package` and `allow-native-package` flags to handle native modules
113113

114114
Previously, the CLI failed with a message that native modules are not supported.
115115

@@ -122,7 +122,7 @@ This update introduces two new CLI flags that help dynamic plugin developers han
122122

123123

124124
[id="bug-fix-rhidp-5120"]
125-
=== Huge icon when techdoc text is selected, and report a doc issue feature didn&#39;t worked [1.4]
125+
=== Resolved the issue with text selection when reporting a TechDoc issue
126126

127127
Previously, the feature to report a documentation (TechDoc) issue failed. Therefore, when a user selected a text in a TechDoc, a large icon appeared instead of a tooltip button.
128128

@@ -132,7 +132,7 @@ With this update, users can select texts when reporting a documentation (TechDoc
132132

133133

134134
[id="bug-fix-rhidp-5136"]
135-
=== cli exits with error &#34;RangeError [ERR_CHILD_PROCESS_STDIO_MAXBUFFER]: stdout maxBuffer length exceeded&#34;
135+
=== Resolved the `stdout maxBuffer` error
136136

137137
Previously, the `export-dynamic-plugin` failed with an error that the `stdout maxBuffer` length was exceeded.
138138

@@ -142,7 +142,7 @@ With this update, the CLI redirects the output of the {{yarn install}} command i
142142

143143

144144
[id="bug-fix-rhidp-5141"]
145-
=== Add a flag to relax version range checks on the main package
145+
=== Added an `--ignore-version-check` flag
146146

147147
Previously, exporting a plugin that has not been updated to a newer backstage version failed due to a semver check performed on dependencies of the dynamic plugin package.
148148

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This section lists known issues in {product} {product-version}.
66

77
[id="known-issue-rhidp-3396"]
8-
== Topology plugin permission does not show up in rbac frontend ui
8+
== Topology plugin permission is not displayed in the RBAC front-end UI
99

1010
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`).
1111
.Additional resources

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,60 @@
55
This section highlights new features in {product} {product-version}.
66

77
[id="enhancement-rhidp-2200"]
8-
== Make possible to configure the path for mounting extra ConfigMaps/Secrets individually
8+
== Added an individual `mountPath`
99

10-
This update adds an additional individual mountPath for extra configmaps or secrets.
10+
This update adds an additional individual `mountPath` for extra configmaps or secrets.
1111

1212
[id="feature-rhidp-3621"]
13-
== Manage PVCs in the Operator
13+
== `PersistentVolumeClaims` support is available
1414

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

1717
[id="feature-rhidp-3817"]
18-
== Multiplatform and multiprofile Operator
18+
== Added Configuration Profiles
1919

20-
With this update, there are additional link:https://github.com/redhat-developer/rhdh-operator/blob/main/docs/profiles.md[Configuration Profiles].
21-
22-
[id="enhancement-rhidp-4236"]
23-
== Remove usage of the kube-rbac-proxy sidecar in the Operator deployment and switch to &#39;WithAuthenticationAndAuthorization&#39; instead
24-
25-
This update removes the `kube-rbac-proxy` sidecar container from the RHDH Operator Pod. This sidecar container protected the operator metrics endpoint. However, the main container now provides this functionality out-of-the-box. Removing this sidecar container allows for reducing the resources required to run the Operator.
20+
With this update, there are additional link:https://github.com/redhat-developer/rhdh-operator/blob/main/docs/profiles.md[configuration profiles].
2621

2722
[id="enhancement-rhidp-4384"]
28-
== Improve use of kube-rbac-proxy
23+
== Enhanced use of `kube-rbac-proxy`
2924

3025
This update removes the `kube-rbac-proxy` sidecar container from the RHDH Operator Pod. This sidecar container protected the operator metrics endpoint. However, the main container now provides this functionality out-of-the-box. Removing this sidecar container allows for reducing the resources required to run the Operator.
3126

3227
[id="feature-rhidp-4414"]
33-
== RHDH Configuration value for plugin consumption
34-
35-
This update adds a new configuration value `flavor` to identify on which flavor of Backstage a plugin is running. Plugin authors can use this configuration value to tailor their plugins based on whether the plugins are running on RHDH, RHTAP, or Backstage.
36-
37-
[id="feature-rhidp-4805"]
38-
== [Docs] Document support for RHBK v24 in RHDH
28+
== Identifying Backstage flavor for plugins by using the `developerHub.flavor` field
3929

40-
With this update, you can use RHBK as an authentication provider. The Keycloak plugin will now support ingesting users and groups with RHBK. 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].
30+
With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, RHTAP, or vanilla Backstage, as shown in the following example:
4131

32+
.`app-config.yaml` fragment with the `developerhub.flavor` field
4233

34+
[source,yaml]
35+
----
36+
developerHub:
37+
flavor: &lt;flavor&gt;
38+
----
4339

40+
`flavor`::
41+
Identify the flavor of Backstage that is running. Default value: `rhdh`
4442

4543

46-
[id="feature-rhidp-5156"]
47-
== Document `backstage-plugin-catalog-backend-module-logs` change to static (1.4)
48-
49-
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.
44+
[id="feature-rhidp-4805"]
45+
== Authenticating with Red Hat Build of Keycloak
5046

51-
[id="feature-rhidp-5218"]
52-
== [Docs] RHSSO 7.6 is deprecated as an authentication provider
47+
With this update, you can use Red Hat Build of Keycloak as an authentication provider. The Keycloak plugin will now support ingesting users and groups with Red Hat Build of Keycloak. 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 Red Hat Build of Keycloak].
5348

54-
RHSSO 7.6 is deprecated as an authentication provider. You can continue to use RHSSO until the end of maintenance support. For details, see link:https://access.redhat.com/support/policy/updates/jboss_notes/#p_sso[RHSSO lifecycle dates]. As an alternative, migrate to RHBK v24.
5549

5650

5751

5852

53+
[id="feature-rhidp-5156"]
54+
== `backstage-plugin-catalog-backend-module-logs` is enabled
5955

56+
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`.
6057

58+
[id="feature-rhidp-5218"]
59+
== RHSSO `7.6` is deprecated as an authentication provider
6160

61+
RHSSO `7.6` is deprecated as an authentication provider. You can continue to use RHSSO until the end of maintenance support. For details, see link:https://access.redhat.com/support/policy/updates/jboss_notes/#p_sso[RHSSO lifecycle dates]. As an alternative, migrate to RHBK `v24`.
6262

6363

6464

modules/release-notes/ref-release-notes-technology-preview.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,17 @@ See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Pr
1313
====
1414

1515
[id="technology-preview-rhidp-5070"]
16-
== [Doc] Version Compatibility Matrix
16+
== Version Compatibility Matrix for {product} `1.4`
1717

18-
.Version Compatibility Matrix
19-
20-
The following tables list products and their versions compatible with RHDH 1.4:
18+
The following tables list products and their versions compatible with {product-very-short} `1.4`:
2119

2220
[cols=&#34;75%,25%&#34;, frame=&#34;all&#34;, options=&#34;header&#34;]
2321
|===
2422
|Hosting Operating System
2523
|Version
2624

27-
| OpenShift Container Platform
28-
| `4.16-4.17`
25+
| {ocp-brand-name}
26+
| `4.16`-`4.17`
2927
|===
3028

3129
[cols=&#34;75%,25%&#34;, frame=&#34;all&#34;, options=&#34;header&#34;]
@@ -36,13 +34,13 @@ The following tables list products and their versions compatible with RHDH 1.4:
3634
| Backstage
3735
| `1.31.3`
3836

39-
| Amazon Elastic Kubernetes Service (EKS)
37+
| {eks-brand-name} ({eks-short})
4038
| Supported for Kubernetes version `1.24`
4139

42-
| Microsoft Azure Kubernetes Service (AKS)
40+
| {aks-brand-name} ({aks-short})
4341
| Supported for Kubernetes version `1.24`
4442

45-
| Google Kubernetes Engine (GKE)
43+
| {gcp-brand-name} ({gcp-short})
4644
| Supported for Kubernetes version `1.24`
4745
|===
4846
.Additional resources

0 commit comments

Comments
 (0)