Dynamic Modules Config Validator (proto)

This extension has the qualified name envoy.config.validators.dynamic_modules

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:

extensions.config.validators.dynamic_modules.v3.DynamicModuleConfigValidator

[extensions.config.validators.dynamic_modules.v3.DynamicModuleConfigValidator proto]

Configuration for an xDS config validator implemented by a dynamic module. For each xDS update the module receives the xDS type URL and the decoded resources, with each resource carrying its name, version, aliases, TTL, and re-serialized protobuf payload. During validation the module can also read current server state, such as the dynamic cluster count, through the validation context. A rejection from the module follows Envoy’s normal xDS rejection path, so the xDS client receives a NACK and the last accepted configuration is retained.

{
  "dynamic_module_config": {...},
  "extension_name": ...,
  "extension_config": {...},
  "type_urls": []
}
dynamic_module_config

(extensions.dynamic_modules.v3.DynamicModuleConfig, REQUIRED) Specifies the shared-object level configuration. This field is required.

Only the name and module.local.filename sources are supported. Remote module sources are not supported because config validators are created without a factory context.

extension_name

(string, REQUIRED) The name identifying the config validator implementation within the module. This is passed to the module’s config validator init function so that a module can host multiple implementations. This field is required.

extension_config

(Any) The configuration for the implementation chosen by extension_name. If not specified, an empty configuration is passed to the module.

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. Otherwise the serialized bytes of the configured message are passed.

type_urls

(repeated string, REQUIRED) The xDS resource type URLs handled by this validator. Only updates whose type URL matches one of these values invoke the module. Each value must use the canonical type.googleapis.com/<message> form. Exactly one type URL is supported today and this restriction may be relaxed in the future. This field is required.