Documentation ¶
Index ¶
- Variables
- type CapabilityRestrictionConfig
- func (*CapabilityRestrictionConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CapabilityRestrictionConfig) GetAllowedCapabilities() map[string]*SanitizationConfig
- func (*CapabilityRestrictionConfig) ProtoMessage()
- func (x *CapabilityRestrictionConfig) ProtoReflect() protoreflect.Message
- func (x *CapabilityRestrictionConfig) Reset()
- func (x *CapabilityRestrictionConfig) String() string
- func (m *CapabilityRestrictionConfig) Validate() error
- func (m *CapabilityRestrictionConfig) ValidateAll() error
- type CapabilityRestrictionConfigMultiError
- type CapabilityRestrictionConfigValidationError
- func (e CapabilityRestrictionConfigValidationError) Cause() error
- func (e CapabilityRestrictionConfigValidationError) Error() string
- func (e CapabilityRestrictionConfigValidationError) ErrorName() string
- func (e CapabilityRestrictionConfigValidationError) Field() string
- func (e CapabilityRestrictionConfigValidationError) Key() bool
- func (e CapabilityRestrictionConfigValidationError) Reason() string
- type EnvironmentVariables
- func (*EnvironmentVariables) Descriptor() ([]byte, []int)deprecated
- func (x *EnvironmentVariables) GetHostEnvKeys() []string
- func (x *EnvironmentVariables) GetKeyValues() map[string]string
- func (*EnvironmentVariables) ProtoMessage()
- func (x *EnvironmentVariables) ProtoReflect() protoreflect.Message
- func (x *EnvironmentVariables) Reset()
- func (x *EnvironmentVariables) String() string
- func (m *EnvironmentVariables) Validate() error
- func (m *EnvironmentVariables) ValidateAll() error
- type EnvironmentVariablesMultiError
- type EnvironmentVariablesValidationError
- func (e EnvironmentVariablesValidationError) Cause() error
- func (e EnvironmentVariablesValidationError) Error() string
- func (e EnvironmentVariablesValidationError) ErrorName() string
- func (e EnvironmentVariablesValidationError) Field() string
- func (e EnvironmentVariablesValidationError) Key() bool
- func (e EnvironmentVariablesValidationError) Reason() string
- type PluginConfig
- func (*PluginConfig) Descriptor() ([]byte, []int)deprecated
- func (x *PluginConfig) GetCapabilityRestrictionConfig() *CapabilityRestrictionConfig
- func (x *PluginConfig) GetConfiguration() *any1.Any
- func (x *PluginConfig) GetFailOpen() bool
- func (x *PluginConfig) GetName() string
- func (x *PluginConfig) GetRootId() string
- func (m *PluginConfig) GetVm() isPluginConfig_Vm
- func (x *PluginConfig) GetVmConfig() *VmConfig
- func (*PluginConfig) ProtoMessage()
- func (x *PluginConfig) ProtoReflect() protoreflect.Message
- func (x *PluginConfig) Reset()
- func (x *PluginConfig) String() string
- func (m *PluginConfig) Validate() error
- func (m *PluginConfig) ValidateAll() error
- type PluginConfigMultiError
- type PluginConfigValidationError
- func (e PluginConfigValidationError) Cause() error
- func (e PluginConfigValidationError) Error() string
- func (e PluginConfigValidationError) ErrorName() string
- func (e PluginConfigValidationError) Field() string
- func (e PluginConfigValidationError) Key() bool
- func (e PluginConfigValidationError) Reason() string
- type PluginConfig_VmConfig
- type SanitizationConfig
- func (*SanitizationConfig) Descriptor() ([]byte, []int)deprecated
- func (*SanitizationConfig) ProtoMessage()
- func (x *SanitizationConfig) ProtoReflect() protoreflect.Message
- func (x *SanitizationConfig) Reset()
- func (x *SanitizationConfig) String() string
- func (m *SanitizationConfig) Validate() error
- func (m *SanitizationConfig) ValidateAll() error
- type SanitizationConfigMultiError
- type SanitizationConfigValidationError
- func (e SanitizationConfigValidationError) Cause() error
- func (e SanitizationConfigValidationError) Error() string
- func (e SanitizationConfigValidationError) ErrorName() string
- func (e SanitizationConfigValidationError) Field() string
- func (e SanitizationConfigValidationError) Key() bool
- func (e SanitizationConfigValidationError) Reason() string
- type VmConfig
- func (*VmConfig) Descriptor() ([]byte, []int)deprecated
- func (x *VmConfig) GetAllowPrecompiled() bool
- func (x *VmConfig) GetCode() *v3.AsyncDataSource
- func (x *VmConfig) GetConfiguration() *any1.Any
- func (x *VmConfig) GetEnvironmentVariables() *EnvironmentVariables
- func (x *VmConfig) GetNackOnCodeCacheMiss() bool
- func (x *VmConfig) GetRuntime() string
- func (x *VmConfig) GetVmId() string
- func (*VmConfig) ProtoMessage()
- func (x *VmConfig) ProtoReflect() protoreflect.Message
- func (x *VmConfig) Reset()
- func (x *VmConfig) String() string
- func (m *VmConfig) Validate() error
- func (m *VmConfig) ValidateAll() error
- type VmConfigMultiError
- type VmConfigValidationError
- type WasmService
- func (*WasmService) Descriptor() ([]byte, []int)deprecated
- func (x *WasmService) GetConfig() *PluginConfig
- func (x *WasmService) GetSingleton() bool
- func (*WasmService) ProtoMessage()
- func (x *WasmService) ProtoReflect() protoreflect.Message
- func (x *WasmService) Reset()
- func (x *WasmService) String() string
- func (m *WasmService) Validate() error
- func (m *WasmService) ValidateAll() error
- type WasmServiceMultiError
- type WasmServiceValidationError
- func (e WasmServiceValidationError) Cause() error
- func (e WasmServiceValidationError) Error() string
- func (e WasmServiceValidationError) ErrorName() string
- func (e WasmServiceValidationError) Field() string
- func (e WasmServiceValidationError) Key() bool
- func (e WasmServiceValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_wasm_v3_wasm_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CapabilityRestrictionConfig ¶ added in v0.9.9
type CapabilityRestrictionConfig struct { // The Proxy-Wasm capabilities which will be allowed. Capabilities are mapped by // name. The “SanitizationConfig“ which each capability maps to is currently unimplemented and ignored, // and so should be left empty. // // The capability names are given in the // `Proxy-Wasm ABI <https://github.com/proxy-wasm/spec/tree/master/abi-versions/vNEXT>`_. // Additionally, the following WASI capabilities from // `this list <https://github.com/WebAssembly/WASI/blob/master/phases/snapshot/docs.md#modules>`_ // are implemented and can be allowed: // “fd_write“, “fd_read“, “fd_seek“, “fd_close“, “fd_fdstat_get“, “environ_get“, “environ_sizes_get“, // “args_get“, “args_sizes_get“, “proc_exit“, “clock_time_get“, “random_get“. AllowedCapabilities map[string]*SanitizationConfig `` /* 206-byte string literal not displayed */ // contains filtered or unexported fields }
Configuration for restricting Proxy-Wasm capabilities available to modules.
func (*CapabilityRestrictionConfig) Descriptor
deprecated
added in
v0.9.9
func (*CapabilityRestrictionConfig) Descriptor() ([]byte, []int)
Deprecated: Use CapabilityRestrictionConfig.ProtoReflect.Descriptor instead.
func (*CapabilityRestrictionConfig) GetAllowedCapabilities ¶ added in v0.9.9
func (x *CapabilityRestrictionConfig) GetAllowedCapabilities() map[string]*SanitizationConfig
func (*CapabilityRestrictionConfig) ProtoMessage ¶ added in v0.9.9
func (*CapabilityRestrictionConfig) ProtoMessage()
func (*CapabilityRestrictionConfig) ProtoReflect ¶ added in v0.9.9
func (x *CapabilityRestrictionConfig) ProtoReflect() protoreflect.Message
func (*CapabilityRestrictionConfig) Reset ¶ added in v0.9.9
func (x *CapabilityRestrictionConfig) Reset()
func (*CapabilityRestrictionConfig) String ¶ added in v0.9.9
func (x *CapabilityRestrictionConfig) String() string
func (*CapabilityRestrictionConfig) Validate ¶ added in v0.9.9
func (m *CapabilityRestrictionConfig) Validate() error
Validate checks the field values on CapabilityRestrictionConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*CapabilityRestrictionConfig) ValidateAll ¶ added in v0.10.0
func (m *CapabilityRestrictionConfig) ValidateAll() error
ValidateAll checks the field values on CapabilityRestrictionConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CapabilityRestrictionConfigMultiError, or nil if none found.
type CapabilityRestrictionConfigMultiError ¶ added in v0.10.0
type CapabilityRestrictionConfigMultiError []error
CapabilityRestrictionConfigMultiError is an error wrapping multiple validation errors returned by CapabilityRestrictionConfig.ValidateAll() if the designated constraints aren't met.
func (CapabilityRestrictionConfigMultiError) AllErrors ¶ added in v0.10.0
func (m CapabilityRestrictionConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (CapabilityRestrictionConfigMultiError) Error ¶ added in v0.10.0
func (m CapabilityRestrictionConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type CapabilityRestrictionConfigValidationError ¶ added in v0.9.9
type CapabilityRestrictionConfigValidationError struct {
// contains filtered or unexported fields
}
CapabilityRestrictionConfigValidationError is the validation error returned by CapabilityRestrictionConfig.Validate if the designated constraints aren't met.
func (CapabilityRestrictionConfigValidationError) Cause ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) Cause() error
Cause function returns cause value.
func (CapabilityRestrictionConfigValidationError) Error ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) Error() string
Error satisfies the builtin error interface
func (CapabilityRestrictionConfigValidationError) ErrorName ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) ErrorName() string
ErrorName returns error name.
func (CapabilityRestrictionConfigValidationError) Field ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) Field() string
Field function returns field value.
func (CapabilityRestrictionConfigValidationError) Key ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) Key() bool
Key function returns key value.
func (CapabilityRestrictionConfigValidationError) Reason ¶ added in v0.9.9
func (e CapabilityRestrictionConfigValidationError) Reason() string
Reason function returns reason value.
type EnvironmentVariables ¶ added in v0.9.9
type EnvironmentVariables struct { // The keys of *Envoy's* environment variables exposed to this VM. In other words, if a key exists in Envoy's environment // variables, then that key-value pair will be injected. Note that if a key does not exist, it will be ignored. HostEnvKeys []string `protobuf:"bytes,1,rep,name=host_env_keys,json=hostEnvKeys,proto3" json:"host_env_keys,omitempty"` // Explicitly given key-value pairs to be injected to this VM in the form of "KEY=VALUE". KeyValues map[string]string `` /* 176-byte string literal not displayed */ // contains filtered or unexported fields }
func (*EnvironmentVariables) Descriptor
deprecated
added in
v0.9.9
func (*EnvironmentVariables) Descriptor() ([]byte, []int)
Deprecated: Use EnvironmentVariables.ProtoReflect.Descriptor instead.
func (*EnvironmentVariables) GetHostEnvKeys ¶ added in v0.9.9
func (x *EnvironmentVariables) GetHostEnvKeys() []string
func (*EnvironmentVariables) GetKeyValues ¶ added in v0.9.9
func (x *EnvironmentVariables) GetKeyValues() map[string]string
func (*EnvironmentVariables) ProtoMessage ¶ added in v0.9.9
func (*EnvironmentVariables) ProtoMessage()
func (*EnvironmentVariables) ProtoReflect ¶ added in v0.9.9
func (x *EnvironmentVariables) ProtoReflect() protoreflect.Message
func (*EnvironmentVariables) Reset ¶ added in v0.9.9
func (x *EnvironmentVariables) Reset()
func (*EnvironmentVariables) String ¶ added in v0.9.9
func (x *EnvironmentVariables) String() string
func (*EnvironmentVariables) Validate ¶ added in v0.9.9
func (m *EnvironmentVariables) Validate() error
Validate checks the field values on EnvironmentVariables with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*EnvironmentVariables) ValidateAll ¶ added in v0.10.0
func (m *EnvironmentVariables) ValidateAll() error
ValidateAll checks the field values on EnvironmentVariables with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EnvironmentVariablesMultiError, or nil if none found.
type EnvironmentVariablesMultiError ¶ added in v0.10.0
type EnvironmentVariablesMultiError []error
EnvironmentVariablesMultiError is an error wrapping multiple validation errors returned by EnvironmentVariables.ValidateAll() if the designated constraints aren't met.
func (EnvironmentVariablesMultiError) AllErrors ¶ added in v0.10.0
func (m EnvironmentVariablesMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (EnvironmentVariablesMultiError) Error ¶ added in v0.10.0
func (m EnvironmentVariablesMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type EnvironmentVariablesValidationError ¶ added in v0.9.9
type EnvironmentVariablesValidationError struct {
// contains filtered or unexported fields
}
EnvironmentVariablesValidationError is the validation error returned by EnvironmentVariables.Validate if the designated constraints aren't met.
func (EnvironmentVariablesValidationError) Cause ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) Cause() error
Cause function returns cause value.
func (EnvironmentVariablesValidationError) Error ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) Error() string
Error satisfies the builtin error interface
func (EnvironmentVariablesValidationError) ErrorName ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) ErrorName() string
ErrorName returns error name.
func (EnvironmentVariablesValidationError) Field ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) Field() string
Field function returns field value.
func (EnvironmentVariablesValidationError) Key ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) Key() bool
Key function returns key value.
func (EnvironmentVariablesValidationError) Reason ¶ added in v0.9.9
func (e EnvironmentVariablesValidationError) Reason() string
Reason function returns reason value.
type PluginConfig ¶
type PluginConfig struct { // A unique name for a filters/services in a VM for use in identifying the filter/service if // multiple filters/services are handled by the same “vm_id“ and “root_id“ and for // logging/debugging. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts // if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog). If left blank, all // filters/services with a blank root_id with the same “vm_id“ will share Context(s). RootId string `protobuf:"bytes,2,opt,name=root_id,json=rootId,proto3" json:"root_id,omitempty"` // Configuration for finding or starting VM. // // Types that are assignable to Vm: // *PluginConfig_VmConfig Vm isPluginConfig_Vm `protobuf_oneof:"vm"` // Filter/service configuration used to configure or reconfigure a plugin // (“proxy_on_configure“). // “google.protobuf.Struct“ is serialized as JSON before // passing it to the plugin. “google.protobuf.BytesValue“ and // “google.protobuf.StringValue“ are passed directly without the wrapper. Configuration *any1.Any `protobuf:"bytes,4,opt,name=configuration,proto3" json:"configuration,omitempty"` // If there is a fatal error on the VM (e.g. exception, abort(), on_start or on_configure return false), // then all plugins associated with the VM will either fail closed (by default), e.g. by returning an HTTP 503 error, // or fail open (if 'fail_open' is set to true) by bypassing the filter. Note: when on_start or on_configure return false // during xDS updates the xDS configuration will be rejected and when on_start or on_configuration return false on initial // startup the proxy will not start. FailOpen bool `protobuf:"varint,5,opt,name=fail_open,json=failOpen,proto3" json:"fail_open,omitempty"` // Configuration for restricting Proxy-Wasm capabilities available to modules. CapabilityRestrictionConfig *CapabilityRestrictionConfig `` /* 144-byte string literal not displayed */ // contains filtered or unexported fields }
Base Configuration for Wasm Plugins e.g. filters and services. [#next-free-field: 7]
func (*PluginConfig) Descriptor
deprecated
func (*PluginConfig) Descriptor() ([]byte, []int)
Deprecated: Use PluginConfig.ProtoReflect.Descriptor instead.
func (*PluginConfig) GetCapabilityRestrictionConfig ¶ added in v0.9.9
func (x *PluginConfig) GetCapabilityRestrictionConfig() *CapabilityRestrictionConfig
func (*PluginConfig) GetConfiguration ¶
func (x *PluginConfig) GetConfiguration() *any1.Any
func (*PluginConfig) GetFailOpen ¶ added in v0.9.7
func (x *PluginConfig) GetFailOpen() bool
func (*PluginConfig) GetName ¶
func (x *PluginConfig) GetName() string
func (*PluginConfig) GetRootId ¶ added in v0.9.7
func (x *PluginConfig) GetRootId() string
func (*PluginConfig) GetVm ¶ added in v0.9.8
func (m *PluginConfig) GetVm() isPluginConfig_Vm
func (*PluginConfig) GetVmConfig ¶
func (x *PluginConfig) GetVmConfig() *VmConfig
func (*PluginConfig) ProtoMessage ¶
func (*PluginConfig) ProtoMessage()
func (*PluginConfig) ProtoReflect ¶ added in v0.9.6
func (x *PluginConfig) ProtoReflect() protoreflect.Message
func (*PluginConfig) Reset ¶
func (x *PluginConfig) Reset()
func (*PluginConfig) String ¶
func (x *PluginConfig) String() string
func (*PluginConfig) Validate ¶
func (m *PluginConfig) Validate() error
Validate checks the field values on PluginConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PluginConfig) ValidateAll ¶ added in v0.10.0
func (m *PluginConfig) ValidateAll() error
ValidateAll checks the field values on PluginConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PluginConfigMultiError, or nil if none found.
type PluginConfigMultiError ¶ added in v0.10.0
type PluginConfigMultiError []error
PluginConfigMultiError is an error wrapping multiple validation errors returned by PluginConfig.ValidateAll() if the designated constraints aren't met.
func (PluginConfigMultiError) AllErrors ¶ added in v0.10.0
func (m PluginConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PluginConfigMultiError) Error ¶ added in v0.10.0
func (m PluginConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PluginConfigValidationError ¶
type PluginConfigValidationError struct {
// contains filtered or unexported fields
}
PluginConfigValidationError is the validation error returned by PluginConfig.Validate if the designated constraints aren't met.
func (PluginConfigValidationError) Cause ¶
func (e PluginConfigValidationError) Cause() error
Cause function returns cause value.
func (PluginConfigValidationError) Error ¶
func (e PluginConfigValidationError) Error() string
Error satisfies the builtin error interface
func (PluginConfigValidationError) ErrorName ¶
func (e PluginConfigValidationError) ErrorName() string
ErrorName returns error name.
func (PluginConfigValidationError) Field ¶
func (e PluginConfigValidationError) Field() string
Field function returns field value.
func (PluginConfigValidationError) Key ¶
func (e PluginConfigValidationError) Key() bool
Key function returns key value.
func (PluginConfigValidationError) Reason ¶
func (e PluginConfigValidationError) Reason() string
Reason function returns reason value.
type PluginConfig_VmConfig ¶ added in v0.9.8
type PluginConfig_VmConfig struct {
VmConfig *VmConfig `protobuf:"bytes,3,opt,name=vm_config,json=vmConfig,proto3,oneof"` // TODO: add referential VM configurations.
}
type SanitizationConfig ¶ added in v0.9.9
type SanitizationConfig struct {
// contains filtered or unexported fields
}
Configuration for sanitization of inputs to an allowed capability.
NOTE: This is currently unimplemented.
func (*SanitizationConfig) Descriptor
deprecated
added in
v0.9.9
func (*SanitizationConfig) Descriptor() ([]byte, []int)
Deprecated: Use SanitizationConfig.ProtoReflect.Descriptor instead.
func (*SanitizationConfig) ProtoMessage ¶ added in v0.9.9
func (*SanitizationConfig) ProtoMessage()
func (*SanitizationConfig) ProtoReflect ¶ added in v0.9.9
func (x *SanitizationConfig) ProtoReflect() protoreflect.Message
func (*SanitizationConfig) Reset ¶ added in v0.9.9
func (x *SanitizationConfig) Reset()
func (*SanitizationConfig) String ¶ added in v0.9.9
func (x *SanitizationConfig) String() string
func (*SanitizationConfig) Validate ¶ added in v0.9.9
func (m *SanitizationConfig) Validate() error
Validate checks the field values on SanitizationConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*SanitizationConfig) ValidateAll ¶ added in v0.10.0
func (m *SanitizationConfig) ValidateAll() error
ValidateAll checks the field values on SanitizationConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SanitizationConfigMultiError, or nil if none found.
type SanitizationConfigMultiError ¶ added in v0.10.0
type SanitizationConfigMultiError []error
SanitizationConfigMultiError is an error wrapping multiple validation errors returned by SanitizationConfig.ValidateAll() if the designated constraints aren't met.
func (SanitizationConfigMultiError) AllErrors ¶ added in v0.10.0
func (m SanitizationConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (SanitizationConfigMultiError) Error ¶ added in v0.10.0
func (m SanitizationConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type SanitizationConfigValidationError ¶ added in v0.9.9
type SanitizationConfigValidationError struct {
// contains filtered or unexported fields
}
SanitizationConfigValidationError is the validation error returned by SanitizationConfig.Validate if the designated constraints aren't met.
func (SanitizationConfigValidationError) Cause ¶ added in v0.9.9
func (e SanitizationConfigValidationError) Cause() error
Cause function returns cause value.
func (SanitizationConfigValidationError) Error ¶ added in v0.9.9
func (e SanitizationConfigValidationError) Error() string
Error satisfies the builtin error interface
func (SanitizationConfigValidationError) ErrorName ¶ added in v0.9.9
func (e SanitizationConfigValidationError) ErrorName() string
ErrorName returns error name.
func (SanitizationConfigValidationError) Field ¶ added in v0.9.9
func (e SanitizationConfigValidationError) Field() string
Field function returns field value.
func (SanitizationConfigValidationError) Key ¶ added in v0.9.9
func (e SanitizationConfigValidationError) Key() bool
Key function returns key value.
func (SanitizationConfigValidationError) Reason ¶ added in v0.9.9
func (e SanitizationConfigValidationError) Reason() string
Reason function returns reason value.
type VmConfig ¶
type VmConfig struct { // An ID which will be used along with a hash of the wasm code (or the name of the registered Null // VM plugin) to determine which VM will be used for the plugin. All plugins which use the same // “vm_id“ and code will use the same VM. May be left blank. Sharing a VM between plugins can // reduce memory utilization and make sharing of data easier which may have security implications. // [#comment: TODO: add ref for details.] VmId string `protobuf:"bytes,1,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"` // The Wasm runtime type, defaults to the first available Wasm engine used at Envoy build-time. // The priority to search for the available engine is: v8 -> wasmtime -> wamr -> wavm. // Available Wasm runtime types are registered as extensions. The following runtimes are included // in Envoy code base: // // .. _extension_envoy.wasm.runtime.null: // // **envoy.wasm.runtime.null**: Null sandbox, the Wasm module must be compiled and linked into the // Envoy binary. The registered name is given in the “code“ field as “inline_string“. // // .. _extension_envoy.wasm.runtime.v8: // // **envoy.wasm.runtime.v8**: `V8 <https://v8.dev/>`_-based WebAssembly runtime. // // .. _extension_envoy.wasm.runtime.wamr: // // **envoy.wasm.runtime.wamr**: `WAMR <https://github.com/bytecodealliance/wasm-micro-runtime/>`_-based WebAssembly runtime. // This runtime is not enabled in the official build. // // .. _extension_envoy.wasm.runtime.wavm: // // **envoy.wasm.runtime.wavm**: `WAVM <https://wavm.github.io/>`_-based WebAssembly runtime. // This runtime is not enabled in the official build. // // .. _extension_envoy.wasm.runtime.wasmtime: // // **envoy.wasm.runtime.wasmtime**: `Wasmtime <https://wasmtime.dev/>`_-based WebAssembly runtime. // This runtime is not enabled in the official build. // // [#extension-category: envoy.wasm.runtime] Runtime string `protobuf:"bytes,2,opt,name=runtime,proto3" json:"runtime,omitempty"` // The Wasm code that Envoy will execute. Code *v3.AsyncDataSource `protobuf:"bytes,3,opt,name=code,proto3" json:"code,omitempty"` // The Wasm configuration used in initialization of a new VM // (proxy_on_start). “google.protobuf.Struct“ is serialized as JSON before // passing it to the plugin. “google.protobuf.BytesValue“ and // “google.protobuf.StringValue“ are passed directly without the wrapper. Configuration *any1.Any `protobuf:"bytes,4,opt,name=configuration,proto3" json:"configuration,omitempty"` // Allow the wasm file to include pre-compiled code on VMs which support it. // Warning: this should only be enable for trusted sources as the precompiled code is not // verified. AllowPrecompiled bool `protobuf:"varint,5,opt,name=allow_precompiled,json=allowPrecompiled,proto3" json:"allow_precompiled,omitempty"` // If true and the code needs to be remotely fetched and it is not in the cache then NACK the configuration // update and do a background fetch to fill the cache, otherwise fetch the code asynchronously and enter // warming state. NackOnCodeCacheMiss bool `protobuf:"varint,6,opt,name=nack_on_code_cache_miss,json=nackOnCodeCacheMiss,proto3" json:"nack_on_code_cache_miss,omitempty"` // Specifies environment variables to be injected to this VM which will be available through // WASI's “environ_get“ and “environ_get_sizes“ system calls. Note that these functions are mostly implicitly // called in your language's standard library, so you do not need to call them directly and you can access to env // vars just like when you do on native platforms. // Warning: Envoy rejects the configuration if there's conflict of key space. EnvironmentVariables *EnvironmentVariables `protobuf:"bytes,7,opt,name=environment_variables,json=environmentVariables,proto3" json:"environment_variables,omitempty"` // contains filtered or unexported fields }
Configuration for a Wasm VM. [#next-free-field: 8]
func (*VmConfig) Descriptor
deprecated
func (*VmConfig) GetAllowPrecompiled ¶
func (*VmConfig) GetCode ¶
func (x *VmConfig) GetCode() *v3.AsyncDataSource
func (*VmConfig) GetConfiguration ¶
func (*VmConfig) GetEnvironmentVariables ¶ added in v0.9.9
func (x *VmConfig) GetEnvironmentVariables() *EnvironmentVariables
func (*VmConfig) GetNackOnCodeCacheMiss ¶ added in v0.9.7
func (*VmConfig) GetRuntime ¶
func (*VmConfig) ProtoMessage ¶
func (*VmConfig) ProtoMessage()
func (*VmConfig) ProtoReflect ¶ added in v0.9.6
func (x *VmConfig) ProtoReflect() protoreflect.Message
func (*VmConfig) Validate ¶
Validate checks the field values on VmConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*VmConfig) ValidateAll ¶ added in v0.10.0
ValidateAll checks the field values on VmConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in VmConfigMultiError, or nil if none found.
type VmConfigMultiError ¶ added in v0.10.0
type VmConfigMultiError []error
VmConfigMultiError is an error wrapping multiple validation errors returned by VmConfig.ValidateAll() if the designated constraints aren't met.
func (VmConfigMultiError) AllErrors ¶ added in v0.10.0
func (m VmConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (VmConfigMultiError) Error ¶ added in v0.10.0
func (m VmConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type VmConfigValidationError ¶
type VmConfigValidationError struct {
// contains filtered or unexported fields
}
VmConfigValidationError is the validation error returned by VmConfig.Validate if the designated constraints aren't met.
func (VmConfigValidationError) Cause ¶
func (e VmConfigValidationError) Cause() error
Cause function returns cause value.
func (VmConfigValidationError) Error ¶
func (e VmConfigValidationError) Error() string
Error satisfies the builtin error interface
func (VmConfigValidationError) ErrorName ¶
func (e VmConfigValidationError) ErrorName() string
ErrorName returns error name.
func (VmConfigValidationError) Field ¶
func (e VmConfigValidationError) Field() string
Field function returns field value.
func (VmConfigValidationError) Key ¶
func (e VmConfigValidationError) Key() bool
Key function returns key value.
func (VmConfigValidationError) Reason ¶
func (e VmConfigValidationError) Reason() string
Reason function returns reason value.
type WasmService ¶
type WasmService struct { // General plugin configuration. Config *PluginConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"` // If true, create a single VM rather than creating one VM per worker. Such a singleton can // not be used with filters. Singleton bool `protobuf:"varint,2,opt,name=singleton,proto3" json:"singleton,omitempty"` // contains filtered or unexported fields }
WasmService is configured as a built-in “envoy.wasm_service“ :ref:`WasmService <config_wasm_service>` This opaque configuration will be used to create a Wasm Service.
func (*WasmService) Descriptor
deprecated
func (*WasmService) Descriptor() ([]byte, []int)
Deprecated: Use WasmService.ProtoReflect.Descriptor instead.
func (*WasmService) GetConfig ¶
func (x *WasmService) GetConfig() *PluginConfig
func (*WasmService) GetSingleton ¶
func (x *WasmService) GetSingleton() bool
func (*WasmService) ProtoMessage ¶
func (*WasmService) ProtoMessage()
func (*WasmService) ProtoReflect ¶ added in v0.9.6
func (x *WasmService) ProtoReflect() protoreflect.Message
func (*WasmService) Reset ¶
func (x *WasmService) Reset()
func (*WasmService) String ¶
func (x *WasmService) String() string
func (*WasmService) Validate ¶
func (m *WasmService) Validate() error
Validate checks the field values on WasmService with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*WasmService) ValidateAll ¶ added in v0.10.0
func (m *WasmService) ValidateAll() error
ValidateAll checks the field values on WasmService with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WasmServiceMultiError, or nil if none found.
type WasmServiceMultiError ¶ added in v0.10.0
type WasmServiceMultiError []error
WasmServiceMultiError is an error wrapping multiple validation errors returned by WasmService.ValidateAll() if the designated constraints aren't met.
func (WasmServiceMultiError) AllErrors ¶ added in v0.10.0
func (m WasmServiceMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (WasmServiceMultiError) Error ¶ added in v0.10.0
func (m WasmServiceMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type WasmServiceValidationError ¶
type WasmServiceValidationError struct {
// contains filtered or unexported fields
}
WasmServiceValidationError is the validation error returned by WasmService.Validate if the designated constraints aren't met.
func (WasmServiceValidationError) Cause ¶
func (e WasmServiceValidationError) Cause() error
Cause function returns cause value.
func (WasmServiceValidationError) Error ¶
func (e WasmServiceValidationError) Error() string
Error satisfies the builtin error interface
func (WasmServiceValidationError) ErrorName ¶
func (e WasmServiceValidationError) ErrorName() string
ErrorName returns error name.
func (WasmServiceValidationError) Field ¶
func (e WasmServiceValidationError) Field() string
Field function returns field value.
func (WasmServiceValidationError) Key ¶
func (e WasmServiceValidationError) Key() bool
Key function returns key value.
func (WasmServiceValidationError) Reason ¶
func (e WasmServiceValidationError) Reason() string
Reason function returns reason value.