Skip to content

Commit 1f1e2aa

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #76920 from gwynnemonahan/OSSM-6640
OSSM-6640 OSSM Release Notes 2.5.z Restructure
2 parents 134632a + ae8612b commit 1f1e2aa

10 files changed

+387
-315
lines changed

‎modules/ossm-release-2-3-12.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
////
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ossm-release-2-3-12_{context}"]
8+
= {SMProductName} version 2.3.12
9+
10+
////
11+
*Feature* – Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes.
12+
*Reason* – If known, include why has the enhancement been implemented (use case, performance, technology, etc.). For example, showcases integration of X with Y, demonstrates Z API feature, includes latest framework bug fixes. There may not have been a 'problem' previously, but system behavior may have changed.
13+
*Result* – If changed, describe the current user experience
14+
////
15+
16+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
17+
18+
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` resource.
19+
20+
[id="ossm-component-updates-2-3-12_{context}"]
21+
== Component updates
22+
23+
|===
24+
|Component |Version
25+
26+
|Istio
27+
|1.14.5
28+
29+
|Envoy Proxy
30+
|1.22.11
31+
32+
|Kiali
33+
|1.57.14
34+
|===

‎modules/ossm-release-2-4-8.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/ossm-release-2-5-2.adoc
4+
////
5+
6+
:_mod-docs-content-type: PROCEDURE
7+
[id="ossm-release-2-4-8_{context}"]
8+
= {SMProductName} version 2.4.8
9+
10+
//Release is scheduled for May 22, 2024.
11+
//As of May 8, there are no new features so the phrase "new features" has been removed. This is a z-stream release to update containers before they are Grade B or C on May 28.
12+
//Includes 2.5.2, 2.4.8, 2.3.12
13+
14+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.12 and later.
15+
16+
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`.
17+
18+
[id="ossm-component-updates-2-4-8_{context}"]
19+
== Component updates
20+
21+
// 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.
22+
23+
|===
24+
|Component |Version
25+
26+
|Istio
27+
|1.16.7
28+
29+
|Envoy Proxy
30+
|1.24.12
31+
32+
|Kiali
33+
|1.65.11
34+
|===

‎modules/ossm-release-2-4-9.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
////
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ossm-release-2-4-9_{context}"]
8+
= {SMProductName} version 2.4.9
9+
10+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), and is supported on {product-title} 4.12 and later.
11+
12+
[id="ossm-release-2-4-9-components_{context}"]
13+
== Component updates
14+
// Release is scheduled for July 10, 2024. --> delayed
15+
// Includes 2.6, 2.5.3, 2.4.9. 2.6 ends support for v2.3
16+
17+
|===
18+
|Component |Version
19+
20+
|Istio
21+
|1.16.7
22+
23+
|Envoy Proxy
24+
|1.24.12
25+
26+
|Kiali
27+
|1.65.11
28+
|===
29+
//add horizonal line rule/line break to help user visually understand that 2.6, 2.5.3, and 2.4.9 are one release, and that 2.5.2 is a separate, different release.
30+
'''

‎modules/ossm-release-2-5-2.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
////
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ossm-release-2-5-2-only_{context}"]
8+
= {SMProductName} version 2.5.2
9+
10+
////
11+
*Feature* – Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes.
12+
*Reason* – If known, include why has the enhancement been implemented (use case, performance, technology, etc.). For example, showcases integration of X with Y, demonstrates Z API feature, includes latest framework bug fixes. There may not have been a 'problem' previously, but system behavior may have changed.
13+
*Result* – If changed, describe the current user experience
14+
////
15+
16+
This release of {SMProductName} includes versions 2.4.8 and 2.3.12, addresses Common Vulnerabilities and Exposures (CVEs), and contains bug fixes.
17+
18+
This release is supported on {product-title} 4.12 and later.
19+
20+
[id="ossm-component-updates-2-5-2-only_{context}"]
21+
== Component updates
22+
23+
// 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.
24+
25+
|===
26+
|Component |Version
27+
28+
|Istio
29+
|1.18.5
30+
31+
|Envoy Proxy
32+
|1.26.8
33+
34+
|Kiali
35+
|1.73.8
36+
|===
37+
38+
[id="ossm-fixed-issues-2-5-2_{context}"]
39+
== Fixed issues
40+
// The explanations of these issues have been reviewed/approved in previous releases.
41+
42+
* 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.
43+
44+
* 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.
45+
46+
* 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.
47+
48+
* 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.
49+
50+
//Keeping to make next release easier in case there are Known issues.
51+
// [id="ossm-known-issues-RELEASE_{context}"]
52+
// == Service Mesh known issues
53+
54+
// [id="ossm-kiali-known-issues-RELEASE_{context}"]
55+
// == Kiali known issues

‎modules/ossm-release-2-5-3.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
////
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ossm-release-2-5-3_{context}"]
8+
= {SMProductName} version 2.5.3
9+
10+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), and is supported on {product-title} 4.12 and later.
11+
12+
[id=ossm-release-2-5-3-components_{context}]
13+
== Component updates
14+
15+
|===
16+
|Component |Version
17+
18+
|Istio
19+
|1.18.5
20+
21+
|Envoy Proxy
22+
|1.26.8
23+
24+
|Kiali
25+
|1.73.9
26+
|===

‎modules/ossm-release-2-6-0.adoc

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
////
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ossm-release-2-6-0_{context}"]
8+
= {SMProductName} version 2.6.0
9+
10+
////
11+
*Feature* – Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes.
12+
*Reason* – If known, include why has the enhancement been implemented (use case, performance, technology, etc.). For example, showcases integration of X with Y, demonstrates Z API feature, includes latest framework bug fixes. There may not have been a 'problem' previously, but system behavior may have changed.
13+
*Result* – If changed, describe the current user experience
14+
////
15+
16+
This release of {SMProductName} includes versions 2.5.3 and 2.4.9, adds new features, addresses Common Vulnerabilities and Exposures (CVEs), and is supported on {product-title} 4.14 and later.
17+
18+
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.
19+
20+
include::snippets/ossm-current-version-support-snippet.adoc[]
21+
//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.
22+
//Per Scott Dodson on 07/15/204 via Slack, confirmed that RHEL 2.9 has been submitted for FIPS validation. Admonition updated accordingly.
23+
//Per Kirsten Newcomer on 07/16/2024 via Slack, FIPS messaging for Service Mesh has been changed. Jamie (PM) has agreed with change.
24+
[IMPORTANT]
25+
====
26+
{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.
27+
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].
28+
====
29+
30+
[id="component-versions-ossm-2-6-0_{context}"]
31+
== Component updates
32+
33+
//Component versions updated 07/25/2024.
34+
//Component tables for 2.5.3 and 2.4.9 updated 07/25/2024
35+
36+
|===
37+
|Component |Version
38+
39+
|Istio
40+
|1.20.8
41+
42+
|Envoy Proxy
43+
|1.28.5
44+
45+
|Kiali
46+
|1.73.9
47+
|===
48+
49+
[id="istio-1-20-support-ossm-2-6-0_{context}"]
50+
== Istio 1.20 support
51+
//Jamie
52+
//OSSM 2.6 supports both Istio 1.19 and Istio 1.20 but only include Istio 1.20.
53+
//Listing 2 items that are supported instead of only what is not supported.
54+
55+
Service Mesh 2.6 is based on Istio 1.20, which provides new features and product enhancements, including:
56+
57+
* Native sidecars are supported on {product-title} 4.16 or later.
58+
+
59+
.Example `ServiceMeshControlPlane` resource
60+
[source,yaml]
61+
----
62+
apiVersion: maistra.io/v2
63+
kind: ServiceMeshControlPlane
64+
metadata:
65+
name: basic
66+
spec:
67+
runtime:
68+
components:
69+
pilot:
70+
container:
71+
env:
72+
ENABLE_NATIVE_SIDECARS: "true"
73+
----
74+
75+
* 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.
76+
77+
While {SMProductName} supports many Istio 1.20 features, the following exceptions should be noted:
78+
79+
//List what is NOT SUPPORTED --> same as 2.5 so copied from 2.5 entry
80+
* Ambient mesh is not supported
81+
* QuickAssist Technology (QAT) PrivateKeyProvider in Istio is not supported
82+
83+
[id="istio-kiali-bundle-image-name-changes-ossm-2-6-0_{context}"]
84+
== Istio and Kiali bundle image name changes
85+
//This content may need to be removed for 2.6 as per Dev via Slack, name change may need to be reversed.
86+
//Filip. Approve 07/11/2024
87+
This release updates the Istio bundle image name and the Kiali bundle image name to better align with Red Hat naming conventions.
88+
89+
* Istio bundle image name: `openshift-service-mesh/istio-operator-bundle`
90+
* Kiali bundle image name: `openshift-service-mesh/kiali-operator-bundle`
91+
92+
[id="integration-otel-tempo-ossm-2-6-0_{context}"]
93+
== Integration with {TempoName} and {OTELName}
94+
//Yuanlin
95+
This release introduces a generally available integration of the tracing extension provider(s) {TempoName} and {OTELName}.
96+
97+
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.
98+
99+
You can create a {OTELName} instance in a mesh namespace and configure it to send tracing data to a tracing platform backend service.
100+
101+
//Still true for 2.6
102+
//Asked in forum-ocp-tracing channel 06/24/2024, verified 06/25/2024
103+
[NOTE]
104+
====
105+
{TempoName} Stack is not supported on {ibm-z-title}.
106+
====
107+
108+
[id="jaeger-default-setting-change-ossm-2-6-0_{context}"]
109+
== {JaegerName} default setting change
110+
//also included in "Upgrading --> Upgrading 2.5 to 2.6" but added here for increased visibility.
111+
//Dean. Approved 07/11/2024
112+
This release disables {JaegerName} by default for new instances of the `ServiceMeshControlPlane` resource.
113+
114+
When updating existing instances of the `ServiceMeshControlPlane` resource to {SMProductName} version 2.6, {JaegerShortName} remains enabled by default.
115+
116+
{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}.
117+
118+
//Gateway API Update for 2.6 OSSM-5854
119+
//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.
120+
[id="gateway-api-ga-cluster-wide-deployments-ossm-2-6-0_{context}"]
121+
== {product-title} Gateway API generally available for cluster-wide deployments
122+
//Jacek. Approved 07/11/2024
123+
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.
124+
125+
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.
126+
127+
[IMPORTANT]
128+
====
129+
Gateway API for multitenant mesh deployments is still in Technology Preview.
130+
====
131+
132+
Refer to the following table to determine which Gateway API version should be installed with the OpenShift {SMProductShortName} version you are using:
133+
134+
|===
135+
|Service Mesh Version | Istio Version | Gateway API Version | Notes
136+
137+
|2.6
138+
|1.20.x
139+
|1.0.0
140+
|N/A
141+
142+
|2.5.x
143+
|1.18.x
144+
|0.6.2
145+
|Use the experimental branch because `ReferenceGrand` is missing in v0.6.2.
146+
147+
|2.4.x
148+
|1.16.x
149+
|0.5.1
150+
|For multitenant mesh deployment, all Gateway API CRDs must be present. Use the experimental branch.
151+
|===
152+
153+
You can disable this feature by setting `PILOT_ENABLE_GATEWAY_API` to `false`:
154+
155+
[source,yaml]
156+
----
157+
apiVersion: maistra.io/v2
158+
kind: ServiceMeshControlPlane
159+
metadata:
160+
name: basic
161+
spec:
162+
runtime:
163+
components:
164+
pilot:
165+
container:
166+
env:
167+
PILOT_ENABLE_GATEWAY_API: "false"
168+
----
169+
170+
[id="ossm-fixed-issues-2-6-0_{context}"]
171+
== Fixed issues
172+
173+
* 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.
174+
175+
* 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).
176+
177+
//kept so make it easier for the next release
178+
//[id="ossm-known-issues-RELEASE_{context}"]
179+
//== Service Mesh Known issues
180+
181+
[id="ossm-kiali-known-issues-2-6-0_{context}"]
182+
== Kiali known issues
183+
// The explanations of these issues have been reviewed/approved in previous releases.
184+
* https://issues.redhat.com/browse/OSSM-6099[OSSM-6099] Installing the OpenShift {SMProductShortName} Console (OSSMC) plugin fails on an IPv6 cluster.
185+
+
186+
Workaround: Install the OSSMC plugin on an IPv4 cluster.

0 commit comments

Comments
 (0)