Skip to content

Commit fb93631

Browse files
jmagakGitHub Actions
andauthored
Update fixed issues and known issues (#1556)
Co-authored-by: GitHub Actions <github-actions@github.com>
1 parent ee48e88 commit fb93631

File tree

2 files changed

+115
-72
lines changed

2 files changed

+115
-72
lines changed

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

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -56,31 +56,4 @@ In the new release, a timing problem during the RHDH 1.7 installation with Orche
5656

5757

5858
.Additional resources
59-
* link:https://issues.redhat.com/browse/RHDHBUGS-2036[RHDHBUGS-2036]
60-
61-
== Fixed issues in 1.7.2
62-
63-
[id="bug-fix-rhdhbugs-2117"]
64-
=== Fixed SCM integration failures for self-hosted enterprise SCM providers
65-
66-
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.
67-
68-
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.
69-
70-
71-
.Additional resources
72-
* link:https://issues.redhat.com/browse/RHDHBUGS-2117[RHDHBUGS-2117]
73-
74-
== Fixed issues in 1.7.1
75-
76-
[id="bug-fix-rhdhbugs-1878"]
77-
=== Fixed incorrect version detection for local plugin updates
78-
79-
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.
80-
81-
82-
.Additional resources
83-
* link:https://issues.redhat.com/browse/RHDHBUGS-1878[RHDHBUGS-1878]
84-
85-
86-
59+
* link:https://issues.redhat.com/browse/RHDHBUGS-2036[RHDHBUGS-2036]

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

Lines changed: 114 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -39,68 +39,82 @@ data:
3939
.Additional resources
4040
* link:https://issues.redhat.com/browse/RHDHBUGS-2240[RHDHBUGS-2240]
4141

42-
[id="known-issue-rhdhbugs-986"]
43-
== MUI v5 components might render with broken styles in non-bundled plugins
42+
[id="known-issue-rhdhbugs-2227"]
43+
== Deployment update error with dynamic plugin configuration
4444

45-
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.
45+
Updating the deployment configuration using the `values.yaml` to include specific dynamic plugin configurations might cause an error during the deployment process.
4646

47-
. Workaround
48-
* Add the following code to the plugin’s entry file, such as `workspaces/&lt;pluginId&gt;/plugins/&lt;pluginId&gt;/src/index.ts`:
49-
+
50-
[source,javascript]
51-
----
52-
import { unstable_ClassNameGenerator as ClassNameGenerator } from &#39;@mui/material/className&#39;;
47+
When configuring the `dynamicRoutes` for the `red-hat-developer-hub.backstage-plugin-dynamic-home-page` plugin, the use of the placeholder {{firstName}} in a configuration property, for example title, can result in the following fatal deployment error:
5348

54-
ClassNameGenerator.configure(componentName =&gt; {
55-
return componentName.startsWith(&#39;v5-&#39;)
56-
? componentName
57-
: `v5-${componentName}`;
58-
});
49+
"function `firstName` not defined".
50+
51+
This error prevents the cluster from spinning up correctly.
52+
53+
.Configuration example
54+
[source,yaml]
55+
----
56+
dynamicPlugins:
57+
frontend:
58+
red-hat-developer-hub.backstage-plugin-dynamic-home-page:
59+
dynamicRoutes:
60+
- path: /
61+
importName: DynamicHomePage
62+
config:
63+
props:
64+
title: 'Howdy {{firstName}} or {{displayName}}'
5965
----
6066

61-
// Source: https://docs.google.com/document/d/1cF-pRNY7duwD5JP8ACQVP24oJJw8ffphCzIgmyICcAM/edit?usp=sharing
67+
.Additional resources
68+
* link:https://issues.redhat.com/browse/RHDHBUGS-2227[RHDHBUGS-2227]
69+
70+
[id="known-issue-rhdhbugs-2220"]
71+
== Starting time is not displayed correctly in Results pane when workflows are started
6272

73+
There is an known issue with the displayed starting time in the Orchestrator 1.8.2 plugins when starting a workflow. When a workflow starts executing, the starting time is not displayed correctly in the Results window of the workflow instance. It remains this way until the workflow changes state. This will be fixed in a future release.
6374

6475
.Additional resources
65-
* link:https://issues.redhat.com/browse/RHDHBUGS-986[RHDHBUGS-986]
76+
* link:https://issues.redhat.com/browse/RHDHBUGS-2220[RHDHBUGS-2220]
6677

67-
[id="known-issue-rhdhbugs-664"]
68-
== Out-Of-Memory errors in the {product} Operator
78+
[id="known-issue-rhdhbugs-2132"]
79+
== Clicking on the dedicated {product-very-short} local guide link in the UI sidebar also highlights the Catalog item
6980

70-
To resolve Out-Of-Memory errors in the {product} Operator, adjust memory settings manually:
81+
In this update, the {product-very-short} Local default configuration includes built-in TechDocs. However, when selecting the new "{product-very-short} Local Guide" link in the {product-very-short} Local UI sidebar, the `Catalog` link is also highlighted.
82+
There is currently no known workaround.
7183

72-
. Edit the deployment:
73-
+
74-
----
75-
kubectl edit deployment rhdh-operator -n &lt;namespace&gt;
76-
----
84+
.Additional resources
85+
* link:https://issues.redhat.com/browse/RHDHBUGS-2132[RHDHBUGS-2132]
7786

78-
. In the editor, set the memory request to 1 GiB and the limit to 2 GiB:
79-
+
80-
[source,yaml]
81-
----
82-
spec:
83-
containers:
84-
- name: rhdh-operator
85-
resources:
86-
requests:
87-
memory: &#34;1G&#34;
88-
limits:
89-
memory: &#34;2G&#34;
90-
----
87+
[id="known-issue-rhdhbugs-2126"]
88+
== Handle installation disabled scenario in the installed packages page
9189

92-
. Reapply this change whenever the Operator is actively reconciled. The pod should become healthy, using about 1.07 GiB of memory.
90+
When installation is disabled, the actions on the Installed Packages page are still shown. Similarly, if the YAML file is misconfigured, the actions appear, but the API call fails with an error. This doesn't break the UI, the API failure is handled gracefully, and the correct reason for the failure is displayed in the UI.
91+
92+
.Additional resources
93+
* link:https://issues.redhat.com/browse/RHDHBUGS-2126[RHDHBUGS-2126]
9394

95+
[id="known-issue-rhdhbugs-2102"]
96+
== Changes to the Operator default configuration do not persist across operator upgrades
97+
98+
Changes to the {product-short} Operator default configuration do not persist across operator upgrades. There is no known workaround.
9499

95100
.Additional resources
96-
* link:https://issues.redhat.com/browse/RHDHBUGS-664[RHDHBUGS-664]
101+
* link:https://issues.redhat.com/browse/RHDHBUGS-2102[RHDHBUGS-2102]
97102

98-
[id="known-issue-rhdhbugs-2220"]
99-
== Starting time is not displayed correctly in Results pane when workflows are started
100-
There is an known issue with the displayed starting time in the Orchestrator 1.8.2 plugins when starting a workflow. When a workflow starts executing, the starting time is not displayed correctly in the Results window of the workflow instance. It remains this way until the workflow changes state. This will be fixed in a future release.
103+
[id="known-issue-rhdhbugs-2059"]
104+
== Error message when manually accessing accessing plugins without associated entity YAML
105+
106+
This error occurs when a user tries to access a package or plugin that does not have an associated entity YAML. Users will not encounter this error under normal usage; it only appears if they manually modify the plugin or package name in the URL. This ticket will handle this scenario more gracefully by indicating why access to a particular plugin is not allowed.
101107

102108
.Additional resources
103-
* link:https://issues.redhat.com/browse/RHDHBUGS-2220[RHDHBUGS-2220]
109+
* link:https://issues.redhat.com/browse/RHDHBUGS-2059[RHDHBUGS-2059]
110+
111+
[id="known-issue-rhdhbugs-2058"]
112+
== Hide package for entities missing `dynamicArtifact` value in code editor
113+
114+
For packages with missing `spec.dynamicArtifact` value in their catalog entity, we currently show `- package: ./dynamic-plugins/dis/...`
115+
116+
.Additional resources
117+
* link:https://issues.redhat.com/browse/RHDHBUGS-2058[RHDHBUGS-2058]
104118

105119
[id="known-issue-rhdhbugs-2038"]
106120
== Quay and Argo CD require their respective backend plugins to correctly display permissions in the UI.
@@ -150,4 +164,60 @@ permission:
150164
----
151165

152166
.Additional resources
153-
* link:https://issues.redhat.com/browse/RHDHBUGS-2038[RHDHBUGS-2038]
167+
* link:https://issues.redhat.com/browse/RHDHBUGS-2038[RHDHBUGS-2038]
168+
169+
[id="known-issue-rhdhbugs-986"]
170+
== MUI v5 components might render with broken styles in non-bundled plugins
171+
172+
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.
173+
174+
. Workaround
175+
* Add the following code to the plugin’s entry file, such as `workspaces/&lt;pluginId&gt;/plugins/&lt;pluginId&gt;/src/index.ts`:
176+
+
177+
[source,javascript]
178+
----
179+
import { unstable_ClassNameGenerator as ClassNameGenerator } from &#39;@mui/material/className&#39;;
180+
181+
ClassNameGenerator.configure(componentName =&gt; {
182+
return componentName.startsWith(&#39;v5-&#39;)
183+
? componentName
184+
: `v5-${componentName}`;
185+
});
186+
----
187+
188+
// Source: https://docs.google.com/document/d/1cF-pRNY7duwD5JP8ACQVP24oJJw8ffphCzIgmyICcAM/edit?usp=sharing
189+
190+
191+
.Additional resources
192+
* link:https://issues.redhat.com/browse/RHDHBUGS-986[RHDHBUGS-986]
193+
194+
[id="known-issue-rhdhbugs-664"]
195+
== Out-Of-Memory errors in the {product} Operator
196+
197+
To resolve Out-Of-Memory errors in the {product} Operator, adjust memory settings manually:
198+
199+
. Edit the deployment:
200+
+
201+
----
202+
kubectl edit deployment rhdh-operator -n &lt;namespace&gt;
203+
----
204+
205+
. In the editor, set the memory request to 1 GiB and the limit to 2 GiB:
206+
+
207+
[source,yaml]
208+
----
209+
spec:
210+
containers:
211+
- name: rhdh-operator
212+
resources:
213+
requests:
214+
memory: &#34;1G&#34;
215+
limits:
216+
memory: &#34;2G&#34;
217+
----
218+
219+
. Reapply this change whenever the Operator is actively reconciled. The pod should become healthy, using about 1.07 GiB of memory.
220+
221+
222+
.Additional resources
223+
* link:https://issues.redhat.com/browse/RHDHBUGS-664[RHDHBUGS-664]

0 commit comments

Comments
 (0)