Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include breaking changes in release notes #1048

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Include breaking changes in release notes #1048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff53a15
Include breaking chenges in release notes
nataliasitko Oct 1, 2024
dc575f3
rephrase
nataliasitko Oct 1, 2024
b07ca13
Update docs/release-notes/1.9.0.md
nataliasitko Oct 1, 2024
151aa25
format tables
nataliasitko Oct 1, 2024
9011cf6
Apply suggestions from code review
nataliasitko Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/release-notes/1.9.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
## New Features

- During the Istio upgrade, Pods with the Istio sidecar proxies will now be divided into smaller groups and restarted in multiple reconciliations instead of all at once. This will increase the stability and reliability of the reconciliation for the Istio module's operator. See the [issue #155](https://github.com/kyma-project/istio/issues/155).
- Update the Istio version to 1.23.2 [#1024](https://github.com/kyma-project/istio/pull/1024). Read [Istio 1.23.2 Release Announcement](https://istio.io/latest/news/releases/1.23.x/announcing-1.23.2/).
- We've updated the Istio version to 1.23.2 ([#1024](https://github.com/kyma-project/istio/pull/1024)). Read Istio 1.23.2 [Release Announcement](https://istio.io/latest/news/releases/1.23.x/announcing-1.23.2/) and Istio 1.23.0 [Change Notes](https://istio.io/latest/news/releases/1.23.x/announcing-1.23/change-notes/).
Take note of the following breaking changes included in the new minor version of Istio:
- An experimental feature to enable cluster creation on worker threads inline during requests. This saves memory and CPU cycles in cases where there are lots of inactive clusters and more than one worker thread.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- An experimental feature to enable cluster creation on worker threads inline during requests. This saves memory and CPU cycles in cases where there are lots of inactive clusters and more than one worker thread.
- An experimental feature that enables more resource friendly propagation of the configuration within the Envoy worker threads.

- Previously, the Envoy cluster metrics for services that did not have a `.svc.cluster.local` suffix
were incorrectly truncated and parsed. This was due to the fact that Envoy cluster metrics use dots "." as
a delimeter between metric namespaces, and it is impossible to properly distinguish between those
delimeters and the dots in hostnames/cluster names. To address this, the regex for parsing the cluster_name
has been updated to look for a semicolon to indicate the end of the cluster name. If you're using
the `inbound_cluster_stat_name` or `outbound_cluster_stat_name` fields in meshconfig, the semicolon
will be added automatically for you. If you have any dependency on the full stat name for cluster metrics,
Comment on lines +11 to +13
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
has been updated to look for a semicolon to indicate the end of the cluster name. If you're using
the `inbound_cluster_stat_name` or `outbound_cluster_stat_name` fields in meshconfig, the semicolon
will be added automatically for you. If you have any dependency on the full stat name for cluster metrics,
has been updated to look for a semicolon to indicate the end of the cluster name. If you have any dependency on the full stat name for cluster metrics,

you will need to update your monitoring system to account for this change.


If any of these changes are causing disruption to your applications and you require more time to make adjustments, consider enabling compatibility version of Istio 1.22. It reverts the new bahavior by applying the `ENABLE_DELIMITED_STATS_TAG_REGEX` and `ENABLE_DEFERRED_CLUSTER_CREATION` enavironment variables. See [Compatibility Version](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode).
14 changes: 7 additions & 7 deletions docs/user/00-10-overview-istio-controller.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,16 @@ To enable compatibility mode in the Istio module, you can set the **spec.compati

The following Istio Pilot environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR:

| Name | Value |
|--------------------------------------|---------|
| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` |
| Name | Value | Description |
|--------------------------------------|---------|------------------------------------------------------------------------------------------------|
| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Pilot from using the new delimited stat tag regex to generate Envoy cluster metrics. |

The following Istio Proxy environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR:

| Name | Value |
|--------------------------------------|---------|
| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` |
| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` |
| Name | Value | Description |
|--------------------------------------|---------|-------------------------------------------------------------------------------------------------------------|
| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental Envoy feature that optimizes Envoy configuration resources usage by inlining certain parts with already ongoing requests. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental Envoy feature that optimizes Envoy configuration resources usage by inlining certain parts with already ongoing requests. |
| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental Envoy feature that optimizes Envoy configuration by inlining certain steps with already ongoing requests. |

| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy cluster metrics. |

> [!WARNING]
> You can use the compatibility mode to retain the behavior of the current Istio version when a new version of the Istio module with a higher version of Istio is released. Then, the compatibility will be first set to a minor version lower than the one you are currently using. If this lower version’s behavior is not compatible with your current mesh setup, some configurations may be broken until the new release of the Istio module is rolled out.