envoy_config_filter_network_tcp_proxy_v2

package
v1.12.1 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 valid to be assigned to ClusterSpecifier:
	//	*TcpProxy_Cluster
	//	*TcpProxy_WeightedClusters
	ClusterSpecifier isTcpProxy_ClusterSpecifier `protobuf_oneof:"cluster_specifier"`
	// 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 *core.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.
	//
	// .. warning::
	//   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
	//   FIN packets, etc.
	IdleTimeout *types.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 *types.Duration `` /* 126-byte string literal not displayed */
	// [#not-implemented-hide:]
	UpstreamIdleTimeout *types.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 []*v2.AccessLog `protobuf:"bytes,5,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
	// [#not-implemented-hide:] Deprecated.
	DeprecatedV1 *TcpProxy_DeprecatedV1 `protobuf:"bytes,6,opt,name=deprecated_v1,json=deprecatedV1,proto3" json:"deprecated_v1,omitempty"` // Deprecated: Do not use.
	// 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   *types.UInt32Value `protobuf:"bytes,7,opt,name=max_connect_attempts,json=maxConnectAttempts,proto3" json:"max_connect_attempts,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

[#next-free-field: 11]

func (*TcpProxy) Descriptor 

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

func (*TcpProxy) GetAccessLog 

func (m *TcpProxy) GetAccessLog() []*v2.AccessLog

func (*TcpProxy) GetCluster 

func (m *TcpProxy) GetCluster() string

func (*TcpProxy) GetClusterSpecifier 

func (m *TcpProxy) GetClusterSpecifier() isTcpProxy_ClusterSpecifier

func (*TcpProxy) GetDeprecatedV1 deprecated 

func (m *TcpProxy) GetDeprecatedV1() *TcpProxy_DeprecatedV1

Deprecated: Do not use.

func (*TcpProxy) GetDownstreamIdleTimeout 

func (m *TcpProxy) GetDownstreamIdleTimeout() *types.Duration

func (*TcpProxy) GetIdleTimeout 

func (m *TcpProxy) GetIdleTimeout() *types.Duration

func (*TcpProxy) GetMaxConnectAttempts 

func (m *TcpProxy) GetMaxConnectAttempts() *types.UInt32Value

func (*TcpProxy) GetMetadataMatch 

func (m *TcpProxy) GetMetadataMatch() *core.Metadata

func (*TcpProxy) GetStatPrefix 

func (m *TcpProxy) GetStatPrefix() string

func (*TcpProxy) GetUpstreamIdleTimeout 

func (m *TcpProxy) GetUpstreamIdleTimeout() *types.Duration

func (*TcpProxy) GetWeightedClusters 

func (m *TcpProxy) GetWeightedClusters() *TcpProxy_WeightedCluster

func (*TcpProxy) ProtoMessage 

func (*TcpProxy) ProtoMessage()

func (*TcpProxy) Reset 

func (m *TcpProxy) Reset()

func (*TcpProxy) String 

func (m *TcpProxy) String() string

func (*TcpProxy) XXX_DiscardUnknown 

func (m *TcpProxy) XXX_DiscardUnknown()

func (*TcpProxy) XXX_Marshal 

func (m *TcpProxy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TcpProxy) XXX_Merge 

func (m *TcpProxy) XXX_Merge(src proto.Message)

func (*TcpProxy) XXX_OneofWrappers 

func (*TcpProxy) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*TcpProxy) XXX_Size 

func (m *TcpProxy) XXX_Size() int

func (*TcpProxy) XXX_Unmarshal 

func (m *TcpProxy) XXX_Unmarshal(b []byte) error

type TcpProxy_Cluster 

type TcpProxy_Cluster struct {
	Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3,oneof"`
}

type TcpProxy_DeprecatedV1 deprecated 

type TcpProxy_DeprecatedV1 struct {
	// The route table for the filter. All filter instances must have a route
	// table, even if it is empty.
	Routes               []*TcpProxy_DeprecatedV1_TCPRoute `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

Deprecated: Do not use.

func (*TcpProxy_DeprecatedV1) Descriptor 

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

func (*TcpProxy_DeprecatedV1) GetRoutes 

func (m *TcpProxy_DeprecatedV1) GetRoutes() []*TcpProxy_DeprecatedV1_TCPRoute

func (*TcpProxy_DeprecatedV1) ProtoMessage 

func (*TcpProxy_DeprecatedV1) ProtoMessage()

func (*TcpProxy_DeprecatedV1) Reset 

func (m *TcpProxy_DeprecatedV1) Reset()

func (*TcpProxy_DeprecatedV1) String 

func (m *TcpProxy_DeprecatedV1) String() string

func (*TcpProxy_DeprecatedV1) XXX_DiscardUnknown 

func (m *TcpProxy_DeprecatedV1) XXX_DiscardUnknown()

func (*TcpProxy_DeprecatedV1) XXX_Marshal 

func (m *TcpProxy_DeprecatedV1) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TcpProxy_DeprecatedV1) XXX_Merge 

func (m *TcpProxy_DeprecatedV1) XXX_Merge(src proto.Message)

func (*TcpProxy_DeprecatedV1) XXX_Size 

func (m *TcpProxy_DeprecatedV1) XXX_Size() int

func (*TcpProxy_DeprecatedV1) XXX_Unmarshal 

func (m *TcpProxy_DeprecatedV1) XXX_Unmarshal(b []byte) error

type TcpProxy_DeprecatedV1_TCPRoute 

type TcpProxy_DeprecatedV1_TCPRoute struct {
	// The cluster to connect to when a the downstream network connection
	// matches the specified criteria.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// 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.
	DestinationIpList []*core.CidrRange `protobuf:"bytes,2,rep,name=destination_ip_list,json=destinationIpList,proto3" json:"destination_ip_list,omitempty"`
	// 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.
	DestinationPorts string `protobuf:"bytes,3,opt,name=destination_ports,json=destinationPorts,proto3" json:"destination_ports,omitempty"`
	// 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.
	SourceIpList []*core.CidrRange `protobuf:"bytes,4,rep,name=source_ip_list,json=sourceIpList,proto3" json:"source_ip_list,omitempty"`
	// 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.
	SourcePorts          string   `protobuf:"bytes,5,opt,name=source_ports,json=sourcePorts,proto3" json:"source_ports,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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]

func (*TcpProxy_DeprecatedV1_TCPRoute) Descriptor 

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

func (*TcpProxy_DeprecatedV1_TCPRoute) GetCluster 

func (m *TcpProxy_DeprecatedV1_TCPRoute) GetCluster() string

func (*TcpProxy_DeprecatedV1_TCPRoute) GetDestinationIpList 

func (m *TcpProxy_DeprecatedV1_TCPRoute) GetDestinationIpList() []*core.CidrRange

func (*TcpProxy_DeprecatedV1_TCPRoute) GetDestinationPorts 

func (m *TcpProxy_DeprecatedV1_TCPRoute) GetDestinationPorts() string

func (*TcpProxy_DeprecatedV1_TCPRoute) GetSourceIpList 

func (m *TcpProxy_DeprecatedV1_TCPRoute) GetSourceIpList() []*core.CidrRange

func (*TcpProxy_DeprecatedV1_TCPRoute) GetSourcePorts 

func (m *TcpProxy_DeprecatedV1_TCPRoute) GetSourcePorts() string

func (*TcpProxy_DeprecatedV1_TCPRoute) ProtoMessage 

func (*TcpProxy_DeprecatedV1_TCPRoute) ProtoMessage()

func (*TcpProxy_DeprecatedV1_TCPRoute) Reset 

func (m *TcpProxy_DeprecatedV1_TCPRoute) Reset()

func (*TcpProxy_DeprecatedV1_TCPRoute) String 

func (m *TcpProxy_DeprecatedV1_TCPRoute) String() string

func (*TcpProxy_DeprecatedV1_TCPRoute) XXX_DiscardUnknown 

func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_DiscardUnknown()

func (*TcpProxy_DeprecatedV1_TCPRoute) XXX_Marshal 

func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TcpProxy_DeprecatedV1_TCPRoute) XXX_Merge 

func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Merge(src proto.Message)

func (*TcpProxy_DeprecatedV1_TCPRoute) XXX_Size 

func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Size() int

func (*TcpProxy_DeprecatedV1_TCPRoute) XXX_Unmarshal 

func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                                  `json:"-"`
	XXX_unrecognized     []byte                                    `json:"-"`
	XXX_sizecache        int32                                     `json:"-"`
}

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 

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

func (*TcpProxy_WeightedCluster) GetClusters 

func (m *TcpProxy_WeightedCluster) GetClusters() []*TcpProxy_WeightedCluster_ClusterWeight

func (*TcpProxy_WeightedCluster) ProtoMessage 

func (*TcpProxy_WeightedCluster) ProtoMessage()

func (*TcpProxy_WeightedCluster) Reset 

func (m *TcpProxy_WeightedCluster) Reset()

func (*TcpProxy_WeightedCluster) String 

func (m *TcpProxy_WeightedCluster) String() string

func (*TcpProxy_WeightedCluster) XXX_DiscardUnknown 

func (m *TcpProxy_WeightedCluster) XXX_DiscardUnknown()

func (*TcpProxy_WeightedCluster) XXX_Marshal 

func (m *TcpProxy_WeightedCluster) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TcpProxy_WeightedCluster) XXX_Merge 

func (m *TcpProxy_WeightedCluster) XXX_Merge(src proto.Message)

func (*TcpProxy_WeightedCluster) XXX_Size 

func (m *TcpProxy_WeightedCluster) XXX_Size() int

func (*TcpProxy_WeightedCluster) XXX_Unmarshal 

func (m *TcpProxy_WeightedCluster) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*TcpProxy_WeightedCluster_ClusterWeight) Descriptor 

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

func (*TcpProxy_WeightedCluster_ClusterWeight) GetName 

func (m *TcpProxy_WeightedCluster_ClusterWeight) GetName() string

func (*TcpProxy_WeightedCluster_ClusterWeight) GetWeight 

func (m *TcpProxy_WeightedCluster_ClusterWeight) GetWeight() uint32

func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage 

func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage()

func (*TcpProxy_WeightedCluster_ClusterWeight) Reset 

func (m *TcpProxy_WeightedCluster_ClusterWeight) Reset()

func (*TcpProxy_WeightedCluster_ClusterWeight) String 

func (m *TcpProxy_WeightedCluster_ClusterWeight) String() string

func (*TcpProxy_WeightedCluster_ClusterWeight) XXX_DiscardUnknown 

func (m *TcpProxy_WeightedCluster_ClusterWeight) XXX_DiscardUnknown()

func (*TcpProxy_WeightedCluster_ClusterWeight) XXX_Marshal 

func (m *TcpProxy_WeightedCluster_ClusterWeight) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TcpProxy_WeightedCluster_ClusterWeight) XXX_Merge 

func (m *TcpProxy_WeightedCluster_ClusterWeight) XXX_Merge(src proto.Message)

func (*TcpProxy_WeightedCluster_ClusterWeight) XXX_Size 

func (m *TcpProxy_WeightedCluster_ClusterWeight) XXX_Size() int

func (*TcpProxy_WeightedCluster_ClusterWeight) XXX_Unmarshal 

func (m *TcpProxy_WeightedCluster_ClusterWeight) XXX_Unmarshal(b []byte) error

type TcpProxy_WeightedClusters 

type TcpProxy_WeightedClusters struct {
	WeightedClusters *TcpProxy_WeightedCluster `protobuf:"bytes,10,opt,name=weighted_clusters,json=weightedClusters,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.