package envoy.config.filter.network.tcp_proxy.v2

Get desktop application:
View/edit binary Protocol Buffers messages

[#next-free-field: 13]

• string stat_prefix = 1

  The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.

• oneof cluster_specifier

  • string cluster = 2

    The upstream cluster to connect to.

  • TcpProxy.WeightedCluster weighted_clusters = 10

    Multiple upstream clusters can be specified for a given route. The request is routed to one of the upstream clusters based on weights assigned to each cluster.

• optional api.v2.core.Metadata metadata_match = 9

  Optional endpoint metadata match criteria. Only endpoints in the upstream cluster with metadata matching that set in metadata_match will be considered. The filter name should be specified as *envoy.lb*.

• optional google.protobuf.Duration idle_timeout = 8

  The idle timeout for connections managed by the TCP proxy filter. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. .. warning:: Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP FIN packets, etc.

• optional google.protobuf.Duration downstream_idle_timeout = 3

  [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter. The idle timeout is defined as the period in which there is no active traffic. If not set, there is no idle timeout. When the idle timeout is reached the connection will be closed. The distinction between downstream_idle_timeout/upstream_idle_timeout provides a means to set timeout based on the last byte sent on the downstream/upstream connection.

• optional google.protobuf.Duration upstream_idle_timeout = 4

  [#not-implemented-hide:]

• repeated accesslog.v2.AccessLog access_log = 5

  Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.

• optional TcpProxy.DeprecatedV1 deprecated_v1 = 6

  [#not-implemented-hide:] Deprecated.

• optional google.protobuf.UInt32Value max_connect_attempts = 7

  The maximum number of unsuccessful connection attempts that will be made before giving up. If the parameter is not specified, 1 connection attempt will be made.

• repeated type.HashPolicy hash_policy = 11

  Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based load balancing algorithms will select a host randomly. Currently the number of hash policies is limited to 1.

• optional TcpProxy.TunnelingConfig tunneling_config = 12

  [#not-implemented-hide:] feature in progress If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP payloads over a shared HTTP/2 tunnel. If this message is absent, the payload will be proxied upstream as per usual.

[#not-implemented-hide:] Deprecated. TCP Proxy filter configuration using V1 format.

Used in: TcpProxy

• repeated DeprecatedV1.TCPRoute routes = 1

  The route table for the filter. All filter instances must have a route table, even if it is empty.

A TCP proxy route consists of a set of optional L4 criteria and the name of a cluster. If a downstream connection matches all the specified criteria, the cluster in the route is used for the corresponding upstream connection. Routes are tried in the order specified until a match is found. If no match is found, the connection is closed. A route with no criteria is valid and always produces a match. [#next-free-field: 6]

Used in: DeprecatedV1

• string cluster = 1

  The cluster to connect to when a the downstream network connection matches the specified criteria.

• repeated api.v2.core.CidrRange destination_ip_list = 2

  An optional list of IP address subnets in the form “ip_address/xx”. The criteria is satisfied if the destination IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the destination IP address is ignored. The destination IP address of the downstream connection might be different from the addresses on which the proxy is listening if the connection has been redirected.

• string destination_ports = 3

  An optional string containing a comma-separated list of port numbers or ranges. The criteria is satisfied if the destination port of the downstream connection is contained in at least one of the specified ranges. If the parameter is not specified, the destination port is ignored. The destination port address of the downstream connection might be different from the port on which the proxy is listening if the connection has been redirected.

• repeated api.v2.core.CidrRange source_ip_list = 4

  An optional list of IP address subnets in the form “ip_address/xx”. The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the source IP address is ignored.

• string source_ports = 5

  An optional string containing a comma-separated list of port numbers or ranges. The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ranges. If the parameter is not specified, the source port is ignored.

Configuration for tunneling TCP over other transports or application layers. Currently, only HTTP/2 is supported. When other options exist, HTTP/2 will remain the default.

Used in: TcpProxy

• string hostname = 1

  The hostname to send in the synthesized CONNECT headers to the upstream proxy.

Allows for specification of multiple upstream clusters along with weights that indicate the percentage of traffic to be forwarded to each cluster. The router selects an upstream cluster based on these weights.

Used in: TcpProxy

• repeated WeightedCluster.ClusterWeight clusters = 1

  Specifies one or more upstream clusters associated with the route.

Used in: WeightedCluster

• string name = 1

  Name of the upstream cluster.

• uint32 weight = 2

  When a request matches the route, the choice of an upstream cluster is determined by its weight. The sum of weights across all entries in the clusters array determines the total weight.

• optional api.v2.core.Metadata metadata_match = 3

  Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered for load balancing. Note that this will be merged with what's provided in :ref:`TcpProxy.metadata_match <envoy_api_field_config.filter.network.tcp_proxy.v2.TcpProxy.metadata_match>`, with values here taking precedence. The filter name should be specified as *envoy.lb*.