Skip to content

Commit f11fef0

Browse files
authored
Merge pull request #45271 from JStickler/OSSMDOC-442
OSSMDOC-442 Clarify lack of support for EnvoyFilters.
2 parents 3b5c9df + dfc1470 commit f11fef0

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

modules/ossm-rn-deprecated-features.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ In Service Mesh 2.1, the Mixer component is removed. Bug fixes and support is pr
2121

2222
Upgrading from a Service Mesh 2.0.x release to 2.1 will not proceed if Mixer plug-ins are enabled. Mixer plug-ins must be ported to WebAssembly Extensions.
2323

24-
With Mixer removed, custom metrics for telemetry must be obtained using Envoy filter.
25-
2624
== Deprecated features {SMProductName} 2.0
2725

2826
The Mixer component was deprecated in release 2.0 and will be removed in release 2.1. While using Mixer for implementing extensions was still supported in release 2.0, extensions should have been migrated to the new link:https://istio.io/latest/blog/2020/wasm-announce/[WebAssembly] mechanism.

modules/ossm-supported-configurations.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ For additional information about {SMProductName} lifecycle and supported configu
3535
* OVN-Kubernetes is supported on {product-title} 4.7.32+, {product-title} 4.8.12+, and {product-title} 4.9+.
3636
* Third-Party Container Network Interface (CNI) plug-ins that have been certified on {product-title} and passed {SMProductShortName} conformance testing. See link:https://access.redhat.com/articles/5436171[Certified OpenShift CNI Plug-ins] for more information.
3737

38+
[id="ossm-supported-configurations-sm_{context}"]
39+
== Supported configurations for Service Mesh
40+
41+
* {SMProductName} does not support `EnvoyFilter` configuration except where explicitly documented.
42+
3843
[id="ossm-supported-configurations-kiali_{context}"]
3944
== Supported configurations for Kiali
4045

modules/ossm-vs-istio.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ spec:
100100
* Godebug has been removed from all templates
101101
* The `istio-multi` ServiceAccount and ClusterRoleBinding have been removed, as well as the `istio-reader` ClusterRole.
102102

103+
[id="ossm-envoy-filters_{context}"]
104+
== Envoy filters
105+
106+
{SMProductName} does not support `EnvoyFilter` configuration except where explicitly documented. Due to tight coupling with the underlying Envoy APIs, backward compatibility cannot be maintained. `EnvoyFilter` patches are very sensitive to the format of the Envoy configuration that is generated by Istio. If the configuration generated by Istio changes, it has the potential to break the application of the `EnvoyFilter`.
107+
103108
[id="ossm-envoy-services_{context}"]
104109
== Envoy services
105110

0 commit comments

Comments
 (0)