Documentation ¶
Index ¶
- Variables
- type CdsDummy
- type Cluster
- func (*Cluster) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster) GetAltStatName() string
- func (x *Cluster) GetCircuitBreakers() *cluster.CircuitBreakers
- func (x *Cluster) GetCleanupInterval() *durationpb.Duration
- func (x *Cluster) GetCloseConnectionsOnHostHealthFailure() bool
- func (m *Cluster) GetClusterDiscoveryType() isCluster_ClusterDiscoveryType
- func (x *Cluster) GetClusterType() *Cluster_CustomClusterType
- func (x *Cluster) GetCommonHttpProtocolOptions() *core.HttpProtocolOptions
- func (x *Cluster) GetCommonLbConfig() *Cluster_CommonLbConfig
- func (x *Cluster) GetConnectTimeout() *durationpb.Duration
- func (x *Cluster) GetDnsFailureRefreshRate() *Cluster_RefreshRate
- func (x *Cluster) GetDnsLookupFamily() Cluster_DnsLookupFamily
- func (x *Cluster) GetDnsRefreshRate() *durationpb.Duration
- func (x *Cluster) GetDnsResolvers() []*core.Address
- func (x *Cluster) GetDrainConnectionsOnHostRemoval() bool
- func (x *Cluster) GetEdsClusterConfig() *Cluster_EdsClusterConfig
- func (x *Cluster) GetExtensionProtocolOptions() map[string]*structpb.Structdeprecated
- func (x *Cluster) GetFilters() []*cluster.Filter
- func (x *Cluster) GetHealthChecks() []*core.HealthCheck
- func (x *Cluster) GetHosts() []*core.Addressdeprecated
- func (x *Cluster) GetHttp2ProtocolOptions() *core.Http2ProtocolOptions
- func (x *Cluster) GetHttpProtocolOptions() *core.Http1ProtocolOptions
- func (m *Cluster) GetLbConfig() isCluster_LbConfig
- func (x *Cluster) GetLbPolicy() Cluster_LbPolicy
- func (x *Cluster) GetLbSubsetConfig() *Cluster_LbSubsetConfig
- func (x *Cluster) GetLeastRequestLbConfig() *Cluster_LeastRequestLbConfig
- func (x *Cluster) GetLoadAssignment() *ClusterLoadAssignment
- func (x *Cluster) GetLoadBalancingPolicy() *LoadBalancingPolicy
- func (x *Cluster) GetLrsServer() *core.ConfigSource
- func (x *Cluster) GetMaxRequestsPerConnection() *wrapperspb.UInt32Value
- func (x *Cluster) GetMetadata() *core.Metadata
- func (x *Cluster) GetName() string
- func (x *Cluster) GetOriginalDstLbConfig() *Cluster_OriginalDstLbConfig
- func (x *Cluster) GetOutlierDetection() *cluster.OutlierDetection
- func (x *Cluster) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value
- func (x *Cluster) GetProtocolSelection() Cluster_ClusterProtocolSelection
- func (x *Cluster) GetRespectDnsTtl() bool
- func (x *Cluster) GetRingHashLbConfig() *Cluster_RingHashLbConfig
- func (x *Cluster) GetTlsContext() *auth.UpstreamTlsContextdeprecated
- func (x *Cluster) GetTrackTimeoutBudgets() bool
- func (x *Cluster) GetTransportSocket() *core.TransportSocket
- func (x *Cluster) GetTransportSocketMatches() []*Cluster_TransportSocketMatch
- func (x *Cluster) GetType() Cluster_DiscoveryType
- func (x *Cluster) GetTypedExtensionProtocolOptions() map[string]*anypb.Any
- func (x *Cluster) GetUpstreamBindConfig() *core.BindConfig
- func (x *Cluster) GetUpstreamConnectionOptions() *UpstreamConnectionOptions
- func (x *Cluster) GetUpstreamHttpProtocolOptions() *core.UpstreamHttpProtocolOptions
- func (x *Cluster) GetUseTcpForDnsLookups() bool
- func (*Cluster) ProtoMessage()
- func (x *Cluster) ProtoReflect() protoreflect.Message
- func (x *Cluster) Reset()
- func (x *Cluster) String() string
- type ClusterLoadAssignment
- func (*ClusterLoadAssignment) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterLoadAssignment) GetClusterName() string
- func (x *ClusterLoadAssignment) GetEndpoints() []*endpoint.LocalityLbEndpoints
- func (x *ClusterLoadAssignment) GetNamedEndpoints() map[string]*endpoint.Endpoint
- func (x *ClusterLoadAssignment) GetPolicy() *ClusterLoadAssignment_Policy
- func (*ClusterLoadAssignment) ProtoMessage()
- func (x *ClusterLoadAssignment) ProtoReflect() protoreflect.Message
- func (x *ClusterLoadAssignment) Reset()
- func (x *ClusterLoadAssignment) String() string
- type ClusterLoadAssignment_Policy
- func (*ClusterLoadAssignment_Policy) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterLoadAssignment_Policy) GetDisableOverprovisioning() booldeprecated
- func (x *ClusterLoadAssignment_Policy) GetDropOverloads() []*ClusterLoadAssignment_Policy_DropOverload
- func (x *ClusterLoadAssignment_Policy) GetEndpointStaleAfter() *durationpb.Duration
- func (x *ClusterLoadAssignment_Policy) GetOverprovisioningFactor() *wrapperspb.UInt32Value
- func (*ClusterLoadAssignment_Policy) ProtoMessage()
- func (x *ClusterLoadAssignment_Policy) ProtoReflect() protoreflect.Message
- func (x *ClusterLoadAssignment_Policy) Reset()
- func (x *ClusterLoadAssignment_Policy) String() string
- type ClusterLoadAssignment_Policy_DropOverload
- func (*ClusterLoadAssignment_Policy_DropOverload) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterLoadAssignment_Policy_DropOverload) GetCategory() string
- func (x *ClusterLoadAssignment_Policy_DropOverload) GetDropPercentage() *_type.FractionalPercent
- func (*ClusterLoadAssignment_Policy_DropOverload) ProtoMessage()
- func (x *ClusterLoadAssignment_Policy_DropOverload) ProtoReflect() protoreflect.Message
- func (x *ClusterLoadAssignment_Policy_DropOverload) Reset()
- func (x *ClusterLoadAssignment_Policy_DropOverload) String() string
- type Cluster_ClusterProtocolSelection
- func (Cluster_ClusterProtocolSelection) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_ClusterProtocolSelection) Enum() *Cluster_ClusterProtocolSelection
- func (Cluster_ClusterProtocolSelection) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_ClusterProtocolSelection) Number() protoreflect.EnumNumber
- func (x Cluster_ClusterProtocolSelection) String() string
- func (Cluster_ClusterProtocolSelection) Type() protoreflect.EnumType
- type Cluster_ClusterType
- type Cluster_CommonLbConfig
- func (*Cluster_CommonLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_CommonLbConfig) GetCloseConnectionsOnHostSetChange() bool
- func (x *Cluster_CommonLbConfig) GetConsistentHashingLbConfig() *Cluster_CommonLbConfig_ConsistentHashingLbConfig
- func (x *Cluster_CommonLbConfig) GetHealthyPanicThreshold() *_type.Percent
- func (x *Cluster_CommonLbConfig) GetIgnoreNewHostsUntilFirstHc() bool
- func (m *Cluster_CommonLbConfig) GetLocalityConfigSpecifier() isCluster_CommonLbConfig_LocalityConfigSpecifier
- func (x *Cluster_CommonLbConfig) GetLocalityWeightedLbConfig() *Cluster_CommonLbConfig_LocalityWeightedLbConfig
- func (x *Cluster_CommonLbConfig) GetUpdateMergeWindow() *durationpb.Duration
- func (x *Cluster_CommonLbConfig) GetZoneAwareLbConfig() *Cluster_CommonLbConfig_ZoneAwareLbConfig
- func (*Cluster_CommonLbConfig) ProtoMessage()
- func (x *Cluster_CommonLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_CommonLbConfig) Reset()
- func (x *Cluster_CommonLbConfig) String() string
- type Cluster_CommonLbConfig_ConsistentHashingLbConfig
- func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) GetUseHostnameForHashing() bool
- func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoMessage()
- func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) Reset()
- func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) String() string
- type Cluster_CommonLbConfig_LocalityWeightedLbConfig
- func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) Descriptor() ([]byte, []int)deprecated
- func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoMessage()
- func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) Reset()
- func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) String() string
- type Cluster_CommonLbConfig_LocalityWeightedLbConfig_
- type Cluster_CommonLbConfig_ZoneAwareLbConfig
- func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetFailTrafficOnPanic() bool
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetMinClusterSize() *wrapperspb.UInt64Value
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetRoutingEnabled() *_type.Percent
- func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoMessage()
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) Reset()
- func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) String() string
- type Cluster_CommonLbConfig_ZoneAwareLbConfig_
- type Cluster_CustomClusterType
- func (*Cluster_CustomClusterType) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_CustomClusterType) GetName() string
- func (x *Cluster_CustomClusterType) GetTypedConfig() *anypb.Any
- func (*Cluster_CustomClusterType) ProtoMessage()
- func (x *Cluster_CustomClusterType) ProtoReflect() protoreflect.Message
- func (x *Cluster_CustomClusterType) Reset()
- func (x *Cluster_CustomClusterType) String() string
- type Cluster_DiscoveryType
- func (Cluster_DiscoveryType) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_DiscoveryType) Enum() *Cluster_DiscoveryType
- func (Cluster_DiscoveryType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_DiscoveryType) Number() protoreflect.EnumNumber
- func (x Cluster_DiscoveryType) String() string
- func (Cluster_DiscoveryType) Type() protoreflect.EnumType
- type Cluster_DnsLookupFamily
- func (Cluster_DnsLookupFamily) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_DnsLookupFamily) Enum() *Cluster_DnsLookupFamily
- func (Cluster_DnsLookupFamily) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_DnsLookupFamily) Number() protoreflect.EnumNumber
- func (x Cluster_DnsLookupFamily) String() string
- func (Cluster_DnsLookupFamily) Type() protoreflect.EnumType
- type Cluster_EdsClusterConfig
- func (*Cluster_EdsClusterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_EdsClusterConfig) GetEdsConfig() *core.ConfigSource
- func (x *Cluster_EdsClusterConfig) GetServiceName() string
- func (*Cluster_EdsClusterConfig) ProtoMessage()
- func (x *Cluster_EdsClusterConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_EdsClusterConfig) Reset()
- func (x *Cluster_EdsClusterConfig) String() string
- type Cluster_LbPolicy
- func (Cluster_LbPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_LbPolicy) Enum() *Cluster_LbPolicy
- func (Cluster_LbPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_LbPolicy) Number() protoreflect.EnumNumber
- func (x Cluster_LbPolicy) String() string
- func (Cluster_LbPolicy) Type() protoreflect.EnumType
- type Cluster_LbSubsetConfig
- func (*Cluster_LbSubsetConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_LbSubsetConfig) GetDefaultSubset() *structpb.Struct
- func (x *Cluster_LbSubsetConfig) GetFallbackPolicy() Cluster_LbSubsetConfig_LbSubsetFallbackPolicy
- func (x *Cluster_LbSubsetConfig) GetListAsAny() bool
- func (x *Cluster_LbSubsetConfig) GetLocalityWeightAware() bool
- func (x *Cluster_LbSubsetConfig) GetPanicModeAny() bool
- func (x *Cluster_LbSubsetConfig) GetScaleLocalityWeight() bool
- func (x *Cluster_LbSubsetConfig) GetSubsetSelectors() []*Cluster_LbSubsetConfig_LbSubsetSelector
- func (*Cluster_LbSubsetConfig) ProtoMessage()
- func (x *Cluster_LbSubsetConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_LbSubsetConfig) Reset()
- func (x *Cluster_LbSubsetConfig) String() string
- type Cluster_LbSubsetConfig_LbSubsetFallbackPolicy
- func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Enum() *Cluster_LbSubsetConfig_LbSubsetFallbackPolicy
- func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Number() protoreflect.EnumNumber
- func (x Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) String() string
- func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Type() protoreflect.EnumType
- type Cluster_LbSubsetConfig_LbSubsetSelector
- func (*Cluster_LbSubsetConfig_LbSubsetSelector) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackKeysSubset() []string
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackPolicy() Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetKeys() []string
- func (*Cluster_LbSubsetConfig_LbSubsetSelector) ProtoMessage()
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) ProtoReflect() protoreflect.Message
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) Reset()
- func (x *Cluster_LbSubsetConfig_LbSubsetSelector) String() string
- type Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy
- func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Enum() *Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy
- func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Number() protoreflect.EnumNumber
- func (x Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) String() string
- func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Type() protoreflect.EnumType
- type Cluster_LeastRequestLbConfig
- func (*Cluster_LeastRequestLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_LeastRequestLbConfig) GetChoiceCount() *wrapperspb.UInt32Value
- func (*Cluster_LeastRequestLbConfig) ProtoMessage()
- func (x *Cluster_LeastRequestLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_LeastRequestLbConfig) Reset()
- func (x *Cluster_LeastRequestLbConfig) String() string
- type Cluster_LeastRequestLbConfig_
- type Cluster_OriginalDstLbConfig
- func (*Cluster_OriginalDstLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_OriginalDstLbConfig) GetUseHttpHeader() bool
- func (*Cluster_OriginalDstLbConfig) ProtoMessage()
- func (x *Cluster_OriginalDstLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_OriginalDstLbConfig) Reset()
- func (x *Cluster_OriginalDstLbConfig) String() string
- type Cluster_OriginalDstLbConfig_
- type Cluster_RefreshRate
- func (*Cluster_RefreshRate) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_RefreshRate) GetBaseInterval() *durationpb.Duration
- func (x *Cluster_RefreshRate) GetMaxInterval() *durationpb.Duration
- func (*Cluster_RefreshRate) ProtoMessage()
- func (x *Cluster_RefreshRate) ProtoReflect() protoreflect.Message
- func (x *Cluster_RefreshRate) Reset()
- func (x *Cluster_RefreshRate) String() string
- type Cluster_RingHashLbConfig
- func (*Cluster_RingHashLbConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_RingHashLbConfig) GetHashFunction() Cluster_RingHashLbConfig_HashFunction
- func (x *Cluster_RingHashLbConfig) GetMaximumRingSize() *wrapperspb.UInt64Value
- func (x *Cluster_RingHashLbConfig) GetMinimumRingSize() *wrapperspb.UInt64Value
- func (*Cluster_RingHashLbConfig) ProtoMessage()
- func (x *Cluster_RingHashLbConfig) ProtoReflect() protoreflect.Message
- func (x *Cluster_RingHashLbConfig) Reset()
- func (x *Cluster_RingHashLbConfig) String() string
- type Cluster_RingHashLbConfig_
- type Cluster_RingHashLbConfig_HashFunction
- func (Cluster_RingHashLbConfig_HashFunction) Descriptor() protoreflect.EnumDescriptor
- func (x Cluster_RingHashLbConfig_HashFunction) Enum() *Cluster_RingHashLbConfig_HashFunction
- func (Cluster_RingHashLbConfig_HashFunction) EnumDescriptor() ([]byte, []int)deprecated
- func (x Cluster_RingHashLbConfig_HashFunction) Number() protoreflect.EnumNumber
- func (x Cluster_RingHashLbConfig_HashFunction) String() string
- func (Cluster_RingHashLbConfig_HashFunction) Type() protoreflect.EnumType
- type Cluster_TransportSocketMatch
- func (*Cluster_TransportSocketMatch) Descriptor() ([]byte, []int)deprecated
- func (x *Cluster_TransportSocketMatch) GetMatch() *structpb.Struct
- func (x *Cluster_TransportSocketMatch) GetName() string
- func (x *Cluster_TransportSocketMatch) GetTransportSocket() *core.TransportSocket
- func (*Cluster_TransportSocketMatch) ProtoMessage()
- func (x *Cluster_TransportSocketMatch) ProtoReflect() protoreflect.Message
- func (x *Cluster_TransportSocketMatch) Reset()
- func (x *Cluster_TransportSocketMatch) String() string
- type Cluster_Type
- type DeltaDiscoveryRequest
- func (*DeltaDiscoveryRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeltaDiscoveryRequest) GetErrorDetail() *status.Status
- func (x *DeltaDiscoveryRequest) GetInitialResourceVersions() map[string]string
- func (x *DeltaDiscoveryRequest) GetNode() *core.Node
- func (x *DeltaDiscoveryRequest) GetResourceNamesSubscribe() []string
- func (x *DeltaDiscoveryRequest) GetResourceNamesUnsubscribe() []string
- func (x *DeltaDiscoveryRequest) GetResponseNonce() string
- func (x *DeltaDiscoveryRequest) GetTypeUrl() string
- func (*DeltaDiscoveryRequest) ProtoMessage()
- func (x *DeltaDiscoveryRequest) ProtoReflect() protoreflect.Message
- func (x *DeltaDiscoveryRequest) Reset()
- func (x *DeltaDiscoveryRequest) String() string
- type DeltaDiscoveryResponse
- func (*DeltaDiscoveryResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DeltaDiscoveryResponse) GetNonce() string
- func (x *DeltaDiscoveryResponse) GetRemovedResources() []string
- func (x *DeltaDiscoveryResponse) GetResources() []*Resource
- func (x *DeltaDiscoveryResponse) GetSystemVersionInfo() string
- func (x *DeltaDiscoveryResponse) GetTypeUrl() string
- func (*DeltaDiscoveryResponse) ProtoMessage()
- func (x *DeltaDiscoveryResponse) ProtoReflect() protoreflect.Message
- func (x *DeltaDiscoveryResponse) Reset()
- func (x *DeltaDiscoveryResponse) String() string
- type DiscoveryRequest
- func (*DiscoveryRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DiscoveryRequest) GetErrorDetail() *status.Status
- func (x *DiscoveryRequest) GetNode() *core.Node
- func (x *DiscoveryRequest) GetResourceNames() []string
- func (x *DiscoveryRequest) GetResponseNonce() string
- func (x *DiscoveryRequest) GetTypeUrl() string
- func (x *DiscoveryRequest) GetVersionInfo() string
- func (*DiscoveryRequest) ProtoMessage()
- func (x *DiscoveryRequest) ProtoReflect() protoreflect.Message
- func (x *DiscoveryRequest) Reset()
- func (x *DiscoveryRequest) String() string
- type DiscoveryResponse
- func (*DiscoveryResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DiscoveryResponse) GetCanary() bool
- func (x *DiscoveryResponse) GetControlPlane() *core.ControlPlane
- func (x *DiscoveryResponse) GetNonce() string
- func (x *DiscoveryResponse) GetResources() []*anypb.Any
- func (x *DiscoveryResponse) GetTypeUrl() string
- func (x *DiscoveryResponse) GetVersionInfo() string
- func (*DiscoveryResponse) ProtoMessage()
- func (x *DiscoveryResponse) ProtoReflect() protoreflect.Message
- func (x *DiscoveryResponse) Reset()
- func (x *DiscoveryResponse) String() string
- type EdsDummy
- type LdsDummy
- type Listener
- func (*Listener) Descriptor() ([]byte, []int)deprecated
- func (x *Listener) GetAccessLog() []*v21.AccessLog
- func (x *Listener) GetAddress() *core.Address
- func (x *Listener) GetApiListener() *v2.ApiListener
- func (x *Listener) GetConnectionBalanceConfig() *Listener_ConnectionBalanceConfig
- func (x *Listener) GetContinueOnListenerFiltersTimeout() bool
- func (x *Listener) GetDeprecatedV1() *Listener_DeprecatedV1
- func (x *Listener) GetDrainType() Listener_DrainType
- func (x *Listener) GetFilterChains() []*listener.FilterChain
- func (x *Listener) GetFreebind() *wrapperspb.BoolValue
- func (x *Listener) GetListenerFilters() []*listener.ListenerFilter
- func (x *Listener) GetListenerFiltersTimeout() *durationpb.Duration
- func (x *Listener) GetMetadata() *core.Metadata
- func (x *Listener) GetName() string
- func (x *Listener) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value
- func (x *Listener) GetReusePort() bool
- func (x *Listener) GetSocketOptions() []*core.SocketOption
- func (x *Listener) GetTcpFastOpenQueueLength() *wrapperspb.UInt32Value
- func (x *Listener) GetTrafficDirection() core.TrafficDirection
- func (x *Listener) GetTransparent() *wrapperspb.BoolValue
- func (x *Listener) GetUdpListenerConfig() *listener.UdpListenerConfig
- func (x *Listener) GetUseOriginalDst() *wrapperspb.BoolValuedeprecated
- func (*Listener) ProtoMessage()
- func (x *Listener) ProtoReflect() protoreflect.Message
- func (x *Listener) Reset()
- func (x *Listener) String() string
- type Listener_ConnectionBalanceConfig
- func (*Listener_ConnectionBalanceConfig) Descriptor() ([]byte, []int)deprecated
- func (m *Listener_ConnectionBalanceConfig) GetBalanceType() isListener_ConnectionBalanceConfig_BalanceType
- func (x *Listener_ConnectionBalanceConfig) GetExactBalance() *Listener_ConnectionBalanceConfig_ExactBalance
- func (*Listener_ConnectionBalanceConfig) ProtoMessage()
- func (x *Listener_ConnectionBalanceConfig) ProtoReflect() protoreflect.Message
- func (x *Listener_ConnectionBalanceConfig) Reset()
- func (x *Listener_ConnectionBalanceConfig) String() string
- type Listener_ConnectionBalanceConfig_ExactBalance
- func (*Listener_ConnectionBalanceConfig_ExactBalance) Descriptor() ([]byte, []int)deprecated
- func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoMessage()
- func (x *Listener_ConnectionBalanceConfig_ExactBalance) ProtoReflect() protoreflect.Message
- func (x *Listener_ConnectionBalanceConfig_ExactBalance) Reset()
- func (x *Listener_ConnectionBalanceConfig_ExactBalance) String() string
- type Listener_ConnectionBalanceConfig_ExactBalance_
- type Listener_DeprecatedV1
- func (*Listener_DeprecatedV1) Descriptor() ([]byte, []int)deprecated
- func (x *Listener_DeprecatedV1) GetBindToPort() *wrapperspb.BoolValue
- func (*Listener_DeprecatedV1) ProtoMessage()
- func (x *Listener_DeprecatedV1) ProtoReflect() protoreflect.Message
- func (x *Listener_DeprecatedV1) Reset()
- func (x *Listener_DeprecatedV1) String() string
- type Listener_DrainType
- func (Listener_DrainType) Descriptor() protoreflect.EnumDescriptor
- func (x Listener_DrainType) Enum() *Listener_DrainType
- func (Listener_DrainType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Listener_DrainType) Number() protoreflect.EnumNumber
- func (x Listener_DrainType) String() string
- func (Listener_DrainType) Type() protoreflect.EnumType
- type LoadBalancingPolicy
- func (*LoadBalancingPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *LoadBalancingPolicy) GetPolicies() []*LoadBalancingPolicy_Policy
- func (*LoadBalancingPolicy) ProtoMessage()
- func (x *LoadBalancingPolicy) ProtoReflect() protoreflect.Message
- func (x *LoadBalancingPolicy) Reset()
- func (x *LoadBalancingPolicy) String() string
- type LoadBalancingPolicy_Policy
- func (*LoadBalancingPolicy_Policy) Descriptor() ([]byte, []int)deprecated
- func (x *LoadBalancingPolicy_Policy) GetConfig() *structpb.Structdeprecated
- func (x *LoadBalancingPolicy_Policy) GetName() string
- func (x *LoadBalancingPolicy_Policy) GetTypedConfig() *anypb.Any
- func (*LoadBalancingPolicy_Policy) ProtoMessage()
- func (x *LoadBalancingPolicy_Policy) ProtoReflect() protoreflect.Message
- func (x *LoadBalancingPolicy_Policy) Reset()
- func (x *LoadBalancingPolicy_Policy) String() string
- type RdsDummy
- type Resource
- func (*Resource) Descriptor() ([]byte, []int)deprecated
- func (x *Resource) GetAliases() []string
- func (x *Resource) GetName() string
- func (x *Resource) GetResource() *anypb.Any
- func (x *Resource) GetVersion() string
- func (*Resource) ProtoMessage()
- func (x *Resource) ProtoReflect() protoreflect.Message
- func (x *Resource) Reset()
- func (x *Resource) String() string
- type RouteConfiguration
- func (*RouteConfiguration) Descriptor() ([]byte, []int)deprecated
- func (x *RouteConfiguration) GetInternalOnlyHeaders() []string
- func (x *RouteConfiguration) GetMostSpecificHeaderMutationsWins() bool
- func (x *RouteConfiguration) GetName() string
- func (x *RouteConfiguration) GetRequestHeadersToAdd() []*core.HeaderValueOption
- func (x *RouteConfiguration) GetRequestHeadersToRemove() []string
- func (x *RouteConfiguration) GetResponseHeadersToAdd() []*core.HeaderValueOption
- func (x *RouteConfiguration) GetResponseHeadersToRemove() []string
- func (x *RouteConfiguration) GetValidateClusters() *wrapperspb.BoolValue
- func (x *RouteConfiguration) GetVhds() *Vhds
- func (x *RouteConfiguration) GetVirtualHosts() []*route.VirtualHost
- func (*RouteConfiguration) ProtoMessage()
- func (x *RouteConfiguration) ProtoReflect() protoreflect.Message
- func (x *RouteConfiguration) Reset()
- func (x *RouteConfiguration) String() string
- type ScopedRouteConfiguration
- func (*ScopedRouteConfiguration) Descriptor() ([]byte, []int)deprecated
- func (x *ScopedRouteConfiguration) GetKey() *ScopedRouteConfiguration_Key
- func (x *ScopedRouteConfiguration) GetName() string
- func (x *ScopedRouteConfiguration) GetRouteConfigurationName() string
- func (*ScopedRouteConfiguration) ProtoMessage()
- func (x *ScopedRouteConfiguration) ProtoReflect() protoreflect.Message
- func (x *ScopedRouteConfiguration) Reset()
- func (x *ScopedRouteConfiguration) String() string
- type ScopedRouteConfiguration_Key
- func (*ScopedRouteConfiguration_Key) Descriptor() ([]byte, []int)deprecated
- func (x *ScopedRouteConfiguration_Key) GetFragments() []*ScopedRouteConfiguration_Key_Fragment
- func (*ScopedRouteConfiguration_Key) ProtoMessage()
- func (x *ScopedRouteConfiguration_Key) ProtoReflect() protoreflect.Message
- func (x *ScopedRouteConfiguration_Key) Reset()
- func (x *ScopedRouteConfiguration_Key) String() string
- type ScopedRouteConfiguration_Key_Fragment
- func (*ScopedRouteConfiguration_Key_Fragment) Descriptor() ([]byte, []int)deprecated
- func (x *ScopedRouteConfiguration_Key_Fragment) GetStringKey() string
- func (m *ScopedRouteConfiguration_Key_Fragment) GetType() isScopedRouteConfiguration_Key_Fragment_Type
- func (*ScopedRouteConfiguration_Key_Fragment) ProtoMessage()
- func (x *ScopedRouteConfiguration_Key_Fragment) ProtoReflect() protoreflect.Message
- func (x *ScopedRouteConfiguration_Key_Fragment) Reset()
- func (x *ScopedRouteConfiguration_Key_Fragment) String() string
- type ScopedRouteConfiguration_Key_Fragment_StringKey
- type SrdsDummy
- type UpstreamBindConfig
- func (*UpstreamBindConfig) Descriptor() ([]byte, []int)deprecated
- func (x *UpstreamBindConfig) GetSourceAddress() *core.Address
- func (*UpstreamBindConfig) ProtoMessage()
- func (x *UpstreamBindConfig) ProtoReflect() protoreflect.Message
- func (x *UpstreamBindConfig) Reset()
- func (x *UpstreamBindConfig) String() string
- type UpstreamConnectionOptions
- func (*UpstreamConnectionOptions) Descriptor() ([]byte, []int)deprecated
- func (x *UpstreamConnectionOptions) GetTcpKeepalive() *core.TcpKeepalive
- func (*UpstreamConnectionOptions) ProtoMessage()
- func (x *UpstreamConnectionOptions) ProtoReflect() protoreflect.Message
- func (x *UpstreamConnectionOptions) Reset()
- func (x *UpstreamConnectionOptions) String() string
- type Vhds
Constants ¶
This section is empty.
Variables ¶
var ( Cluster_DiscoveryType_name = map[int32]string{ 0: "STATIC", 1: "STRICT_DNS", 2: "LOGICAL_DNS", 3: "EDS", 4: "ORIGINAL_DST", } Cluster_DiscoveryType_value = map[string]int32{ "STATIC": 0, "STRICT_DNS": 1, "LOGICAL_DNS": 2, "EDS": 3, "ORIGINAL_DST": 4, } )
Enum value maps for Cluster_DiscoveryType.
var ( Cluster_LbPolicy_name = map[int32]string{ 0: "ROUND_ROBIN", 1: "LEAST_REQUEST", 2: "RING_HASH", 3: "RANDOM", 4: "ORIGINAL_DST_LB", 5: "MAGLEV", 6: "CLUSTER_PROVIDED", 7: "LOAD_BALANCING_POLICY_CONFIG", } Cluster_LbPolicy_value = map[string]int32{ "ROUND_ROBIN": 0, "LEAST_REQUEST": 1, "RING_HASH": 2, "RANDOM": 3, "ORIGINAL_DST_LB": 4, "MAGLEV": 5, "CLUSTER_PROVIDED": 6, "LOAD_BALANCING_POLICY_CONFIG": 7, } )
Enum value maps for Cluster_LbPolicy.
var ( Cluster_DnsLookupFamily_name = map[int32]string{ 0: "AUTO", 1: "V4_ONLY", 2: "V6_ONLY", } Cluster_DnsLookupFamily_value = map[string]int32{ "AUTO": 0, "V4_ONLY": 1, "V6_ONLY": 2, } )
Enum value maps for Cluster_DnsLookupFamily.
var ( Cluster_ClusterProtocolSelection_name = map[int32]string{ 0: "USE_CONFIGURED_PROTOCOL", 1: "USE_DOWNSTREAM_PROTOCOL", } Cluster_ClusterProtocolSelection_value = map[string]int32{ "USE_CONFIGURED_PROTOCOL": 0, "USE_DOWNSTREAM_PROTOCOL": 1, } )
Enum value maps for Cluster_ClusterProtocolSelection.
var ( Cluster_LbSubsetConfig_LbSubsetFallbackPolicy_name = map[int32]string{ 0: "NO_FALLBACK", 1: "ANY_ENDPOINT", 2: "DEFAULT_SUBSET", } Cluster_LbSubsetConfig_LbSubsetFallbackPolicy_value = map[string]int32{ "NO_FALLBACK": 0, "ANY_ENDPOINT": 1, "DEFAULT_SUBSET": 2, } )
Enum value maps for Cluster_LbSubsetConfig_LbSubsetFallbackPolicy.
var ( Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy_name = map[int32]string{ 0: "NOT_DEFINED", 1: "NO_FALLBACK", 2: "ANY_ENDPOINT", 3: "DEFAULT_SUBSET", 4: "KEYS_SUBSET", } Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy_value = map[string]int32{ "NOT_DEFINED": 0, "NO_FALLBACK": 1, "ANY_ENDPOINT": 2, "DEFAULT_SUBSET": 3, "KEYS_SUBSET": 4, } )
Enum value maps for Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy.
var ( Cluster_RingHashLbConfig_HashFunction_name = map[int32]string{ 0: "XX_HASH", 1: "MURMUR_HASH_2", } Cluster_RingHashLbConfig_HashFunction_value = map[string]int32{ "XX_HASH": 0, "MURMUR_HASH_2": 1, } )
Enum value maps for Cluster_RingHashLbConfig_HashFunction.
var ( Listener_DrainType_name = map[int32]string{ 0: "DEFAULT", 1: "MODIFY_ONLY", } Listener_DrainType_value = map[string]int32{ "DEFAULT": 0, "MODIFY_ONLY": 1, } )
Enum value maps for Listener_DrainType.
var File_envoy_api_v2_cds_proto protoreflect.FileDescriptor
var File_envoy_api_v2_cluster_proto protoreflect.FileDescriptor
var File_envoy_api_v2_discovery_proto protoreflect.FileDescriptor
var File_envoy_api_v2_eds_proto protoreflect.FileDescriptor
var File_envoy_api_v2_endpoint_proto protoreflect.FileDescriptor
var File_envoy_api_v2_lds_proto protoreflect.FileDescriptor
var File_envoy_api_v2_listener_proto protoreflect.FileDescriptor
var File_envoy_api_v2_rds_proto protoreflect.FileDescriptor
var File_envoy_api_v2_route_proto protoreflect.FileDescriptor
var File_envoy_api_v2_scoped_route_proto protoreflect.FileDescriptor
var File_envoy_api_v2_srds_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CdsDummy ¶
type CdsDummy struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
func (*CdsDummy) ProtoReflect ¶
func (x *CdsDummy) ProtoReflect() protoreflect.Message
type Cluster ¶
type Cluster struct { // Configuration to use different transport sockets for different endpoints. // The entry of *envoy.transport_socket_match* in the // :ref:`LbEndpoint.Metadata <envoy_api_field_endpoint.LbEndpoint.metadata>` // is used to match against the transport sockets as they appear in the list. The first // :ref:`match <envoy_api_msg_Cluster.TransportSocketMatch>` is used. // For example, with the following match // // .. code-block:: yaml // // transport_socket_matches: // - name: "enableMTLS" // match: // acceptMTLS: true // transport_socket: // name: envoy.transport_sockets.tls // config: { ... } # tls socket configuration // - name: "defaultToPlaintext" // match: {} // transport_socket: // name: envoy.transport_sockets.raw_buffer // // Connections to the endpoints whose metadata value under *envoy.transport_socket_match* // having "acceptMTLS"/"true" key/value pair use the "enableMTLS" socket configuration. // // If a :ref:`socket match <envoy_api_msg_Cluster.TransportSocketMatch>` with empty match // criteria is provided, that always match any endpoint. For example, the "defaultToPlaintext" // socket match in case above. // // If an endpoint metadata's value under *envoy.transport_socket_match* does not match any // *TransportSocketMatch*, socket configuration fallbacks to use the *tls_context* or // *transport_socket* specified in this cluster. // // This field allows gradual and flexible transport socket configuration changes. // // The metadata of endpoints in EDS can indicate transport socket capabilities. For example, // an endpoint's metadata can have two key value pairs as "acceptMTLS": "true", // "acceptPlaintext": "true". While some other endpoints, only accepting plaintext traffic // has "acceptPlaintext": "true" metadata information. // // Then the xDS server can configure the CDS to a client, Envoy A, to send mutual TLS // traffic for endpoints with "acceptMTLS": "true", by adding a corresponding // *TransportSocketMatch* in this field. Other client Envoys receive CDS without // *transport_socket_match* set, and still send plain text traffic to the same cluster. // // [#comment:TODO(incfly): add a detailed architecture doc on intended usage.] TransportSocketMatches []*Cluster_TransportSocketMatch `` /* 130-byte string literal not displayed */ // Supplies the name of the cluster which must be unique across all clusters. // The cluster name is used when emitting // :ref:`statistics <config_cluster_manager_cluster_stats>` if :ref:`alt_stat_name // <envoy_api_field_Cluster.alt_stat_name>` is not provided. // Any “:“ in the cluster name will be converted to “_“ when emitting statistics. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // An optional alternative to the cluster name to be used while emitting stats. // Any “:“ in the name will be converted to “_“ when emitting statistics. This should not be // confused with :ref:`Router Filter Header // <config_http_filters_router_x-envoy-upstream-alt-stat-name>`. AltStatName string `protobuf:"bytes,28,opt,name=alt_stat_name,json=altStatName,proto3" json:"alt_stat_name,omitempty"` // Types that are assignable to ClusterDiscoveryType: // // *Cluster_Type // *Cluster_ClusterType ClusterDiscoveryType isCluster_ClusterDiscoveryType `protobuf_oneof:"cluster_discovery_type"` // Configuration to use for EDS updates for the Cluster. EdsClusterConfig *Cluster_EdsClusterConfig `protobuf:"bytes,3,opt,name=eds_cluster_config,json=edsClusterConfig,proto3" json:"eds_cluster_config,omitempty"` // The timeout for new network connections to hosts in the cluster. ConnectTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=connect_timeout,json=connectTimeout,proto3" json:"connect_timeout,omitempty"` // Soft limit on size of the cluster’s connections read and write buffers. If // unspecified, an implementation defined default is applied (1MiB). PerConnectionBufferLimitBytes *wrapperspb.UInt32Value `` /* 154-byte string literal not displayed */ // The :ref:`load balancer type <arch_overview_load_balancing_types>` to use // when picking a host in the cluster. LbPolicy Cluster_LbPolicy `protobuf:"varint,6,opt,name=lb_policy,json=lbPolicy,proto3,enum=envoy.api.v2.Cluster_LbPolicy" json:"lb_policy,omitempty"` // If the service discovery type is // :ref:`STATIC<envoy_api_enum_value_Cluster.DiscoveryType.STATIC>`, // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` // or :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>`, // then hosts is required. // // .. attention:: // // **This field is deprecated**. Set the // :ref:`load_assignment<envoy_api_field_Cluster.load_assignment>` field instead. // // Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto. Hosts []*core.Address `protobuf:"bytes,7,rep,name=hosts,proto3" json:"hosts,omitempty"` // Setting this is required for specifying members of // :ref:`STATIC<envoy_api_enum_value_Cluster.DiscoveryType.STATIC>`, // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` // or :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>` clusters. // This field supersedes the *hosts* field in the v2 API. // // .. attention:: // // Setting this allows non-EDS cluster types to contain embedded EDS equivalent // :ref:`endpoint assignments<envoy_api_msg_ClusterLoadAssignment>`. LoadAssignment *ClusterLoadAssignment `protobuf:"bytes,33,opt,name=load_assignment,json=loadAssignment,proto3" json:"load_assignment,omitempty"` // Optional :ref:`active health checking <arch_overview_health_checking>` // configuration for the cluster. If no // configuration is specified no health checking will be done and all cluster // members will be considered healthy at all times. HealthChecks []*core.HealthCheck `protobuf:"bytes,8,rep,name=health_checks,json=healthChecks,proto3" json:"health_checks,omitempty"` // Optional maximum requests for a single upstream connection. This parameter // is respected by both the HTTP/1.1 and HTTP/2 connection pool // implementations. If not specified, there is no limit. Setting this // parameter to 1 will effectively disable keep alive. MaxRequestsPerConnection *wrapperspb.UInt32Value `` /* 137-byte string literal not displayed */ // Optional :ref:`circuit breaking <arch_overview_circuit_break>` for the cluster. CircuitBreakers *cluster.CircuitBreakers `protobuf:"bytes,10,opt,name=circuit_breakers,json=circuitBreakers,proto3" json:"circuit_breakers,omitempty"` // The TLS configuration for connections to the upstream cluster. // // .. attention:: // // **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are // set, `transport_socket` takes priority. // // Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto. TlsContext *auth.UpstreamTlsContext `protobuf:"bytes,11,opt,name=tls_context,json=tlsContext,proto3" json:"tls_context,omitempty"` // HTTP protocol options that are applied only to upstream HTTP connections. // These options apply to all HTTP versions. UpstreamHttpProtocolOptions *core.UpstreamHttpProtocolOptions `` /* 147-byte string literal not displayed */ // Additional options when handling HTTP requests upstream. These options will be applicable to // both HTTP1 and HTTP2 requests. CommonHttpProtocolOptions *core.HttpProtocolOptions `` /* 141-byte string literal not displayed */ // Additional options when handling HTTP1 requests. HttpProtocolOptions *core.Http1ProtocolOptions `protobuf:"bytes,13,opt,name=http_protocol_options,json=httpProtocolOptions,proto3" json:"http_protocol_options,omitempty"` // Even if default HTTP2 protocol options are desired, this field must be // set so that Envoy will assume that the upstream supports HTTP/2 when // making new HTTP connection pool connections. Currently, Envoy only // supports prior knowledge for upstream connections. Even if TLS is used // with ALPN, `http2_protocol_options` must be specified. As an aside this allows HTTP/2 // connections to happen over plain text. Http2ProtocolOptions *core.Http2ProtocolOptions `protobuf:"bytes,14,opt,name=http2_protocol_options,json=http2ProtocolOptions,proto3" json:"http2_protocol_options,omitempty"` // The extension_protocol_options field is used to provide extension-specific protocol options // for upstream connections. The key should match the extension filter name, such as // "envoy.filters.network.thrift_proxy". See the extension's documentation for details on // specific options. // // Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto. ExtensionProtocolOptions map[string]*structpb.Struct `` /* 224-byte string literal not displayed */ // The extension_protocol_options field is used to provide extension-specific protocol options // for upstream connections. The key should match the extension filter name, such as // "envoy.filters.network.thrift_proxy". See the extension's documentation for details on // specific options. TypedExtensionProtocolOptions map[string]*anypb.Any `` /* 241-byte string literal not displayed */ // If the DNS refresh rate is specified and the cluster type is either // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>`, // or :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>`, // this value is used as the cluster’s DNS refresh // rate. The value configured must be at least 1ms. If this setting is not specified, the // value defaults to 5000ms. For cluster types other than // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` // and :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>` // this setting is ignored. DnsRefreshRate *durationpb.Duration `protobuf:"bytes,16,opt,name=dns_refresh_rate,json=dnsRefreshRate,proto3" json:"dns_refresh_rate,omitempty"` // If the DNS failure refresh rate is specified and the cluster type is either // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>`, // or :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>`, // this is used as the cluster’s DNS refresh rate when requests are failing. If this setting is // not specified, the failure refresh rate defaults to the DNS refresh rate. For cluster types // other than :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` and // :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>` this setting is // ignored. DnsFailureRefreshRate *Cluster_RefreshRate `` /* 129-byte string literal not displayed */ // Optional configuration for setting cluster's DNS refresh rate. If the value is set to true, // cluster's DNS refresh rate will be set to resource record's TTL which comes from DNS // resolution. RespectDnsTtl bool `protobuf:"varint,39,opt,name=respect_dns_ttl,json=respectDnsTtl,proto3" json:"respect_dns_ttl,omitempty"` // The DNS IP address resolution policy. If this setting is not specified, the // value defaults to // :ref:`AUTO<envoy_api_enum_value_Cluster.DnsLookupFamily.AUTO>`. DnsLookupFamily Cluster_DnsLookupFamily `` /* 152-byte string literal not displayed */ // If DNS resolvers are specified and the cluster type is either // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>`, // or :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>`, // this value is used to specify the cluster’s dns resolvers. // If this setting is not specified, the value defaults to the default // resolver, which uses /etc/resolv.conf for configuration. For cluster types // other than // :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` // and :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>` // this setting is ignored. // Setting this value causes failure if the // “envoy.restart_features.use_apple_api_for_dns_lookups“ runtime value is true during // server startup. Apple's API only allows overriding DNS resolvers via system settings. DnsResolvers []*core.Address `protobuf:"bytes,18,rep,name=dns_resolvers,json=dnsResolvers,proto3" json:"dns_resolvers,omitempty"` // [#next-major-version: Reconcile DNS options in a single message.] // Always use TCP queries instead of UDP queries for DNS lookups. // Setting this value causes failure if the // “envoy.restart_features.use_apple_api_for_dns_lookups“ runtime value is true during // server startup. Apple' API only uses UDP for DNS resolution. UseTcpForDnsLookups bool `` /* 126-byte string literal not displayed */ // If specified, outlier detection will be enabled for this upstream cluster. // Each of the configuration values can be overridden via // :ref:`runtime values <config_cluster_manager_cluster_runtime_outlier_detection>`. OutlierDetection *cluster.OutlierDetection `protobuf:"bytes,19,opt,name=outlier_detection,json=outlierDetection,proto3" json:"outlier_detection,omitempty"` // The interval for removing stale hosts from a cluster type // :ref:`ORIGINAL_DST<envoy_api_enum_value_Cluster.DiscoveryType.ORIGINAL_DST>`. // Hosts are considered stale if they have not been used // as upstream destinations during this interval. New hosts are added // to original destination clusters on demand as new connections are // redirected to Envoy, causing the number of hosts in the cluster to // grow over time. Hosts that are not stale (they are actively used as // destinations) are kept in the cluster, which allows connections to // them remain open, saving the latency that would otherwise be spent // on opening new connections. If this setting is not specified, the // value defaults to 5000ms. For cluster types other than // :ref:`ORIGINAL_DST<envoy_api_enum_value_Cluster.DiscoveryType.ORIGINAL_DST>` // this setting is ignored. CleanupInterval *durationpb.Duration `protobuf:"bytes,20,opt,name=cleanup_interval,json=cleanupInterval,proto3" json:"cleanup_interval,omitempty"` // Optional configuration used to bind newly established upstream connections. // This overrides any bind_config specified in the bootstrap proto. // If the address and port are empty, no bind will be performed. UpstreamBindConfig *core.BindConfig `protobuf:"bytes,21,opt,name=upstream_bind_config,json=upstreamBindConfig,proto3" json:"upstream_bind_config,omitempty"` // Configuration for load balancing subsetting. LbSubsetConfig *Cluster_LbSubsetConfig `protobuf:"bytes,22,opt,name=lb_subset_config,json=lbSubsetConfig,proto3" json:"lb_subset_config,omitempty"` // Optional configuration for the load balancing algorithm selected by // LbPolicy. Currently only // :ref:`RING_HASH<envoy_api_enum_value_Cluster.LbPolicy.RING_HASH>` and // :ref:`LEAST_REQUEST<envoy_api_enum_value_Cluster.LbPolicy.LEAST_REQUEST>` // has additional configuration options. // Specifying ring_hash_lb_config or least_request_lb_config without setting the corresponding // LbPolicy will generate an error at runtime. // // Types that are assignable to LbConfig: // // *Cluster_RingHashLbConfig_ // *Cluster_OriginalDstLbConfig_ // *Cluster_LeastRequestLbConfig_ LbConfig isCluster_LbConfig `protobuf_oneof:"lb_config"` // Common configuration for all load balancer implementations. CommonLbConfig *Cluster_CommonLbConfig `protobuf:"bytes,27,opt,name=common_lb_config,json=commonLbConfig,proto3" json:"common_lb_config,omitempty"` // Optional custom transport socket implementation to use for upstream connections. // To setup TLS, set a transport socket with name `tls` and // :ref:`UpstreamTlsContexts <envoy_api_msg_auth.UpstreamTlsContext>` in the `typed_config`. // If no transport socket configuration is specified, new connections // will be set up with plaintext. TransportSocket *core.TransportSocket `protobuf:"bytes,24,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"` // The Metadata field can be used to provide additional information about the // cluster. It can be used for stats, logging, and varying filter behavior. // Fields should use reverse DNS notation to denote which entity within Envoy // will need the information. For instance, if the metadata is intended for // the Router filter, the filter name should be specified as *envoy.filters.http.router*. Metadata *core.Metadata `protobuf:"bytes,25,opt,name=metadata,proto3" json:"metadata,omitempty"` // Determines how Envoy selects the protocol used to speak to upstream hosts. ProtocolSelection Cluster_ClusterProtocolSelection `` /* 165-byte string literal not displayed */ // Optional options for upstream connections. UpstreamConnectionOptions *UpstreamConnectionOptions `` /* 139-byte string literal not displayed */ // If an upstream host becomes unhealthy (as determined by the configured health checks // or outlier detection), immediately close all connections to the failed host. // // .. note:: // // This is currently only supported for connections created by tcp_proxy. // // .. note:: // // The current implementation of this feature closes all connections immediately when // the unhealthy status is detected. If there are a large number of connections open // to an upstream host that becomes unhealthy, Envoy may spend a substantial amount of // time exclusively closing these connections, and not processing any other traffic. CloseConnectionsOnHostHealthFailure bool `` /* 176-byte string literal not displayed */ // If set to true, Envoy will ignore the health value of a host when processing its removal // from service discovery. This means that if active health checking is used, Envoy will *not* // wait for the endpoint to go unhealthy before removing it. DrainConnectionsOnHostRemoval bool `` /* 156-byte string literal not displayed */ // An (optional) network filter chain, listed in the order the filters should be applied. // The chain will be applied to all outgoing connections that Envoy makes to the upstream // servers of this cluster. Filters []*cluster.Filter `protobuf:"bytes,40,rep,name=filters,proto3" json:"filters,omitempty"` // [#not-implemented-hide:] New mechanism for LB policy configuration. Used only if the // :ref:`lb_policy<envoy_api_field_Cluster.lb_policy>` field has the value // :ref:`LOAD_BALANCING_POLICY_CONFIG<envoy_api_enum_value_Cluster.LbPolicy.LOAD_BALANCING_POLICY_CONFIG>`. LoadBalancingPolicy *LoadBalancingPolicy `protobuf:"bytes,41,opt,name=load_balancing_policy,json=loadBalancingPolicy,proto3" json:"load_balancing_policy,omitempty"` // [#not-implemented-hide:] // If present, tells the client where to send load reports via LRS. If not present, the // client will fall back to a client-side default, which may be either (a) don't send any // load reports or (b) send load reports for all clusters to a single default server // (which may be configured in the bootstrap file). // // Note that if multiple clusters point to the same LRS server, the client may choose to // create a separate stream for each cluster or it may choose to coalesce the data for // multiple clusters onto a single stream. Either way, the client must make sure to send // the data for any given cluster on no more than one stream. // // [#next-major-version: In the v3 API, we should consider restructuring this somehow, // maybe by allowing LRS to go on the ADS stream, or maybe by moving some of the negotiation // from the LRS stream here.] LrsServer *core.ConfigSource `protobuf:"bytes,42,opt,name=lrs_server,json=lrsServer,proto3" json:"lrs_server,omitempty"` // If track_timeout_budgets is true, the :ref:`timeout budget histograms // <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each // request. These show what percentage of a request's per try and global timeout was used. A value // of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value // of 100 would indicate that the request took the entirety of the timeout given to it. TrackTimeoutBudgets bool `protobuf:"varint,47,opt,name=track_timeout_budgets,json=trackTimeoutBudgets,proto3" json:"track_timeout_budgets,omitempty"` // contains filtered or unexported fields }
Configuration for a single upstream cluster. [#next-free-field: 48]
func (*Cluster) GetCircuitBreakers ¶
func (x *Cluster) GetCircuitBreakers() *cluster.CircuitBreakers
func (*Cluster) GetCleanupInterval ¶
func (x *Cluster) GetCleanupInterval() *durationpb.Duration
func (*Cluster) GetCloseConnectionsOnHostHealthFailure ¶
func (*Cluster) GetClusterDiscoveryType ¶
func (m *Cluster) GetClusterDiscoveryType() isCluster_ClusterDiscoveryType
func (*Cluster) GetClusterType ¶
func (x *Cluster) GetClusterType() *Cluster_CustomClusterType
func (*Cluster) GetCommonHttpProtocolOptions ¶
func (x *Cluster) GetCommonHttpProtocolOptions() *core.HttpProtocolOptions
func (*Cluster) GetCommonLbConfig ¶
func (x *Cluster) GetCommonLbConfig() *Cluster_CommonLbConfig
func (*Cluster) GetConnectTimeout ¶
func (x *Cluster) GetConnectTimeout() *durationpb.Duration
func (*Cluster) GetDnsFailureRefreshRate ¶
func (x *Cluster) GetDnsFailureRefreshRate() *Cluster_RefreshRate
func (*Cluster) GetDnsLookupFamily ¶
func (x *Cluster) GetDnsLookupFamily() Cluster_DnsLookupFamily
func (*Cluster) GetDnsRefreshRate ¶
func (x *Cluster) GetDnsRefreshRate() *durationpb.Duration
func (*Cluster) GetDrainConnectionsOnHostRemoval ¶
func (*Cluster) GetEdsClusterConfig ¶
func (x *Cluster) GetEdsClusterConfig() *Cluster_EdsClusterConfig
func (*Cluster) GetHealthChecks ¶
func (x *Cluster) GetHealthChecks() []*core.HealthCheck
func (*Cluster) GetHttp2ProtocolOptions ¶
func (x *Cluster) GetHttp2ProtocolOptions() *core.Http2ProtocolOptions
func (*Cluster) GetHttpProtocolOptions ¶
func (x *Cluster) GetHttpProtocolOptions() *core.Http1ProtocolOptions
func (*Cluster) GetLbPolicy ¶
func (x *Cluster) GetLbPolicy() Cluster_LbPolicy
func (*Cluster) GetLbSubsetConfig ¶
func (x *Cluster) GetLbSubsetConfig() *Cluster_LbSubsetConfig
func (*Cluster) GetLeastRequestLbConfig ¶
func (x *Cluster) GetLeastRequestLbConfig() *Cluster_LeastRequestLbConfig
func (*Cluster) GetLoadAssignment ¶
func (x *Cluster) GetLoadAssignment() *ClusterLoadAssignment
func (*Cluster) GetLoadBalancingPolicy ¶
func (x *Cluster) GetLoadBalancingPolicy() *LoadBalancingPolicy
func (*Cluster) GetLrsServer ¶
func (x *Cluster) GetLrsServer() *core.ConfigSource
func (*Cluster) GetMaxRequestsPerConnection ¶
func (x *Cluster) GetMaxRequestsPerConnection() *wrapperspb.UInt32Value
func (*Cluster) GetOriginalDstLbConfig ¶
func (x *Cluster) GetOriginalDstLbConfig() *Cluster_OriginalDstLbConfig
func (*Cluster) GetOutlierDetection ¶
func (x *Cluster) GetOutlierDetection() *cluster.OutlierDetection
func (*Cluster) GetPerConnectionBufferLimitBytes ¶
func (x *Cluster) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value
func (*Cluster) GetProtocolSelection ¶
func (x *Cluster) GetProtocolSelection() Cluster_ClusterProtocolSelection
func (*Cluster) GetRingHashLbConfig ¶
func (x *Cluster) GetRingHashLbConfig() *Cluster_RingHashLbConfig
func (*Cluster) GetTlsContext
deprecated
func (x *Cluster) GetTlsContext() *auth.UpstreamTlsContext
Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto.
func (*Cluster) GetTransportSocket ¶
func (x *Cluster) GetTransportSocket() *core.TransportSocket
func (*Cluster) GetTransportSocketMatches ¶
func (x *Cluster) GetTransportSocketMatches() []*Cluster_TransportSocketMatch
func (*Cluster) GetType ¶
func (x *Cluster) GetType() Cluster_DiscoveryType
func (*Cluster) GetTypedExtensionProtocolOptions ¶
func (*Cluster) GetUpstreamBindConfig ¶
func (x *Cluster) GetUpstreamBindConfig() *core.BindConfig
func (*Cluster) GetUpstreamConnectionOptions ¶
func (x *Cluster) GetUpstreamConnectionOptions() *UpstreamConnectionOptions
func (*Cluster) GetUpstreamHttpProtocolOptions ¶
func (x *Cluster) GetUpstreamHttpProtocolOptions() *core.UpstreamHttpProtocolOptions
func (*Cluster) ProtoReflect ¶
func (x *Cluster) ProtoReflect() protoreflect.Message
type ClusterLoadAssignment ¶
type ClusterLoadAssignment struct { // Name of the cluster. This will be the :ref:`service_name // <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified // in the cluster :ref:`EdsClusterConfig // <envoy_api_msg_Cluster.EdsClusterConfig>`. ClusterName string `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"` // List of endpoints to load balance to. Endpoints []*endpoint.LocalityLbEndpoints `protobuf:"bytes,2,rep,name=endpoints,proto3" json:"endpoints,omitempty"` // Map of named endpoints that can be referenced in LocalityLbEndpoints. // [#not-implemented-hide:] NamedEndpoints map[string]*endpoint.Endpoint `` /* 191-byte string literal not displayed */ // Load balancing policy settings. Policy *ClusterLoadAssignment_Policy `protobuf:"bytes,4,opt,name=policy,proto3" json:"policy,omitempty"` // contains filtered or unexported fields }
Each route from RDS will map to a single cluster or traffic split across clusters using weights expressed in the RDS WeightedCluster.
With EDS, each cluster is treated independently from a LB perspective, with LB taking place between the Localities within a cluster and at a finer granularity between the hosts within a locality. The percentage of traffic for each endpoint is determined by both its load_balancing_weight, and the load_balancing_weight of its locality. First, a locality will be selected, then an endpoint within that locality will be chose based on its weight. [#next-free-field: 6]
func (*ClusterLoadAssignment) Descriptor
deprecated
func (*ClusterLoadAssignment) Descriptor() ([]byte, []int)
Deprecated: Use ClusterLoadAssignment.ProtoReflect.Descriptor instead.
func (*ClusterLoadAssignment) GetClusterName ¶
func (x *ClusterLoadAssignment) GetClusterName() string
func (*ClusterLoadAssignment) GetEndpoints ¶
func (x *ClusterLoadAssignment) GetEndpoints() []*endpoint.LocalityLbEndpoints
func (*ClusterLoadAssignment) GetNamedEndpoints ¶
func (x *ClusterLoadAssignment) GetNamedEndpoints() map[string]*endpoint.Endpoint
func (*ClusterLoadAssignment) GetPolicy ¶
func (x *ClusterLoadAssignment) GetPolicy() *ClusterLoadAssignment_Policy
func (*ClusterLoadAssignment) ProtoMessage ¶
func (*ClusterLoadAssignment) ProtoMessage()
func (*ClusterLoadAssignment) ProtoReflect ¶
func (x *ClusterLoadAssignment) ProtoReflect() protoreflect.Message
func (*ClusterLoadAssignment) Reset ¶
func (x *ClusterLoadAssignment) Reset()
func (*ClusterLoadAssignment) String ¶
func (x *ClusterLoadAssignment) String() string
type ClusterLoadAssignment_Policy ¶
type ClusterLoadAssignment_Policy struct { // Action to trim the overall incoming traffic to protect the upstream // hosts. This action allows protection in case the hosts are unable to // recover from an outage, or unable to autoscale or unable to handle // incoming traffic volume for any reason. // // At the client each category is applied one after the other to generate // the 'actual' drop percentage on all outgoing traffic. For example: // // .. code-block:: json // // { "drop_overloads": [ // { "category": "throttle", "drop_percentage": 60 } // { "category": "lb", "drop_percentage": 50 } // ]} // // The actual drop percentages applied to the traffic at the clients will be // // "throttle"_drop = 60% // "lb"_drop = 20% // 50% of the remaining 'actual' load, which is 40%. // actual_outgoing_load = 20% // remaining after applying all categories. // // [#not-implemented-hide:] DropOverloads []*ClusterLoadAssignment_Policy_DropOverload `protobuf:"bytes,2,rep,name=drop_overloads,json=dropOverloads,proto3" json:"drop_overloads,omitempty"` // Priority levels and localities are considered overprovisioned with this // factor (in percentage). This means that we don't consider a priority // level or locality unhealthy until the percentage of healthy hosts // multiplied by the overprovisioning factor drops below 100. // With the default value 140(1.4), Envoy doesn't consider a priority level // or a locality unhealthy until their percentage of healthy hosts drops // below 72%. For example: // // .. code-block:: json // // { "overprovisioning_factor": 100 } // // Read more at :ref:`priority levels <arch_overview_load_balancing_priority_levels>` and // :ref:`localities <arch_overview_load_balancing_locality_weighted_lb>`. OverprovisioningFactor *wrapperspb.UInt32Value `` /* 127-byte string literal not displayed */ // The max time until which the endpoints from this assignment can be used. // If no new assignments are received before this time expires the endpoints // are considered stale and should be marked unhealthy. // Defaults to 0 which means endpoints never go stale. EndpointStaleAfter *durationpb.Duration `protobuf:"bytes,4,opt,name=endpoint_stale_after,json=endpointStaleAfter,proto3" json:"endpoint_stale_after,omitempty"` // The flag to disable overprovisioning. If it is set to true, // :ref:`overprovisioning factor // <arch_overview_load_balancing_overprovisioning_factor>` will be ignored // and Envoy will not perform graceful failover between priority levels or // localities as endpoints become unhealthy. Otherwise Envoy will perform // graceful failover as :ref:`overprovisioning factor // <arch_overview_load_balancing_overprovisioning_factor>` suggests. // [#not-implemented-hide:] // // Deprecated: Marked as deprecated in envoy/api/v2/endpoint.proto. DisableOverprovisioning bool `` /* 131-byte string literal not displayed */ // contains filtered or unexported fields }
Load balancing policy settings. [#next-free-field: 6]
func (*ClusterLoadAssignment_Policy) Descriptor
deprecated
func (*ClusterLoadAssignment_Policy) Descriptor() ([]byte, []int)
Deprecated: Use ClusterLoadAssignment_Policy.ProtoReflect.Descriptor instead.
func (*ClusterLoadAssignment_Policy) GetDisableOverprovisioning
deprecated
func (x *ClusterLoadAssignment_Policy) GetDisableOverprovisioning() bool
Deprecated: Marked as deprecated in envoy/api/v2/endpoint.proto.
func (*ClusterLoadAssignment_Policy) GetDropOverloads ¶
func (x *ClusterLoadAssignment_Policy) GetDropOverloads() []*ClusterLoadAssignment_Policy_DropOverload
func (*ClusterLoadAssignment_Policy) GetEndpointStaleAfter ¶
func (x *ClusterLoadAssignment_Policy) GetEndpointStaleAfter() *durationpb.Duration
func (*ClusterLoadAssignment_Policy) GetOverprovisioningFactor ¶
func (x *ClusterLoadAssignment_Policy) GetOverprovisioningFactor() *wrapperspb.UInt32Value
func (*ClusterLoadAssignment_Policy) ProtoMessage ¶
func (*ClusterLoadAssignment_Policy) ProtoMessage()
func (*ClusterLoadAssignment_Policy) ProtoReflect ¶
func (x *ClusterLoadAssignment_Policy) ProtoReflect() protoreflect.Message
func (*ClusterLoadAssignment_Policy) Reset ¶
func (x *ClusterLoadAssignment_Policy) Reset()
func (*ClusterLoadAssignment_Policy) String ¶
func (x *ClusterLoadAssignment_Policy) String() string
type ClusterLoadAssignment_Policy_DropOverload ¶
type ClusterLoadAssignment_Policy_DropOverload struct { // Identifier for the policy specifying the drop. Category string `protobuf:"bytes,1,opt,name=category,proto3" json:"category,omitempty"` // Percentage of traffic that should be dropped for the category. DropPercentage *_type.FractionalPercent `protobuf:"bytes,2,opt,name=drop_percentage,json=dropPercentage,proto3" json:"drop_percentage,omitempty"` // contains filtered or unexported fields }
[#not-implemented-hide:]
func (*ClusterLoadAssignment_Policy_DropOverload) Descriptor
deprecated
func (*ClusterLoadAssignment_Policy_DropOverload) Descriptor() ([]byte, []int)
Deprecated: Use ClusterLoadAssignment_Policy_DropOverload.ProtoReflect.Descriptor instead.
func (*ClusterLoadAssignment_Policy_DropOverload) GetCategory ¶
func (x *ClusterLoadAssignment_Policy_DropOverload) GetCategory() string
func (*ClusterLoadAssignment_Policy_DropOverload) GetDropPercentage ¶
func (x *ClusterLoadAssignment_Policy_DropOverload) GetDropPercentage() *_type.FractionalPercent
func (*ClusterLoadAssignment_Policy_DropOverload) ProtoMessage ¶
func (*ClusterLoadAssignment_Policy_DropOverload) ProtoMessage()
func (*ClusterLoadAssignment_Policy_DropOverload) ProtoReflect ¶
func (x *ClusterLoadAssignment_Policy_DropOverload) ProtoReflect() protoreflect.Message
func (*ClusterLoadAssignment_Policy_DropOverload) Reset ¶
func (x *ClusterLoadAssignment_Policy_DropOverload) Reset()
func (*ClusterLoadAssignment_Policy_DropOverload) String ¶
func (x *ClusterLoadAssignment_Policy_DropOverload) String() string
type Cluster_ClusterProtocolSelection ¶
type Cluster_ClusterProtocolSelection int32
const ( // Cluster can only operate on one of the possible upstream protocols (HTTP1.1, HTTP2). // If :ref:`http2_protocol_options <envoy_api_field_Cluster.http2_protocol_options>` are // present, HTTP2 will be used, otherwise HTTP1.1 will be used. Cluster_USE_CONFIGURED_PROTOCOL Cluster_ClusterProtocolSelection = 0 // Use HTTP1.1 or HTTP2, depending on which one is used on the downstream connection. Cluster_USE_DOWNSTREAM_PROTOCOL Cluster_ClusterProtocolSelection = 1 )
func (Cluster_ClusterProtocolSelection) Descriptor ¶
func (Cluster_ClusterProtocolSelection) Descriptor() protoreflect.EnumDescriptor
func (Cluster_ClusterProtocolSelection) Enum ¶
func (x Cluster_ClusterProtocolSelection) Enum() *Cluster_ClusterProtocolSelection
func (Cluster_ClusterProtocolSelection) EnumDescriptor
deprecated
func (Cluster_ClusterProtocolSelection) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_ClusterProtocolSelection.Descriptor instead.
func (Cluster_ClusterProtocolSelection) Number ¶
func (x Cluster_ClusterProtocolSelection) Number() protoreflect.EnumNumber
func (Cluster_ClusterProtocolSelection) String ¶
func (x Cluster_ClusterProtocolSelection) String() string
func (Cluster_ClusterProtocolSelection) Type ¶
func (Cluster_ClusterProtocolSelection) Type() protoreflect.EnumType
type Cluster_ClusterType ¶
type Cluster_ClusterType struct { // The custom cluster type. ClusterType *Cluster_CustomClusterType `protobuf:"bytes,38,opt,name=cluster_type,json=clusterType,proto3,oneof"` }
type Cluster_CommonLbConfig ¶
type Cluster_CommonLbConfig struct { // Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`. // If not specified, the default is 50%. // To disable panic mode, set to 0%. // // .. note:: // // The specified percent will be truncated to the nearest 1%. HealthyPanicThreshold *_type.Percent `` /* 126-byte string literal not displayed */ // Types that are assignable to LocalityConfigSpecifier: // // *Cluster_CommonLbConfig_ZoneAwareLbConfig_ // *Cluster_CommonLbConfig_LocalityWeightedLbConfig_ LocalityConfigSpecifier isCluster_CommonLbConfig_LocalityConfigSpecifier `protobuf_oneof:"locality_config_specifier"` // If set, all health check/weight/metadata updates that happen within this duration will be // merged and delivered in one shot when the duration expires. The start of the duration is when // the first update happens. This is useful for big clusters, with potentially noisy deploys // that might trigger excessive CPU usage due to a constant stream of healthcheck state changes // or metadata updates. The first set of updates to be seen apply immediately (e.g.: a new // cluster). Please always keep in mind that the use of sandbox technologies may change this // behavior. // // If this is not set, we default to a merge window of 1000ms. To disable it, set the merge // window to 0. // // Note: merging does not apply to cluster membership changes (e.g.: adds/removes); this is // because merging those updates isn't currently safe. See // https://github.com/envoyproxy/envoy/pull/3941. UpdateMergeWindow *durationpb.Duration `protobuf:"bytes,4,opt,name=update_merge_window,json=updateMergeWindow,proto3" json:"update_merge_window,omitempty"` // If set to true, Envoy will not consider new hosts when computing load balancing weights until // they have been health checked for the first time. This will have no effect unless // active health checking is also configured. // // Ignoring a host means that for any load balancing calculations that adjust weights based // on the ratio of eligible hosts and total hosts (priority spillover, locality weighting and // panic mode) Envoy will exclude these hosts in the denominator. // // For example, with hosts in two priorities P0 and P1, where P0 looks like // {healthy, unhealthy (new), unhealthy (new)} // and where P1 looks like // {healthy, healthy} // all traffic will still hit P0, as 1 / (3 - 2) = 1. // // Enabling this will allow scaling up the number of hosts for a given cluster without entering // panic mode or triggering priority spillover, assuming the hosts pass the first health check. // // If panic mode is triggered, new hosts are still eligible for traffic; they simply do not // contribute to the calculation when deciding whether panic mode is enabled or not. IgnoreNewHostsUntilFirstHc bool `` /* 148-byte string literal not displayed */ // If set to `true`, the cluster manager will drain all existing // connections to upstream hosts whenever hosts are added or removed from the cluster. CloseConnectionsOnHostSetChange bool `` /* 163-byte string literal not displayed */ // Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.) ConsistentHashingLbConfig *Cluster_CommonLbConfig_ConsistentHashingLbConfig `` /* 140-byte string literal not displayed */ // contains filtered or unexported fields }
Common configuration for all load balancer implementations. [#next-free-field: 8]
func (*Cluster_CommonLbConfig) Descriptor
deprecated
func (*Cluster_CommonLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_CommonLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_CommonLbConfig) GetCloseConnectionsOnHostSetChange ¶
func (x *Cluster_CommonLbConfig) GetCloseConnectionsOnHostSetChange() bool
func (*Cluster_CommonLbConfig) GetConsistentHashingLbConfig ¶
func (x *Cluster_CommonLbConfig) GetConsistentHashingLbConfig() *Cluster_CommonLbConfig_ConsistentHashingLbConfig
func (*Cluster_CommonLbConfig) GetHealthyPanicThreshold ¶
func (x *Cluster_CommonLbConfig) GetHealthyPanicThreshold() *_type.Percent
func (*Cluster_CommonLbConfig) GetIgnoreNewHostsUntilFirstHc ¶
func (x *Cluster_CommonLbConfig) GetIgnoreNewHostsUntilFirstHc() bool
func (*Cluster_CommonLbConfig) GetLocalityConfigSpecifier ¶
func (m *Cluster_CommonLbConfig) GetLocalityConfigSpecifier() isCluster_CommonLbConfig_LocalityConfigSpecifier
func (*Cluster_CommonLbConfig) GetLocalityWeightedLbConfig ¶
func (x *Cluster_CommonLbConfig) GetLocalityWeightedLbConfig() *Cluster_CommonLbConfig_LocalityWeightedLbConfig
func (*Cluster_CommonLbConfig) GetUpdateMergeWindow ¶
func (x *Cluster_CommonLbConfig) GetUpdateMergeWindow() *durationpb.Duration
func (*Cluster_CommonLbConfig) GetZoneAwareLbConfig ¶
func (x *Cluster_CommonLbConfig) GetZoneAwareLbConfig() *Cluster_CommonLbConfig_ZoneAwareLbConfig
func (*Cluster_CommonLbConfig) ProtoMessage ¶
func (*Cluster_CommonLbConfig) ProtoMessage()
func (*Cluster_CommonLbConfig) ProtoReflect ¶
func (x *Cluster_CommonLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_CommonLbConfig) Reset ¶
func (x *Cluster_CommonLbConfig) Reset()
func (*Cluster_CommonLbConfig) String ¶
func (x *Cluster_CommonLbConfig) String() string
type Cluster_CommonLbConfig_ConsistentHashingLbConfig ¶
type Cluster_CommonLbConfig_ConsistentHashingLbConfig struct { // If set to `true`, the cluster will use hostname instead of the resolved // address as the key to consistently hash to an upstream host. Only valid for StrictDNS clusters with hostnames which resolve to a single IP address. UseHostnameForHashing bool `` /* 129-byte string literal not displayed */ // contains filtered or unexported fields }
Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) Descriptor
deprecated
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_CommonLbConfig_ConsistentHashingLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) GetUseHostnameForHashing ¶
func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) GetUseHostnameForHashing() bool
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoMessage ¶
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoMessage()
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoReflect ¶
func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) Reset ¶
func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) Reset()
func (*Cluster_CommonLbConfig_ConsistentHashingLbConfig) String ¶
func (x *Cluster_CommonLbConfig_ConsistentHashingLbConfig) String() string
type Cluster_CommonLbConfig_LocalityWeightedLbConfig ¶
type Cluster_CommonLbConfig_LocalityWeightedLbConfig struct {
// contains filtered or unexported fields
}
Configuration for :ref:`locality weighted load balancing <arch_overview_load_balancing_locality_weighted_lb>`
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) Descriptor
deprecated
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_CommonLbConfig_LocalityWeightedLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoMessage ¶
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoMessage()
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoReflect ¶
func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) Reset ¶
func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) Reset()
func (*Cluster_CommonLbConfig_LocalityWeightedLbConfig) String ¶
func (x *Cluster_CommonLbConfig_LocalityWeightedLbConfig) String() string
type Cluster_CommonLbConfig_LocalityWeightedLbConfig_ ¶
type Cluster_CommonLbConfig_LocalityWeightedLbConfig_ struct {
LocalityWeightedLbConfig *Cluster_CommonLbConfig_LocalityWeightedLbConfig `protobuf:"bytes,3,opt,name=locality_weighted_lb_config,json=localityWeightedLbConfig,proto3,oneof"`
}
type Cluster_CommonLbConfig_ZoneAwareLbConfig ¶
type Cluster_CommonLbConfig_ZoneAwareLbConfig struct { // Configures percentage of requests that will be considered for zone aware routing // if zone aware routing is configured. If not specified, the default is 100%. // * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`. // * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`. RoutingEnabled *_type.Percent `protobuf:"bytes,1,opt,name=routing_enabled,json=routingEnabled,proto3" json:"routing_enabled,omitempty"` // Configures minimum upstream cluster size required for zone aware routing // If upstream cluster size is less than specified, zone aware routing is not performed // even if zone aware routing is configured. If not specified, the default is 6. // * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`. // * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`. MinClusterSize *wrapperspb.UInt64Value `protobuf:"bytes,2,opt,name=min_cluster_size,json=minClusterSize,proto3" json:"min_cluster_size,omitempty"` // If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic // mode<arch_overview_load_balancing_panic_threshold>`. Instead, the cluster will fail all // requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a // failing service. FailTrafficOnPanic bool `protobuf:"varint,3,opt,name=fail_traffic_on_panic,json=failTrafficOnPanic,proto3" json:"fail_traffic_on_panic,omitempty"` // contains filtered or unexported fields }
Configuration for :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>`.
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) Descriptor
deprecated
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_CommonLbConfig_ZoneAwareLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) GetFailTrafficOnPanic ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetFailTrafficOnPanic() bool
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) GetMinClusterSize ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetMinClusterSize() *wrapperspb.UInt64Value
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) GetRoutingEnabled ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) GetRoutingEnabled() *_type.Percent
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoMessage ¶
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoMessage()
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoReflect ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) Reset ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) Reset()
func (*Cluster_CommonLbConfig_ZoneAwareLbConfig) String ¶
func (x *Cluster_CommonLbConfig_ZoneAwareLbConfig) String() string
type Cluster_CommonLbConfig_ZoneAwareLbConfig_ ¶
type Cluster_CommonLbConfig_ZoneAwareLbConfig_ struct {
ZoneAwareLbConfig *Cluster_CommonLbConfig_ZoneAwareLbConfig `protobuf:"bytes,2,opt,name=zone_aware_lb_config,json=zoneAwareLbConfig,proto3,oneof"`
}
type Cluster_CustomClusterType ¶
type Cluster_CustomClusterType struct { // The type of the cluster to instantiate. The name must match a supported cluster type. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Cluster specific configuration which depends on the cluster being instantiated. // See the supported cluster for further documentation. TypedConfig *anypb.Any `protobuf:"bytes,2,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"` // contains filtered or unexported fields }
Extended cluster type.
func (*Cluster_CustomClusterType) Descriptor
deprecated
func (*Cluster_CustomClusterType) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_CustomClusterType.ProtoReflect.Descriptor instead.
func (*Cluster_CustomClusterType) GetName ¶
func (x *Cluster_CustomClusterType) GetName() string
func (*Cluster_CustomClusterType) GetTypedConfig ¶
func (x *Cluster_CustomClusterType) GetTypedConfig() *anypb.Any
func (*Cluster_CustomClusterType) ProtoMessage ¶
func (*Cluster_CustomClusterType) ProtoMessage()
func (*Cluster_CustomClusterType) ProtoReflect ¶
func (x *Cluster_CustomClusterType) ProtoReflect() protoreflect.Message
func (*Cluster_CustomClusterType) Reset ¶
func (x *Cluster_CustomClusterType) Reset()
func (*Cluster_CustomClusterType) String ¶
func (x *Cluster_CustomClusterType) String() string
type Cluster_DiscoveryType ¶
type Cluster_DiscoveryType int32
Refer to :ref:`service discovery type <arch_overview_service_discovery_types>` for an explanation on each type.
const ( // Refer to the :ref:`static discovery type<arch_overview_service_discovery_types_static>` // for an explanation. Cluster_STATIC Cluster_DiscoveryType = 0 // Refer to the :ref:`strict DNS discovery // type<arch_overview_service_discovery_types_strict_dns>` // for an explanation. Cluster_STRICT_DNS Cluster_DiscoveryType = 1 // Refer to the :ref:`logical DNS discovery // type<arch_overview_service_discovery_types_logical_dns>` // for an explanation. Cluster_LOGICAL_DNS Cluster_DiscoveryType = 2 // Refer to the :ref:`service discovery type<arch_overview_service_discovery_types_eds>` // for an explanation. Cluster_EDS Cluster_DiscoveryType = 3 // Refer to the :ref:`original destination discovery // type<arch_overview_service_discovery_types_original_destination>` // for an explanation. Cluster_ORIGINAL_DST Cluster_DiscoveryType = 4 )
func (Cluster_DiscoveryType) Descriptor ¶
func (Cluster_DiscoveryType) Descriptor() protoreflect.EnumDescriptor
func (Cluster_DiscoveryType) Enum ¶
func (x Cluster_DiscoveryType) Enum() *Cluster_DiscoveryType
func (Cluster_DiscoveryType) EnumDescriptor
deprecated
func (Cluster_DiscoveryType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_DiscoveryType.Descriptor instead.
func (Cluster_DiscoveryType) Number ¶
func (x Cluster_DiscoveryType) Number() protoreflect.EnumNumber
func (Cluster_DiscoveryType) String ¶
func (x Cluster_DiscoveryType) String() string
func (Cluster_DiscoveryType) Type ¶
func (Cluster_DiscoveryType) Type() protoreflect.EnumType
type Cluster_DnsLookupFamily ¶
type Cluster_DnsLookupFamily int32
When V4_ONLY is selected, the DNS resolver will only perform a lookup for addresses in the IPv4 family. If V6_ONLY is selected, the DNS resolver will only perform a lookup for addresses in the IPv6 family. If AUTO is specified, the DNS resolver will first perform a lookup for addresses in the IPv6 family and fallback to a lookup for addresses in the IPv4 family. For cluster types other than :ref:`STRICT_DNS<envoy_api_enum_value_Cluster.DiscoveryType.STRICT_DNS>` and :ref:`LOGICAL_DNS<envoy_api_enum_value_Cluster.DiscoveryType.LOGICAL_DNS>`, this setting is ignored.
const ( Cluster_AUTO Cluster_DnsLookupFamily = 0 Cluster_V4_ONLY Cluster_DnsLookupFamily = 1 Cluster_V6_ONLY Cluster_DnsLookupFamily = 2 )
func (Cluster_DnsLookupFamily) Descriptor ¶
func (Cluster_DnsLookupFamily) Descriptor() protoreflect.EnumDescriptor
func (Cluster_DnsLookupFamily) Enum ¶
func (x Cluster_DnsLookupFamily) Enum() *Cluster_DnsLookupFamily
func (Cluster_DnsLookupFamily) EnumDescriptor
deprecated
func (Cluster_DnsLookupFamily) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_DnsLookupFamily.Descriptor instead.
func (Cluster_DnsLookupFamily) Number ¶
func (x Cluster_DnsLookupFamily) Number() protoreflect.EnumNumber
func (Cluster_DnsLookupFamily) String ¶
func (x Cluster_DnsLookupFamily) String() string
func (Cluster_DnsLookupFamily) Type ¶
func (Cluster_DnsLookupFamily) Type() protoreflect.EnumType
type Cluster_EdsClusterConfig ¶
type Cluster_EdsClusterConfig struct { // Configuration for the source of EDS updates for this Cluster. EdsConfig *core.ConfigSource `protobuf:"bytes,1,opt,name=eds_config,json=edsConfig,proto3" json:"eds_config,omitempty"` // Optional alternative to cluster name to present to EDS. This does not // have the same restrictions as cluster name, i.e. it may be arbitrary // length. ServiceName string `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"` // contains filtered or unexported fields }
Only valid when discovery type is EDS.
func (*Cluster_EdsClusterConfig) Descriptor
deprecated
func (*Cluster_EdsClusterConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_EdsClusterConfig.ProtoReflect.Descriptor instead.
func (*Cluster_EdsClusterConfig) GetEdsConfig ¶
func (x *Cluster_EdsClusterConfig) GetEdsConfig() *core.ConfigSource
func (*Cluster_EdsClusterConfig) GetServiceName ¶
func (x *Cluster_EdsClusterConfig) GetServiceName() string
func (*Cluster_EdsClusterConfig) ProtoMessage ¶
func (*Cluster_EdsClusterConfig) ProtoMessage()
func (*Cluster_EdsClusterConfig) ProtoReflect ¶
func (x *Cluster_EdsClusterConfig) ProtoReflect() protoreflect.Message
func (*Cluster_EdsClusterConfig) Reset ¶
func (x *Cluster_EdsClusterConfig) Reset()
func (*Cluster_EdsClusterConfig) String ¶
func (x *Cluster_EdsClusterConfig) String() string
type Cluster_LbPolicy ¶
type Cluster_LbPolicy int32
Refer to :ref:`load balancer type <arch_overview_load_balancing_types>` architecture overview section for information on each type.
const ( // Refer to the :ref:`round robin load balancing // policy<arch_overview_load_balancing_types_round_robin>` // for an explanation. Cluster_ROUND_ROBIN Cluster_LbPolicy = 0 // Refer to the :ref:`least request load balancing // policy<arch_overview_load_balancing_types_least_request>` // for an explanation. Cluster_LEAST_REQUEST Cluster_LbPolicy = 1 // Refer to the :ref:`ring hash load balancing // policy<arch_overview_load_balancing_types_ring_hash>` // for an explanation. Cluster_RING_HASH Cluster_LbPolicy = 2 // Refer to the :ref:`random load balancing // policy<arch_overview_load_balancing_types_random>` // for an explanation. Cluster_RANDOM Cluster_LbPolicy = 3 // Refer to the :ref:`original destination load balancing // policy<arch_overview_load_balancing_types_original_destination>` // for an explanation. // // .. attention:: // // **This load balancing policy is deprecated**. Use CLUSTER_PROVIDED instead. // // Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto. Cluster_ORIGINAL_DST_LB Cluster_LbPolicy = 4 // Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` // for an explanation. Cluster_MAGLEV Cluster_LbPolicy = 5 // This load balancer type must be specified if the configured cluster provides a cluster // specific load balancer. Consult the configured cluster's documentation for whether to set // this option or not. Cluster_CLUSTER_PROVIDED Cluster_LbPolicy = 6 // [#not-implemented-hide:] Use the new :ref:`load_balancing_policy // <envoy_api_field_Cluster.load_balancing_policy>` field to determine the LB policy. // [#next-major-version: In the v3 API, we should consider deprecating the lb_policy field // and instead using the new load_balancing_policy field as the one and only mechanism for // configuring this.] Cluster_LOAD_BALANCING_POLICY_CONFIG Cluster_LbPolicy = 7 )
func (Cluster_LbPolicy) Descriptor ¶
func (Cluster_LbPolicy) Descriptor() protoreflect.EnumDescriptor
func (Cluster_LbPolicy) Enum ¶
func (x Cluster_LbPolicy) Enum() *Cluster_LbPolicy
func (Cluster_LbPolicy) EnumDescriptor
deprecated
func (Cluster_LbPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_LbPolicy.Descriptor instead.
func (Cluster_LbPolicy) Number ¶
func (x Cluster_LbPolicy) Number() protoreflect.EnumNumber
func (Cluster_LbPolicy) String ¶
func (x Cluster_LbPolicy) String() string
func (Cluster_LbPolicy) Type ¶
func (Cluster_LbPolicy) Type() protoreflect.EnumType
type Cluster_LbSubsetConfig ¶
type Cluster_LbSubsetConfig struct { // The behavior used when no endpoint subset matches the selected route's // metadata. The value defaults to // :ref:`NO_FALLBACK<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`. FallbackPolicy Cluster_LbSubsetConfig_LbSubsetFallbackPolicy `` /* 168-byte string literal not displayed */ // Specifies the default subset of endpoints used during fallback if // fallback_policy is // :ref:`DEFAULT_SUBSET<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`. // Each field in default_subset is // compared to the matching LbEndpoint.Metadata under the *envoy.lb* // namespace. It is valid for no hosts to match, in which case the behavior // is the same as a fallback_policy of // :ref:`NO_FALLBACK<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`. DefaultSubset *structpb.Struct `protobuf:"bytes,2,opt,name=default_subset,json=defaultSubset,proto3" json:"default_subset,omitempty"` // For each entry, LbEndpoint.Metadata's // *envoy.lb* namespace is traversed and a subset is created for each unique // combination of key and value. For example: // // .. code-block:: json // // { "subset_selectors": [ // { "keys": [ "version" ] }, // { "keys": [ "stage", "hardware_type" ] } // ]} // // A subset is matched when the metadata from the selected route and // weighted cluster contains the same keys and values as the subset's // metadata. The same host may appear in multiple subsets. SubsetSelectors []*Cluster_LbSubsetConfig_LbSubsetSelector `protobuf:"bytes,3,rep,name=subset_selectors,json=subsetSelectors,proto3" json:"subset_selectors,omitempty"` // If true, routing to subsets will take into account the localities and locality weights of the // endpoints when making the routing decision. // // There are some potential pitfalls associated with enabling this feature, as the resulting // traffic split after applying both a subset match and locality weights might be undesirable. // // Consider for example a situation in which you have 50/50 split across two localities X/Y // which have 100 hosts each without subsetting. If the subset LB results in X having only 1 // host selected but Y having 100, then a lot more load is being dumped on the single host in X // than originally anticipated in the load balancing assignment delivered via EDS. LocalityWeightAware bool `protobuf:"varint,4,opt,name=locality_weight_aware,json=localityWeightAware,proto3" json:"locality_weight_aware,omitempty"` // When used with locality_weight_aware, scales the weight of each locality by the ratio // of hosts in the subset vs hosts in the original subset. This aims to even out the load // going to an individual locality if said locality is disproportionately affected by the // subset predicate. ScaleLocalityWeight bool `protobuf:"varint,5,opt,name=scale_locality_weight,json=scaleLocalityWeight,proto3" json:"scale_locality_weight,omitempty"` // If true, when a fallback policy is configured and its corresponding subset fails to find // a host this will cause any host to be selected instead. // // This is useful when using the default subset as the fallback policy, given the default // subset might become empty. With this option enabled, if that happens the LB will attempt // to select a host from the entire cluster. PanicModeAny bool `protobuf:"varint,6,opt,name=panic_mode_any,json=panicModeAny,proto3" json:"panic_mode_any,omitempty"` // If true, metadata specified for a metadata key will be matched against the corresponding // endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value // and any of the elements in the list matches the criteria. ListAsAny bool `protobuf:"varint,7,opt,name=list_as_any,json=listAsAny,proto3" json:"list_as_any,omitempty"` // contains filtered or unexported fields }
Optionally divide the endpoints in this cluster into subsets defined by endpoint metadata and selected by route and weighted cluster metadata. [#next-free-field: 8]
func (*Cluster_LbSubsetConfig) Descriptor
deprecated
func (*Cluster_LbSubsetConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_LbSubsetConfig.ProtoReflect.Descriptor instead.
func (*Cluster_LbSubsetConfig) GetDefaultSubset ¶
func (x *Cluster_LbSubsetConfig) GetDefaultSubset() *structpb.Struct
func (*Cluster_LbSubsetConfig) GetFallbackPolicy ¶
func (x *Cluster_LbSubsetConfig) GetFallbackPolicy() Cluster_LbSubsetConfig_LbSubsetFallbackPolicy
func (*Cluster_LbSubsetConfig) GetListAsAny ¶
func (x *Cluster_LbSubsetConfig) GetListAsAny() bool
func (*Cluster_LbSubsetConfig) GetLocalityWeightAware ¶
func (x *Cluster_LbSubsetConfig) GetLocalityWeightAware() bool
func (*Cluster_LbSubsetConfig) GetPanicModeAny ¶
func (x *Cluster_LbSubsetConfig) GetPanicModeAny() bool
func (*Cluster_LbSubsetConfig) GetScaleLocalityWeight ¶
func (x *Cluster_LbSubsetConfig) GetScaleLocalityWeight() bool
func (*Cluster_LbSubsetConfig) GetSubsetSelectors ¶
func (x *Cluster_LbSubsetConfig) GetSubsetSelectors() []*Cluster_LbSubsetConfig_LbSubsetSelector
func (*Cluster_LbSubsetConfig) ProtoMessage ¶
func (*Cluster_LbSubsetConfig) ProtoMessage()
func (*Cluster_LbSubsetConfig) ProtoReflect ¶
func (x *Cluster_LbSubsetConfig) ProtoReflect() protoreflect.Message
func (*Cluster_LbSubsetConfig) Reset ¶
func (x *Cluster_LbSubsetConfig) Reset()
func (*Cluster_LbSubsetConfig) String ¶
func (x *Cluster_LbSubsetConfig) String() string
type Cluster_LbSubsetConfig_LbSubsetFallbackPolicy ¶
type Cluster_LbSubsetConfig_LbSubsetFallbackPolicy int32
If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported. If ANY_ENDPOINT is selected, any cluster endpoint may be returned (subject to policy, health checks, etc). If DEFAULT_SUBSET is selected, load balancing is performed over the endpoints matching the values from the default_subset field.
const ( Cluster_LbSubsetConfig_NO_FALLBACK Cluster_LbSubsetConfig_LbSubsetFallbackPolicy = 0 Cluster_LbSubsetConfig_ANY_ENDPOINT Cluster_LbSubsetConfig_LbSubsetFallbackPolicy = 1 Cluster_LbSubsetConfig_DEFAULT_SUBSET Cluster_LbSubsetConfig_LbSubsetFallbackPolicy = 2 )
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Descriptor ¶
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Descriptor() protoreflect.EnumDescriptor
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Enum ¶
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) EnumDescriptor
deprecated
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_LbSubsetConfig_LbSubsetFallbackPolicy.Descriptor instead.
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Number ¶
func (x Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Number() protoreflect.EnumNumber
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) String ¶
func (x Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) String() string
func (Cluster_LbSubsetConfig_LbSubsetFallbackPolicy) Type ¶
type Cluster_LbSubsetConfig_LbSubsetSelector ¶
type Cluster_LbSubsetConfig_LbSubsetSelector struct { // List of keys to match with the weighted cluster metadata. Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"` // The behavior used when no endpoint subset matches the selected route's // metadata. FallbackPolicy Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy `` /* 193-byte string literal not displayed */ // Subset of // :ref:`keys<envoy_api_field_Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by // :ref:`KEYS_SUBSET<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>` // fallback policy. // It has to be a non empty list if KEYS_SUBSET fallback policy is selected. // For any other fallback policy the parameter is not used and should not be set. // Only values also present in // :ref:`keys<envoy_api_field_Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but // `fallback_keys_subset` cannot be equal to `keys`. FallbackKeysSubset []string `protobuf:"bytes,3,rep,name=fallback_keys_subset,json=fallbackKeysSubset,proto3" json:"fallback_keys_subset,omitempty"` // contains filtered or unexported fields }
Specifications for subsets.
func (*Cluster_LbSubsetConfig_LbSubsetSelector) Descriptor
deprecated
func (*Cluster_LbSubsetConfig_LbSubsetSelector) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_LbSubsetConfig_LbSubsetSelector.ProtoReflect.Descriptor instead.
func (*Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackKeysSubset ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackKeysSubset() []string
func (*Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackPolicy ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetFallbackPolicy() Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy
func (*Cluster_LbSubsetConfig_LbSubsetSelector) GetKeys ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) GetKeys() []string
func (*Cluster_LbSubsetConfig_LbSubsetSelector) ProtoMessage ¶
func (*Cluster_LbSubsetConfig_LbSubsetSelector) ProtoMessage()
func (*Cluster_LbSubsetConfig_LbSubsetSelector) ProtoReflect ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) ProtoReflect() protoreflect.Message
func (*Cluster_LbSubsetConfig_LbSubsetSelector) Reset ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) Reset()
func (*Cluster_LbSubsetConfig_LbSubsetSelector) String ¶
func (x *Cluster_LbSubsetConfig_LbSubsetSelector) String() string
type Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy ¶
type Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy int32
Allows to override top level fallback policy per selector.
const ( // If NOT_DEFINED top level config fallback policy is used instead. Cluster_LbSubsetConfig_LbSubsetSelector_NOT_DEFINED Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy = 0 // If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported. Cluster_LbSubsetConfig_LbSubsetSelector_NO_FALLBACK Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy = 1 // If ANY_ENDPOINT is selected, any cluster endpoint may be returned // (subject to policy, health checks, etc). Cluster_LbSubsetConfig_LbSubsetSelector_ANY_ENDPOINT Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy = 2 // If DEFAULT_SUBSET is selected, load balancing is performed over the // endpoints matching the values from the default_subset field. Cluster_LbSubsetConfig_LbSubsetSelector_DEFAULT_SUBSET Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy = 3 // If KEYS_SUBSET is selected, subset selector matching is performed again with metadata // keys reduced to // :ref:`fallback_keys_subset<envoy_api_field_Cluster.LbSubsetConfig.LbSubsetSelector.fallback_keys_subset>`. // It allows for a fallback to a different, less specific selector if some of the keys of // the selector are considered optional. Cluster_LbSubsetConfig_LbSubsetSelector_KEYS_SUBSET Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy = 4 )
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Descriptor ¶
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Enum ¶
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) EnumDescriptor
deprecated
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy.Descriptor instead.
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Number ¶
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) String ¶
func (x Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) String() string
func (Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy) Type ¶
type Cluster_LeastRequestLbConfig ¶
type Cluster_LeastRequestLbConfig struct { // The number of random healthy hosts from which the host with the fewest active requests will // be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set. ChoiceCount *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=choice_count,json=choiceCount,proto3" json:"choice_count,omitempty"` // contains filtered or unexported fields }
Specific configuration for the LeastRequest load balancing policy.
func (*Cluster_LeastRequestLbConfig) Descriptor
deprecated
func (*Cluster_LeastRequestLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_LeastRequestLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_LeastRequestLbConfig) GetChoiceCount ¶
func (x *Cluster_LeastRequestLbConfig) GetChoiceCount() *wrapperspb.UInt32Value
func (*Cluster_LeastRequestLbConfig) ProtoMessage ¶
func (*Cluster_LeastRequestLbConfig) ProtoMessage()
func (*Cluster_LeastRequestLbConfig) ProtoReflect ¶
func (x *Cluster_LeastRequestLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_LeastRequestLbConfig) Reset ¶
func (x *Cluster_LeastRequestLbConfig) Reset()
func (*Cluster_LeastRequestLbConfig) String ¶
func (x *Cluster_LeastRequestLbConfig) String() string
type Cluster_LeastRequestLbConfig_ ¶
type Cluster_LeastRequestLbConfig_ struct { // Optional configuration for the LeastRequest load balancing policy. LeastRequestLbConfig *Cluster_LeastRequestLbConfig `protobuf:"bytes,37,opt,name=least_request_lb_config,json=leastRequestLbConfig,proto3,oneof"` }
type Cluster_OriginalDstLbConfig ¶
type Cluster_OriginalDstLbConfig struct { // When true, :ref:`x-envoy-original-dst-host // <config_http_conn_man_headers_x-envoy-original-dst-host>` can be used to override destination // address. // // .. attention:: // // This header isn't sanitized by default, so enabling this feature allows HTTP clients to // route traffic to arbitrary hosts and/or ports, which may have serious security // consequences. // // .. note:: // // If the header appears multiple times only the first value is used. UseHttpHeader bool `protobuf:"varint,1,opt,name=use_http_header,json=useHttpHeader,proto3" json:"use_http_header,omitempty"` // contains filtered or unexported fields }
Specific configuration for the :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>` load balancing policy.
func (*Cluster_OriginalDstLbConfig) Descriptor
deprecated
func (*Cluster_OriginalDstLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_OriginalDstLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_OriginalDstLbConfig) GetUseHttpHeader ¶
func (x *Cluster_OriginalDstLbConfig) GetUseHttpHeader() bool
func (*Cluster_OriginalDstLbConfig) ProtoMessage ¶
func (*Cluster_OriginalDstLbConfig) ProtoMessage()
func (*Cluster_OriginalDstLbConfig) ProtoReflect ¶
func (x *Cluster_OriginalDstLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_OriginalDstLbConfig) Reset ¶
func (x *Cluster_OriginalDstLbConfig) Reset()
func (*Cluster_OriginalDstLbConfig) String ¶
func (x *Cluster_OriginalDstLbConfig) String() string
type Cluster_OriginalDstLbConfig_ ¶
type Cluster_OriginalDstLbConfig_ struct { // Optional configuration for the Original Destination load balancing policy. OriginalDstLbConfig *Cluster_OriginalDstLbConfig `protobuf:"bytes,34,opt,name=original_dst_lb_config,json=originalDstLbConfig,proto3,oneof"` }
type Cluster_RefreshRate ¶
type Cluster_RefreshRate struct { // Specifies the base interval between refreshes. This parameter is required and must be greater // than zero and less than // :ref:`max_interval <envoy_api_field_Cluster.RefreshRate.max_interval>`. BaseInterval *durationpb.Duration `protobuf:"bytes,1,opt,name=base_interval,json=baseInterval,proto3" json:"base_interval,omitempty"` // Specifies the maximum interval between refreshes. This parameter is optional, but must be // greater than or equal to the // :ref:`base_interval <envoy_api_field_Cluster.RefreshRate.base_interval>` if set. The default // is 10 times the :ref:`base_interval <envoy_api_field_Cluster.RefreshRate.base_interval>`. MaxInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"` // contains filtered or unexported fields }
func (*Cluster_RefreshRate) Descriptor
deprecated
func (*Cluster_RefreshRate) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_RefreshRate.ProtoReflect.Descriptor instead.
func (*Cluster_RefreshRate) GetBaseInterval ¶
func (x *Cluster_RefreshRate) GetBaseInterval() *durationpb.Duration
func (*Cluster_RefreshRate) GetMaxInterval ¶
func (x *Cluster_RefreshRate) GetMaxInterval() *durationpb.Duration
func (*Cluster_RefreshRate) ProtoMessage ¶
func (*Cluster_RefreshRate) ProtoMessage()
func (*Cluster_RefreshRate) ProtoReflect ¶
func (x *Cluster_RefreshRate) ProtoReflect() protoreflect.Message
func (*Cluster_RefreshRate) Reset ¶
func (x *Cluster_RefreshRate) Reset()
func (*Cluster_RefreshRate) String ¶
func (x *Cluster_RefreshRate) String() string
type Cluster_RingHashLbConfig ¶
type Cluster_RingHashLbConfig struct { // Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each // provided host) the better the request distribution will reflect the desired weights. Defaults // to 1024 entries, and limited to 8M entries. See also // :ref:`maximum_ring_size<envoy_api_field_Cluster.RingHashLbConfig.maximum_ring_size>`. MinimumRingSize *wrapperspb.UInt64Value `protobuf:"bytes,1,opt,name=minimum_ring_size,json=minimumRingSize,proto3" json:"minimum_ring_size,omitempty"` // The hash function used to hash hosts onto the ketama ring. The value defaults to // :ref:`XX_HASH<envoy_api_enum_value_Cluster.RingHashLbConfig.HashFunction.XX_HASH>`. HashFunction Cluster_RingHashLbConfig_HashFunction `` /* 154-byte string literal not displayed */ // Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered // to further constrain resource use. See also // :ref:`minimum_ring_size<envoy_api_field_Cluster.RingHashLbConfig.minimum_ring_size>`. MaximumRingSize *wrapperspb.UInt64Value `protobuf:"bytes,4,opt,name=maximum_ring_size,json=maximumRingSize,proto3" json:"maximum_ring_size,omitempty"` // contains filtered or unexported fields }
Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.
func (*Cluster_RingHashLbConfig) Descriptor
deprecated
func (*Cluster_RingHashLbConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_RingHashLbConfig.ProtoReflect.Descriptor instead.
func (*Cluster_RingHashLbConfig) GetHashFunction ¶
func (x *Cluster_RingHashLbConfig) GetHashFunction() Cluster_RingHashLbConfig_HashFunction
func (*Cluster_RingHashLbConfig) GetMaximumRingSize ¶
func (x *Cluster_RingHashLbConfig) GetMaximumRingSize() *wrapperspb.UInt64Value
func (*Cluster_RingHashLbConfig) GetMinimumRingSize ¶
func (x *Cluster_RingHashLbConfig) GetMinimumRingSize() *wrapperspb.UInt64Value
func (*Cluster_RingHashLbConfig) ProtoMessage ¶
func (*Cluster_RingHashLbConfig) ProtoMessage()
func (*Cluster_RingHashLbConfig) ProtoReflect ¶
func (x *Cluster_RingHashLbConfig) ProtoReflect() protoreflect.Message
func (*Cluster_RingHashLbConfig) Reset ¶
func (x *Cluster_RingHashLbConfig) Reset()
func (*Cluster_RingHashLbConfig) String ¶
func (x *Cluster_RingHashLbConfig) String() string
type Cluster_RingHashLbConfig_ ¶
type Cluster_RingHashLbConfig_ struct { // Optional configuration for the Ring Hash load balancing policy. RingHashLbConfig *Cluster_RingHashLbConfig `protobuf:"bytes,23,opt,name=ring_hash_lb_config,json=ringHashLbConfig,proto3,oneof"` }
type Cluster_RingHashLbConfig_HashFunction ¶
type Cluster_RingHashLbConfig_HashFunction int32
The hash function used to hash hosts onto the ketama ring.
const ( // Use `xxHash <https://github.com/Cyan4973/xxHash>`_, this is the default hash function. Cluster_RingHashLbConfig_XX_HASH Cluster_RingHashLbConfig_HashFunction = 0 // Use `MurmurHash2 <https://sites.google.com/site/murmurhash/>`_, this is compatible with // std:hash<string> in GNU libstdc++ 3.4.20 or above. This is typically the case when compiled // on Linux and not macOS. Cluster_RingHashLbConfig_MURMUR_HASH_2 Cluster_RingHashLbConfig_HashFunction = 1 )
func (Cluster_RingHashLbConfig_HashFunction) Descriptor ¶
func (Cluster_RingHashLbConfig_HashFunction) Descriptor() protoreflect.EnumDescriptor
func (Cluster_RingHashLbConfig_HashFunction) Enum ¶
func (Cluster_RingHashLbConfig_HashFunction) EnumDescriptor
deprecated
func (Cluster_RingHashLbConfig_HashFunction) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_RingHashLbConfig_HashFunction.Descriptor instead.
func (Cluster_RingHashLbConfig_HashFunction) Number ¶
func (x Cluster_RingHashLbConfig_HashFunction) Number() protoreflect.EnumNumber
func (Cluster_RingHashLbConfig_HashFunction) String ¶
func (x Cluster_RingHashLbConfig_HashFunction) String() string
func (Cluster_RingHashLbConfig_HashFunction) Type ¶
func (Cluster_RingHashLbConfig_HashFunction) Type() protoreflect.EnumType
type Cluster_TransportSocketMatch ¶
type Cluster_TransportSocketMatch struct { // The name of the match, used in stats generation. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional endpoint metadata match criteria. // The connection to the endpoint with metadata matching what is set in this field // will use the transport socket configuration specified here. // The endpoint's metadata entry in *envoy.transport_socket_match* is used to match // against the values specified in this field. Match *structpb.Struct `protobuf:"bytes,2,opt,name=match,proto3" json:"match,omitempty"` // The configuration of the transport socket. TransportSocket *core.TransportSocket `protobuf:"bytes,3,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"` // contains filtered or unexported fields }
TransportSocketMatch specifies what transport socket config will be used when the match conditions are satisfied.
func (*Cluster_TransportSocketMatch) Descriptor
deprecated
func (*Cluster_TransportSocketMatch) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_TransportSocketMatch.ProtoReflect.Descriptor instead.
func (*Cluster_TransportSocketMatch) GetMatch ¶
func (x *Cluster_TransportSocketMatch) GetMatch() *structpb.Struct
func (*Cluster_TransportSocketMatch) GetName ¶
func (x *Cluster_TransportSocketMatch) GetName() string
func (*Cluster_TransportSocketMatch) GetTransportSocket ¶
func (x *Cluster_TransportSocketMatch) GetTransportSocket() *core.TransportSocket
func (*Cluster_TransportSocketMatch) ProtoMessage ¶
func (*Cluster_TransportSocketMatch) ProtoMessage()
func (*Cluster_TransportSocketMatch) ProtoReflect ¶
func (x *Cluster_TransportSocketMatch) ProtoReflect() protoreflect.Message
func (*Cluster_TransportSocketMatch) Reset ¶
func (x *Cluster_TransportSocketMatch) Reset()
func (*Cluster_TransportSocketMatch) String ¶
func (x *Cluster_TransportSocketMatch) String() string
type Cluster_Type ¶
type Cluster_Type struct { // The :ref:`service discovery type <arch_overview_service_discovery_types>` // to use for resolving the cluster. Type Cluster_DiscoveryType `protobuf:"varint,2,opt,name=type,proto3,enum=envoy.api.v2.Cluster_DiscoveryType,oneof"` }
type DeltaDiscoveryRequest ¶
type DeltaDiscoveryRequest struct { // The node making the request. Node *core.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` // Type of the resource that is being requested, e.g. // "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". TypeUrl string `protobuf:"bytes,2,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // DeltaDiscoveryRequests allow the client to add or remove individual // resources to the set of tracked resources in the context of a stream. // All resource names in the resource_names_subscribe list are added to the // set of tracked resources and all resource names in the resource_names_unsubscribe // list are removed from the set of tracked resources. // // *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or // resource_names_unsubscribe list simply means that no resources are to be // added or removed to the resource list. // *Like* state-of-the-world xDS, the server must send updates for all tracked // resources, but can also send updates for resources the client has not subscribed to. // // NOTE: the server must respond with all resources listed in resource_names_subscribe, // even if it believes the client has the most recent version of them. The reason: // the client may have dropped them, but then regained interest before it had a chance // to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd. // // These two fields can be set in any DeltaDiscoveryRequest, including ACKs // and initial_resource_versions. // // A list of Resource names to add to the list of tracked resources. ResourceNamesSubscribe []string `` /* 129-byte string literal not displayed */ // A list of Resource names to remove from the list of tracked resources. ResourceNamesUnsubscribe []string `` /* 135-byte string literal not displayed */ // Informs the server of the versions of the resources the xDS client knows of, to enable the // client to continue the same logical xDS session even in the face of gRPC stream reconnection. // It will not be populated: [1] in the very first stream of a session, since the client will // not yet have any resources, [2] in any message after the first in a stream (for a given // type_url), since the server will already be correctly tracking the client's state. // (In ADS, the first message *of each type_url* of a reconnected stream populates this map.) // The map's keys are names of xDS resources known to the xDS client. // The map's values are opaque resource versions. InitialResourceVersions map[string]string `` /* 220-byte string literal not displayed */ // When the DeltaDiscoveryRequest is a ACK or NACK message in response // to a previous DeltaDiscoveryResponse, the response_nonce must be the // nonce in the DeltaDiscoveryResponse. // Otherwise (unlike in DiscoveryRequest) response_nonce must be omitted. ResponseNonce string `protobuf:"bytes,6,opt,name=response_nonce,json=responseNonce,proto3" json:"response_nonce,omitempty"` // This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` // failed to update configuration. The *message* field in *error_details* // provides the Envoy internal exception related to the failure. ErrorDetail *status.Status `protobuf:"bytes,7,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"` // contains filtered or unexported fields }
DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.
With Delta xDS, the DeltaDiscoveryResponses do not need to include a full snapshot of the tracked resources. Instead, DeltaDiscoveryResponses are a diff to the state of a xDS client. In Delta XDS there are per-resource versions, which allow tracking state at the resource granularity. An xDS Delta session is always in the context of a gRPC bidirectional stream. This allows the xDS server to keep track of the state of xDS clients connected to it.
In Delta xDS the nonce field is required and used to pair DeltaDiscoveryResponse to a DeltaDiscoveryRequest ACK or NACK. Optionally, a response message level system_version_info is present for debugging purposes only.
DeltaDiscoveryRequest plays two independent roles. Any DeltaDiscoveryRequest can be either or both of: [1] informing the server of what resources the client has gained/lost interest in (using resource_names_subscribe and resource_names_unsubscribe), or [2] (N)ACKing an earlier resource update from the server (using response_nonce, with presence of error_detail making it a NACK). Additionally, the first message (for a given type_url) of a reconnected gRPC stream has a third role: informing the server of the resources (and their versions) that the client already possesses, using the initial_resource_versions field.
As with state-of-the-world, when multiple resource types are multiplexed (ADS), all requests/acknowledgments/updates are logically walled off by type_url: a Cluster ACK exists in a completely separate world from a prior Route NACK. In particular, initial_resource_versions being sent at the "start" of every gRPC stream actually entails a message for each type_url, each with its own initial_resource_versions. [#next-free-field: 8]
func (*DeltaDiscoveryRequest) Descriptor
deprecated
func (*DeltaDiscoveryRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaDiscoveryRequest.ProtoReflect.Descriptor instead.
func (*DeltaDiscoveryRequest) GetErrorDetail ¶
func (x *DeltaDiscoveryRequest) GetErrorDetail() *status.Status
func (*DeltaDiscoveryRequest) GetInitialResourceVersions ¶
func (x *DeltaDiscoveryRequest) GetInitialResourceVersions() map[string]string
func (*DeltaDiscoveryRequest) GetNode ¶
func (x *DeltaDiscoveryRequest) GetNode() *core.Node
func (*DeltaDiscoveryRequest) GetResourceNamesSubscribe ¶
func (x *DeltaDiscoveryRequest) GetResourceNamesSubscribe() []string
func (*DeltaDiscoveryRequest) GetResourceNamesUnsubscribe ¶
func (x *DeltaDiscoveryRequest) GetResourceNamesUnsubscribe() []string
func (*DeltaDiscoveryRequest) GetResponseNonce ¶
func (x *DeltaDiscoveryRequest) GetResponseNonce() string
func (*DeltaDiscoveryRequest) GetTypeUrl ¶
func (x *DeltaDiscoveryRequest) GetTypeUrl() string
func (*DeltaDiscoveryRequest) ProtoMessage ¶
func (*DeltaDiscoveryRequest) ProtoMessage()
func (*DeltaDiscoveryRequest) ProtoReflect ¶
func (x *DeltaDiscoveryRequest) ProtoReflect() protoreflect.Message
func (*DeltaDiscoveryRequest) Reset ¶
func (x *DeltaDiscoveryRequest) Reset()
func (*DeltaDiscoveryRequest) String ¶
func (x *DeltaDiscoveryRequest) String() string
type DeltaDiscoveryResponse ¶
type DeltaDiscoveryResponse struct { // The version of the response data (used for debugging). SystemVersionInfo string `protobuf:"bytes,1,opt,name=system_version_info,json=systemVersionInfo,proto3" json:"system_version_info,omitempty"` // The response resources. These are typed resources, whose types must match // the type_url field. Resources []*Resource `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"` // Type URL for resources. Identifies the xDS API when muxing over ADS. // Must be consistent with the type_url in the Any within 'resources' if 'resources' is non-empty. TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // Resources names of resources that have be deleted and to be removed from the xDS Client. // Removed resources for missing resources can be ignored. RemovedResources []string `protobuf:"bytes,6,rep,name=removed_resources,json=removedResources,proto3" json:"removed_resources,omitempty"` // The nonce provides a way for DeltaDiscoveryRequests to uniquely // reference a DeltaDiscoveryResponse when (N)ACKing. The nonce is required. Nonce string `protobuf:"bytes,5,opt,name=nonce,proto3" json:"nonce,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 7]
func (*DeltaDiscoveryResponse) Descriptor
deprecated
func (*DeltaDiscoveryResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaDiscoveryResponse.ProtoReflect.Descriptor instead.
func (*DeltaDiscoveryResponse) GetNonce ¶
func (x *DeltaDiscoveryResponse) GetNonce() string
func (*DeltaDiscoveryResponse) GetRemovedResources ¶
func (x *DeltaDiscoveryResponse) GetRemovedResources() []string
func (*DeltaDiscoveryResponse) GetResources ¶
func (x *DeltaDiscoveryResponse) GetResources() []*Resource
func (*DeltaDiscoveryResponse) GetSystemVersionInfo ¶
func (x *DeltaDiscoveryResponse) GetSystemVersionInfo() string
func (*DeltaDiscoveryResponse) GetTypeUrl ¶
func (x *DeltaDiscoveryResponse) GetTypeUrl() string
func (*DeltaDiscoveryResponse) ProtoMessage ¶
func (*DeltaDiscoveryResponse) ProtoMessage()
func (*DeltaDiscoveryResponse) ProtoReflect ¶
func (x *DeltaDiscoveryResponse) ProtoReflect() protoreflect.Message
func (*DeltaDiscoveryResponse) Reset ¶
func (x *DeltaDiscoveryResponse) Reset()
func (*DeltaDiscoveryResponse) String ¶
func (x *DeltaDiscoveryResponse) String() string
type DiscoveryRequest ¶
type DiscoveryRequest struct { // The version_info provided in the request messages will be the version_info // received with the most recent successfully processed response or empty on // the first request. It is expected that no new request is sent after a // response is received until the Envoy instance is ready to ACK/NACK the new // configuration. ACK/NACK takes place by returning the new API config version // as applied or the previous API config version respectively. Each type_url // (see below) has an independent version associated with it. VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"` // The node making the request. Node *core.Node `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"` // List of resources to subscribe to, e.g. list of cluster names or a route // configuration name. If this is empty, all resources for the API are // returned. LDS/CDS may have empty resource_names, which will cause all // resources for the Envoy instance to be returned. The LDS and CDS responses // will then imply a number of resources that need to be fetched via EDS/RDS, // which will be explicitly enumerated in resource_names. ResourceNames []string `protobuf:"bytes,3,rep,name=resource_names,json=resourceNames,proto3" json:"resource_names,omitempty"` // Type of the resource that is being requested, e.g. // "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". This is implicit // in requests made via singleton xDS APIs such as CDS, LDS, etc. but is // required for ADS. TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // nonce corresponding to DiscoveryResponse being ACK/NACKed. See above // discussion on version_info and the DiscoveryResponse nonce comment. This // may be empty only if 1) this is a non-persistent-stream xDS such as HTTP, // or 2) the client has not yet accepted an update in this xDS stream (unlike // delta, where it is populated only for new explicit ACKs). ResponseNonce string `protobuf:"bytes,5,opt,name=response_nonce,json=responseNonce,proto3" json:"response_nonce,omitempty"` // This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` // failed to update configuration. The *message* field in *error_details* provides the Envoy // internal exception related to the failure. It is only intended for consumption during manual // debugging, the string provided is not guaranteed to be stable across Envoy versions. ErrorDetail *status.Status `protobuf:"bytes,6,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"` // contains filtered or unexported fields }
A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API. [#next-free-field: 7]
func (*DiscoveryRequest) Descriptor
deprecated
func (*DiscoveryRequest) Descriptor() ([]byte, []int)
Deprecated: Use DiscoveryRequest.ProtoReflect.Descriptor instead.
func (*DiscoveryRequest) GetErrorDetail ¶
func (x *DiscoveryRequest) GetErrorDetail() *status.Status
func (*DiscoveryRequest) GetNode ¶
func (x *DiscoveryRequest) GetNode() *core.Node
func (*DiscoveryRequest) GetResourceNames ¶
func (x *DiscoveryRequest) GetResourceNames() []string
func (*DiscoveryRequest) GetResponseNonce ¶
func (x *DiscoveryRequest) GetResponseNonce() string
func (*DiscoveryRequest) GetTypeUrl ¶
func (x *DiscoveryRequest) GetTypeUrl() string
func (*DiscoveryRequest) GetVersionInfo ¶
func (x *DiscoveryRequest) GetVersionInfo() string
func (*DiscoveryRequest) ProtoMessage ¶
func (*DiscoveryRequest) ProtoMessage()
func (*DiscoveryRequest) ProtoReflect ¶
func (x *DiscoveryRequest) ProtoReflect() protoreflect.Message
func (*DiscoveryRequest) Reset ¶
func (x *DiscoveryRequest) Reset()
func (*DiscoveryRequest) String ¶
func (x *DiscoveryRequest) String() string
type DiscoveryResponse ¶
type DiscoveryResponse struct { // The version of the response data. VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"` // The response resources. These resources are typed and depend on the API being called. Resources []*anypb.Any `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"` // [#not-implemented-hide:] // Canary is used to support two Envoy command line flags: // // - --terminate-on-canary-transition-failure. When set, Envoy is able to // terminate if it detects that configuration is stuck at canary. Consider // this example sequence of updates: // - Management server applies a canary config successfully. // - Management server rolls back to a production config. // - Envoy rejects the new production config. // Since there is no sensible way to continue receiving configuration // updates, Envoy will then terminate and apply production config from a // clean slate. // - --dry-run-canary. When set, a canary response will never be applied, only // validated via a dry run. Canary bool `protobuf:"varint,3,opt,name=canary,proto3" json:"canary,omitempty"` // Type URL for resources. Identifies the xDS API when muxing over ADS. // Must be consistent with the type_url in the 'resources' repeated Any (if non-empty). TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // For gRPC based subscriptions, the nonce provides a way to explicitly ack a // specific DiscoveryResponse in a following DiscoveryRequest. Additional // messages may have been sent by Envoy to the management server for the // previous version on the stream prior to this DiscoveryResponse, that were // unprocessed at response send time. The nonce allows the management server // to ignore any further DiscoveryRequests for the previous version until a // DiscoveryRequest bearing the nonce. The nonce is optional and is not // required for non-stream based xDS implementations. Nonce string `protobuf:"bytes,5,opt,name=nonce,proto3" json:"nonce,omitempty"` // [#not-implemented-hide:] // The control plane instance that sent the response. ControlPlane *core.ControlPlane `protobuf:"bytes,6,opt,name=control_plane,json=controlPlane,proto3" json:"control_plane,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 7]
func (*DiscoveryResponse) Descriptor
deprecated
func (*DiscoveryResponse) Descriptor() ([]byte, []int)
Deprecated: Use DiscoveryResponse.ProtoReflect.Descriptor instead.
func (*DiscoveryResponse) GetCanary ¶
func (x *DiscoveryResponse) GetCanary() bool
func (*DiscoveryResponse) GetControlPlane ¶
func (x *DiscoveryResponse) GetControlPlane() *core.ControlPlane
func (*DiscoveryResponse) GetNonce ¶
func (x *DiscoveryResponse) GetNonce() string
func (*DiscoveryResponse) GetResources ¶
func (x *DiscoveryResponse) GetResources() []*anypb.Any
func (*DiscoveryResponse) GetTypeUrl ¶
func (x *DiscoveryResponse) GetTypeUrl() string
func (*DiscoveryResponse) GetVersionInfo ¶
func (x *DiscoveryResponse) GetVersionInfo() string
func (*DiscoveryResponse) ProtoMessage ¶
func (*DiscoveryResponse) ProtoMessage()
func (*DiscoveryResponse) ProtoReflect ¶
func (x *DiscoveryResponse) ProtoReflect() protoreflect.Message
func (*DiscoveryResponse) Reset ¶
func (x *DiscoveryResponse) Reset()
func (*DiscoveryResponse) String ¶
func (x *DiscoveryResponse) String() string
type EdsDummy ¶
type EdsDummy struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
func (*EdsDummy) ProtoReflect ¶
func (x *EdsDummy) ProtoReflect() protoreflect.Message
type LdsDummy ¶
type LdsDummy struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
func (*LdsDummy) ProtoReflect ¶
func (x *LdsDummy) ProtoReflect() protoreflect.Message
type Listener ¶
type Listener struct { // The unique name by which this listener is known. If no name is provided, // Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically // updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The address that the listener should listen on. In general, the address must be unique, though // that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on // Linux as the actual port will be allocated by the OS. Address *core.Address `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"` // A list of filter chains to consider for this listener. The // :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific // :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` criteria is used on a // connection. // // Example using SNI for filter chain selection can be found in the // :ref:`FAQ entry <faq_how_to_setup_sni>`. FilterChains []*listener.FilterChain `protobuf:"bytes,3,rep,name=filter_chains,json=filterChains,proto3" json:"filter_chains,omitempty"` // If a connection is redirected using *iptables*, the port on which the proxy // receives it might be different from the original destination address. When this flag is set to // true, the listener hands off redirected connections to the listener associated with the // original destination address. If there is no listener associated with the original destination // address, the connection is handled by the listener that receives it. Defaults to false. // // .. attention:: // // This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>` // :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead. // // Note that hand off to another listener is *NOT* performed without this flag. Once // :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag // will be removed, as filter chain matching can be used to select a filter chain based on the // restored destination address. // // Deprecated: Marked as deprecated in envoy/api/v2/listener.proto. UseOriginalDst *wrapperspb.BoolValue `protobuf:"bytes,4,opt,name=use_original_dst,json=useOriginalDst,proto3" json:"use_original_dst,omitempty"` // Soft limit on size of the listener’s new connection read and write buffers. // If unspecified, an implementation defined default is applied (1MiB). PerConnectionBufferLimitBytes *wrapperspb.UInt32Value `` /* 154-byte string literal not displayed */ // Listener metadata. Metadata *core.Metadata `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"` // [#not-implemented-hide:] DeprecatedV1 *Listener_DeprecatedV1 `protobuf:"bytes,7,opt,name=deprecated_v1,json=deprecatedV1,proto3" json:"deprecated_v1,omitempty"` // The type of draining to perform at a listener-wide level. DrainType Listener_DrainType `` /* 126-byte string literal not displayed */ // Listener filters have the opportunity to manipulate and augment the connection metadata that // is used in connection filter chain matching, for example. These filters are run before any in // :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the // filters are processed sequentially right after a socket has been accepted by the listener, and // before a connection is created. // UDP Listener filters can be specified when the protocol in the listener socket address in // :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP // <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`. // UDP listeners currently support a single filter. ListenerFilters []*listener.ListenerFilter `protobuf:"bytes,9,rep,name=listener_filters,json=listenerFilters,proto3" json:"listener_filters,omitempty"` // The timeout to wait for all listener filters to complete operation. If the timeout is reached, // the accepted socket is closed without a connection being created unless // `continue_on_listener_filters_timeout` is set to true. Specify 0 to disable the // timeout. If not specified, a default timeout of 15s is used. ListenerFiltersTimeout *durationpb.Duration `` /* 130-byte string literal not displayed */ // Whether a connection should be created when listener filters timeout. Default is false. // // .. attention:: // // Some listener filters, such as :ref:`Proxy Protocol filter // <config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause // unexpected behavior when a connection is created. ContinueOnListenerFiltersTimeout bool `` /* 165-byte string literal not displayed */ // Whether the listener should be set as a transparent socket. // When this flag is set to true, connections can be redirected to the listener using an // *iptables* *TPROXY* target, in which case the original source and destination addresses and // ports are preserved on accepted connections. This flag should be used in combination with // :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter // <envoy_api_field_Listener.listener_filters>` to mark the connections' local addresses as // "restored." This can be used to hand off each redirected connection to another listener // associated with the connection's destination address. Direct connections to the socket without // using *TPROXY* cannot be distinguished from connections redirected using *TPROXY* and are // therefore treated as if they were redirected. // When this flag is set to false, the listener's socket is explicitly reset as non-transparent. // Setting this flag requires Envoy to run with the *CAP_NET_ADMIN* capability. // When this flag is not set (default), the socket is not modified, i.e. the transparent option // is neither set nor reset. Transparent *wrapperspb.BoolValue `protobuf:"bytes,10,opt,name=transparent,proto3" json:"transparent,omitempty"` // Whether the listener should set the *IP_FREEBIND* socket option. When this // flag is set to true, listeners can be bound to an IP address that is not // configured on the system running Envoy. When this flag is set to false, the // option *IP_FREEBIND* is disabled on the socket. When this flag is not set // (default), the socket is not modified, i.e. the option is neither enabled // nor disabled. Freebind *wrapperspb.BoolValue `protobuf:"bytes,11,opt,name=freebind,proto3" json:"freebind,omitempty"` // Additional socket options that may not be present in Envoy source code or // precompiled binaries. SocketOptions []*core.SocketOption `protobuf:"bytes,13,rep,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"` // Whether the listener should accept TCP Fast Open (TFO) connections. // When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on // the socket, with a queue length of the specified size // (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_). // When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket. // When this flag is not set (default), the socket is not modified, // i.e. the option is neither enabled nor disabled. // // On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable // TCP_FASTOPEN. // See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_. // // On macOS, only values of 0, 1, and unset are valid; other values may result in an error. // To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter. TcpFastOpenQueueLength *wrapperspb.UInt32Value `` /* 134-byte string literal not displayed */ // Specifies the intended direction of the traffic relative to the local Envoy. // This property is required on Windows for listeners using the original destination filter, // see :ref:`Original Destination <config_listener_filters_original_dst>`. TrafficDirection core.TrafficDirection `` /* 151-byte string literal not displayed */ // If the protocol in the listener socket address in :ref:`protocol // <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP // <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp // listener to create, i.e. :ref:`udp_listener_name // <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for // creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener". UdpListenerConfig *listener.UdpListenerConfig `protobuf:"bytes,18,opt,name=udp_listener_config,json=udpListenerConfig,proto3" json:"udp_listener_config,omitempty"` // Used to represent an API listener, which is used in non-proxy clients. The type of API // exposed to the non-proxy application depends on the type of API listener. // When this field is set, no other field except for :ref:`name<envoy_api_field_Listener.name>` // should be set. // // .. note:: // // Currently only one ApiListener can be installed; and it can only be done via bootstrap config, // not LDS. // // [#next-major-version: In the v3 API, instead of this messy approach where the socket // listener fields are directly in the top-level Listener message and the API listener types // are in the ApiListener message, the socket listener messages should be in their own message, // and the top-level Listener should essentially be a oneof that selects between the // socket listener and the various types of API listener. That way, a given Listener message // can structurally only contain the fields of the relevant type.] ApiListener *v2.ApiListener `protobuf:"bytes,19,opt,name=api_listener,json=apiListener,proto3" json:"api_listener,omitempty"` // The listener's connection balancer configuration, currently only applicable to TCP listeners. // If no configuration is specified, Envoy will not attempt to balance active connections between // worker threads. ConnectionBalanceConfig *Listener_ConnectionBalanceConfig `` /* 133-byte string literal not displayed */ // When this flag is set to true, listeners set the *SO_REUSEPORT* socket option and // create one socket for each worker thread. This makes inbound connections // distribute among worker threads roughly evenly in cases where there are a high number // of connections. When this flag is set to false, all worker threads share one socket. // // Before Linux v4.19-rc1, new TCP connections may be rejected during hot restart // (see `3rd paragraph in 'soreuseport' commit message // <https://github.com/torvalds/linux/commit/c617f398edd4db2b8567a28e89>`_). // This issue was fixed by `tcp: Avoid TCP syncookie rejected by SO_REUSEPORT socket // <https://github.com/torvalds/linux/commit/40a1227ea845a37ab197dd1caffb60b047fa36b1>`_. ReusePort bool `protobuf:"varint,21,opt,name=reuse_port,json=reusePort,proto3" json:"reuse_port,omitempty"` // Configuration for :ref:`access logs <arch_overview_access_logs>` // emitted by this listener. AccessLog []*v21.AccessLog `protobuf:"bytes,22,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 23]
func (*Listener) GetApiListener ¶
func (x *Listener) GetApiListener() *v2.ApiListener
func (*Listener) GetConnectionBalanceConfig ¶
func (x *Listener) GetConnectionBalanceConfig() *Listener_ConnectionBalanceConfig
func (*Listener) GetContinueOnListenerFiltersTimeout ¶
func (*Listener) GetDeprecatedV1 ¶
func (x *Listener) GetDeprecatedV1() *Listener_DeprecatedV1
func (*Listener) GetDrainType ¶
func (x *Listener) GetDrainType() Listener_DrainType
func (*Listener) GetFilterChains ¶
func (x *Listener) GetFilterChains() []*listener.FilterChain
func (*Listener) GetFreebind ¶
func (x *Listener) GetFreebind() *wrapperspb.BoolValue
func (*Listener) GetListenerFilters ¶
func (x *Listener) GetListenerFilters() []*listener.ListenerFilter
func (*Listener) GetListenerFiltersTimeout ¶
func (x *Listener) GetListenerFiltersTimeout() *durationpb.Duration
func (*Listener) GetPerConnectionBufferLimitBytes ¶
func (x *Listener) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value
func (*Listener) GetSocketOptions ¶
func (x *Listener) GetSocketOptions() []*core.SocketOption
func (*Listener) GetTcpFastOpenQueueLength ¶
func (x *Listener) GetTcpFastOpenQueueLength() *wrapperspb.UInt32Value
func (*Listener) GetTrafficDirection ¶
func (x *Listener) GetTrafficDirection() core.TrafficDirection
func (*Listener) GetTransparent ¶
func (x *Listener) GetTransparent() *wrapperspb.BoolValue
func (*Listener) GetUdpListenerConfig ¶
func (x *Listener) GetUdpListenerConfig() *listener.UdpListenerConfig
func (*Listener) GetUseOriginalDst
deprecated
func (x *Listener) GetUseOriginalDst() *wrapperspb.BoolValue
Deprecated: Marked as deprecated in envoy/api/v2/listener.proto.
func (*Listener) ProtoReflect ¶
func (x *Listener) ProtoReflect() protoreflect.Message
type Listener_ConnectionBalanceConfig ¶
type Listener_ConnectionBalanceConfig struct { // Types that are assignable to BalanceType: // // *Listener_ConnectionBalanceConfig_ExactBalance_ BalanceType isListener_ConnectionBalanceConfig_BalanceType `protobuf_oneof:"balance_type"` // contains filtered or unexported fields }
Configuration for listener connection balancing.
func (*Listener_ConnectionBalanceConfig) Descriptor
deprecated
func (*Listener_ConnectionBalanceConfig) Descriptor() ([]byte, []int)
Deprecated: Use Listener_ConnectionBalanceConfig.ProtoReflect.Descriptor instead.
func (*Listener_ConnectionBalanceConfig) GetBalanceType ¶
func (m *Listener_ConnectionBalanceConfig) GetBalanceType() isListener_ConnectionBalanceConfig_BalanceType
func (*Listener_ConnectionBalanceConfig) GetExactBalance ¶
func (x *Listener_ConnectionBalanceConfig) GetExactBalance() *Listener_ConnectionBalanceConfig_ExactBalance
func (*Listener_ConnectionBalanceConfig) ProtoMessage ¶
func (*Listener_ConnectionBalanceConfig) ProtoMessage()
func (*Listener_ConnectionBalanceConfig) ProtoReflect ¶
func (x *Listener_ConnectionBalanceConfig) ProtoReflect() protoreflect.Message
func (*Listener_ConnectionBalanceConfig) Reset ¶
func (x *Listener_ConnectionBalanceConfig) Reset()
func (*Listener_ConnectionBalanceConfig) String ¶
func (x *Listener_ConnectionBalanceConfig) String() string
type Listener_ConnectionBalanceConfig_ExactBalance ¶
type Listener_ConnectionBalanceConfig_ExactBalance struct {
// contains filtered or unexported fields
}
A connection balancer implementation that does exact balancing. This means that a lock is held during balancing so that connection counts are nearly exactly balanced between worker threads. This is "nearly" exact in the sense that a connection might close in parallel thus making the counts incorrect, but this should be rectified on the next accept. This balancer sacrifices accept throughput for accuracy and should be used when there are a small number of connections that rarely cycle (e.g., service mesh gRPC egress).
func (*Listener_ConnectionBalanceConfig_ExactBalance) Descriptor
deprecated
func (*Listener_ConnectionBalanceConfig_ExactBalance) Descriptor() ([]byte, []int)
Deprecated: Use Listener_ConnectionBalanceConfig_ExactBalance.ProtoReflect.Descriptor instead.
func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoMessage ¶
func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoMessage()
func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoReflect ¶
func (x *Listener_ConnectionBalanceConfig_ExactBalance) ProtoReflect() protoreflect.Message
func (*Listener_ConnectionBalanceConfig_ExactBalance) Reset ¶
func (x *Listener_ConnectionBalanceConfig_ExactBalance) Reset()
func (*Listener_ConnectionBalanceConfig_ExactBalance) String ¶
func (x *Listener_ConnectionBalanceConfig_ExactBalance) String() string
type Listener_ConnectionBalanceConfig_ExactBalance_ ¶
type Listener_ConnectionBalanceConfig_ExactBalance_ struct { // If specified, the listener will use the exact connection balancer. ExactBalance *Listener_ConnectionBalanceConfig_ExactBalance `protobuf:"bytes,1,opt,name=exact_balance,json=exactBalance,proto3,oneof"` }
type Listener_DeprecatedV1 ¶
type Listener_DeprecatedV1 struct { // Whether the listener should bind to the port. A listener that doesn't // bind can only receive connections redirected from other listeners that // set use_original_dst parameter to true. Default is true. // // This is deprecated in v2, all Listeners will bind to their port. An // additional filter chain must be created for every original destination // port this listener may redirect to in v2, with the original port // specified in the FilterChainMatch destination_port field. // // [#comment:TODO(PiotrSikora): Remove this once verified that we no longer need it.] BindToPort *wrapperspb.BoolValue `protobuf:"bytes,1,opt,name=bind_to_port,json=bindToPort,proto3" json:"bind_to_port,omitempty"` // contains filtered or unexported fields }
[#not-implemented-hide:]
func (*Listener_DeprecatedV1) Descriptor
deprecated
func (*Listener_DeprecatedV1) Descriptor() ([]byte, []int)
Deprecated: Use Listener_DeprecatedV1.ProtoReflect.Descriptor instead.
func (*Listener_DeprecatedV1) GetBindToPort ¶
func (x *Listener_DeprecatedV1) GetBindToPort() *wrapperspb.BoolValue
func (*Listener_DeprecatedV1) ProtoMessage ¶
func (*Listener_DeprecatedV1) ProtoMessage()
func (*Listener_DeprecatedV1) ProtoReflect ¶
func (x *Listener_DeprecatedV1) ProtoReflect() protoreflect.Message
func (*Listener_DeprecatedV1) Reset ¶
func (x *Listener_DeprecatedV1) Reset()
func (*Listener_DeprecatedV1) String ¶
func (x *Listener_DeprecatedV1) String() string
type Listener_DrainType ¶
type Listener_DrainType int32
const ( // Drain in response to calling /healthcheck/fail admin endpoint (along with the health check // filter), listener removal/modification, and hot restart. Listener_DEFAULT Listener_DrainType = 0 // Drain in response to listener removal/modification and hot restart. This setting does not // include /healthcheck/fail. This setting may be desirable if Envoy is hosting both ingress // and egress listeners. Listener_MODIFY_ONLY Listener_DrainType = 1 )
func (Listener_DrainType) Descriptor ¶
func (Listener_DrainType) Descriptor() protoreflect.EnumDescriptor
func (Listener_DrainType) Enum ¶
func (x Listener_DrainType) Enum() *Listener_DrainType
func (Listener_DrainType) EnumDescriptor
deprecated
func (Listener_DrainType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Listener_DrainType.Descriptor instead.
func (Listener_DrainType) Number ¶
func (x Listener_DrainType) Number() protoreflect.EnumNumber
func (Listener_DrainType) String ¶
func (x Listener_DrainType) String() string
func (Listener_DrainType) Type ¶
func (Listener_DrainType) Type() protoreflect.EnumType
type LoadBalancingPolicy ¶
type LoadBalancingPolicy struct { // Each client will iterate over the list in order and stop at the first policy that it // supports. This provides a mechanism for starting to use new LB policies that are not yet // supported by all clients. Policies []*LoadBalancingPolicy_Policy `protobuf:"bytes,1,rep,name=policies,proto3" json:"policies,omitempty"` // contains filtered or unexported fields }
[#not-implemented-hide:] Extensible load balancing policy configuration.
Every LB policy defined via this mechanism will be identified via a unique name using reverse DNS notation. If the policy needs configuration parameters, it must define a message for its own configuration, which will be stored in the config field. The name of the policy will tell clients which type of message they should expect to see in the config field.
Note that there are cases where it is useful to be able to independently select LB policies for choosing a locality and for choosing an endpoint within that locality. For example, a given deployment may always use the same policy to choose the locality, but for choosing the endpoint within the locality, some clusters may use weighted-round-robin, while others may use some sort of session-based balancing.
This can be accomplished via hierarchical LB policies, where the parent LB policy creates a child LB policy for each locality. For each request, the parent chooses the locality and then delegates to the child policy for that locality to choose the endpoint within the locality.
To facilitate this, the config message for the top-level LB policy may include a field of type LoadBalancingPolicy that specifies the child policy.
func (*LoadBalancingPolicy) Descriptor
deprecated
func (*LoadBalancingPolicy) Descriptor() ([]byte, []int)
Deprecated: Use LoadBalancingPolicy.ProtoReflect.Descriptor instead.
func (*LoadBalancingPolicy) GetPolicies ¶
func (x *LoadBalancingPolicy) GetPolicies() []*LoadBalancingPolicy_Policy
func (*LoadBalancingPolicy) ProtoMessage ¶
func (*LoadBalancingPolicy) ProtoMessage()
func (*LoadBalancingPolicy) ProtoReflect ¶
func (x *LoadBalancingPolicy) ProtoReflect() protoreflect.Message
func (*LoadBalancingPolicy) Reset ¶
func (x *LoadBalancingPolicy) Reset()
func (*LoadBalancingPolicy) String ¶
func (x *LoadBalancingPolicy) String() string
type LoadBalancingPolicy_Policy ¶
type LoadBalancingPolicy_Policy struct { // Required. The name of the LB policy. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional config for the LB policy. // No more than one of these two fields may be populated. // // Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto. Config *structpb.Struct `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"` TypedConfig *anypb.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"` // contains filtered or unexported fields }
func (*LoadBalancingPolicy_Policy) Descriptor
deprecated
func (*LoadBalancingPolicy_Policy) Descriptor() ([]byte, []int)
Deprecated: Use LoadBalancingPolicy_Policy.ProtoReflect.Descriptor instead.
func (*LoadBalancingPolicy_Policy) GetConfig
deprecated
func (x *LoadBalancingPolicy_Policy) GetConfig() *structpb.Struct
Deprecated: Marked as deprecated in envoy/api/v2/cluster.proto.
func (*LoadBalancingPolicy_Policy) GetName ¶
func (x *LoadBalancingPolicy_Policy) GetName() string
func (*LoadBalancingPolicy_Policy) GetTypedConfig ¶
func (x *LoadBalancingPolicy_Policy) GetTypedConfig() *anypb.Any
func (*LoadBalancingPolicy_Policy) ProtoMessage ¶
func (*LoadBalancingPolicy_Policy) ProtoMessage()
func (*LoadBalancingPolicy_Policy) ProtoReflect ¶
func (x *LoadBalancingPolicy_Policy) ProtoReflect() protoreflect.Message
func (*LoadBalancingPolicy_Policy) Reset ¶
func (x *LoadBalancingPolicy_Policy) Reset()
func (*LoadBalancingPolicy_Policy) String ¶
func (x *LoadBalancingPolicy_Policy) String() string
type RdsDummy ¶
type RdsDummy struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
func (*RdsDummy) ProtoReflect ¶
func (x *RdsDummy) ProtoReflect() protoreflect.Message
type Resource ¶
type Resource struct { // The resource's name, to distinguish it from others of the same type of resource. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` // The aliases are a list of other names that this resource can go by. Aliases []string `protobuf:"bytes,4,rep,name=aliases,proto3" json:"aliases,omitempty"` // The resource level version. It allows xDS to track the state of individual // resources. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // The resource being tracked. Resource *anypb.Any `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"` // contains filtered or unexported fields }
func (*Resource) ProtoReflect ¶
func (x *Resource) ProtoReflect() protoreflect.Message
type RouteConfiguration ¶
type RouteConfiguration struct { // The name of the route configuration. For example, it might match // :ref:`route_config_name // <envoy_api_field_config.filter.network.http_connection_manager.v2.Rds.route_config_name>` in // :ref:`envoy_api_msg_config.filter.network.http_connection_manager.v2.Rds`. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // An array of virtual hosts that make up the route table. VirtualHosts []*route.VirtualHost `protobuf:"bytes,2,rep,name=virtual_hosts,json=virtualHosts,proto3" json:"virtual_hosts,omitempty"` // An array of virtual hosts will be dynamically loaded via the VHDS API. // Both *virtual_hosts* and *vhds* fields will be used when present. *virtual_hosts* can be used // for a base routing table or for infrequently changing virtual hosts. *vhds* is used for // on-demand discovery of virtual hosts. The contents of these two fields will be merged to // generate a routing table for a given RouteConfiguration, with *vhds* derived configuration // taking precedence. Vhds *Vhds `protobuf:"bytes,9,opt,name=vhds,proto3" json:"vhds,omitempty"` // Optionally specifies a list of HTTP headers that the connection manager // will consider to be internal only. If they are found on external requests they will be cleaned // prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more // information. InternalOnlyHeaders []string `protobuf:"bytes,3,rep,name=internal_only_headers,json=internalOnlyHeaders,proto3" json:"internal_only_headers,omitempty"` // Specifies a list of HTTP headers that should be added to each response that // the connection manager encodes. Headers specified at this level are applied // after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or // :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on // header value syntax, see the documentation on :ref:`custom request headers // <config_http_conn_man_headers_custom_request_headers>`. ResponseHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,4,rep,name=response_headers_to_add,json=responseHeadersToAdd,proto3" json:"response_headers_to_add,omitempty"` // Specifies a list of HTTP headers that should be removed from each response // that the connection manager encodes. ResponseHeadersToRemove []string `` /* 134-byte string literal not displayed */ // Specifies a list of HTTP headers that should be added to each request // routed by the HTTP connection manager. Headers specified at this level are // applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or // :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on // header value syntax, see the documentation on :ref:`custom request headers // <config_http_conn_man_headers_custom_request_headers>`. RequestHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,6,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"` // Specifies a list of HTTP headers that should be removed from each request // routed by the HTTP connection manager. RequestHeadersToRemove []string `` /* 131-byte string literal not displayed */ // By default, headers that should be added/removed are evaluated from most to least specific: // // * route level // * virtual host level // * connection manager level // // To allow setting overrides at the route or virtual host level, this order can be reversed // by setting this option to true. Defaults to false. // // [#next-major-version: In the v3 API, this will default to true.] MostSpecificHeaderMutationsWins bool `` /* 162-byte string literal not displayed */ // An optional boolean that specifies whether the clusters that the route // table refers to will be validated by the cluster manager. If set to true // and a route refers to a non-existent cluster, the route table will not // load. If set to false and a route refers to a non-existent cluster, the // route table will load and the router filter will return a 404 if the route // is selected at runtime. This setting defaults to true if the route table // is statically defined via the :ref:`route_config // <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>` // option. This setting default to false if the route table is loaded dynamically via the // :ref:`rds // <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.rds>` // option. Users may wish to override the default behavior in certain cases (for example when // using CDS with a static route table). ValidateClusters *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=validate_clusters,json=validateClusters,proto3" json:"validate_clusters,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 11]
func (*RouteConfiguration) Descriptor
deprecated
func (*RouteConfiguration) Descriptor() ([]byte, []int)
Deprecated: Use RouteConfiguration.ProtoReflect.Descriptor instead.
func (*RouteConfiguration) GetInternalOnlyHeaders ¶
func (x *RouteConfiguration) GetInternalOnlyHeaders() []string
func (*RouteConfiguration) GetMostSpecificHeaderMutationsWins ¶
func (x *RouteConfiguration) GetMostSpecificHeaderMutationsWins() bool
func (*RouteConfiguration) GetName ¶
func (x *RouteConfiguration) GetName() string
func (*RouteConfiguration) GetRequestHeadersToAdd ¶
func (x *RouteConfiguration) GetRequestHeadersToAdd() []*core.HeaderValueOption
func (*RouteConfiguration) GetRequestHeadersToRemove ¶
func (x *RouteConfiguration) GetRequestHeadersToRemove() []string
func (*RouteConfiguration) GetResponseHeadersToAdd ¶
func (x *RouteConfiguration) GetResponseHeadersToAdd() []*core.HeaderValueOption
func (*RouteConfiguration) GetResponseHeadersToRemove ¶
func (x *RouteConfiguration) GetResponseHeadersToRemove() []string
func (*RouteConfiguration) GetValidateClusters ¶
func (x *RouteConfiguration) GetValidateClusters() *wrapperspb.BoolValue
func (*RouteConfiguration) GetVhds ¶
func (x *RouteConfiguration) GetVhds() *Vhds
func (*RouteConfiguration) GetVirtualHosts ¶
func (x *RouteConfiguration) GetVirtualHosts() []*route.VirtualHost
func (*RouteConfiguration) ProtoMessage ¶
func (*RouteConfiguration) ProtoMessage()
func (*RouteConfiguration) ProtoReflect ¶
func (x *RouteConfiguration) ProtoReflect() protoreflect.Message
func (*RouteConfiguration) Reset ¶
func (x *RouteConfiguration) Reset()
func (*RouteConfiguration) String ¶
func (x *RouteConfiguration) String() string
type ScopedRouteConfiguration ¶
type ScopedRouteConfiguration struct { // The name assigned to the routing scope. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an // RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated // with this scope. RouteConfigurationName string `` /* 129-byte string literal not displayed */ // The key to match against. Key *ScopedRouteConfiguration_Key `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
Specifies a routing scope, which associates a :ref:`Key<envoy_api_msg_ScopedRouteConfiguration.Key>` to a :ref:`envoy_api_msg_RouteConfiguration` (identified by its resource name).
The HTTP connection manager builds up a table consisting of these Key to RouteConfiguration mappings, and looks up the RouteConfiguration to use per request according to the algorithm specified in the :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>` assigned to the HttpConnectionManager.
For example, with the following configurations (in YAML):
HttpConnectionManager config:
.. code::
... scoped_routes: name: foo-scoped-routes scope_key_builder: fragments: - header_value_extractor: name: X-Route-Selector element_separator: "," element: separator: = key: vip
ScopedRouteConfiguration resources (specified statically via :ref:`scoped_route_configurations_list<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scoped_route_configurations_list>` or obtained dynamically via SRDS):
.. code::
(1) name: route-scope1 route_configuration_name: route-config1 key: fragments: - string_key: 172.10.10.20 (2) name: route-scope2 route_configuration_name: route-config2 key: fragments: - string_key: 172.20.20.30
A request from a client such as:
.. code::
GET / HTTP/1.1 Host: foo.com X-Route-Selector: vip=172.10.10.20
would result in the routing table defined by the `route-config1` RouteConfiguration being assigned to the HTTP request/stream.
func (*ScopedRouteConfiguration) Descriptor
deprecated
func (*ScopedRouteConfiguration) Descriptor() ([]byte, []int)
Deprecated: Use ScopedRouteConfiguration.ProtoReflect.Descriptor instead.
func (*ScopedRouteConfiguration) GetKey ¶
func (x *ScopedRouteConfiguration) GetKey() *ScopedRouteConfiguration_Key
func (*ScopedRouteConfiguration) GetName ¶
func (x *ScopedRouteConfiguration) GetName() string
func (*ScopedRouteConfiguration) GetRouteConfigurationName ¶
func (x *ScopedRouteConfiguration) GetRouteConfigurationName() string
func (*ScopedRouteConfiguration) ProtoMessage ¶
func (*ScopedRouteConfiguration) ProtoMessage()
func (*ScopedRouteConfiguration) ProtoReflect ¶
func (x *ScopedRouteConfiguration) ProtoReflect() protoreflect.Message
func (*ScopedRouteConfiguration) Reset ¶
func (x *ScopedRouteConfiguration) Reset()
func (*ScopedRouteConfiguration) String ¶
func (x *ScopedRouteConfiguration) String() string
type ScopedRouteConfiguration_Key ¶
type ScopedRouteConfiguration_Key struct { // The ordered set of fragments to match against. The order must match the // fragments in the corresponding // :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>`. Fragments []*ScopedRouteConfiguration_Key_Fragment `protobuf:"bytes,1,rep,name=fragments,proto3" json:"fragments,omitempty"` // contains filtered or unexported fields }
Specifies a key which is matched against the output of the :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>` specified in the HttpConnectionManager. The matching is done per HTTP request and is dependent on the order of the fragments contained in the Key.
func (*ScopedRouteConfiguration_Key) Descriptor
deprecated
func (*ScopedRouteConfiguration_Key) Descriptor() ([]byte, []int)
Deprecated: Use ScopedRouteConfiguration_Key.ProtoReflect.Descriptor instead.
func (*ScopedRouteConfiguration_Key) GetFragments ¶
func (x *ScopedRouteConfiguration_Key) GetFragments() []*ScopedRouteConfiguration_Key_Fragment
func (*ScopedRouteConfiguration_Key) ProtoMessage ¶
func (*ScopedRouteConfiguration_Key) ProtoMessage()
func (*ScopedRouteConfiguration_Key) ProtoReflect ¶
func (x *ScopedRouteConfiguration_Key) ProtoReflect() protoreflect.Message
func (*ScopedRouteConfiguration_Key) Reset ¶
func (x *ScopedRouteConfiguration_Key) Reset()
func (*ScopedRouteConfiguration_Key) String ¶
func (x *ScopedRouteConfiguration_Key) String() string
type ScopedRouteConfiguration_Key_Fragment ¶
type ScopedRouteConfiguration_Key_Fragment struct { // Types that are assignable to Type: // // *ScopedRouteConfiguration_Key_Fragment_StringKey Type isScopedRouteConfiguration_Key_Fragment_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
func (*ScopedRouteConfiguration_Key_Fragment) Descriptor
deprecated
func (*ScopedRouteConfiguration_Key_Fragment) Descriptor() ([]byte, []int)
Deprecated: Use ScopedRouteConfiguration_Key_Fragment.ProtoReflect.Descriptor instead.
func (*ScopedRouteConfiguration_Key_Fragment) GetStringKey ¶
func (x *ScopedRouteConfiguration_Key_Fragment) GetStringKey() string
func (*ScopedRouteConfiguration_Key_Fragment) GetType ¶
func (m *ScopedRouteConfiguration_Key_Fragment) GetType() isScopedRouteConfiguration_Key_Fragment_Type
func (*ScopedRouteConfiguration_Key_Fragment) ProtoMessage ¶
func (*ScopedRouteConfiguration_Key_Fragment) ProtoMessage()
func (*ScopedRouteConfiguration_Key_Fragment) ProtoReflect ¶
func (x *ScopedRouteConfiguration_Key_Fragment) ProtoReflect() protoreflect.Message
func (*ScopedRouteConfiguration_Key_Fragment) Reset ¶
func (x *ScopedRouteConfiguration_Key_Fragment) Reset()
func (*ScopedRouteConfiguration_Key_Fragment) String ¶
func (x *ScopedRouteConfiguration_Key_Fragment) String() string
type ScopedRouteConfiguration_Key_Fragment_StringKey ¶
type ScopedRouteConfiguration_Key_Fragment_StringKey struct { // A string to match against. StringKey string `protobuf:"bytes,1,opt,name=string_key,json=stringKey,proto3,oneof"` }
type SrdsDummy ¶
type SrdsDummy struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
func (*SrdsDummy) ProtoReflect ¶
func (x *SrdsDummy) ProtoReflect() protoreflect.Message
type UpstreamBindConfig ¶
type UpstreamBindConfig struct { // The address Envoy should bind to when establishing upstream connections. SourceAddress *core.Address `protobuf:"bytes,1,opt,name=source_address,json=sourceAddress,proto3" json:"source_address,omitempty"` // contains filtered or unexported fields }
An extensible structure containing the address Envoy should bind to when establishing upstream connections.
func (*UpstreamBindConfig) Descriptor
deprecated
func (*UpstreamBindConfig) Descriptor() ([]byte, []int)
Deprecated: Use UpstreamBindConfig.ProtoReflect.Descriptor instead.
func (*UpstreamBindConfig) GetSourceAddress ¶
func (x *UpstreamBindConfig) GetSourceAddress() *core.Address
func (*UpstreamBindConfig) ProtoMessage ¶
func (*UpstreamBindConfig) ProtoMessage()
func (*UpstreamBindConfig) ProtoReflect ¶
func (x *UpstreamBindConfig) ProtoReflect() protoreflect.Message
func (*UpstreamBindConfig) Reset ¶
func (x *UpstreamBindConfig) Reset()
func (*UpstreamBindConfig) String ¶
func (x *UpstreamBindConfig) String() string
type UpstreamConnectionOptions ¶
type UpstreamConnectionOptions struct { // If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives. TcpKeepalive *core.TcpKeepalive `protobuf:"bytes,1,opt,name=tcp_keepalive,json=tcpKeepalive,proto3" json:"tcp_keepalive,omitempty"` // contains filtered or unexported fields }
func (*UpstreamConnectionOptions) Descriptor
deprecated
func (*UpstreamConnectionOptions) Descriptor() ([]byte, []int)
Deprecated: Use UpstreamConnectionOptions.ProtoReflect.Descriptor instead.
func (*UpstreamConnectionOptions) GetTcpKeepalive ¶
func (x *UpstreamConnectionOptions) GetTcpKeepalive() *core.TcpKeepalive
func (*UpstreamConnectionOptions) ProtoMessage ¶
func (*UpstreamConnectionOptions) ProtoMessage()
func (*UpstreamConnectionOptions) ProtoReflect ¶
func (x *UpstreamConnectionOptions) ProtoReflect() protoreflect.Message
func (*UpstreamConnectionOptions) Reset ¶
func (x *UpstreamConnectionOptions) Reset()
func (*UpstreamConnectionOptions) String ¶
func (x *UpstreamConnectionOptions) String() string
type Vhds ¶
type Vhds struct { // Configuration source specifier for VHDS. ConfigSource *core.ConfigSource `protobuf:"bytes,1,opt,name=config_source,json=configSource,proto3" json:"config_source,omitempty"` // contains filtered or unexported fields }
func (*Vhds) GetConfigSource ¶
func (x *Vhds) GetConfigSource() *core.ConfigSource
func (*Vhds) ProtoReflect ¶
func (x *Vhds) ProtoReflect() protoreflect.Message