WasmExtensions

Modify an existing WasmExtension. When modifying the details of an extension in use, such as the image property, enabled flag, phase, or default configuration, a redeploy or reconfiguration of the extension may be triggered, affecting live traffic in all those places that reference the extension. Similarly, changes to the allowed_in property may trigger the removal of the extension from all places where the extension was in use that are not allowed to use it anymore, affecting live traffic on the relevant namespaces as well.

put/v2/organizations/{organization}/extensions/{extension}

Request

Base URL
https://docs.tetrate.io (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/docs/v2/organizations/:organization/extensions/:extension/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Organization name.

extensionstring required

Extension name.

Request body

allowedInstring[]

List of fqns where this extension is allowed to run. If it is empty, the extension can be used across the entire organization. Currently only Tenant resources are considered.

configobject

Configuration parameters sent to the WASM plugin execution The configuration can be overwritten when instantiating the extensions in IngressGateways or Security groups. The config is serialized using proto3 JSON marshaling and passed to proxy_on_configure when the host environment starts the plugin.

descriptionstring

displayNamestring

etagstring

imagestring

Deprecated. Use the url field instead. Repository and tag of the OCI image containing the WASM extension.

imagePullPolicy'UNSPECIFIED_POLICY' | 'IfNotPresent' | 'Always'

The pull behaviour to be applied when fetching a WASM module, mirroring K8s behaviour.

UNSPECIFIED_POLICY: Defaults to IfNotPresent, except for OCI images with tag latest, for which the default will be Always.
IfNotPresent: If an existing version of the image has been pulled before, that will be used. If no version of the image is present locally, we will pull the latest version.
Always: We will always pull the latest version of an image when changing this plugin. Note that the change includes metadata field as well.

imagePullSecretstring

Credentials to use for OCI image pulling. Name of a K8s Secret that contains a docker pull secret which is to be used to authenticate against the registry when pulling the image. If TSB is configured to use the WASM download proxy, this secret must exist in the istio-system namespace of each cluster that has applications that use the extension. If the downlaod proxy is disabled, the secret must exist in each application namespace that is using the extension.

phase'UNSPECIFIED_PHASE' | 'AUTHN' | 'AUTHZ' | 'STATS'

UNSPECIFIED_PHASE: Control plane decides where to insert the plugin. This will generally be at the end of the filter chain, right before the Router. Do not specify PluginPhase if the plugin is independent of others.
AUTHN: Insert plugin before Istio authentication filters.
AUTHZ: Insert plugin before Istio authorization filters and after Istio authentication filters.
STATS: Insert plugin before Istio stats filters and after Istio authorization filters.

priorityinteger

Determines the ordering of WasmExtensions in the same phase. When multiple WasmExtensions are applied to the same workload in the same phase, they will be applied by priority, in descending order. If no priority is assigned it will use the default 0 value. In case of several extensions having the same priority in the same phase, the fqn will be used to sort them.

sourcestring

urlstring required

URL of a Wasm module or OCI container. If no scheme is present, defaults to oci://, referencing an OCI image. Other valid schemes are file:// for referencing .wasm module files present locally within the proxy container, and http[s]:// for .wasm module files hosted remotely.

Response

A successful response.

fqnstring