tcp_proxyv3

package
v1.34.0-20240426201503... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: unknown License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_filters_network_tcp_proxy_v3_tcp_proxy_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type TcpProxy

type TcpProxy struct {

	// The prefix to use when emitting :ref:`statistics
	// <config_network_filters_tcp_proxy_stats>`.
	StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Types that are assignable to ClusterSpecifier:
	//
	//	*TcpProxy_Cluster
	//	*TcpProxy_WeightedClusters
	ClusterSpecifier isTcpProxy_ClusterSpecifier `protobuf_oneof:"cluster_specifier"`
	// The on demand policy for the upstream cluster.
	// It applies to both
	// :ref:`TcpProxy.cluster <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.cluster>`
	// and
	// :ref:`TcpProxy.weighted_clusters <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.weighted_clusters>`.
	OnDemand *TcpProxy_OnDemand `protobuf:"bytes,14,opt,name=on_demand,json=onDemand,proto3" json:"on_demand,omitempty"`
	// 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“.
	MetadataMatch *v3.Metadata `protobuf:"bytes,9,opt,name=metadata_match,json=metadataMatch,proto3" json:"metadata_match,omitempty"`
	// 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.
	// It is possible to dynamically override this configuration by setting a per-connection filter
	// state object for the key “envoy.tcp_proxy.per_connection_idle_timeout_ms“.
	//
	// .. warning::
	//
	//	Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
	//	FIN packets, etc.
	IdleTimeout *durationpb.Duration `protobuf:"bytes,8,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// [#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.
	DownstreamIdleTimeout *durationpb.Duration `` /* 126-byte string literal not displayed */
	// [#not-implemented-hide:]
	UpstreamIdleTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=upstream_idle_timeout,json=upstreamIdleTimeout,proto3" json:"upstream_idle_timeout,omitempty"`
	// Configuration for :ref:`access logs <arch_overview_access_logs>`
	// emitted by the this tcp_proxy.
	AccessLog []*v31.AccessLog `protobuf:"bytes,5,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
	// 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.
	MaxConnectAttempts *wrapperspb.UInt32Value `protobuf:"bytes,7,opt,name=max_connect_attempts,json=maxConnectAttempts,proto3" json:"max_connect_attempts,omitempty"`
	// 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.
	HashPolicy []*v32.HashPolicy `protobuf:"bytes,11,rep,name=hash_policy,json=hashPolicy,proto3" json:"hash_policy,omitempty"`
	// If set, this configures tunneling, e.g. configuration options to tunnel TCP payload over
	// HTTP CONNECT. If this message is absent, the payload will be proxied upstream as per usual.
	// It is possible to dynamically override this configuration and disable tunneling per connection,
	// by setting a per-connection filter state object for the key “envoy.tcp_proxy.disable_tunneling“.
	TunnelingConfig *TcpProxy_TunnelingConfig `protobuf:"bytes,12,opt,name=tunneling_config,json=tunnelingConfig,proto3" json:"tunneling_config,omitempty"`
	// The maximum duration of a connection. The duration is defined as the period since a connection
	// was established. If not set, there is no max duration. When max_downstream_connection_duration
	// is reached the connection will be closed. Duration must be at least 1ms.
	MaxDownstreamConnectionDuration *durationpb.Duration `` /* 159-byte string literal not displayed */
	// .. attention::
	// This field is deprecated in favor of
	// :ref:`access_log_flush_interval
	// <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`.
	// Note that if both this field and :ref:`access_log_flush_interval
	// <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`
	// are specified, the former (deprecated field) is ignored.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto.
	AccessLogFlushInterval *durationpb.Duration `` /* 132-byte string literal not displayed */
	// .. attention::
	// This field is deprecated in favor of
	// :ref:`flush_access_log_on_connected
	// <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>`.
	// Note that if both this field and :ref:`flush_access_log_on_connected
	// <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>`
	// are specified, the former (deprecated field) is ignored.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto.
	FlushAccessLogOnConnected bool `` /* 144-byte string literal not displayed */
	// Additional access log options for TCP Proxy.
	AccessLogOptions *TcpProxy_TcpAccessLogOptions `protobuf:"bytes,17,opt,name=access_log_options,json=accessLogOptions,proto3" json:"access_log_options,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 18]

func (*TcpProxy) Descriptor deprecated

func (*TcpProxy) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy.ProtoReflect.Descriptor instead.

func (*TcpProxy) GetAccessLog

func (x *TcpProxy) GetAccessLog() []*v31.AccessLog

func (*TcpProxy) GetAccessLogFlushInterval deprecated

func (x *TcpProxy) GetAccessLogFlushInterval() *durationpb.Duration

Deprecated: Marked as deprecated in envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto.

func (*TcpProxy) GetAccessLogOptions

func (x *TcpProxy) GetAccessLogOptions() *TcpProxy_TcpAccessLogOptions

func (*TcpProxy) GetCluster

func (x *TcpProxy) GetCluster() string

func (*TcpProxy) GetClusterSpecifier

func (m *TcpProxy) GetClusterSpecifier() isTcpProxy_ClusterSpecifier

func (*TcpProxy) GetDownstreamIdleTimeout

func (x *TcpProxy) GetDownstreamIdleTimeout() *durationpb.Duration

func (*TcpProxy) GetFlushAccessLogOnConnected deprecated

func (x *TcpProxy) GetFlushAccessLogOnConnected() bool

Deprecated: Marked as deprecated in envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto.

func (*TcpProxy) GetHashPolicy

func (x *TcpProxy) GetHashPolicy() []*v32.HashPolicy

func (*TcpProxy) GetIdleTimeout

func (x *TcpProxy) GetIdleTimeout() *durationpb.Duration

func (*TcpProxy) GetMaxConnectAttempts

func (x *TcpProxy) GetMaxConnectAttempts() *wrapperspb.UInt32Value

func (*TcpProxy) GetMaxDownstreamConnectionDuration

func (x *TcpProxy) GetMaxDownstreamConnectionDuration() *durationpb.Duration

func (*TcpProxy) GetMetadataMatch

func (x *TcpProxy) GetMetadataMatch() *v3.Metadata

func (*TcpProxy) GetOnDemand

func (x *TcpProxy) GetOnDemand() *TcpProxy_OnDemand

func (*TcpProxy) GetStatPrefix

func (x *TcpProxy) GetStatPrefix() string

func (*TcpProxy) GetTunnelingConfig

func (x *TcpProxy) GetTunnelingConfig() *TcpProxy_TunnelingConfig

func (*TcpProxy) GetUpstreamIdleTimeout

func (x *TcpProxy) GetUpstreamIdleTimeout() *durationpb.Duration

func (*TcpProxy) GetWeightedClusters

func (x *TcpProxy) GetWeightedClusters() *TcpProxy_WeightedCluster

func (*TcpProxy) ProtoMessage

func (*TcpProxy) ProtoMessage()

func (*TcpProxy) ProtoReflect

func (x *TcpProxy) ProtoReflect() protoreflect.Message

func (*TcpProxy) Reset

func (x *TcpProxy) Reset()

func (*TcpProxy) String

func (x *TcpProxy) String() string

type TcpProxy_Cluster

type TcpProxy_Cluster struct {
	// The upstream cluster to connect to.
	Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3,oneof"`
}

type TcpProxy_OnDemand

type TcpProxy_OnDemand struct {

	// An optional configuration for on-demand cluster discovery
	// service. If not specified, the on-demand cluster discovery will
	// be disabled. When it's specified, the filter will pause a request
	// to an unknown cluster and will begin a cluster discovery
	// process. When the discovery is finished (successfully or not),
	// the request will be resumed.
	OdcdsConfig *v3.ConfigSource `protobuf:"bytes,1,opt,name=odcds_config,json=odcdsConfig,proto3" json:"odcds_config,omitempty"`
	// xdstp:// resource locator for on-demand cluster collection.
	// [#not-implemented-hide:]
	ResourcesLocator string `protobuf:"bytes,2,opt,name=resources_locator,json=resourcesLocator,proto3" json:"resources_locator,omitempty"`
	// The timeout for on demand cluster lookup. If the CDS cannot return the required cluster,
	// the downstream request will be closed with the error code detail NO_CLUSTER_FOUND.
	// [#not-implemented-hide:]
	Timeout *durationpb.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

func (*TcpProxy_OnDemand) Descriptor deprecated

func (*TcpProxy_OnDemand) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy_OnDemand.ProtoReflect.Descriptor instead.

func (*TcpProxy_OnDemand) GetOdcdsConfig

func (x *TcpProxy_OnDemand) GetOdcdsConfig() *v3.ConfigSource

func (*TcpProxy_OnDemand) GetResourcesLocator

func (x *TcpProxy_OnDemand) GetResourcesLocator() string

func (*TcpProxy_OnDemand) GetTimeout

func (x *TcpProxy_OnDemand) GetTimeout() *durationpb.Duration

func (*TcpProxy_OnDemand) ProtoMessage

func (*TcpProxy_OnDemand) ProtoMessage()

func (*TcpProxy_OnDemand) ProtoReflect

func (x *TcpProxy_OnDemand) ProtoReflect() protoreflect.Message

func (*TcpProxy_OnDemand) Reset

func (x *TcpProxy_OnDemand) Reset()

func (*TcpProxy_OnDemand) String

func (x *TcpProxy_OnDemand) String() string

type TcpProxy_TcpAccessLogOptions

type TcpProxy_TcpAccessLogOptions struct {

	// The interval to flush access log. The TCP proxy will flush only one access log when the connection
	// is closed by default. If this field is set, the TCP proxy will flush access log periodically with
	// the specified interval.
	// The interval must be at least 1ms.
	AccessLogFlushInterval *durationpb.Duration `` /* 131-byte string literal not displayed */
	// If set to true, access log will be flushed when the TCP proxy has successfully established a
	// connection with the upstream. If the connection failed, the access log will not be flushed.
	FlushAccessLogOnConnected bool `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*TcpProxy_TcpAccessLogOptions) Descriptor deprecated

func (*TcpProxy_TcpAccessLogOptions) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy_TcpAccessLogOptions.ProtoReflect.Descriptor instead.

func (*TcpProxy_TcpAccessLogOptions) GetAccessLogFlushInterval

func (x *TcpProxy_TcpAccessLogOptions) GetAccessLogFlushInterval() *durationpb.Duration

func (*TcpProxy_TcpAccessLogOptions) GetFlushAccessLogOnConnected

func (x *TcpProxy_TcpAccessLogOptions) GetFlushAccessLogOnConnected() bool

func (*TcpProxy_TcpAccessLogOptions) ProtoMessage

func (*TcpProxy_TcpAccessLogOptions) ProtoMessage()

func (*TcpProxy_TcpAccessLogOptions) ProtoReflect

func (*TcpProxy_TcpAccessLogOptions) Reset

func (x *TcpProxy_TcpAccessLogOptions) Reset()

func (*TcpProxy_TcpAccessLogOptions) String

type TcpProxy_TunnelingConfig

type TcpProxy_TunnelingConfig struct {

	// The hostname to send in the synthesized CONNECT headers to the upstream proxy.
	// This field evaluates command operators if set, otherwise returns hostname as is.
	//
	// Example: dynamically set hostname using downstream SNI
	//
	// .. code-block:: yaml
	//
	//	tunneling_config:
	//	  hostname: "%REQUESTED_SERVER_NAME%:443"
	//
	// Example: dynamically set hostname using dynamic metadata
	//
	// .. code-block:: yaml
	//
	//	tunneling_config:
	//	  hostname: "%DYNAMIC_METADATA(tunnel:address)%"
	Hostname string `protobuf:"bytes,1,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Use POST method instead of CONNECT method to tunnel the TCP stream.
	// The 'protocol: bytestream' header is also NOT set for HTTP/2 to comply with the spec.
	//
	// The upstream proxy is expected to convert POST payload as raw TCP.
	UsePost bool `protobuf:"varint,2,opt,name=use_post,json=usePost,proto3" json:"use_post,omitempty"`
	// Additional request headers to upstream proxy. This is mainly used to
	// trigger upstream to convert POST requests back to CONNECT requests.
	//
	// Neither “:-prefixed“ pseudo-headers nor the Host: header can be overridden.
	HeadersToAdd []*v3.HeaderValueOption `protobuf:"bytes,3,rep,name=headers_to_add,json=headersToAdd,proto3" json:"headers_to_add,omitempty"`
	// Save the response headers to the downstream info filter state for consumption
	// by the network filters. The filter state key is “envoy.tcp_proxy.propagate_response_headers“.
	PropagateResponseHeaders bool `` /* 136-byte string literal not displayed */
	// The path used with POST method. Default path is “/“. If post path is specified and
	// :ref:`use_post field <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig.use_post>`
	// isn't true, it will be rejected.
	PostPath string `protobuf:"bytes,5,opt,name=post_path,json=postPath,proto3" json:"post_path,omitempty"`
	// Save the response trailers to the downstream info filter state for consumption
	// by the network filters. The filter state key is “envoy.tcp_proxy.propagate_response_trailers“.
	PropagateResponseTrailers bool `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for tunneling TCP over other transports or application layers. Tunneling is supported over both HTTP/1.1 and HTTP/2. Upstream protocol is determined by the cluster configuration. [#next-free-field: 7]

func (*TcpProxy_TunnelingConfig) Descriptor deprecated

func (*TcpProxy_TunnelingConfig) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy_TunnelingConfig.ProtoReflect.Descriptor instead.

func (*TcpProxy_TunnelingConfig) GetHeadersToAdd

func (x *TcpProxy_TunnelingConfig) GetHeadersToAdd() []*v3.HeaderValueOption

func (*TcpProxy_TunnelingConfig) GetHostname

func (x *TcpProxy_TunnelingConfig) GetHostname() string

func (*TcpProxy_TunnelingConfig) GetPostPath

func (x *TcpProxy_TunnelingConfig) GetPostPath() string

func (*TcpProxy_TunnelingConfig) GetPropagateResponseHeaders

func (x *TcpProxy_TunnelingConfig) GetPropagateResponseHeaders() bool

func (*TcpProxy_TunnelingConfig) GetPropagateResponseTrailers

func (x *TcpProxy_TunnelingConfig) GetPropagateResponseTrailers() bool

func (*TcpProxy_TunnelingConfig) GetUsePost

func (x *TcpProxy_TunnelingConfig) GetUsePost() bool

func (*TcpProxy_TunnelingConfig) ProtoMessage

func (*TcpProxy_TunnelingConfig) ProtoMessage()

func (*TcpProxy_TunnelingConfig) ProtoReflect

func (x *TcpProxy_TunnelingConfig) ProtoReflect() protoreflect.Message

func (*TcpProxy_TunnelingConfig) Reset

func (x *TcpProxy_TunnelingConfig) Reset()

func (*TcpProxy_TunnelingConfig) String

func (x *TcpProxy_TunnelingConfig) String() string

type TcpProxy_WeightedCluster

type TcpProxy_WeightedCluster struct {

	// Specifies one or more upstream clusters associated with the route.
	Clusters []*TcpProxy_WeightedCluster_ClusterWeight `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*TcpProxy_WeightedCluster) Descriptor deprecated

func (*TcpProxy_WeightedCluster) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy_WeightedCluster.ProtoReflect.Descriptor instead.

func (*TcpProxy_WeightedCluster) GetClusters

func (*TcpProxy_WeightedCluster) ProtoMessage

func (*TcpProxy_WeightedCluster) ProtoMessage()

func (*TcpProxy_WeightedCluster) ProtoReflect

func (x *TcpProxy_WeightedCluster) ProtoReflect() protoreflect.Message

func (*TcpProxy_WeightedCluster) Reset

func (x *TcpProxy_WeightedCluster) Reset()

func (*TcpProxy_WeightedCluster) String

func (x *TcpProxy_WeightedCluster) String() string

type TcpProxy_WeightedCluster_ClusterWeight

type TcpProxy_WeightedCluster_ClusterWeight struct {

	// Name of the upstream cluster.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 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.
	Weight uint32 `protobuf:"varint,2,opt,name=weight,proto3" json:"weight,omitempty"`
	// 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_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.metadata_match>`, with values
	// here taking precedence. The filter name should be specified as “envoy.lb“.
	MetadataMatch *v3.Metadata `protobuf:"bytes,3,opt,name=metadata_match,json=metadataMatch,proto3" json:"metadata_match,omitempty"`
	// contains filtered or unexported fields
}

func (*TcpProxy_WeightedCluster_ClusterWeight) Descriptor deprecated

func (*TcpProxy_WeightedCluster_ClusterWeight) Descriptor() ([]byte, []int)

Deprecated: Use TcpProxy_WeightedCluster_ClusterWeight.ProtoReflect.Descriptor instead.

func (*TcpProxy_WeightedCluster_ClusterWeight) GetMetadataMatch

func (x *TcpProxy_WeightedCluster_ClusterWeight) GetMetadataMatch() *v3.Metadata

func (*TcpProxy_WeightedCluster_ClusterWeight) GetName

func (*TcpProxy_WeightedCluster_ClusterWeight) GetWeight

func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage

func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoReflect

func (*TcpProxy_WeightedCluster_ClusterWeight) Reset

func (*TcpProxy_WeightedCluster_ClusterWeight) String

type TcpProxy_WeightedClusters

type TcpProxy_WeightedClusters struct {
	// 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.
	WeightedClusters *TcpProxy_WeightedCluster `protobuf:"bytes,10,opt,name=weighted_clusters,json=weightedClusters,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL