Skip to content

Commit 01c9b0b

Browse files
adellapeadellape
authored
Merge pull request #77982 from gwynnemonahan/OSSM-6457
OSSM-6457 OSSM 2.6.0 (At Stage): [DOC] Release Notes, Known Issues an…
2 parents 82ef771 + 1e35e0b commit 01c9b0b

File tree

4 files changed

+228
-14
lines changed

4 files changed

+228
-14
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ endif::[]
172172
:product-rosa: Red Hat OpenShift Service on AWS
173173
:SMProductName: Red Hat OpenShift Service Mesh
174174
:SMProductShortName: Service Mesh
175-
:SMProductVersion: 2.5.2
176-
:MaistraVersion: 2.5
175+
:SMProductVersion: 2.6.0
176+
:MaistraVersion: 2.6
177177
:KialiProduct: Kiali Operator provided by Red Hat
178178
:SMPlugin: OpenShift Service Mesh Console (OSSMC) plugin
179179
:SMPluginShort: OSSMC plugin

‎modules/ossm-rn-fixed-issues.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,26 @@ Provide the following info for each issue if possible:
1616

1717
The following issues have been resolved in the current release:
1818

19-
//current release is 2.5.2/2.4.8/2.3.12 scheduled for May 22, 2024
19+
//current release is 2.6/2.5.3/2.4.9 is scheduled for July 10, 2024 --> delayed. New estimated release date: July 24, 2024. New estimated release date: July 31, 2024.
2020

21-
* https://issues.redhat.com/browse/OSSM-6331[OSSM-6331] Previously, the `smcp.general.logging.componentLevels` spec accepted invalid `LogLevel` values, and the `ServiceMeshControlPlane` resource was still created. Now, the terminal shows an error message if an invalid value is used, and the control plane is not created.
22-
23-
* https://issues.redhat.com/browse/OSSM-6290[OSSM-6290] Previously, the **Project** filter of the **Istio Config** list page did not work correctly. All `istio config` items were displayed from all namespaces even if you selected a specific project from the drop-down menu. Now, only the `istio config` items that belong to the selected project in the filter dropdown are displayed.
21+
//https://issues.redhat.com/browse/OSSM-6766[OSSM-6766] moved to "Kiali known issues"
2422

25-
* https://issues.redhat.com/browse/OSSM-6298[OSSM-6298] Previously, when you clicked an item reference within the {SMPlugin}, the console sometimes performed multiple redirects before opening the desired page. As a result, navigating back to the previous page that was open in the console caused your web browser to open the wrong page. Now, these redirects do not occur, and clicking *Back* in a web browser brings you to the correct page.
23+
* https://issues.redhat.com/browse/OSSM-6754[OSSM-6754] Previously, in {product-title} 4.15, when users navigated to a *Service details* page, clicked the *Service Mesh* tab, and refreshed the page, the *Service Mesh details* page remained stuck on Service Mesh content information, even though the active tab was the default *Details* tab. Now, after a refresh, users can navigate through the different tabs of the *Service details* page without issue.
2624
27-
* https://issues.redhat.com/browse/OSSM-6299[OSSM-6299] Previously, in {product-title} 4.15, when you clicked the **Node graph** menu option of any node menu within the traffic graph, the node graph was not displayed. Instead, the page refreshed with the same traffic graph. Now, clicking the **Node graph** menu option correctly displays the node graph.
25+
* https://issues.redhat.com/browse/OSSM-2101[OSSM-2101] Previously, the Istio Operator never deleted the `istio-cni-node` DaemonSet and other CNI resources when they were no longer needed. Now, after upgrading the Operator, if there is at least one SMCP installed in the cluster, the Operator reconciles this SMCP, and then deletes all unused CNI installations (even very old CNI versions as early as v2.0).
2826
2927
The following issues have been resolved in previous releases:
3028

3129
[id="ossm-rn-fixed-issues-ossm_{context}"]
3230
== {SMProductShortName} fixed issues
31+
//The explanations of these issues have been reviewed/approved in previous releases.
32+
* https://issues.redhat.com/browse/OSSM-6331[OSSM-6331] Previously, the `smcp.general.logging.componentLevels` spec accepted invalid `LogLevel` values, and the `ServiceMeshControlPlane` resource was still created. Now, the terminal shows an error message if an invalid value is used, and the control plane is not created.
33+
34+
* https://issues.redhat.com/browse/OSSM-6290[OSSM-6290] Previously, the **Project** filter drop-down of the **Istio Config** list page did not work correctly. All `istio config` items were displayed from all namespaces even if you selected a specific project from the drop-down menu. Now, only the `istio config` items that belong to the selected project in the filter drop-down are displayed.
35+
36+
* https://issues.redhat.com/browse/OSSM-6298[OSSM-6298] Previously, when you clicked an item reference within the {SMPlugin}, the console sometimes performed multiple redirects before opening the desired page. As a result, navigating back to the previous page that was open in the console caused your web browser to open the wrong page. Now, these redirects do not occur, and clicking *Back* in a web browser opens the correct page.
37+
38+
* https://issues.redhat.com/browse/OSSM-6299[OSSM-6299] Previously, in {product-title} 4.15, when you clicked the **Node graph** menu option of any node menu within the traffic graph, the node graph was not displayed. Instead, the page refreshed with the same traffic graph. Now, clicking the **Node graph** menu option correctly displays the node graph.
3339

3440
* https://issues.redhat.com/browse/OSSM-6177[OSSM-6177] Previously, when validation messages were enabled in the `ServiceMeshControlPlane` (SMCP), the `istiod` crashed continuously unless `GatewayAPI` support was enabled. Now, when validation messages are enabled but `GatewayAPI` support is not, the `istiod` does not continuously crash.
3541

‎modules/ossm-rn-known-issues.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,9 @@ New issues for Kiali should be created in the link:https://issues.redhat.com/pro
201201

202202
These are the known issues in Kiali:
203203

204+
* https://issues.redhat.com/browse/OSSM-6766[OSSM-6766] The {SMPlugin} fails if the user wants to update a namespace (for example, enable/disable injection) or create any Istio object (for example, create traffic policies).
205+
206+
Workaround: Use the standalone Kiali application to update a namespace or create any Istio object.
204207
//Keep KIALI-2206 in RN as this is for information purposes.
205208
* link:https://issues.jboss.org/browse/KIALI-2206[KIALI-2206] When you are accessing the Kiali console for the first time, and there is no cached browser data for Kiali, the “View in Grafana” link on the Metrics tab of the Kiali Service Details page redirects to the wrong location. The only way you would encounter this issue is if you are accessing Kiali for the first time.
206209
//Keep KIALI-507 in RN as this is for information purposes.

‎modules/ossm-rn-new-features.adoc

Lines changed: 211 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,193 @@ Module included in the following assemblies:
1515

1616
This release adds improvements related to the following components and concepts.
1717

18+
//Includes 2.6, 2.5.3, 2.4.9.
19+
20+
//OSSM 2.6 Release Day tentatively scheduled for Wednesday, July 10, 2024 --> delayed. New estimated release date: July 24, 2024.
21+
22+
//This release will include new features such as OTEL+Tempo, Gateway API, and perhaps some others.
23+
24+
[id="new-features-ossm-2-6"]
25+
== New features {SMProductName} version 2.6
26+
27+
This release of {SMProductName} adds new features, addresses Common Vulnerabilities and Exposures (CVEs), and is supported on {product-title} 4.12 and later.
28+
29+
This release ends maintenance support for {SMProductName} version 2.3. If you are using {SMProductShortName} version 2.3, you should update to a supported version.
30+
31+
include::snippets/ossm-current-version-support-snippet.adoc[]
32+
//FIPS messaging verified with Matt Werner, CS, OCP on 06/27/2024 via Slack. It is also the same FIPS messaging currently used by Serverless.
33+
//Per Scott Dodson on 07/15/204 via Slack, confirmed that RHEL 2.9 has been submitted for FIPS validation. Admonition updated accordingly.
34+
//Per Kirsten Newcomer on 07/16/2024 via Slack, FIPS messaging for Service Mesh has been changed. Jamie (PM) has agreed with change.
35+
[IMPORTANT]
36+
====
37+
{SMProductName} is designed for FIPS. {SMProductShortName} uses the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on the x86_64, ppc64le, and s390x architectures.
38+
For more information about the NIST validation program, see link:https://csrc.nist.gov/Projects/cryptographic-module-validation-program/validated-modules[Cryptographic Module Validation Program]. For the latest NIST status for the individual versions of RHEL cryptographic libraries that have been submitted for validation, see link:https://access.redhat.com/articles/compliance_activities_and_gov_standards#fips-140-2-and-fips-140-3-2[Compliance Activities and Government Standards].
39+
====
40+
41+
[id="component-versions-ossm-2-6"]
42+
=== Component versions for {SMProductName} version 2.6
43+
44+
//Component versions updated 07/25/2024.
45+
//Component tables for 2.5.3 and 2.4.9 updated 07/25/2024
46+
47+
|===
48+
|Component |Version
49+
50+
|Istio
51+
|1.20.8
52+
53+
|Envoy Proxy
54+
|1.28.5
55+
56+
|Kiali
57+
|1.73.9
58+
|===
59+
60+
[id="istio-1-20-support-ossm-2-6"]
61+
=== Istio 1.20 support
62+
//Jamie
63+
//OSSM 2.6 supports both Istio 1.19 and Istio 1.20 but only include Istio 1.20.
64+
//Listing 2 items that are supported instead of only what is not supported.
65+
66+
Service Mesh 2.6 is based on Istio 1.20, which provides new features and product enhancements, including:
67+
68+
* Native sidecars are supported on {product-title} 4.16 or later.
69+
+
70+
.Example `ServiceMeshControlPlane` resource
71+
[source,yaml]
72+
----
73+
apiVersion: maistra.io/v2
74+
kind: ServiceMeshControlPlane
75+
metadata:
76+
name: basic
77+
spec:
78+
runtime:
79+
components:
80+
pilot:
81+
container:
82+
env:
83+
ENABLE_NATIVE_SIDECARS: "true"
84+
----
85+
86+
* Traffic mirroring in Istio 1.20 now supports multiple destinations. This feature enables the mirroring of traffic to various endpoints, allowing for simultaneous observation across different service versions or configurations.
87+
88+
While {SMProductName} supports many Istio 1.20 features, the following exceptions should be noted:
89+
90+
//List what is NOT SUPPORTED --> same as 2.5 so copied from 2.5 entry
91+
* Ambient mesh is not supported
92+
* QuickAssist Technology (QAT) PrivateKeyProvider in Istio is not supported
93+
94+
[id="istio-kiali-bundle-image-name-changes-ossm-2-6"]
95+
=== Istio and Kiali bundle image name changes
96+
//This content may need to be removed for 2.6 as per Dev via Slack, name change may need to be reversed.
97+
//Filip. Approve 07/11/2024
98+
This release updates the Istio bundle image name and the Kiali bundle image name to better align with Red Hat naming conventions.
99+
100+
* Istio bundle image name: `openshift-service-mesh/istio-operator-bundle`
101+
* Kiali bundle image name: `openshift-service-mesh/kiali-operator-bundle`
102+
103+
[id="integration-otel-tempo-ossm-2-6"]
104+
=== Integration with {TempoName} and {OTELName}
105+
//Yuanlin
106+
This release introduces a generally available integration of the tracing extension provider(s) {TempoName} and {OTELName}.
107+
108+
You can expose tracing data to the {TempoName} by appending a named element and the `opentelemetry` provider to the `spec.meshConfig.extensionProviders` specification in the `ServiceMehControlPlane` resource. Then, a telemetry custom resource configures Istio proxies to collect trace spans and send them to the OpenTelemetry Collector endpoint.
109+
110+
You can create a {OTELName} instance in a mesh namespace and configure it to send tracing data to a tracing platform backend service.
111+
112+
//Still true for 2.6
113+
//Asked in forum-ocp-tracing channel 06/24/2024, verified 06/25/2024
114+
[NOTE]
115+
====
116+
{TempoName} Stack is not supported on {ibm-z-title}.
117+
====
118+
119+
[id="jaeger-default-setting-change-ossm-2-6"]
120+
=== {JaegerName} default setting change
121+
//also included in "Upgrading --> Upgrading 2.5 to 2.6" but added here for increased visibility.
122+
//Dean. Approved 07/11/2024
123+
This release disables {JaegerName} by default for new instances of the `ServiceMeshControlPlane` resource.
124+
125+
When updating existing instances of the `ServiceMeshControlPlane` resource to {SMProductName} version 2.6, {JaegerShortName} remains enabled by default.
126+
127+
{SMProductName} 2.6 is the last release that includes support for {JaegerName} and {es-op}. Both {JaegerShortName} and {es-op} will be removed in the next release. If you are currently using {JaegerShortName} and {es-op}, you need to switch to {TempoName} and {OTELName}.
128+
129+
//Gateway API Update for 2.6 OSSM-5854
130+
//Kubernetes Gateway API and {product-title} Gateway API are the same. It is referenced as {product-title} Gateway API in 2.5 and as {product-title} Gateway API here https://docs.openshift.com/container-platform/4.15/nodes/clusters/nodes-cluster-enabling-features.html so to be consistent, it is also referenced as {product-title} Gateway API for 2.6.
131+
[id="gateway-api-ga-cluster-wide-deployments-ossm-2-6"]
132+
=== {product-title} Gateway API generally available for cluster-wide deployments
133+
//Jacek. Approved 07/11/2024
134+
This release introduces the General Availability of {product-title} Gateway API, also known as the Kubernetes Gateway API, which is enabled by default only for cluster-wide deployments.
135+
136+
Gateway API is now enabled by default if cluster-wide mode is enabled (`spec.mode: ClusterWide`). It can be enabled even if the custom resource definitions (CRDs) are not installed in the cluster.
137+
138+
[IMPORTANT]
139+
====
140+
Gateway API for multitenant mesh deployments is still in Technology Preview.
141+
====
142+
143+
Refer to the following table to determine which Gateway API version should be installed with the OpenShift {SMProductShortName} version you are using:
144+
145+
|===
146+
|Service Mesh Version | Istio Version | Gateway API Version | Notes
147+
148+
|2.6
149+
|1.20.x
150+
|1.0.0
151+
|N/A
152+
153+
|2.5.x
154+
|1.18.x
155+
|0.6.2
156+
|Use the experimental branch because `ReferenceGrand` is missing in v0.6.2.
157+
158+
|2.4.x
159+
|1.16.x
160+
|0.5.1
161+
|For multitenant mesh deployment, all Gateway API CRDs must be present. Use the experimental branch.
162+
|===
163+
164+
You can disable this feature by setting `PILOT_ENABLE_GATEWAY_API` to `false`:
165+
166+
[source,yaml]
167+
----
168+
apiVersion: maistra.io/v2
169+
kind: ServiceMeshControlPlane
170+
metadata:
171+
name: basic
172+
spec:
173+
runtime:
174+
components:
175+
pilot:
176+
container:
177+
env:
178+
PILOT_ENABLE_GATEWAY_API: "false"
179+
----
180+
181+
[id="new-features-ossm-2-5-3"]
182+
== New features {SMProductName} version 2.5.3
183+
184+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
185+
186+
[id="component-versions-ossm-2-5-3"]
187+
=== Component versions for {SMProductName} version 2.5.3
188+
189+
// Release is scheduled for July 10, 2024. --> delayed
190+
//Includes 2.6, 2.5.3, 2.4.9. 2.6 ends support for v2.3
191+
192+
|===
193+
|Component |Version
194+
195+
|Istio
196+
|1.18.5
197+
198+
|Envoy Proxy
199+
|1.26.8
200+
201+
|Kiali
202+
|1.73.9
203+
|===
204+
18205
[id="new-features-ossm-2-5-2"]
19206
== New features {SMProductName} version 2.5.2
20207

@@ -24,8 +211,6 @@ This release adds improvements related to the following components and concepts.
24211

25212
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
26213

27-
The most current version of the {SMProductName} Operator can be used with all supported versions of {SMProductShortName}. The version of {SMProductShortName} is specified using the `ServiceMeshControlPlane`.
28-
29214
=== Component versions for {SMProductName} version 2.5.2
30215

31216
// Release is scheduled for May 22, 2024. Code and Doc Freeze is scheduled for May 10, 2024. Component versions should be available after May 10.
@@ -178,6 +363,30 @@ A new version of the Gateway API custom resource definition (CRD) is now availab
178363
|For multitenant mesh deployment, all Gateway API CRDs must be present. Use the experimental branch.
179364
|===
180365

366+
[id="new-features-ossm-2-4-9"]
367+
== New features {SMProductName} version 2.4.9
368+
369+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
370+
371+
[id="component-versions-2-4-9"]
372+
=== Component versions for {SMProductName} version 2.4.9
373+
374+
// Release is scheduled for July 10, 2024. --> delayed
375+
//Includes 2.6, 2.5.3, 2.4.9. 2.6 ends support for v2.3
376+
377+
|===
378+
|Component |Version
379+
380+
|Istio
381+
|1.16.7
382+
383+
|Envoy Proxy
384+
|1.24.12
385+
386+
|Kiali
387+
|1.65.11
388+
|===
389+
181390
[id="new-features-ossm-2-4-8"]
182391
== New features {SMProductName} version 2.4.8
183392

@@ -187,8 +396,6 @@ A new version of the Gateway API custom resource definition (CRD) is now availab
187396

188397
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
189398

190-
The most current version of the {SMProductName} Operator can be used with all supported versions of {SMProductShortName}. The version of {SMProductShortName} is specified using the `ServiceMeshControlPlane`.
191-
192399
=== Component versions for {SMProductName} version 2.4.8
193400

194401
// Release is scheduled for May 22, 2024. Code and Doc Freeze is scheduled for May 10, 2024. Component versions should be available after May 10.
@@ -539,8 +746,6 @@ endif::openshift-rosa,openshift-dedicated[]
539746

540747
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
541748

542-
The most current version of the {SMProductName} Operator can be used with all supported versions of {SMProductShortName}. The version of {SMProductShortName} is specified using the `ServiceMeshControlPlane`.
543-
544749
=== Component versions for {SMProductName} version 2.3.12
545750

546751
// Release is scheduled for May 22, 2024. Code and Doc Freeze is scheduled for May 10, 2024. Component versions should be available after May 10.

0 commit comments

Comments
 (0)