Skip to content

Commit

Permalink
OSSM-6170 OSSM 2.5.1, 2.4.7, and 2.3.11 (At Stage): [DOC] Release Not…
Browse files Browse the repository at this point in the history
…es, Known Issues and Bug Fixes
  • Loading branch information
gwynnemonahan committed Mar 28, 2024
1 parent b9d5dec commit 73282c8
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 17 deletions.
14 changes: 8 additions & 6 deletions modules/ossm-rn-fixed-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,20 @@ Provide the following info for each issue if possible:

The following issue has been resolved in the current release:

* https://issues.redhat.com/browse/OSSM-1397[OSSM-1397] Previously, if you removed the `maistra.io/member-of` label from a namespace, the {SMProductShortName} Operator did not automatically reapply the label to the namespace. As a result, sidecar injection did not work in the namespace.
+
The Operator would reapply the label to the namespace when you made changes to the `ServiceMeshMember` object, which triggered the reconciliation of this member object.
+
Now, any change to the namespace also triggers the member object reconciliation.
* https://issues.redhat.com/browse/OSSM-6099[OSSM-6099] Previously, the OpenShift Service Mesh Console (OSSMC) plugin failed to load correctly in an IPv6 cluster. Now, the OSSMC plugin configuration has been modified to ensure proper loading in an IPv6 cluster.
The following issues have been resolved in previous releases:

[id="ossm-rn-fixed-issues-ossm_{context}"]
== {SMProductShortName} fixed issues

* https://issues.redhat.com/browse/OSSM-3647[OSSM-3647] Previously, in the {SMProductShortName} control plane (SMCP) v2.2 (Istio 1.12), WasmPlugins were applied only to inbound listeners. Since SMCP v2.3 (Istio 1.14), WasmPlugins have been applied to inbound and outbound listeners by default, which introduced regression for users of the 3scale WasmPlugin. Now, the environment variable `APPLY_WASM_PLUGINS_TO_INBOUND_ONLY` is added, which allows safe migration from SMCP v2.2 to v2.3 and v2.4.
* https://issues.redhat.com/browse/OSSM-1397[OSSM-1397] Previously, if you removed the `maistra.io/member-of` label from a namespace, the {SMProductShortName} Operator did not automatically reapply the label to the namespace. As a result, sidecar injection did not work in the namespace.
+
The Operator would reapply the label to the namespace when you made changes to the `ServiceMeshMember` object, which triggered the reconciliation of this member object.
+
Now, any change to the namespace also triggers the member object reconciliation.

* https://issues.redhat.com/browse/OSSM-3647[OSSM-3647] Previously, in the {SMProductShortName} control plane (SMCP) v2.2 (Istio 1.12), WasmPlugins were applied only to inbound listeners. Since SMCP v2.3 (Istio 1.14), WasmPlugins have been applied to inbound and outbound listeners by default, which introduced regression for users of the 3scale WasmPlugin. Now, the environment variable `APPLY_WASM_PLUGINS_TO_INBOUND_ONLY` is added, which allows safe migration from SMCP v2.2 to v2.3 and v2.4.
+
The following setting should be added to the SMCP config:
+
Expand Down
95 changes: 84 additions & 11 deletions modules/ossm-rn-new-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,30 @@ Module included in the following assemblies:

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

[id="new-features-ossm-2-5-1"]
== New features {SMProductName} version 2.5.1

//As of March 28, 2024, there are no new features so the phrase "new features" has been removed. This release is to address container grades, and at least 1 Kiali bug fix.

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

=== Component versions for {SMProductName} version 2.5.1

//Release is scheduled for April 18, 2024. Code Freeze is scheduled for April 4, 2024. Component versions should be available after April 4.

|===
|Component |Version

|Istio
|

|Envoy Proxy
|

|Kiali
|1.73.4
|===

[id="new-features-ossm-2-5"]
== New features {SMProductName} version 2.5

Expand Down Expand Up @@ -55,28 +79,28 @@ This release adds documentation for migrating from a multitenant mesh to a clust

=== {SMProductName} Operator on ARM-based clusters

This release provides the {SMProductName} Operator on ARM-based clusters as a generally available feature.
This release provides the {SMProductName} Operator on ARM-based clusters as a generally available feature.

=== Integration with {DTProductName} (Tempo) Stack

This release introduces a generally available integration of the tracing extension provider(s). You can expose tracing data to the {DTProductName} (Tempo) stack by appending a named element and the `zipkin` provider to the `spec.meshConfig.extensionProviders` specification. Then, a telemetry custom resource configures Istio proxies to collect trace spans and send them to the Tempo distributor service endpoint.

[NOTE]
====
{DTProductName} (Tempo) Stack is not supported on {ibm-z-title}.
{DTProductName} (Tempo) Stack is not supported on {ibm-z-title}.
====

=== OpenShift Service Mesh Console plugin

This release introduces a generally available version of the OpenShift {SMProductShortName} Console (OSSMC) plugin.
This release introduces a generally available version of the OpenShift {SMProductShortName} Console (OSSMC) plugin.

The OSSMC plugin is an extension to the OpenShift Console that provides visibility into your Service Mesh. With the OSSMC plugin installed, a new Service Mesh menu option is available in the left-hand navigation of the web console, as well as new Service Mesh tabs that enhance existing Workloads and Service console pages.
The OSSMC plugin is an extension to the OpenShift Console that provides visibility into your Service Mesh. With the OSSMC plugin installed, a new Service Mesh menu option is available in the left-hand navigation of the web console, as well as new Service Mesh tabs that enhance existing Workloads and Service console pages.

The features of the OSSMC plugin are very similar to those of the standalone Kiali Console. The OSSMC plugin does not replace the Kiali Console, and after installing the OSSMC plugin, you can still access the standalone Kiali Console.
The features of the OSSMC plugin are very similar to those of the standalone Kiali Console. The OSSMC plugin does not replace the Kiali Console, and after installing the OSSMC plugin, you can still access the standalone Kiali Console.

=== Istio OpenShift Routing (IOR) default setting change

The default setting for Istio OpenShift Routing (IOR) has changed. Starting with this release, automatic routes are disabled by default for new instances of the `ServiceMeshControlPlane` resource.
The default setting for Istio OpenShift Routing (IOR) has changed. Starting with this release, automatic routes are disabled by default for new instances of the `ServiceMeshControlPlane` resource.

For new instances of the `ServiceMeshControlPlane` resources, you can use automatic routes by setting the `enabled` field to `true` in the `gateways.openshiftRoute` specification of the `ServiceMeshControlPlane` resource.

Expand All @@ -95,11 +119,11 @@ When updating existing instances of the `ServiceMeshControlPlane` resource to {S

=== Istio proxy concurrency configuration enhancement

The `concurrency` parameter in the `networking.istio` API configures how many worker threads the Istio proxy runs.
The `concurrency` parameter in the `networking.istio` API configures how many worker threads the Istio proxy runs.

For consistency across deployments, Istio now configures the `concurrency` parameter based upon the CPU limit allocated to the proxy container. For example, a limit of 2500m would set the `concurrency` parameter to `3`. If you set the `concurrency` parameter to a different value, then Istio uses that value to configure how many threads the proxy runs instead of using the CPU limit.
For consistency across deployments, Istio now configures the `concurrency` parameter based upon the CPU limit allocated to the proxy container. For example, a limit of 2500m would set the `concurrency` parameter to `3`. If you set the `concurrency` parameter to a different value, then Istio uses that value to configure how many threads the proxy runs instead of using the CPU limit.

Previously, the default setting for the parameter was `2`.
Previously, the default setting for the parameter was `2`.

=== Gateway API CRD versions
:FeatureName: {product-title} Gateway API support
Expand All @@ -121,6 +145,30 @@ A new version of the Gateway API custom resource definition (CRD) is now availab
|For multitenant mesh deployment, all Gateway API CRDs must be present. Use the experimental branch.
|===

[id="new-features-ossm-2-4-7"]
== New features {SMProductName} version 2.4.7

//As of March 28, 2024, there are no new features so the phrase "new features" has been removed. This release is to address container grades, and at least 1 Kiali bug fix.

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

=== Component versions for {SMProductName} version 2.4.7

//Release is scheduled for April 18, 2024. Code Freeze is scheduled for April 4, 2024. Component versions should be available after April 4.

|===
|Component |Version

|Istio
|

|Envoy Proxy
|

|Kiali
|1.73.4
|===

[id="new-features-ossm-2-4-6"]
== New features {SMProductName} version 2.4.6

Expand Down Expand Up @@ -172,8 +220,8 @@ This release of {SMProductName} addresses Common Vulnerabilities and Exposures (
//Istio stays the same
//Envoy updated to 1.24.12
//According to distributed tracing release 2.9, the latest at time of OSSM 2.4.4, Jaeger has been updated to 1.47.0
//Kiali updated to 1.65.9
//Kiali updated to 1.65.10 on 10/31/2023 due to security fix
//Kiali updated to 1.65.9
//Kiali updated to 1.65.10 on 10/31/2023 due to security fix
|===
|Component |Version

Expand Down Expand Up @@ -417,6 +465,31 @@ ifndef::openshift-rosa,openshift-dedicated[]
* OpenTelemetry API remains a Technology Preview feature.
endif::openshift-rosa,openshift-dedicated[]

[id="new-features-ossm-2-3-11"]
== New features {SMProductName} version 2.3.11

//With 2.5.1
//As of March 28, 2024, there are no new features so the phrase "new features" has been removed.

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

=== Component versions for {SMProductName} version 2.3.11

//Release is scheduled for April 18, 2024. Code Freeze is scheduled for April 4, 2024. Component versions should be available after April 4.

|===
|Component |Version

|Istio
|

|Envoy Proxy
|

|Kiali
|1.73.4
|===

[id="new-features-ossm-2-3-10"]
== New features {SMProductName} version 2.3.10
//Update with 2.5
Expand Down

0 comments on commit 73282c8

Please sign in to comment.