Skip to content

Commit fa6f812

Browse files
authored
Merge pull request #54610 from rh-tokeefe/OSSMDOC-735
OSSMDOC-735: Service Mesh 2.3.1 Z Stream Release Notes
2 parents 0611b31 + b1b66a7 commit fa6f812

File tree

4 files changed

+104
-16
lines changed

4 files changed

+104
-16
lines changed

_attributes/common-attributes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ endif::[]
133133
:product-dedicated: Red Hat OpenShift Dedicated
134134
:SMProductName: Red Hat OpenShift Service Mesh
135135
:SMProductShortName: Service Mesh
136-
:SMProductVersion: 2.3
137-
:MaistraVersion: 2.3
136+
:SMProductVersion: 2.3.1
137+
:MaistraVersion: 2.3.1
138138
//Service Mesh v1
139139
:SMProductVersion1x: 1.1.18.2
140140
//Windows containers

modules/ossm-rn-fixed-issues.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ The following issues been resolved in the current release:
1919
[id="ossm-rn-fixed-issues-ossm_{context}"]
2020
== {SMProductShortName} fixed issues
2121

22+
* https://issues.redhat.com/browse/OSSM-3025[OSSM-3025] Istiod sometimes fails to become ready. Sometimes, when a mesh contained many member namespaces, the Istiod pod did not become ready due to a deadlock within Istiod. The deadlock is now resolved and the pod now starts as expected.
23+
24+
* https://issues.redhat.com/browse/OSSM-2344[OSSM-2344] Restarting Istiod causes Kiali to flood CRI-O with port-forward requests. This issue occurred when Kiali could not connect to Istiod and Kiali simultaneously issued a large number of requests to istiod. Kiali now limits the number of requests it sends to istiod.
25+
26+
* https://issues.redhat.com/browse/OSSM-2335[OSSM-2335] Dragging the mouse pointer over the Traces scatterchart plot sometimes caused the Kiali console to stop responding due to concurrent backend requests.
27+
2228
* https://issues.redhat.com/browse/OSSM-2053[OSSM-2053] Using {SMProductName} Operator 2.2 or 2.3, during SMCP reconciliation, the SMMR controller removed the member namespaces from `SMMR.status.configuredMembers`. This caused the services in the member namespaces to become unavailable for a few moments.
2329
+
2430
Using {SMProductName} Operator 2.2 or 2.3, the SMMR controller no longer removes the namespaces from `SMMR.status.configuredMembers`. Instead, the controller adds the namespaces to `SMMR.status.pendingMembers` to indicate that they are not up-to-date. During reconciliation, as each namespace synchronizes with the SMCP, the namespace is automatically removed from `SMMR.status.pendingMembers`.
@@ -50,6 +56,8 @@ Namespace starting with `kube` is hidden from Kiali.
5056

5157
* link:https://issues.redhat.com/browse/OSSM-569[OSSM-569] There is no CPU memory limit for the Prometheus `istio-proxy` container. The Prometheus `istio-proxy` sidecar now uses the resource limits defined in `spec.proxy.runtime.container`.
5258

59+
* link:https://issues.redhat.com/browse/OSSM-535[OSSM-535] Support validationMessages in SMCP. The `ValidationMessages` field in the Service Mesh Control Plane can now be set to `True`. This writes a log for the status of the resources, which can be helpful when troubleshooting problems.
60+
5361
* link:https://issues.redhat.com/browse/OSSM-449[OSSM-449] VirtualService and Service causes an error "Only unique values for domains are permitted. Duplicate entry of domain."
5462

5563
* link:https://issues.redhat.com/browse/OSSM-419[OSSM-419] Namespaces with similar names will all show in Kiali namespace list, even though namespaces may not be defined in Service Mesh Member Role.

modules/ossm-rn-known-issues.adoc

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ These limitations exist in {SMProductName}:
3232

3333
These are the known issues in {SMProductName}:
3434

35-
* link:https://github.com/istio/istio/issues/14743[Istio-14743] Due to limitations in the version of Istio that this release of {SMProductName} is based on, there may be applications that are currently incompatible with {SMProductShortName}. See the linked community issue for details.
36-
3735
* https://issues.redhat.com/browse/OSSM-2221[OSSM-2221] Gateway injection does not work in control plane namespace. If you use the Gateway injection feature to create a gateway in the same location as the control plane, the injection fails and OpenShift generates this message:
3836
+
3937
`Warning Failed 10s kubelet, ocp-wide-vh8fd-worker-vhqm9 Failed to pull image "auto": rpc error: code = Unknown desc = reading manifest latest in docker.io/library/auto: errors`
@@ -58,6 +56,22 @@ For more information, see Migrating from `ServiceMeshExtension` to `WasmPlugin`
5856

5957
* https://issues.redhat.com/browse/OSSM-1168[OSSM-1168] When service mesh resources are created as a single YAML file, the Envoy proxy sidecar is not reliably injected into pods. When the SMCP, SMMR, and Deployment resources are created individually, the deployment works as expected.
6058
//Keep OSSM-1052 in RN - Closed as documented.
59+
60+
* https://issues.redhat.com/browse/OSSM-1115[OSSM-1115] The `concurrency` field of the `spec.proxy` API did not propagate to the istio-proxy. The `concurrency` field works when set with `ProxyConfig`. The `concurrency` field specifies the number of worker threads to run. If the field is set to `0`, then the number of worker threads available is equal to the number of CPU cores. If the field is not set, then the number of worker threads available defaults to `2`.
61+
+
62+
In the following example, the `concurrency` field is set to `0`.
63+
+
64+
[source,yaml]
65+
----
66+
apiVersion: networking.istio.io/v1beta1
67+
kind: ProxyConfig
68+
metadata:
69+
name: mesh-wide-concurrency
70+
namespace: <istiod-namespace>
71+
spec:
72+
concurrency: 0
73+
----
74+
6175
* https://issues.redhat.com/browse/OSSM-1052[OSSM-1052] When configuring a Service `ExternalIP` for the ingressgateway in the {SMProductShortName} control plane, the service is not created. The schema for the SMCP is missing the parameter for the service.
6276
+
6377
Workaround: Disable the gateway creation in the SMCP spec and manage the gateway deployment entirely manually (including Service, Role and RoleBinding).

modules/ossm-rn-new-features.adoc

Lines changed: 78 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,37 @@ Module included in the following assemblies:
1515

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

18-
== New features {SMProductName} version {SMProductVersion}
18+
== New features {SMProductName} version 2.3.1
1919

20-
This release of {SMProductName} introduces new features, addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9, 4.10, and 4.11.
20+
This release of {SMProductName} introduces new features, addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9 or later.
2121

2222
=== Component versions included in {SMProductName} version {SMProductVersion}
2323

2424
|===
2525
|Component |Version
2626

27+
|Istio
28+
|1.14.5
29+
30+
|Envoy Proxy
31+
|1.22.4
32+
33+
|Jaeger
34+
|1.39
35+
36+
|Kiali
37+
|1.57.5
38+
|===
39+
40+
== New features {SMProductName} version 2.3
41+
42+
This release of {SMProductName} introduces new features, addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9, 4.10, and 4.11.
43+
44+
=== Component versions included in {SMProductName} version 2.3
45+
46+
|===
47+
|Component |Version
48+
2749
|Istio
2850
|1.14.3
2951

@@ -103,9 +125,31 @@ Additionally, the SMMR must also be configured for cluster-wide deployment. This
103125
----
104126
<1> Adds all namespaces to the mesh, including any namespaces you subsequently create. The following namespaces are not part of the mesh: kube, openshift, kube-* and openshift-*.
105127

128+
== New features {SMProductName} version 2.2.5
129+
130+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9 or later.
131+
132+
=== Component versions included in {SMProductName} version 2.2.5
133+
134+
|===
135+
|Component |Version
136+
137+
|Istio
138+
|1.12.9
139+
140+
|Envoy Proxy
141+
|1.20.8
142+
143+
|Jaeger
144+
|1.39
145+
146+
|Kiali
147+
|1.48.3
148+
|===
149+
106150
== New features {SMProductName} version 2.2.4
107151

108-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
152+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9 or later.
109153

110154
=== Component versions included in {SMProductName} version 2.2.4
111155

@@ -127,7 +171,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
127171

128172
== New features {SMProductName} version 2.2.3
129173

130-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
174+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
131175

132176
=== Component versions included in {SMProductName} version 2.2.3
133177

@@ -149,7 +193,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
149193

150194
== New features {SMProductName} version 2.2.2
151195

152-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
196+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
153197

154198
=== Component versions included in {SMProductName} version 2.2.2
155199

@@ -175,7 +219,7 @@ With this enhancement, in addition to copying annotations, you can copy specific
175219

176220
== New features {SMProductName} version 2.2.1
177221

178-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
222+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
179223

180224
=== Component versions included in {SMProductName} version 2.2.1
181225

@@ -197,7 +241,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
197241

198242
== New features {SMProductName} 2.2
199243

200-
This release of {SMProductName} adds new features and enhancements, and is supported on OpenShift Container Platform 4.9 or later.
244+
This release of {SMProductName} adds new features and enhancements, and is supported on {product-title} 4.9 or later.
201245

202246
=== Component versions included in {SMProductName} version 2.2
203247

@@ -292,9 +336,31 @@ If the Kubernetes API deployment controller is disabled, you must manually deplo
292336
type: Hostname
293337
----
294338

339+
== New features {SMProductName} 2.1.6
340+
341+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9 or later.
342+
343+
=== Component versions included in {SMProductName} version 2.1.6
344+
345+
|===
346+
|Component |Version
347+
348+
|Istio
349+
|1.9.9
350+
351+
|Envoy Proxy
352+
|1.17.5
353+
354+
|Jaeger
355+
|1.36
356+
357+
|Kiali
358+
|1.36.14
359+
|===
360+
295361
== New features {SMProductName} 2.1.5.2
296362

297-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
363+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), contains bug fixes, and is supported on {product-title} 4.9 or later.
298364

299365
=== Component versions included in {SMProductName} version 2.1.5.2
300366

@@ -316,7 +382,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
316382

317383
== New features {SMProductName} 2.1.5.1
318384

319-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
385+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
320386

321387
=== Component versions included in {SMProductName} version 2.1.5.1
322388

@@ -338,7 +404,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
338404

339405
== New features {SMProductName} 2.1.5
340406

341-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
407+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
342408

343409
=== Component versions included in {SMProductName} version 2.1.5
344410

@@ -588,7 +654,7 @@ Kiali 1.36 includes the following features and enhancements:
588654

589655
== New features {SMProductName} 2.0.11.1
590656

591-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
657+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
592658

593659
=== Component versions included in {SMProductName} version 2.0.11.1
594660

@@ -610,7 +676,7 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
610676

611677
== New features {SMProductName} 2.0.11
612678

613-
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on OpenShift Container Platform 4.9 or later.
679+
This release of {SMProductName} addresses Common Vulnerabilities and Exposures (CVEs), bug fixes, and is supported on {product-title} 4.9 or later.
614680

615681
=== Component versions included in {SMProductName} version 2.0.11
616682

0 commit comments

Comments
 (0)