Skip to content

Commit d042efe

Browse files
committed
OSSMDOC-705: Update deprecation statement for Service Mesh Extension API
1 parent dd497f3 commit d042efe

10 files changed

+7
-15
lines changed

modules/ossm-control-plane-cli.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,4 @@ istiod-basic-55d78bbbcd-j5556 1/1 Running 0 108s
8383
jaeger-67c75bd6dc-jv6k6 2/2 Running 0 65m
8484
kiali-6476c7656c-x5msp 1/1 Running 0 43m
8585
prometheus-58954b8d6b-m5std 2/2 Running 0 66m
86-
wasm-cacher-basic-8c986c75-vj2cd 1/1 Running 0 65m
8786
----

modules/ossm-extensions-migrating-to-wasmplugin.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ To upgrade your WebAssembly extensions from the `ServiceMeshExtension` API to th
1212
1313
* `ServiceMeshControlPlane` is upgraded to version 2.2 or later.
1414
15-
[CAUTION]
16-
====
17-
Because both plug-ins will be called for every request, you might want to remove your existing `ServiceMeshExtension` resource before creating the new `WasmPlugin` resource. You might get undesired results having two plug-ins active at the same time.
18-
====
19-
2015
.Procedure
2116
2217
. Update your container image. If the plug-in is already in `/plugin.wasm` inside the container, skip to the next step. If not:

modules/ossm-extensions-migration-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This module included in the following assemblies:
66
[id="ossm-extensions-migration-overview_{context}"]
77
= Migrating from `ServiceMeshExtension` to `WasmPlugin` resources
88
9-
The `ServiceMeshExtension` API is deprecated as of {SMProductName} version 2.2 and will be removed in a future release. If you are using the `ServiceMeshExtention` API, you must migrate to the `WasmPlugin` API to continue using your WebAssembly extensions.
9+
The `ServiceMeshExtension` API, which was deprecated in {SMProductName} version 2.2, was removed in {SMProductName} version 2.3. If you are using the `ServiceMeshExtension` API, you must migrate to the `WasmPlugin` API to continue using your WebAssembly extensions.
1010
1111
The APIs are very similar. The migration consists of two steps:
1212

modules/ossm-extensions-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ WebAssembly modules can be run on many platforms, including proxies, and have br
1616
1717
[NOTE]
1818
====
19-
When creating new WebAssembly extensions, use the WasmPlugin API. The ServiceMeshExtension API is deprecated as of {SMProductName} version 2.2 and will be removed in a future release.
19+
When creating new WebAssembly extensions, use the `WasmPlugin` API. The `ServiceMeshExtension` API was deprecated in {SMProductName} version 2.2 and was removed in {SMProductName} version 2.3.
2020
====
2121
2222
There are two parts to writing a {SMProductName} extension:

modules/ossm-extensions-ref-smextension.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The ServiceMeshExtension API provides a mechanism to extend the functionality pr
1313
1414
[NOTE]
1515
====
16-
When creating new WebAssembly extensions, use WasmPlugin. ServiceMeshExtension is deprecated as of {SMProductName} version 2.2 and will be removed in a future release.
16+
When creating new WebAssembly extensions, use the `WasmPlugin` API. The `ServiceMeshExtension` API, which was deprecated in {SMProductName} version 2.2, was removed in {SMProductName} version 2.3.
1717
====
1818
1919
.ServiceMeshExtension Field Reference

modules/ossm-extensions-ref-wasmplugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The WasmPlugins API provides a mechanism to extend the functionality provided by
1010
1111
You can deploy multiple WasmPlugins. The `phase` and `priority` settings determine the order of execution (as part of Envoy's filter chain), allowing the configuration of complex interactions between user-supplied WasmPlugins and Istio’s internal filters.
1212
13-
In the following example, an authentication filter implements an OpenID flow and populates the Authorization header with a JSON Web Token (JWT). Istio authentication consumes this token and deployes it to the ingress gateway. The WasmPlugin file lives in the proxy sidecar filesystem. Note the field `url`.
13+
In the following example, an authentication filter implements an OpenID flow and populates the Authorization header with a JSON Web Token (JWT). Istio authentication consumes this token and deploys it to the ingress gateway. The WasmPlugin file lives in the proxy sidecar filesystem. Note the field `url`.
1414
1515
[source,yaml]
1616
----

modules/ossm-extensions-smextension-deploy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can enable {SMProductName} extensions using the `ServiceMeshExtension` resou
1010
1111
[NOTE]
1212
====
13-
When creating new WebAssembly extensions, use WasmPlugin. ServiceMeshExtension is deprecated as of {SMProductName} version 2.2 and will be removed in a future release.
13+
When creating new WebAssembly extensions, use the `WasmPlugin` API. The `ServiceMeshExtension` API was deprecated in {SMProductName} version 2.2 and removed in {SMProductName} version 2.3.
1414
====
1515
1616
For a complete example that was built using the Rust SDK, take a look at the link:https://github.com/maistra/header-append-filter[header-append-filter]. It is a simple filter that appends one or more headers to the HTTP responses, with their names and values taken out from the `config` field of the extension. See a sample configuration in the snippet below.

modules/ossm-extensions-smextension-format.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You must have a `.wasm` file containing the bytecode of your WebAssembly module,
1010
1111
[NOTE]
1212
====
13-
When creating new WebAssembly extensions, use WasmPlugin. ServiceMeshExtension is deprecated as of {SMProductName} version 2.2 and will be removed in a future release.
13+
When creating new WebAssembly extensions, use the `WasmPlugin` API. The `ServiceMeshExtension` API was deprecated in {SMProductName} version 2.2 and was removed in {SMProductName} version 2.3.
1414
====
1515
1616
.manifest.yaml

modules/ossm-upgrade-21-22-changes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ Upgrading the {SMProductShortName} control plane from version 2.1 to 2.2 introdu
1111
1212
* Istio 1.10 updated Envoy to send traffic to the application container using `eth0` rather than `lo` by default.
1313
14-
* This release adds support for the `WasmPlugin` API and deprecates the `ServiceMeshExtention` API.
14+
* This release adds support for the `WasmPlugin` API and deprecates the `ServiceMeshExtension` API.

modules/ossm-validating-smcp.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ When you create the {SMProductShortName} control plane, the {SMProductShortName}
1313
** `istio-egressgateway`
1414
** `grafana`
1515
** `prometheus`
16-
** `wasm-cacher`
1716
* Calls the Kiali Operator to create Kaili deployment based on configuration in either the SMCP or the Kiali custom resource.
1817
+
1918
[NOTE]
@@ -81,7 +80,6 @@ istiod-basic-6c9cc55998-wg4zq 1/1 Running 0 2m14s
8180
jaeger-6865d5d8bf-zrfss 2/2 Running 0 100s
8281
kiali-579799fbb7-8mwc8 1/1 Running 0 46s
8382
prometheus-5c579dfb-6qhjk 2/2 Running 0 115s
84-
wasm-cacher-basic-5b99bfcddb-m775l 1/1 Running 0 86s
8583
----
8684
+
8785
. Check the status of the {SMProductShortName} control plane deployment by using the following command. Replace `istio-system` with the namespace where you deployed the SMCP.

0 commit comments

Comments
 (0)