From ff53a15f5df4934f28aa8ed530e33f07de7d0ae1 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Tue, 1 Oct 2024 11:18:03 +0200 Subject: [PATCH 01/14] Include breaking chenges in release notes --- docs/release-notes/1.9.0.md | 15 ++++++++++++++- docs/user/00-10-overview-istio-controller.md | 14 +++++++------- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 55f199aa7..e2c560bf6 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -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/). +Pay attention the following breaking chnges in the new Istio verison: + - 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. + - 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, + 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). diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 33ccf26d7..2476e4064 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -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 stats tags. | 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 | | +|--------------------------------------|---------|------------| +| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental feature that allows for cluster creation on worker threads inline during requests. | +| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy stats tags. | > [!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. From dc575f3f7b6af9fd5341b626caa7d5da9c680ddd Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Tue, 1 Oct 2024 11:25:49 +0200 Subject: [PATCH 02/14] rephrase --- docs/release-notes/1.9.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index e2c560bf6..275d6d6a4 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -2,7 +2,7 @@ - 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). - 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/). -Pay attention the following breaking chnges in the new Istio verison: +Take note of the following breaking chnges 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. - 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 From b07ca130a884b4791b1a999a6859c4100c76a0d7 Mon Sep 17 00:00:00 2001 From: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com> Date: Tue, 1 Oct 2024 11:27:15 +0200 Subject: [PATCH 03/14] Update docs/release-notes/1.9.0.md --- docs/release-notes/1.9.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 275d6d6a4..39ae44c14 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -2,7 +2,7 @@ - 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). - 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 chnges included in the new minor version of Istio: + 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. - 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 From 151aa2578d76983edd027cacc5f14e7a607334be Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Tue, 1 Oct 2024 11:28:49 +0200 Subject: [PATCH 04/14] format tables --- docs/user/00-10-overview-istio-controller.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 2476e4064..4e0719f7c 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -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 | Description | -|--------------------------------------|---------|--------------| +| Name | Value | Description | +|--------------------------------------|---------|------------------------------------------------------------------------------------------------| | **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Pilot from using the new delimited stat tag regex to generate Envoy stats tags. | The following Istio Proxy environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: -| Name | Value | | -|--------------------------------------|---------|------------| +| Name | Value | Description | +|--------------------------------------|---------|-------------------------------------------------------------------------------------------------------------| | **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental feature that allows for cluster creation on worker threads inline during requests. | -| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy stats tags. | +| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy stats tags. | > [!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. From 9011cf67f754c33d12a6c34d373dc67f84941720 Mon Sep 17 00:00:00 2001 From: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com> Date: Tue, 1 Oct 2024 14:22:40 +0200 Subject: [PATCH 05/14] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marek Kołodziejczak <69915024+kolodziejczak@users.noreply.github.com> --- docs/user/00-10-overview-istio-controller.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 4e0719f7c..0d8039e26 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -106,14 +106,14 @@ The following Istio Pilot environment variables are applied when you set `spec.c | Name | Value | Description | |--------------------------------------|---------|------------------------------------------------------------------------------------------------| -| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Pilot from using the new delimited stat tag regex to generate Envoy stats tags. | +| **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 | Description | |--------------------------------------|---------|-------------------------------------------------------------------------------------------------------------| -| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | Disables an experimental feature that allows for cluster creation on worker threads inline during requests. | -| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy stats tags. | +| **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_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. From bed2ccc592be14148ef4b7c448eac93b5c3a7668 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 10:26:45 +0200 Subject: [PATCH 06/14] adjust rns --- docs/release-notes/1.9.0.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 39ae44c14..0bcfae306 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -1,17 +1,6 @@ ## 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). -- 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. - - 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, - 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). +- 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: + - In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. + - 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 or 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 to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file From 4d256f37b9a9921f62ca155cffb1e9746ec4009d Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 10:44:33 +0200 Subject: [PATCH 07/14] add titles --- docs/release-notes/1.9.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 0bcfae306..f387cd459 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -2,5 +2,5 @@ - 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). - 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: - - In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - - 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 or 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 to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file + - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. + - **Updates to Envoy cluster metrics parsing**: 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 or 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 to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file From bae33697b137ae07c68366a68dc477ae3f1294fc Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 15:26:19 +0200 Subject: [PATCH 08/14] update breaking change rns --- docs/release-notes/1.9.0.md | 2 +- docs/user/00-10-overview-istio-controller.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index f387cd459..50ef396ec 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -3,4 +3,4 @@ - 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). - 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: - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - - **Updates to Envoy cluster metrics parsing**: 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 or 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 to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file + - **Updates to Envoy cluster metrics parsing**: 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 or 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 have any dependency to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 0d8039e26..843d77540 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -99,10 +99,9 @@ kubectl get all| -A -l kyma-project.io/module=istio ## Compatibility Mode -To enable compatibility mode in the Istio module, you can set the **spec.compatibilityMode** field in the Istio CR. This allows you to mitigate breaking changes when a new release introduces an Istio upgrade. The Istio module applies an opinionated subset of Istio compatibilityVersion, and supports compatibility with the previous minor version of Istio. For example, the Istio module with Istio 1.21.0 applies a compatibility version of Istio 1.20. For more information, see [Compatibility Versions](https://istio.io/latest/docs/setup/additional-setup/compatibility-versions/). +To enable compatibility mode in the Istio module, you can set the **spec.compatibilityMode** field in the Istio CR. This allows you to mitigate breaking changes when a new release introduces an Istio upgrade. The Istio module applies an opinionated subset of Istio compatibilityVersion, and supports compatibility with the previous minor version of Istio. See [Compatibility Versions](https://istio.io/latest/docs/setup/additional-setup/compatibility-versions/). - -The following Istio Pilot environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: +If you use version 1.9 of the Istio module, you can enable compatibility version of Istio 1.22. It applies the following Istio Pilot environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: | Name | Value | Description | |--------------------------------------|---------|------------------------------------------------------------------------------------------------| From 42e58274c7cd0d01b728f9af89e91be1597cb5b9 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 15:34:30 +0200 Subject: [PATCH 09/14] remove description from the table --- docs/user/00-10-overview-istio-controller.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 843d77540..36929dca3 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -99,20 +99,21 @@ kubectl get all| -A -l kyma-project.io/module=istio ## Compatibility Mode -To enable compatibility mode in the Istio module, you can set the **spec.compatibilityMode** field in the Istio CR. This allows you to mitigate breaking changes when a new release introduces an Istio upgrade. The Istio module applies an opinionated subset of Istio compatibilityVersion, and supports compatibility with the previous minor version of Istio. See [Compatibility Versions](https://istio.io/latest/docs/setup/additional-setup/compatibility-versions/). +To enable compatibility mode in the Istio module, you can set the **spec.compatibilityMode** field in the Istio CR. This allows you to mitigate breaking changes when a new release introduces an Istio upgrade. The Istio module applies an opinionated subset of Istio compatibilityVersion, and supports compatibility with the previous minor version of Istio. For example, the Istio module with Istio 1.21.0 applies a compatibility version of Istio 1.20. For more information, see [Compatibility Versions](https://istio.io/latest/docs/setup/additional-setup/compatibility-versions/). -If you use version 1.9 of the Istio module, you can enable compatibility version of Istio 1.22. It applies the following Istio Pilot environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: -| 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 Pilot environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: + +| Name | Value | +|--------------------------------------|---------| +| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | The following Istio Proxy environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: -| 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. | -| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | Prevents Istio Proxy from using the new delimited stat tag regex to generate Envoy cluster metrics. | +| Name | Value | +|--------------------------------------|---------| +| **ENABLE_DEFERRED_CLUSTER_CREATION** | `false` | +| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | > [!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. From edd775b095c7b3bfe1dd2a2a7ab8e8be2a80efcc Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 15:35:18 +0200 Subject: [PATCH 10/14] fix the table --- docs/user/00-10-overview-istio-controller.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/00-10-overview-istio-controller.md b/docs/user/00-10-overview-istio-controller.md index 36929dca3..33ccf26d7 100644 --- a/docs/user/00-10-overview-istio-controller.md +++ b/docs/user/00-10-overview-istio-controller.md @@ -106,7 +106,7 @@ The following Istio Pilot environment variables are applied when you set `spec.c | Name | Value | |--------------------------------------|---------| -| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | +| **ENABLE_DELIMITED_STATS_TAG_REGEX** | `false` | The following Istio Proxy environment variables are applied when you set `spec.compatibilityMode: true` in Istio CR: From 99acd1437f03075ac54dc501b0fa57a39bc1645d Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 16:00:24 +0200 Subject: [PATCH 11/14] lang fixes --- docs/release-notes/1.9.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 50ef396ec..3bb8e2a62 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -1,6 +1,6 @@ ## 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). +- During the Istio upgrade, Pods with the Istio sidecar proxies are now 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). - 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: - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - - **Updates to Envoy cluster metrics parsing**: 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 or 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 have any dependency to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file + - **Updates to Envoy cluster metrics parsing**: Previously, the Envoy cluster metrics for services that did not use the `.svc.cluster.local` suffix were incorrectly truncated and parsed. This was becuase Envoy cluster metrics use dots `.` as a delimiter between metric namespaces. It is impossible to properly distinguish between those delimiters and the dots in hostnames or cluster names. To address this, the regex for parsing **cluster_name** has been updated to look for a semicolon that indicats the end of a cluster's name. If you have any dependency to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file From 6b571a176265df148a7e8a50d6e3d70e0515796a Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Wed, 2 Oct 2024 16:03:42 +0200 Subject: [PATCH 12/14] lang fix --- docs/release-notes/1.9.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 3bb8e2a62..6f1373cf6 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -1,6 +1,6 @@ ## New Features -- During the Istio upgrade, Pods with the Istio sidecar proxies are now 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). +- During the Istio upgrade, Pods with the Istio sidecar proxies are now divided into smaller groups and restarted in multiple reconciliations instead of all at once. This increases 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). - 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: - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - **Updates to Envoy cluster metrics parsing**: Previously, the Envoy cluster metrics for services that did not use the `.svc.cluster.local` suffix were incorrectly truncated and parsed. This was becuase Envoy cluster metrics use dots `.` as a delimiter between metric namespaces. It is impossible to properly distinguish between those delimiters and the dots in hostnames or cluster names. To address this, the regex for parsing **cluster_name** has been updated to look for a semicolon that indicats the end of a cluster's name. If you have any dependency to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file From 06d4e43ea8c2f746ba2aece899407a73dff7f64e Mon Sep 17 00:00:00 2001 From: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com> Date: Wed, 2 Oct 2024 16:27:57 +0200 Subject: [PATCH 13/14] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Małgorzata Świeca --- docs/release-notes/1.9.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 6f1373cf6..657ef4e7b 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -1,6 +1,6 @@ ## New Features - During the Istio upgrade, Pods with the Istio sidecar proxies are now divided into smaller groups and restarted in multiple reconciliations instead of all at once. This increases 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). -- 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: +- We've updated the Istio version to 1.23.2 ([#1024](https://github.com/kyma-project/istio/pull/1024)). Read the 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: - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - - **Updates to Envoy cluster metrics parsing**: Previously, the Envoy cluster metrics for services that did not use the `.svc.cluster.local` suffix were incorrectly truncated and parsed. This was becuase Envoy cluster metrics use dots `.` as a delimiter between metric namespaces. It is impossible to properly distinguish between those delimiters and the dots in hostnames or cluster names. To address this, the regex for parsing **cluster_name** has been updated to look for a semicolon that indicats the end of a cluster's name. If you have any dependency to the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file + - **Updates to Envoy cluster metrics parsing**: Previously, the Envoy cluster metrics for services that did not use the `.svc.cluster.local` suffix were incorrectly truncated and parsed. This was because Envoy cluster metrics use dots `.` as a delimiter between metric namespaces. It is impossible to properly distinguish between those delimiters and the dots in hostnames or cluster names. To address this, the regex for parsing **cluster_name** has been updated to look for a semicolon that indicates the end of a cluster's name. If you have any dependency on the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file From 9bf9bd5ccb6a819672b9784725ac1269715013ac Mon Sep 17 00:00:00 2001 From: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com> Date: Wed, 2 Oct 2024 16:44:52 +0200 Subject: [PATCH 14/14] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Małgorzata Świeca --- docs/release-notes/1.9.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/1.9.0.md b/docs/release-notes/1.9.0.md index 657ef4e7b..2b58cb896 100644 --- a/docs/release-notes/1.9.0.md +++ b/docs/release-notes/1.9.0.md @@ -1,6 +1,6 @@ ## New Features -- During the Istio upgrade, Pods with the Istio sidecar proxies are now divided into smaller groups and restarted in multiple reconciliations instead of all at once. This increases 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). +- During the Istio upgrade, Pods with the Istio sidecar proxies are now divided into smaller groups and restarted in multiple reconciliations instead of all at once. This increases the stability and reliability of the reconciliation for the Istio module's operator. See [issue #155](https://github.com/kyma-project/istio/issues/155). - We've updated the Istio version to 1.23.2 ([#1024](https://github.com/kyma-project/istio/pull/1024)). Read the 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: - **Deferred cluster creation**: In the context of Envoy, a cluster is a group of logically similar upstream hosts that Envoy connects to. Typically, clusters are defined and created at startup. This means that regardless of whether or not a cluster will be used during the lifetime of the Envoy process, it will still be initialized. Envoy has introduced a new optimization that allows these clusters to be created on the worker threads inline during requests, which can save memory and CPU cycles. If you rely on the old behavior, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which disables the deferred cluster creation feature by setting **ENABLE_DEFERRED_CLUSTER_CREATION** to `false`. - **Updates to Envoy cluster metrics parsing**: Previously, the Envoy cluster metrics for services that did not use the `.svc.cluster.local` suffix were incorrectly truncated and parsed. This was because Envoy cluster metrics use dots `.` as a delimiter between metric namespaces. It is impossible to properly distinguish between those delimiters and the dots in hostnames or cluster names. To address this, the regex for parsing **cluster_name** has been updated to look for a semicolon that indicates the end of a cluster's name. If you have any dependency on the full stat name for cluster metrics, you must update your monitoring system to account for this change. If you require more time to make adjustments, consider using the [compatibility mode](https://kyma-project.io/#/istio/user/00-10-overview-istio-controller?id=compatibility-mode), which reverts this behavior by setting **ENABLE_DELIMITED_STATS_TAG_REGEX** to `false`. \ No newline at end of file