Dynamic Module Transport Socket (proto)

This extension has the qualified name envoy.transport_sockets.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 categories:

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

extensions.transport_sockets.dynamic_modules.v3.DynamicModuleTransportSocket

[extensions.transport_sockets.dynamic_modules.v3.DynamicModuleTransportSocket proto]

Configuration for a transport socket implemented by a dynamic module. The transport socket performs the raw I/O for a connection and may transform the bytes that flow over it, for example to implement a custom encryption scheme.

Example:

transport_socket:
  name: envoy.transport_sockets.dynamic_modules
  typed_config:
    "@type": type.googleapis.com/envoy.extensions.transport_sockets.dynamic_modules.v3.DynamicModuleTransportSocket
    dynamic_module_config:
      name: my_module
    transport_socket_name: my_transport_socket

{
  "dynamic_module_config": {...},
  "transport_socket_name": ...,
  "transport_socket_config": {...},
  "implements_secure_transport": ...
}
dynamic_module_config

(extensions.dynamic_modules.v3.DynamicModuleConfig, REQUIRED) Dynamic module configuration. See dynamic module configuration for details.

transport_socket_name

(string, REQUIRED) The name of the transport socket implementation in the dynamic module. This is passed to the module’s envoy_dynamic_module_on_transport_socket_factory_config_new function.

transport_socket_config

(Any) Optional configuration for the transport socket. This is passed as bytes to the dynamic module. If not specified, no configuration bytes are passed to the module.

implements_secure_transport

(bool) Whether the transport socket implements secure transport. Set this to true for modules that provide encryption so that Envoy treats connections using this transport socket as secure. If not specified, defaults to false.