Documentation ¶
Index ¶
- Variables
- type TcpProxy
- func (*TcpProxy) Descriptor() ([]byte, []int)deprecated
- func (x *TcpProxy) GetAccessLog() []*v4alpha1.AccessLog
- func (x *TcpProxy) GetCluster() string
- func (m *TcpProxy) GetClusterSpecifier() isTcpProxy_ClusterSpecifier
- func (x *TcpProxy) GetDownstreamIdleTimeout() *duration.Duration
- func (x *TcpProxy) GetHashPolicy() []*v3.HashPolicy
- func (x *TcpProxy) GetIdleTimeout() *duration.Duration
- func (x *TcpProxy) GetMaxConnectAttempts() *wrappers.UInt32Value
- func (x *TcpProxy) GetMaxDownstreamConnectionDuration() *duration.Duration
- func (x *TcpProxy) GetMetadataMatch() *v4alpha.Metadata
- func (x *TcpProxy) GetStatPrefix() string
- func (x *TcpProxy) GetTunnelingConfig() *TcpProxy_TunnelingConfig
- func (x *TcpProxy) GetUpstreamIdleTimeout() *duration.Duration
- func (x *TcpProxy) GetWeightedClusters() *TcpProxy_WeightedCluster
- func (*TcpProxy) ProtoMessage()
- func (x *TcpProxy) ProtoReflect() protoreflect.Message
- func (x *TcpProxy) Reset()
- func (x *TcpProxy) String() string
- func (m *TcpProxy) Validate() error
- type TcpProxyValidationError
- type TcpProxy_Cluster
- type TcpProxy_TunnelingConfig
- func (*TcpProxy_TunnelingConfig) Descriptor() ([]byte, []int)deprecated
- func (x *TcpProxy_TunnelingConfig) GetHeadersToAdd() []*v4alpha.HeaderValueOption
- func (x *TcpProxy_TunnelingConfig) GetHostname() string
- func (x *TcpProxy_TunnelingConfig) GetUsePost() bool
- func (*TcpProxy_TunnelingConfig) ProtoMessage()
- func (x *TcpProxy_TunnelingConfig) ProtoReflect() protoreflect.Message
- func (x *TcpProxy_TunnelingConfig) Reset()
- func (x *TcpProxy_TunnelingConfig) String() string
- func (m *TcpProxy_TunnelingConfig) Validate() error
- type TcpProxy_TunnelingConfigValidationError
- func (e TcpProxy_TunnelingConfigValidationError) Cause() error
- func (e TcpProxy_TunnelingConfigValidationError) Error() string
- func (e TcpProxy_TunnelingConfigValidationError) ErrorName() string
- func (e TcpProxy_TunnelingConfigValidationError) Field() string
- func (e TcpProxy_TunnelingConfigValidationError) Key() bool
- func (e TcpProxy_TunnelingConfigValidationError) Reason() string
- type TcpProxy_WeightedCluster
- func (*TcpProxy_WeightedCluster) Descriptor() ([]byte, []int)deprecated
- func (x *TcpProxy_WeightedCluster) GetClusters() []*TcpProxy_WeightedCluster_ClusterWeight
- func (*TcpProxy_WeightedCluster) ProtoMessage()
- func (x *TcpProxy_WeightedCluster) ProtoReflect() protoreflect.Message
- func (x *TcpProxy_WeightedCluster) Reset()
- func (x *TcpProxy_WeightedCluster) String() string
- func (m *TcpProxy_WeightedCluster) Validate() error
- type TcpProxy_WeightedClusterValidationError
- func (e TcpProxy_WeightedClusterValidationError) Cause() error
- func (e TcpProxy_WeightedClusterValidationError) Error() string
- func (e TcpProxy_WeightedClusterValidationError) ErrorName() string
- func (e TcpProxy_WeightedClusterValidationError) Field() string
- func (e TcpProxy_WeightedClusterValidationError) Key() bool
- func (e TcpProxy_WeightedClusterValidationError) Reason() string
- type TcpProxy_WeightedCluster_ClusterWeight
- func (*TcpProxy_WeightedCluster_ClusterWeight) Descriptor() ([]byte, []int)deprecated
- func (x *TcpProxy_WeightedCluster_ClusterWeight) GetMetadataMatch() *v4alpha.Metadata
- func (x *TcpProxy_WeightedCluster_ClusterWeight) GetName() string
- func (x *TcpProxy_WeightedCluster_ClusterWeight) GetWeight() uint32
- func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage()
- func (x *TcpProxy_WeightedCluster_ClusterWeight) ProtoReflect() protoreflect.Message
- func (x *TcpProxy_WeightedCluster_ClusterWeight) Reset()
- func (x *TcpProxy_WeightedCluster_ClusterWeight) String() string
- func (m *TcpProxy_WeightedCluster_ClusterWeight) Validate() error
- type TcpProxy_WeightedCluster_ClusterWeightValidationError
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Cause() error
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Error() string
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) ErrorName() string
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Field() string
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Key() bool
- func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Reason() string
- type TcpProxy_WeightedClusters
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_network_tcp_proxy_v4alpha_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"` // 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 *v4alpha.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 *duration.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 *duration.Duration `` /* 126-byte string literal not displayed */ // [#not-implemented-hide:] UpstreamIdleTimeout *duration.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 []*v4alpha1.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 *wrappers.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 []*v3.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. 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 *duration.Duration `` /* 159-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 14]
func (*TcpProxy) Descriptor
deprecated
func (*TcpProxy) GetAccessLog ¶
func (*TcpProxy) GetCluster ¶
func (*TcpProxy) GetClusterSpecifier ¶
func (m *TcpProxy) GetClusterSpecifier() isTcpProxy_ClusterSpecifier
func (*TcpProxy) GetDownstreamIdleTimeout ¶
func (*TcpProxy) GetHashPolicy ¶
func (x *TcpProxy) GetHashPolicy() []*v3.HashPolicy
func (*TcpProxy) GetIdleTimeout ¶
func (*TcpProxy) GetMaxConnectAttempts ¶
func (x *TcpProxy) GetMaxConnectAttempts() *wrappers.UInt32Value
func (*TcpProxy) GetMaxDownstreamConnectionDuration ¶ added in v0.9.7
func (*TcpProxy) GetMetadataMatch ¶
func (*TcpProxy) GetStatPrefix ¶
func (*TcpProxy) GetTunnelingConfig ¶
func (x *TcpProxy) GetTunnelingConfig() *TcpProxy_TunnelingConfig
func (*TcpProxy) GetUpstreamIdleTimeout ¶
func (*TcpProxy) GetWeightedClusters ¶
func (x *TcpProxy) GetWeightedClusters() *TcpProxy_WeightedCluster
func (*TcpProxy) ProtoMessage ¶
func (*TcpProxy) ProtoMessage()
func (*TcpProxy) ProtoReflect ¶
func (x *TcpProxy) ProtoReflect() protoreflect.Message
type TcpProxyValidationError ¶
type TcpProxyValidationError struct {
// contains filtered or unexported fields
}
TcpProxyValidationError is the validation error returned by TcpProxy.Validate if the designated constraints aren't met.
func (TcpProxyValidationError) Cause ¶
func (e TcpProxyValidationError) Cause() error
Cause function returns cause value.
func (TcpProxyValidationError) Error ¶
func (e TcpProxyValidationError) Error() string
Error satisfies the builtin error interface
func (TcpProxyValidationError) ErrorName ¶
func (e TcpProxyValidationError) ErrorName() string
ErrorName returns error name.
func (TcpProxyValidationError) Field ¶
func (e TcpProxyValidationError) Field() string
Field function returns field value.
func (TcpProxyValidationError) Key ¶
func (e TcpProxyValidationError) Key() bool
Key function returns key value.
func (TcpProxyValidationError) Reason ¶
func (e TcpProxyValidationError) Reason() string
Reason function returns reason value.
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_TunnelingConfig ¶
type TcpProxy_TunnelingConfig struct { // The hostname to send in the synthesized CONNECT headers to the upstream proxy. 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 []*v4alpha.HeaderValueOption `protobuf:"bytes,3,rep,name=headers_to_add,json=headersToAdd,proto3" json:"headers_to_add,omitempty"` // 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.
func (*TcpProxy_TunnelingConfig) Descriptor
deprecated
func (*TcpProxy_TunnelingConfig) Descriptor() ([]byte, []int)
Deprecated: Use TcpProxy_TunnelingConfig.ProtoReflect.Descriptor instead.
func (*TcpProxy_TunnelingConfig) GetHeadersToAdd ¶ added in v0.9.9
func (x *TcpProxy_TunnelingConfig) GetHeadersToAdd() []*v4alpha.HeaderValueOption
func (*TcpProxy_TunnelingConfig) GetHostname ¶
func (x *TcpProxy_TunnelingConfig) GetHostname() string
func (*TcpProxy_TunnelingConfig) GetUsePost ¶ added in v0.9.9
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
func (*TcpProxy_TunnelingConfig) Validate ¶
func (m *TcpProxy_TunnelingConfig) Validate() error
Validate checks the field values on TcpProxy_TunnelingConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type TcpProxy_TunnelingConfigValidationError ¶
type TcpProxy_TunnelingConfigValidationError struct {
// contains filtered or unexported fields
}
TcpProxy_TunnelingConfigValidationError is the validation error returned by TcpProxy_TunnelingConfig.Validate if the designated constraints aren't met.
func (TcpProxy_TunnelingConfigValidationError) Cause ¶
func (e TcpProxy_TunnelingConfigValidationError) Cause() error
Cause function returns cause value.
func (TcpProxy_TunnelingConfigValidationError) Error ¶
func (e TcpProxy_TunnelingConfigValidationError) Error() string
Error satisfies the builtin error interface
func (TcpProxy_TunnelingConfigValidationError) ErrorName ¶
func (e TcpProxy_TunnelingConfigValidationError) ErrorName() string
ErrorName returns error name.
func (TcpProxy_TunnelingConfigValidationError) Field ¶
func (e TcpProxy_TunnelingConfigValidationError) Field() string
Field function returns field value.
func (TcpProxy_TunnelingConfigValidationError) Key ¶
func (e TcpProxy_TunnelingConfigValidationError) Key() bool
Key function returns key value.
func (TcpProxy_TunnelingConfigValidationError) Reason ¶
func (e TcpProxy_TunnelingConfigValidationError) Reason() string
Reason function returns reason value.
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 (x *TcpProxy_WeightedCluster) GetClusters() []*TcpProxy_WeightedCluster_ClusterWeight
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
func (*TcpProxy_WeightedCluster) Validate ¶
func (m *TcpProxy_WeightedCluster) Validate() error
Validate checks the field values on TcpProxy_WeightedCluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type TcpProxy_WeightedClusterValidationError ¶
type TcpProxy_WeightedClusterValidationError struct {
// contains filtered or unexported fields
}
TcpProxy_WeightedClusterValidationError is the validation error returned by TcpProxy_WeightedCluster.Validate if the designated constraints aren't met.
func (TcpProxy_WeightedClusterValidationError) Cause ¶
func (e TcpProxy_WeightedClusterValidationError) Cause() error
Cause function returns cause value.
func (TcpProxy_WeightedClusterValidationError) Error ¶
func (e TcpProxy_WeightedClusterValidationError) Error() string
Error satisfies the builtin error interface
func (TcpProxy_WeightedClusterValidationError) ErrorName ¶
func (e TcpProxy_WeightedClusterValidationError) ErrorName() string
ErrorName returns error name.
func (TcpProxy_WeightedClusterValidationError) Field ¶
func (e TcpProxy_WeightedClusterValidationError) Field() string
Field function returns field value.
func (TcpProxy_WeightedClusterValidationError) Key ¶
func (e TcpProxy_WeightedClusterValidationError) Key() bool
Key function returns key value.
func (TcpProxy_WeightedClusterValidationError) Reason ¶
func (e TcpProxy_WeightedClusterValidationError) Reason() string
Reason function returns reason value.
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 *v4alpha.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() *v4alpha.Metadata
func (*TcpProxy_WeightedCluster_ClusterWeight) GetName ¶
func (x *TcpProxy_WeightedCluster_ClusterWeight) GetName() string
func (*TcpProxy_WeightedCluster_ClusterWeight) GetWeight ¶
func (x *TcpProxy_WeightedCluster_ClusterWeight) GetWeight() uint32
func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage ¶
func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoMessage()
func (*TcpProxy_WeightedCluster_ClusterWeight) ProtoReflect ¶
func (x *TcpProxy_WeightedCluster_ClusterWeight) ProtoReflect() protoreflect.Message
func (*TcpProxy_WeightedCluster_ClusterWeight) Reset ¶
func (x *TcpProxy_WeightedCluster_ClusterWeight) Reset()
func (*TcpProxy_WeightedCluster_ClusterWeight) String ¶
func (x *TcpProxy_WeightedCluster_ClusterWeight) String() string
func (*TcpProxy_WeightedCluster_ClusterWeight) Validate ¶
func (m *TcpProxy_WeightedCluster_ClusterWeight) Validate() error
Validate checks the field values on TcpProxy_WeightedCluster_ClusterWeight with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type TcpProxy_WeightedCluster_ClusterWeightValidationError ¶
type TcpProxy_WeightedCluster_ClusterWeightValidationError struct {
// contains filtered or unexported fields
}
TcpProxy_WeightedCluster_ClusterWeightValidationError is the validation error returned by TcpProxy_WeightedCluster_ClusterWeight.Validate if the designated constraints aren't met.
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) Cause ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Cause() error
Cause function returns cause value.
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) Error ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Error() string
Error satisfies the builtin error interface
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) ErrorName ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) ErrorName() string
ErrorName returns error name.
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) Field ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Field() string
Field function returns field value.
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) Key ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Key() bool
Key function returns key value.
func (TcpProxy_WeightedCluster_ClusterWeightValidationError) Reason ¶
func (e TcpProxy_WeightedCluster_ClusterWeightValidationError) Reason() string
Reason function returns reason value.
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"` }