TCP Protocol Options (proto)

This extension has the qualified name envoy.upstreams.tcp.tcp_protocol_options

Note

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

This extension has an unknown security posture 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:

• envoy.upstreams

TCProtocolOptions specifies TCP upstream protocol options. This object is used in typed_extension_protocol_options, keyed by the name envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions.

clusters:
  - name: some_service
    connect_timeout: 5s
    typed_extension_protocol_options:
      envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions:
        "@type": type.googleapis.com/envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions
        idle_timeout: 10m
     .... [further cluster config]

extensions.upstreams.tcp.v3.TcpProtocolOptions

[extensions.upstreams.tcp.v3.TcpProtocolOptions proto]

{
  "idle_timeout": {...}
}

idle_timeout

(Duration) The idle timeout for the connection. The idle timeout is defined as the period in which the connection is not associated with a downstream connection. When the idle timeout is reached, the connection will be closed.

If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.

Warning

Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP FIN packets, etc.