Skip to content

Commit fb4af2f

Browse files
themr0cGerry-Forde
themr0c
and
Gerry-Forde
authored
RHIDP-8636 - Release notes for 1.8 (#1536)
Co-authored-by: Gerry-Forde <[email protected]>
1 parent a1d559f commit fb4af2f

7 files changed

+376
-241
lines changed

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

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,49 @@
55

66
This section lists breaking changes in {product} {product-version}.
77

8+
[id="removed-functionality-rhidp-5309"]
9+
== Argo CD, Tekton, and Topology plugins require the Kubernetes Frontend and Kubernetes Backend plugins
10+
11+
With this update, the Argo CD, Tekton, and Topology plugins requires the Kubernetes Frontend and Kubernetes Backend plugins. Before this update, these plugins depended only on the Kubernetes Backend plugin, and the feature provided by the Kubernetes Frontend plugin where provided by the removed `@janus-idp/shared-react` package.
12+
13+
.Procedure
14+
. Enable the Kubernetes Frontend and Kubernetes Backend plugins.
15+
+
16+
[source,yaml]
17+
----
18+
global:
19+
dynamic:
20+
plugins:
21+
- package: ./dynamic-plugins/dist/backstage-plugin-kubernetes
22+
disabled: false
23+
- package: ./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic
24+
disabled: false
25+
----
26+
27+
. The Kubernetes Frontend plugin shows automatically a *Kubernetes* tab for Software Catalog entities with the annotation `backstage.io/kubernetes-id` or `backstage.io/kubernetes-namespace`.
28+
+
29+
Optionally, to hide the *Kubernetes* tab in the Software Catalog, disable the feature with this dynamic plugin configuration:
30+
+
31+
[source,yaml]
32+
----
33+
global:
34+
dynamic:
35+
plugins:
36+
- package: ./dynamic-plugins/dist/backstage-plugin-kubernetes
37+
disabled: false
38+
pluginConfig:
39+
dynamicPlugins:
40+
frontend:
41+
backstage.plugin-kubernetes:
42+
mountPoints: []
43+
- package: ./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic
44+
disabled: false
45+
----
46+
47+
48+
49+
.Additional resources
50+
* link:https://issues.redhat.com/browse/RHIDP-5309[RHIDP-5309]
51+
852

9-
None.
1053

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

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,28 @@
55

66
This section lists deprecated functionalities in {product} {product-version}.
77

8-
[id="deprecated-functionality-rhidp-6917"]
9-
== Backstage CR versions `v1alpha1` and `v1alpha2`
10-
11-
Backstage CR versions `v1alpha1` and `v1alpha2` are deprecated in 1.7 and will be removed in 1.9
12-
13-
14-
.Additional resources
15-
* link:https://issues.redhat.com/browse/RHIDP-6917[RHIDP-6917]
16-
178
[id="deprecated-functionality-rhidp-8525"]
189
== Deprecation of Bundled Plugin Wrappers
1910

2011
To enhance performance, decrease image size, and reduce maintenance, the method of including &#34;wrapped&#34; dynamic plugins within the main {product} container image is being deprecated as of release 1.7.0. We are transitioning to a model where all dynamic plugins will be distributed as independent OCI artifacts.
2112

22-
For the 1.7.0 release, this is a deprecation notice only; there are no breaking changes, and all previously bundled plugins will continue to be bundled. However, we encourage customers to prepare for the removal of wrappers in a future release by beginning to use the new OCI artifacts in 1.8.0. Documentation will be updated to guide this migration.
13+
For the 1.7.0 release, this is a deprecation notice only; there are no breaking changes, and all previously bundled plugins will continue to be bundled. However, we encourage customers to prepare for the removal of wrappers in a future release by beginning to use the new OCI artifacts in 1.9.0. Documentation will be updated to guide this migration.
2314

2415
For more information, see {installing-and-viewing-plugins-book-link}#proc-load-plugin-oci-image_assembly-install-third-party-plugins-rhdh[Loading a plugin packaged as an OCI image].
2516

17+
2618
.Additional resources
2719
* link:https://issues.redhat.com/browse/RHIDP-8525[RHIDP-8525]
20+
21+
[id="deprecated-functionality-rhidp-9180"]
22+
== Deprecation of OCM Plugins
23+
24+
The Open Cluster Management (OCM) plugins integrates your {product} instance with the MultiClusterHub and MultiCluster engines of OCM.
25+
The OCM plugins are deprecated as of RHDH 1.8, and will be removed in a future release.
26+
27+
28+
.Additional resources
29+
* link:https://issues.redhat.com/browse/RHIDP-9180[RHIDP-9180]
30+
31+
32+

‎modules/release-notes/ref-release-notes-developer-preview.adoc‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
:_content-type: REFERENCE
22

33
[id="developer-preview"]
4-
:ls-brand-name: Red Hat Developer Lightspeed for {product}
5-
64
= Developer Preview
75

86
This section lists Developer Preview features in {product} {product-version}.
@@ -14,7 +12,22 @@ Developer Preview features are not supported by Red Hat in any way and are not f
1412
For more information about the support scope of Red Hat Developer Preview features, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
1513
====
1614

17-
== {ls-brand-name}
15+
[id="developer-preview-rhidp-8709"]
16+
== Configurable Key Performance Indicators (KPIs) by using the Scorecard plugin
17+
18+
With this release, {product} integrates the Scorecard plugin, enabling users to visualize software quality and health metrics directly in {product-short}.
19+
20+
Developers can visualize scorecards with the metrics available to the their role in a tab on component detail pages, allowing them to quickly check the quality of their code and ensure it meets team standards.
21+
22+
Platform engineers can configure Key Performance Indicators (KPIs) from various data sources, with initial support for GitHub open pull requests and Jira open issues. Custom metric providers will allow for the addition of more data sources.
23+
24+
This simplifies the monitoring of applications by offering a single, clear report on health, security, and compliance.
25+
26+
// RN already in https://issues.redhat.com/browse/RHIDP-8709
27+
28+
29+
.Additional resources
30+
* link:https://issues.redhat.com/browse/RHIDP-8709[RHIDP-8709]
31+
32+
1833

19-
{ls-brand-name} is available as a Developer Preview feature in {product}, as a virtual assistant powered by generative Artificial Intelligence (AI) designed for {product-very-short}. The assistant offers in-depth insights into {product-very-short}, including its wide range of capabilities. You can interact with this assistant to explore and learn more about {product-very-short} in greater detail.
20-
For more information, see {product-docs-link}/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index[{ls-brand-name}].

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

Lines changed: 38 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,95 @@
11
:_content-type: REFERENCE
2+
23
[id="fixed-issues"]
34
= Fixed issues
45

56
This section lists issues fixed in {product} {product-version}.
67

7-
== Fixed issues in 1.7.0
8-
9-
[id="bug-fix-rhidp-6536"]
10-
=== Improved keyboard accessibility
11-
12-
In this release, various fixes and improvements have been made to improve the keyboard accessibility in {product}.
13-
14-
15-
.Additional resources
16-
* link:https://issues.redhat.com/browse/RHIDP-6536[RHIDP-6536]
8+
== Fixed issues in 1.8.0
179

10+
[id="bug-fix-rhdhbugs-1000"]
11+
=== Improved startup speed with updated init container image pull policy for {product-short} Helm Chart
1812

19-
[id="bug-fix-rhdhbugs-249"]
20-
=== Fixed `techdocs-module-addons-contrib` plugin not displayed as preinstalled plugin
21-
22-
Previously, the `techdocs-module-addons-contrib` plugin was not displayed as preinstalled in Extensions. With this update, the plugin is displayed as preinstalled.
13+
With this update, the pull policy for the init container image of the {product-short} Helm Chart was changed from `Always` to `IfNotPresent`. This change reduces the repeated download time during startup of the container image, which is approximately 2.5 GB, thereby significantly improving startup speed for users.
2314

2415

2516
.Additional resources
26-
* link:https://issues.redhat.com/browse/RHDHBUGS-249[RHDHBUGS-249]
17+
* link:https://issues.redhat.com/browse/RHDHBUGS-1000[RHDHBUGS-1000]
2718

2819

29-
[id="bug-fix-rhdhbugs-322"]
30-
=== Excessive queries to the `relations` database table from the `rbac-backend` plugin
31-
32-
Before this update, excessive queries from the `rbac-backend` plugin to the `relations` database table caused performance issues. As a consequence, users experienced slow performance. With this release, the RBAC backend plugin has been optimized to improve performance by preventing excessive queries to the &#39;relations&#39; database table.
20+
[id="bug-fix-rhdhbugs-1028"]
21+
=== Improved Authentication for Self-Hosted Enterprise SCM Providers
3322

23+
Previously, actions requiring access to a self-hosted enterprise SCM provider failed, returning an error that no authentication provider was available for the specified host.
3424

35-
.Additional resources
36-
* link:https://issues.redhat.com/browse/RHDHBUGS-322[RHDHBUGS-322]
37-
38-
39-
[id="bug-fix-rhdhbugs-503"]
40-
=== The Operator reverts the number of replicas set automatically by a Horizontal Pod Autoscaler (HPA)
41-
42-
Previously the {product-very-short} Operator enforced `replicas: 1` from its default deployment config, which overrode scaling decisions.
43-
44-
With this update, `replicas: 1` is removed from the default deployment profile and the DB-statefulset manifest.
45-
46-
This update allows HPA to control scaling as expected, so that {product-very-short} instances can now scale dynamically with HPA without being reset by the operator.
25+
With this update, the SCM integration correctly identifies and uses the configured authentication provider for the corresponding enterprise host.
4726

4827

4928
.Additional resources
50-
* link:https://issues.redhat.com/browse/RHDHBUGS-503[RHDHBUGS-503]
51-
52-
53-
[id="bug-fix-rhdhbugs-512"]
54-
=== Improved error messaging for bulk imports
55-
56-
Before this update, when users selected 100 or more repositories simultaneously, the create pull request action could fail with a generic error message. In this release, we provide a more informative error message when creating pull requests for multiple repositories. This bug fix helps users to understand the issue by providing more information about what caused the error.
29+
* link:https://issues.redhat.com/browse/RHDHBUGS-1028[RHDHBUGS-1028]
5730

5831

59-
.Additional resources
60-
* link:https://issues.redhat.com/browse/RHDHBUGS-512[RHDHBUGS-512]
61-
32+
[id="bug-fix-rhdhbugs-2003"]
33+
=== Customizable image names for job and data index services in {product-short} Helm Chart
6234

63-
[id="bug-fix-rhdhbugs-622"]
64-
=== Excessive authorize requests generated by the RBAC backend API
65-
66-
Before this update, excessive authorize requests in the REST API for creating/editing roles, permissions, and conditions in rbac-backend led to performance issues. With this release, the excessive authorization requests in the REST API have been fixed by reducing permissions to only &#39;user&#39; credentials.
35+
Previously, when deploying the {product-short} Helm Chart with the Orchestrator enabled, it was not possible to customize the image names of the job and data index services, for example in disconnected environments. Setting the `orchestrator.sonataflowPlatform.jobServiceImage` and `orchestrator.sonataflowPlatform.dataIndexImage` would return a schema validation error from Helm. This update fixes this issue.
6736

6837

6938
.Additional resources
70-
* link:https://issues.redhat.com/browse/RHDHBUGS-622[RHDHBUGS-622]
39+
* link:https://issues.redhat.com/browse/RHDHBUGS-2003[RHDHBUGS-2003]
7140

7241

73-
[id="bug-fix-rhdhbugs-632"]
74-
=== Custom title not persisting on refresh of visited cards
75-
76-
Previously, the custom title set via `app.title` in the _Top Visited_ and _Recently Visited_ cards did not persist after a page refresh, instead it defaulted back to _{product}_.
77-
78-
With this update, after each refresh, the cards correctly display the custom title defined in the `app.title` configuration.
42+
[id="bug-fix-rhdhbugs-2020"]
43+
=== Network policy installation fix for {product-short} RHDH Helm Chart with Orchestrator flavor
7944

45+
Before this update, the {product-short} RHDH Helm Chart would not install Network Policies when the Orchestrator flavor was deployed with `serverlessLogicOperator` disabled, preventing the {product-short} Pods from being completely available. This update fixes this situation by installing network policies unconditionally when the orchestrator is enabled.
8046

81-
.Additional resources
82-
* link:https://issues.redhat.com/browse/RHDHBUGS-632[RHDHBUGS-632]
8347

48+
.Additional resources
49+
* link:https://issues.redhat.com/browse/RHDHBUGS-2020[RHDHBUGS-2020]
8450

85-
[id="bug-fix-rhdhbugs-834"]
86-
=== Fixed role name updates via API to correctly propagate to permissions, metadata, and conditions
87-
88-
Previously, when a role name was updated using the RBAC API, existing permissions, conditions, and metadata were not updated and remained mapped to the old role name.
89-
With this update, role name changes are now correctly updated.
9051

52+
[id="bug-fix-rhdhbugs-2036"]
53+
=== Resolved SonataFlow Pod Crash Issue
9154

92-
.Additional resources
93-
* link:https://issues.redhat.com/browse/RHDHBUGS-834[RHDHBUGS-834]
55+
In the new release, a timing problem during the RHDH 1.7 installation with Orchestrator plugins, affecting SonataFlow database provisioning, has been addressed. This issue caused SonataFlow pods to repeatedly enter the `CrashLoopBackOff` state, leading to delays and potential confusion for users. With this update, SonataFlow pods no longer encounter the `CrashLoopBackOff` state due to the database provisioning delay. This improvement enhances the user experience, as SonataFlow pods now start promptly, eliminating unnecessary wait times.
9456

9557

96-
[id="bug-fix-rhdhbugs-903"]
97-
=== Fixed role actions tooltip delay issue
98-
99-
Previously, tooltips on action icons in the Role list table of the Role-Based Access Control (RBAC) page were slow to appear on hover.
100-
101-
This issue has been fixed, ensuring that tooltips now appear immediately when hovering over action icons in the RBAC page.
58+
.Additional resources
59+
* link:https://issues.redhat.com/browse/RHDHBUGS-2036[RHDHBUGS-2036]
10260

10361

104-
.Additional resources
105-
* link:https://issues.redhat.com/browse/RHDHBUGS-903[RHDHBUGS-903]
62+
[id="bug-fix-rhdhbugs-2117"]
63+
=== Fixed SCM integration failures for self-hosted enterprise SCM providers
10664

65+
Before this update, the SCM integration failed due to lack of identification of the configured authentication provider for self-hosted enterprise SCM hosts. As a consequence, users experienced failed actions with self-hosted enterprise SCM providers due to missing authentication.
10766

108-
[id="bug-fix-rhdhbugs-1110"]
109-
=== The Extensions catalog does not show an error when the backend plugin is not installed
110-
111-
Previously, if the backend Extensions was not installed, {product-very-short} showed the skeleton &#34;forever&#34; instead of an error message.
112-
113-
With this update, the UI shows an empty state with a message to enable the backend plugin.
67+
With this release, the SCM integration now correctly uses the configured authentication provider for corresponding enterprise host. As a result, end users can now successfully perform actions requiring enterprise SCM access.
11468

11569

11670
.Additional resources
117-
* link:https://issues.redhat.com/browse/RHDHBUGS-1110[RHDHBUGS-1110]
71+
* link:https://issues.redhat.com/browse/RHDHBUGS-2117[RHDHBUGS-2117]
11872

11973

120-
[id="bug-fix-rhdhbugs-1139"]
121-
=== Fixed Profile dropdown showing Guest instead of user&#39;s name with OIDC authentication
122-
123-
Previously, the *Profile dropdown* in the Global Header showed `Guest` instead of the logged-in user’s display name when logging in using the OIDC authentication.
124-
125-
With this update, the *Profile dropdown* now correctly displays the user&#39;s name by first checking `spec.profile.displayName`, then `metadata.title`, and finally falls back to the name shown on the *Profile card* in the *Settings* page if neither is available.
74+
[id="bug-fix-rhdhbugs-1878"]
75+
=== Fixed incorrect version detection for local plugin updates
12676

77+
Before this update, local plugins within the image were incorrectly detected for updates due to version misidentification. This led to users being unable to update local plugins from wrappers, resulting in outdated functionality. With this release, local plugin updates are now automatically detected, eliminating the need for manual adjustments and ensuring seamless plugin version updates for end users.
12778

12879

12980
.Additional resources
130-
* link:https://issues.redhat.com/browse/RHDHBUGS-1139[RHDHBUGS-1139]
131-
81+
* link:https://issues.redhat.com/browse/RHDHBUGS-1878[RHDHBUGS-1878]
13282

133-
[id="bug-fix-rhdhbugs-1162"]
134-
=== Excessive filter arguments generated by the RBAC backend `enforcerDelegate.getFilteredPolicy`
135-
136-
Before this update, {product-very-short} performance was affected by the duplication of filter arguments in `enforcerDelegate.getFilteredPolicy`. With this release, the duplication of filter arguments in `enforcerDelegate.ts` is avoided.
13783

84+
[id="bug-fix-rhdhbugs-2041"]
85+
=== Orchestrator plugin updated to 1.7.1
13886

139-
.Additional resources
140-
* link:https://issues.redhat.com/browse/RHDHBUGS-1162[RHDHBUGS-1162]
141-
87+
Before this update, the latest Orchestrator feature set was unavailable because the release included the outdated Orchestrator plugin version `1.6`. This issue is resolved in {product-very-short} `1.7.1`. The Orchestrator plugin is now updated to version `1.7.1`, ensuring that users have access to the latest features and functionality.
14288

143-
[id="bug-fix-rhdhbugs-1213"]
144-
=== Fixed Jenkins permissions not being displayed in RBAC UI
145-
146-
Previously, Jenkins permissions were not exposed by Jenkins at `/api/jenkins/.well-known/backstage/permissions/metadata` with the change to `JenkinsBuilder`. As a result, RBAC UI did not display the permissions. In this release, users can configure Jenkins permissions by using the RBAC UI.
14789

14890

14991
.Additional resources
150-
* link:https://issues.redhat.com/browse/RHDHBUGS-1213[RHDHBUGS-1213]
92+
* link:https://issues.redhat.com/browse/RHDHBUGS-2041[RHDHBUGS-2041]
15193

15294

15395

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

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,61 @@
55

66
This section lists known issues in {product} {product-version}.
77

8-
[id="known-issue-rhdhbugs-1979"]
9-
== Latest Orchestrator feature set is unavailable
8+
[id="known-issue-rhdhbugs-986"]
9+
== MUI v5 components might render with broken styles in non-bundled plugins
1010

11-
This release includes the Orchestrator plugin version from `1.6`. As a result, the latest feature set is not yet available. The Orchestrator plugin will be updated to the latest feature set in a future release.
11+
Plugins that are not bundled with {product}, meaning not part of the {product} wrappers, might experience styling issues or broken visuals when using Material UI v5 components.
1212

13+
. Workaround
14+
* Add the following code to the plugin’s entry file, such as `workspaces/&lt;pluginId&gt;/plugins/&lt;pluginId&gt;/src/index.ts`:
15+
+
16+
[source,javascript]
17+
----
18+
import { unstable_ClassNameGenerator as ClassNameGenerator } from &#39;@mui/material/className&#39;;
1319
20+
ClassNameGenerator.configure(componentName =&gt; {
21+
return componentName.startsWith(&#39;v5-&#39;)
22+
? componentName
23+
: `v5-${componentName}`;
24+
});
25+
----
1426

27+
// Source: https://docs.google.com/document/d/1cF-pRNY7duwD5JP8ACQVP24oJJw8ffphCzIgmyICcAM/edit?usp=sharing
1528

1629

30+
.Additional resources
31+
* link:https://issues.redhat.com/browse/RHDHBUGS-986[RHDHBUGS-986]
32+
33+
[id="known-issue-rhdhbugs-664"]
34+
== Out-Of-Memory errors in the {product} Operator
35+
36+
To resolve Out-Of-Memory errors in the {product} Operator, adjust memory settings manually:
37+
38+
. Edit the deployment:
39+
+
40+
----
41+
kubectl edit deployment rhdh-operator -n &lt;namespace&gt;
42+
----
1743

44+
. In the editor, set the memory request to 1 GiB and the limit to 2 GiB:
45+
+
46+
[source,yaml]
47+
----
48+
spec:
49+
containers:
50+
- name: rhdh-operator
51+
resources:
52+
requests:
53+
memory: &#34;1G&#34;
54+
limits:
55+
memory: &#34;2G&#34;
56+
----
1857

58+
. Reapply this change whenever the Operator is actively reconciled. The pod should become healthy, using about 1.07 GiB of memory.
1959

2060

2161
.Additional resources
22-
* link:https://issues.redhat.com/browse/RHDHBUGS-1979[RHDHBUGS-1979]
62+
* link:https://issues.redhat.com/browse/RHDHBUGS-664[RHDHBUGS-664]
2363

2464

2565

0 commit comments

Comments
 (0)