Documentation
¶
Index ¶
- Variables
- type PluginConfig
- func (*PluginConfig) Descriptor() ([]byte, []int)deprecated
- func (x *PluginConfig) GetConfiguration() *any.Any
- func (x *PluginConfig) GetFailOpen() bool
- func (x *PluginConfig) GetInlineVmConfig() *VmConfig
- func (x *PluginConfig) GetName() string
- func (x *PluginConfig) GetRootId() string
- func (m *PluginConfig) GetVmConfig() isPluginConfig_VmConfig
- func (*PluginConfig) ProtoMessage()
- func (x *PluginConfig) ProtoReflect() protoreflect.Message
- func (x *PluginConfig) Reset()
- func (x *PluginConfig) String() string
- func (m *PluginConfig) Validate() error
- 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_InlineVmConfig
- type VmConfig
- func (*VmConfig) Descriptor() ([]byte, []int)deprecated
- func (x *VmConfig) GetAllowPrecompiled() bool
- func (x *VmConfig) GetCode() *v3.AsyncDataSource
- func (x *VmConfig) GetConfiguration() *any.Any
- 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
- 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
- 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 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 VmConfig:
// *PluginConfig_InlineVmConfig
VmConfig isPluginConfig_VmConfig `protobuf_oneof:"vm_config"`
// Filter/service configuration used to configure or reconfigure a plugin
// (proxy_on_configuration).
// `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 *any.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"`
// contains filtered or unexported fields
}
[[#not-implemented-hide:] Base Configuration for Wasm Plugins e.g. filters and services. [#next-free-field: 6]
func (*PluginConfig) Descriptor
deprecated
func (*PluginConfig) Descriptor() ([]byte, []int)
Deprecated: Use PluginConfig.ProtoReflect.Descriptor instead.
func (*PluginConfig) GetConfiguration ¶
func (x *PluginConfig) GetConfiguration() *any.Any
func (*PluginConfig) GetFailOpen ¶ added in v0.9.7
func (x *PluginConfig) GetFailOpen() bool
func (*PluginConfig) GetInlineVmConfig ¶
func (x *PluginConfig) GetInlineVmConfig() *VmConfig
func (*PluginConfig) GetName ¶
func (x *PluginConfig) GetName() string
func (*PluginConfig) GetRootId ¶ added in v0.9.7
func (x *PluginConfig) GetRootId() string
func (*PluginConfig) GetVmConfig ¶
func (m *PluginConfig) GetVmConfig() isPluginConfig_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, an error is returned.
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_InlineVmConfig ¶
type PluginConfig_InlineVmConfig struct {
InlineVmConfig *VmConfig `protobuf:"bytes,3,opt,name=inline_vm_config,json=inlineVmConfig,proto3,oneof"` // In the future add referential VM configurations.
}
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.
// See ref: "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 (either "v8" or "null" for code compiled into Envoy).
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 *any.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"`
// contains filtered or unexported fields
}
[[#not-implemented-hide:] Configuration for a Wasm VM. [#next-free-field: 7]
func (*VmConfig) Descriptor
deprecated
func (*VmConfig) GetAllowPrecompiled ¶
func (*VmConfig) GetCode ¶
func (x *VmConfig) GetCode() *v3.AsyncDataSource
func (*VmConfig) GetConfiguration ¶
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
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
}
[[#not-implemented-hide:] 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, an error is returned.
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.