Documentation ¶
Index ¶
- Variables
- type TcpProxy
- func (*TcpProxy) Descriptor() ([]byte, []int)
- func (m *TcpProxy) GetAccessLog() []*v2.AccessLog
- func (m *TcpProxy) GetCluster() string
- func (m *TcpProxy) GetDeprecatedV1() *TcpProxy_DeprecatedV1deprecated
- func (m *TcpProxy) GetDownstreamIdleTimeout() *types.Duration
- func (m *TcpProxy) GetIdleTimeout() *time.Duration
- func (m *TcpProxy) GetMaxConnectAttempts() *types.UInt32Value
- func (m *TcpProxy) GetMetadataMatch() *core.Metadata
- func (m *TcpProxy) GetStatPrefix() string
- func (m *TcpProxy) GetUpstreamIdleTimeout() *types.Duration
- func (m *TcpProxy) Marshal() (dAtA []byte, err error)
- func (m *TcpProxy) MarshalTo(dAtA []byte) (int, error)
- func (*TcpProxy) ProtoMessage()
- func (m *TcpProxy) Reset()
- func (m *TcpProxy) Size() (n int)
- func (m *TcpProxy) String() string
- func (m *TcpProxy) Unmarshal(dAtA []byte) error
- func (m *TcpProxy) Validate() error
- func (m *TcpProxy) XXX_DiscardUnknown()
- func (m *TcpProxy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *TcpProxy) XXX_Merge(src proto.Message)
- func (m *TcpProxy) XXX_Size() int
- func (m *TcpProxy) XXX_Unmarshal(b []byte) error
- type TcpProxyValidationError
- type TcpProxy_DeprecatedV1
- func (*TcpProxy_DeprecatedV1) Descriptor() ([]byte, []int)
- func (m *TcpProxy_DeprecatedV1) GetRoutes() []*TcpProxy_DeprecatedV1_TCPRoute
- func (m *TcpProxy_DeprecatedV1) Marshal() (dAtA []byte, err error)
- func (m *TcpProxy_DeprecatedV1) MarshalTo(dAtA []byte) (int, error)
- func (*TcpProxy_DeprecatedV1) ProtoMessage()
- func (m *TcpProxy_DeprecatedV1) Reset()
- func (m *TcpProxy_DeprecatedV1) Size() (n int)
- func (m *TcpProxy_DeprecatedV1) String() string
- func (m *TcpProxy_DeprecatedV1) Unmarshal(dAtA []byte) error
- func (m *TcpProxy_DeprecatedV1) Validate() error
- func (m *TcpProxy_DeprecatedV1) XXX_DiscardUnknown()
- func (m *TcpProxy_DeprecatedV1) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *TcpProxy_DeprecatedV1) XXX_Merge(src proto.Message)
- func (m *TcpProxy_DeprecatedV1) XXX_Size() int
- func (m *TcpProxy_DeprecatedV1) XXX_Unmarshal(b []byte) error
- type TcpProxy_DeprecatedV1ValidationError
- type TcpProxy_DeprecatedV1_TCPRoute
- func (*TcpProxy_DeprecatedV1_TCPRoute) Descriptor() ([]byte, []int)
- func (m *TcpProxy_DeprecatedV1_TCPRoute) GetCluster() string
- func (m *TcpProxy_DeprecatedV1_TCPRoute) GetDestinationIpList() []*core.CidrRange
- func (m *TcpProxy_DeprecatedV1_TCPRoute) GetDestinationPorts() string
- func (m *TcpProxy_DeprecatedV1_TCPRoute) GetSourceIpList() []*core.CidrRange
- func (m *TcpProxy_DeprecatedV1_TCPRoute) GetSourcePorts() string
- func (m *TcpProxy_DeprecatedV1_TCPRoute) Marshal() (dAtA []byte, err error)
- func (m *TcpProxy_DeprecatedV1_TCPRoute) MarshalTo(dAtA []byte) (int, error)
- func (*TcpProxy_DeprecatedV1_TCPRoute) ProtoMessage()
- func (m *TcpProxy_DeprecatedV1_TCPRoute) Reset()
- func (m *TcpProxy_DeprecatedV1_TCPRoute) Size() (n int)
- func (m *TcpProxy_DeprecatedV1_TCPRoute) String() string
- func (m *TcpProxy_DeprecatedV1_TCPRoute) Unmarshal(dAtA []byte) error
- func (m *TcpProxy_DeprecatedV1_TCPRoute) Validate() error
- func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_DiscardUnknown()
- func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *TcpProxy_DeprecatedV1_TCPRoute) XXX_Merge(src proto.Message)
- func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Size() int
- func (m *TcpProxy_DeprecatedV1_TCPRoute) XXX_Unmarshal(b []byte) error
- type TcpProxy_DeprecatedV1_TCPRouteValidationError
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthTcpProxy = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowTcpProxy = fmt.Errorf("proto: integer overflow") )
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"` // The upstream cluster to connect to. // // .. note:: // // Once full filter chain matching is implemented in listeners, this field will become the only // way to configure the target cluster. All other matching will be done via :ref:`filter chain // matching rules <envoy_api_msg_listener.FilterChainMatch>`. For very simple configurations, // this field can still be used to select the cluster when no other matching rules are required. // Otherwise, a :ref:`deprecated_v1 // <envoy_api_field_config.filter.network.tcp_proxy.v2.TcpProxy.deprecated_v1>` configuration is // required to use more complex routing in the interim. // Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3" json:"cluster,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 *core.Metadata `protobuf:"bytes,9,opt,name=metadata_match,json=metadataMatch" 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, connections will never be closed // by the TCP proxy due to being idle. IdleTimeout *time.Duration `protobuf:"bytes,8,opt,name=idle_timeout,json=idleTimeout,stdduration" 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 `protobuf:"bytes,3,opt,name=downstream_idle_timeout,json=downstreamIdleTimeout" json:"downstream_idle_timeout,omitempty"` // [#not-implemented-hide:] UpstreamIdleTimeout *types.Duration `protobuf:"bytes,4,opt,name=upstream_idle_timeout,json=upstreamIdleTimeout" 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" json:"access_log,omitempty"` // TCP Proxy filter configuration using deprecated V1 format. This is required for complex // routing until filter chain matching in the listener is implemented. // // .. attention:: // // Using this field will lead to `problems loading the configuration // <https://github.com/envoyproxy/envoy/issues/2441>`_. If you want to configure the filter // using v1 config structure, please make this field a boolean with value “true“ and configure // via the opaque “value“ field like is suggested in :api:`envoy/config/filter/README.md`. DeprecatedV1 *TcpProxy_DeprecatedV1 `protobuf:"bytes,6,opt,name=deprecated_v1,json=deprecatedV1" 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" json:"max_connect_attempts,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*TcpProxy) Descriptor ¶
func (*TcpProxy) GetAccessLog ¶
func (*TcpProxy) GetCluster ¶
func (*TcpProxy) GetDeprecatedV1
deprecated
func (m *TcpProxy) GetDeprecatedV1() *TcpProxy_DeprecatedV1
Deprecated: Do not use.
func (*TcpProxy) GetDownstreamIdleTimeout ¶
func (*TcpProxy) GetIdleTimeout ¶
func (*TcpProxy) GetMaxConnectAttempts ¶
func (m *TcpProxy) GetMaxConnectAttempts() *types.UInt32Value
func (*TcpProxy) GetMetadataMatch ¶
func (*TcpProxy) GetStatPrefix ¶
func (*TcpProxy) GetUpstreamIdleTimeout ¶
func (*TcpProxy) ProtoMessage ¶
func (*TcpProxy) ProtoMessage()
func (*TcpProxy) Validate ¶
Validate checks the field values on TcpProxy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
func (*TcpProxy) XXX_DiscardUnknown ¶
func (m *TcpProxy) XXX_DiscardUnknown()
func (*TcpProxy) XXX_Marshal ¶
func (*TcpProxy) XXX_Unmarshal ¶
type TcpProxyValidationError ¶
TcpProxyValidationError is the validation error returned by TcpProxy.Validate if the designated constraints aren't met.
func (TcpProxyValidationError) Error ¶
func (e TcpProxyValidationError) Error() string
Error satisfies the builtin error interface
type TcpProxy_DeprecatedV1 ¶
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" json:"routes,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
TCP Proxy filter configuration using V1 format, until Envoy gets the ability to match source/destination at the listener level (called :ref:`filter chain match <envoy_api_msg_listener.FilterChainMatch>`).
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) Marshal ¶
func (m *TcpProxy_DeprecatedV1) Marshal() (dAtA []byte, err error)
func (*TcpProxy_DeprecatedV1) MarshalTo ¶
func (m *TcpProxy_DeprecatedV1) MarshalTo(dAtA []byte) (int, error)
func (*TcpProxy_DeprecatedV1) ProtoMessage ¶
func (*TcpProxy_DeprecatedV1) ProtoMessage()
func (*TcpProxy_DeprecatedV1) Reset ¶
func (m *TcpProxy_DeprecatedV1) Reset()
func (*TcpProxy_DeprecatedV1) Size ¶
func (m *TcpProxy_DeprecatedV1) Size() (n int)
func (*TcpProxy_DeprecatedV1) String ¶
func (m *TcpProxy_DeprecatedV1) String() string
func (*TcpProxy_DeprecatedV1) Unmarshal ¶
func (m *TcpProxy_DeprecatedV1) Unmarshal(dAtA []byte) error
func (*TcpProxy_DeprecatedV1) Validate ¶
func (m *TcpProxy_DeprecatedV1) Validate() error
Validate checks the field values on TcpProxy_DeprecatedV1 with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
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 (dst *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_DeprecatedV1ValidationError ¶
type TcpProxy_DeprecatedV1ValidationError struct { Field string Reason string Cause error Key bool }
TcpProxy_DeprecatedV1ValidationError is the validation error returned by TcpProxy_DeprecatedV1.Validate if the designated constraints aren't met.
func (TcpProxy_DeprecatedV1ValidationError) Error ¶
func (e TcpProxy_DeprecatedV1ValidationError) Error() string
Error satisfies the builtin error interface
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" 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" 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.
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) Marshal ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) Marshal() (dAtA []byte, err error)
func (*TcpProxy_DeprecatedV1_TCPRoute) MarshalTo ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) MarshalTo(dAtA []byte) (int, error)
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) Size ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) Size() (n int)
func (*TcpProxy_DeprecatedV1_TCPRoute) String ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) String() string
func (*TcpProxy_DeprecatedV1_TCPRoute) Unmarshal ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) Unmarshal(dAtA []byte) error
func (*TcpProxy_DeprecatedV1_TCPRoute) Validate ¶
func (m *TcpProxy_DeprecatedV1_TCPRoute) Validate() error
Validate checks the field values on TcpProxy_DeprecatedV1_TCPRoute with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
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 (dst *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_DeprecatedV1_TCPRouteValidationError ¶
type TcpProxy_DeprecatedV1_TCPRouteValidationError struct { Field string Reason string Cause error Key bool }
TcpProxy_DeprecatedV1_TCPRouteValidationError is the validation error returned by TcpProxy_DeprecatedV1_TCPRoute.Validate if the designated constraints aren't met.
func (TcpProxy_DeprecatedV1_TCPRouteValidationError) Error ¶
func (e TcpProxy_DeprecatedV1_TCPRouteValidationError) Error() string
Error satisfies the builtin error interface