Filter state dynamic forward proxy (proto)

extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig

[extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig proto]

Configuration for the filter state based dynamic forward proxy filter. See the architecture overview for more information. Note this filter must be used in conjunction to another filter that sets the ‘envoy.upstream.dynamic_host’ and the ‘envoy.upstream.dynamic_port’ filter state keys for the required upstream UDP session.

This extension has the qualified name envoy.filters.udp.session.dynamic_forward_proxy

Note

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

This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

Tip

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

envoy.filters.udp.session

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

type.googleapis.com/envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig

{
  "stat_prefix": ...,
  "dns_cache_config": {...},
  "buffer_options": {...}
}

stat_prefix: (string, REQUIRED) The prefix to use when emitting statistics.

dns_cache_config: (extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig, REQUIRED) The DNS cache configuration that the filter will attach to. Note this configuration must match that of associated dynamic forward proxy cluster configuration.

buffer_options: (extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions) If configured, the filter will buffer datagrams in case that it is waiting for a DNS response. If this field is not configured, there will be no buffering and downstream datagrams that arrive while the DNS resolution is in progress will be dropped. In case this field is set but the options are not configured, the default values will be applied as described in the BufferOptions.

extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions

[extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions proto]

Configuration for UDP datagrams buffering.

{
  "max_buffered_datagrams": {...},
  "max_buffered_bytes": {...}
}

max_buffered_datagrams: (UInt32Value) If set, the filter will only buffer datagrams up to the requested limit, and will drop new UDP datagrams if the buffer contains the max_buffered_datagrams value at the time of a new datagram arrival. If not set, the default value is 1024 datagrams.

max_buffered_bytes: (UInt64Value) If set, the filter will only buffer datagrams up to the requested total buffered bytes limit, and will drop new UDP datagrams if the buffer contains the max_buffered_datagrams value at the time of a new datagram arrival. If not set, the default value is 16,384 (16KB).