Documentation
¶
Index ¶
- Variables
- type DynamicModuleBootstrapExtension
- func (*DynamicModuleBootstrapExtension) Descriptor() ([]byte, []int)deprecated
- func (x *DynamicModuleBootstrapExtension) GetDynamicModuleConfig() *v3.DynamicModuleConfig
- func (x *DynamicModuleBootstrapExtension) GetExtensionConfig() *anypb.Any
- func (x *DynamicModuleBootstrapExtension) GetExtensionName() string
- func (*DynamicModuleBootstrapExtension) ProtoMessage()
- func (x *DynamicModuleBootstrapExtension) ProtoReflect() protoreflect.Message
- func (x *DynamicModuleBootstrapExtension) Reset()
- func (x *DynamicModuleBootstrapExtension) String() string
- func (m *DynamicModuleBootstrapExtension) Validate() error
- func (m *DynamicModuleBootstrapExtension) ValidateAll() error
- type DynamicModuleBootstrapExtensionMultiError
- type DynamicModuleBootstrapExtensionValidationError
- func (e DynamicModuleBootstrapExtensionValidationError) Cause() error
- func (e DynamicModuleBootstrapExtensionValidationError) Error() string
- func (e DynamicModuleBootstrapExtensionValidationError) ErrorName() string
- func (e DynamicModuleBootstrapExtensionValidationError) Field() string
- func (e DynamicModuleBootstrapExtensionValidationError) Key() bool
- func (e DynamicModuleBootstrapExtensionValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_bootstrap_dynamic_modules_v3_dynamic_modules_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type DynamicModuleBootstrapExtension ¶
type DynamicModuleBootstrapExtension struct {
// Specifies the shared-object level configuration.
DynamicModuleConfig *v3.DynamicModuleConfig `protobuf:"bytes,1,opt,name=dynamic_module_config,json=dynamicModuleConfig,proto3" json:"dynamic_module_config,omitempty"`
// The name for this extension configuration.
//
// This can be used to distinguish between different extension implementations inside a dynamic
// module. For example, a module can have completely different extension implementations. When Envoy
// receives this configuration, it passes the “extension_name“ to the dynamic module's bootstrap
// extension config init function together with the “extension_config“. That way a module can
// decide which in-module extension implementation to use based on the name at load time.
//
// If not specified, defaults to an empty string.
ExtensionName string `protobuf:"bytes,2,opt,name=extension_name,json=extensionName,proto3" json:"extension_name,omitempty"`
// The configuration for the extension chosen by “extension_name“.
//
// This is passed to the module's bootstrap extension initialization function. Together with the
// “extension_name“, the module can decide which in-module extension implementation to use and
// fine-tune the behavior of the extension.
//
// For example, if a module has two extension implementations, one for configuration loading and
// one for metric initialization, “extension_name“ is used to choose the implementation. The
// “extension_config“ can be used to configure the specific behavior of each implementation.
//
// “google.protobuf.Struct“ is serialized as JSON before passing it to the module.
// “google.protobuf.BytesValue“ and “google.protobuf.StringValue“ are passed directly
// without the wrapper.
//
// .. code-block:: yaml
//
// # Passing a string value
// extension_config:
// "@type": "type.googleapis.com/google.protobuf.StringValue"
// value: hello
//
// # Passing raw bytes
// extension_config:
// "@type": "type.googleapis.com/google.protobuf.BytesValue"
// value: aGVsbG8= # echo -n "hello" | base64
ExtensionConfig *anypb.Any `protobuf:"bytes,3,opt,name=extension_config,json=extensionConfig,proto3" json:"extension_config,omitempty"`
// contains filtered or unexported fields
}
Configuration for the Dynamic Modules bootstrap extension. This extension allows loading shared object files that can be loaded via “dlopen“ to extend Envoy's bootstrap behavior.
A module can be loaded by multiple bootstrap extensions; the module is loaded only once and shared across multiple extensions.
Bootstrap extensions run on the main thread and are initialized when Envoy starts. They can:
* Perform initialization tasks when the server is initialized. * Perform per-worker thread initialization when worker threads start. * Access server-level resources like the cluster manager and dispatcher.
func (*DynamicModuleBootstrapExtension) Descriptor
deprecated
func (*DynamicModuleBootstrapExtension) Descriptor() ([]byte, []int)
Deprecated: Use DynamicModuleBootstrapExtension.ProtoReflect.Descriptor instead.
func (*DynamicModuleBootstrapExtension) GetDynamicModuleConfig ¶
func (x *DynamicModuleBootstrapExtension) GetDynamicModuleConfig() *v3.DynamicModuleConfig
func (*DynamicModuleBootstrapExtension) GetExtensionConfig ¶
func (x *DynamicModuleBootstrapExtension) GetExtensionConfig() *anypb.Any
func (*DynamicModuleBootstrapExtension) GetExtensionName ¶
func (x *DynamicModuleBootstrapExtension) GetExtensionName() string
func (*DynamicModuleBootstrapExtension) ProtoMessage ¶
func (*DynamicModuleBootstrapExtension) ProtoMessage()
func (*DynamicModuleBootstrapExtension) ProtoReflect ¶
func (x *DynamicModuleBootstrapExtension) ProtoReflect() protoreflect.Message
func (*DynamicModuleBootstrapExtension) Reset ¶
func (x *DynamicModuleBootstrapExtension) Reset()
func (*DynamicModuleBootstrapExtension) String ¶
func (x *DynamicModuleBootstrapExtension) String() string
func (*DynamicModuleBootstrapExtension) Validate ¶
func (m *DynamicModuleBootstrapExtension) Validate() error
Validate checks the field values on DynamicModuleBootstrapExtension 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 (*DynamicModuleBootstrapExtension) ValidateAll ¶
func (m *DynamicModuleBootstrapExtension) ValidateAll() error
ValidateAll checks the field values on DynamicModuleBootstrapExtension 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 DynamicModuleBootstrapExtensionMultiError, or nil if none found.
type DynamicModuleBootstrapExtensionMultiError ¶
type DynamicModuleBootstrapExtensionMultiError []error
DynamicModuleBootstrapExtensionMultiError is an error wrapping multiple validation errors returned by DynamicModuleBootstrapExtension.ValidateAll() if the designated constraints aren't met.
func (DynamicModuleBootstrapExtensionMultiError) AllErrors ¶
func (m DynamicModuleBootstrapExtensionMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DynamicModuleBootstrapExtensionMultiError) Error ¶
func (m DynamicModuleBootstrapExtensionMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DynamicModuleBootstrapExtensionValidationError ¶
type DynamicModuleBootstrapExtensionValidationError struct {
// contains filtered or unexported fields
}
DynamicModuleBootstrapExtensionValidationError is the validation error returned by DynamicModuleBootstrapExtension.Validate if the designated constraints aren't met.
func (DynamicModuleBootstrapExtensionValidationError) Cause ¶
func (e DynamicModuleBootstrapExtensionValidationError) Cause() error
Cause function returns cause value.
func (DynamicModuleBootstrapExtensionValidationError) Error ¶
func (e DynamicModuleBootstrapExtensionValidationError) Error() string
Error satisfies the builtin error interface
func (DynamicModuleBootstrapExtensionValidationError) ErrorName ¶
func (e DynamicModuleBootstrapExtensionValidationError) ErrorName() string
ErrorName returns error name.
func (DynamicModuleBootstrapExtensionValidationError) Field ¶
func (e DynamicModuleBootstrapExtensionValidationError) Field() string
Field function returns field value.
func (DynamicModuleBootstrapExtensionValidationError) Key ¶
func (e DynamicModuleBootstrapExtensionValidationError) Key() bool
Key function returns key value.
func (DynamicModuleBootstrapExtensionValidationError) Reason ¶
func (e DynamicModuleBootstrapExtensionValidationError) Reason() string
Reason function returns reason value.