# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
This load balancer type must be specified if the configured cluster provides a cluster specific load balancer.
Refer to the :ref:`service discovery type<arch_overview_service_discovery_types_eds>` for an explanation.
No description provided by the author
No description provided by the author
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.
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>`.
If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported.
If NOT_DEFINED top level config fallback policy is used instead.
No description provided by the author
Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.
[#not-implemented-hide:] Use the new :ref:`load_balancing_policy <envoy_api_field_Cluster.load_balancing_policy>` field to determine the LB policy.
Refer to the :ref:`logical DNS discovery type<arch_overview_service_discovery_types_logical_dns>` for an explanation.
Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.
Refer to the :ref:`original destination discovery type<arch_overview_service_discovery_types_original_destination>` for an explanation.
Refer to the :ref:`original destination load balancing policy<arch_overview_load_balancing_types_original_destination>` for an explanation.
Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.
Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.
Use `MurmurHash2 <https://sites.google.com/site/murmurhash/>`_, this is compatible with std:hash<string> in GNU libstdc++ 3.4.20 or above.
Use `xxHash <https://github.com/Cyan4973/xxHash>`_, this is the default hash function.
Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation.
Refer to the :ref:`static discovery type<arch_overview_service_discovery_types_static>` for an explanation.
Refer to the :ref:`strict DNS discovery type<arch_overview_service_discovery_types_strict_dns>` for an explanation.
Cluster can only operate on one of the possible upstream protocols (HTTP1.1, HTTP2).
Use HTTP1.1 or HTTP2, depending on which one is used on the downstream connection.
No description provided by the author
No description provided by the author
Drain in response to calling /healthcheck/fail admin endpoint (along with the health check filter), listener removal/modification, and hot restart.
Drain in response to listener removal/modification and hot restart.
# Variables
Enum value maps for Cluster_ClusterProtocolSelection.
Enum value maps for Cluster_ClusterProtocolSelection.
Enum value maps for Cluster_DiscoveryType.
Enum value maps for Cluster_DiscoveryType.
Enum value maps for Cluster_DnsLookupFamily.
Enum value maps for Cluster_DnsLookupFamily.
Enum value maps for Cluster_LbPolicy.
Enum value maps for Cluster_LbPolicy.
Enum value maps for Cluster_LbSubsetConfig_LbSubsetFallbackPolicy.
Enum value maps for Cluster_LbSubsetConfig_LbSubsetFallbackPolicy.
Enum value maps for Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy.
Enum value maps for Cluster_LbSubsetConfig_LbSubsetSelector_LbSubsetSelectorFallbackPolicy.
Enum value maps for Cluster_RingHashLbConfig_HashFunction.
Enum value maps for Cluster_RingHashLbConfig_HashFunction.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for Listener_DrainType.
Enum value maps for Listener_DrainType.
# Structs
[#not-implemented-hide:] Not configuration.
CdsDummyValidationError is the validation error returned by CdsDummy.Validate if the designated constraints aren't met.
Configuration for a single upstream cluster.
No description provided by the author
Common configuration for all load balancer implementations.
Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.).
Cluster_CommonLbConfig_ConsistentHashingLbConfigValidationError is the validation error returned by Cluster_CommonLbConfig_ConsistentHashingLbConfig.Validate if the designated constraints aren't met.
Configuration for :ref:`locality weighted load balancing <arch_overview_load_balancing_locality_weighted_lb>`.
No description provided by the author
Cluster_CommonLbConfig_LocalityWeightedLbConfigValidationError is the validation error returned by Cluster_CommonLbConfig_LocalityWeightedLbConfig.Validate if the designated constraints aren't met.
Configuration for :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>`.
No description provided by the author
Cluster_CommonLbConfig_ZoneAwareLbConfigValidationError is the validation error returned by Cluster_CommonLbConfig_ZoneAwareLbConfig.Validate if the designated constraints aren't met.
Cluster_CommonLbConfigValidationError is the validation error returned by Cluster_CommonLbConfig.Validate if the designated constraints aren't met.
Extended cluster type.
Cluster_CustomClusterTypeValidationError is the validation error returned by Cluster_CustomClusterType.Validate if the designated constraints aren't met.
Only valid when discovery type is EDS.
Cluster_EdsClusterConfigValidationError is the validation error returned by Cluster_EdsClusterConfig.Validate if the designated constraints aren't met.
Optionally divide the endpoints in this cluster into subsets defined by endpoint metadata and selected by route and weighted cluster metadata.
Specifications for subsets.
Cluster_LbSubsetConfig_LbSubsetSelectorValidationError is the validation error returned by Cluster_LbSubsetConfig_LbSubsetSelector.Validate if the designated constraints aren't met.
Cluster_LbSubsetConfigValidationError is the validation error returned by Cluster_LbSubsetConfig.Validate if the designated constraints aren't met.
Specific configuration for the LeastRequest load balancing policy.
No description provided by the author
Cluster_LeastRequestLbConfigValidationError is the validation error returned by Cluster_LeastRequestLbConfig.Validate if the designated constraints aren't met.
Specific configuration for the :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>` load balancing policy.
No description provided by the author
Cluster_OriginalDstLbConfigValidationError is the validation error returned by Cluster_OriginalDstLbConfig.Validate if the designated constraints aren't met.
No description provided by the author
Cluster_RefreshRateValidationError is the validation error returned by Cluster_RefreshRate.Validate if the designated constraints aren't met.
Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.
No description provided by the author
Cluster_RingHashLbConfigValidationError is the validation error returned by Cluster_RingHashLbConfig.Validate if the designated constraints aren't met.
TransportSocketMatch specifies what transport socket config will be used when the match conditions are satisfied.
Cluster_TransportSocketMatchValidationError is the validation error returned by Cluster_TransportSocketMatch.Validate if the designated constraints aren't met.
No description provided by the author
Each route from RDS will map to a single cluster or traffic split across clusters using weights expressed in the RDS WeightedCluster.
Load balancing policy settings.
[#not-implemented-hide:].
ClusterLoadAssignment_Policy_DropOverloadValidationError is the validation error returned by ClusterLoadAssignment_Policy_DropOverload.Validate if the designated constraints aren't met.
ClusterLoadAssignment_PolicyValidationError is the validation error returned by ClusterLoadAssignment_Policy.Validate if the designated constraints aren't met.
ClusterLoadAssignmentValidationError is the validation error returned by ClusterLoadAssignment.Validate if the designated constraints aren't met.
ClusterValidationError is the validation error returned by Cluster.Validate if the designated constraints aren't met.
DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.
DeltaDiscoveryRequestValidationError is the validation error returned by DeltaDiscoveryRequest.Validate if the designated constraints aren't met.
[#next-free-field: 7].
DeltaDiscoveryResponseValidationError is the validation error returned by DeltaDiscoveryResponse.Validate if the designated constraints aren't met.
A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API.
DiscoveryRequestValidationError is the validation error returned by DiscoveryRequest.Validate if the designated constraints aren't met.
[#next-free-field: 7].
DiscoveryResponseValidationError is the validation error returned by DiscoveryResponse.Validate if the designated constraints aren't met.
[#not-implemented-hide:] Not configuration.
EdsDummyValidationError is the validation error returned by EdsDummy.Validate if the designated constraints aren't met.
[#not-implemented-hide:] Not configuration.
LdsDummyValidationError is the validation error returned by LdsDummy.Validate if the designated constraints aren't met.
[#next-free-field: 23].
Configuration for listener connection balancing.
A connection balancer implementation that does exact balancing.
No description provided by the author
Listener_ConnectionBalanceConfig_ExactBalanceValidationError is the validation error returned by Listener_ConnectionBalanceConfig_ExactBalance.Validate if the designated constraints aren't met.
Listener_ConnectionBalanceConfigValidationError is the validation error returned by Listener_ConnectionBalanceConfig.Validate if the designated constraints aren't met.
[#not-implemented-hide:].
Listener_DeprecatedV1ValidationError is the validation error returned by Listener_DeprecatedV1.Validate if the designated constraints aren't met.
ListenerValidationError is the validation error returned by Listener.Validate if the designated constraints aren't met.
[#not-implemented-hide:] Extensible load balancing policy configuration.
No description provided by the author
LoadBalancingPolicy_PolicyValidationError is the validation error returned by LoadBalancingPolicy_Policy.Validate if the designated constraints aren't met.
LoadBalancingPolicyValidationError is the validation error returned by LoadBalancingPolicy.Validate if the designated constraints aren't met.
[#not-implemented-hide:] Not configuration.
RdsDummyValidationError is the validation error returned by RdsDummy.Validate if the designated constraints aren't met.
No description provided by the author
ResourceValidationError is the validation error returned by Resource.Validate if the designated constraints aren't met.
[#next-free-field: 11].
RouteConfigurationValidationError is the validation error returned by RouteConfiguration.Validate if the designated constraints aren't met.
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).
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.
No description provided by the author
No description provided by the author
ScopedRouteConfiguration_Key_FragmentValidationError is the validation error returned by ScopedRouteConfiguration_Key_Fragment.Validate if the designated constraints aren't met.
ScopedRouteConfiguration_KeyValidationError is the validation error returned by ScopedRouteConfiguration_Key.Validate if the designated constraints aren't met.
ScopedRouteConfigurationValidationError is the validation error returned by ScopedRouteConfiguration.Validate if the designated constraints aren't met.
[#not-implemented-hide:] Not configuration.
SrdsDummyValidationError is the validation error returned by SrdsDummy.Validate if the designated constraints aren't met.
UnimplementedClusterDiscoveryServiceServer can be embedded to have forward compatible implementations.
UnimplementedEndpointDiscoveryServiceServer can be embedded to have forward compatible implementations.
UnimplementedListenerDiscoveryServiceServer can be embedded to have forward compatible implementations.
UnimplementedRouteDiscoveryServiceServer can be embedded to have forward compatible implementations.
UnimplementedScopedRoutesDiscoveryServiceServer can be embedded to have forward compatible implementations.
UnimplementedVirtualHostDiscoveryServiceServer can be embedded to have forward compatible implementations.
An extensible structure containing the address Envoy should bind to when establishing upstream connections.
UpstreamBindConfigValidationError is the validation error returned by UpstreamBindConfig.Validate if the designated constraints aren't met.
No description provided by the author
UpstreamConnectionOptionsValidationError is the validation error returned by UpstreamConnectionOptions.Validate if the designated constraints aren't met.
No description provided by the author
VhdsValidationError is the validation error returned by Vhds.Validate if the designated constraints aren't met.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClusterDiscoveryServiceClient is the client API for ClusterDiscoveryService service.
ClusterDiscoveryServiceServer is the server API for ClusterDiscoveryService service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EndpointDiscoveryServiceClient is the client API for EndpointDiscoveryService service.
EndpointDiscoveryServiceServer is the server API for EndpointDiscoveryService service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ListenerDiscoveryServiceClient is the client API for ListenerDiscoveryService service.
ListenerDiscoveryServiceServer is the server API for ListenerDiscoveryService service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RouteDiscoveryServiceClient is the client API for RouteDiscoveryService service.
RouteDiscoveryServiceServer is the server API for RouteDiscoveryService service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ScopedRoutesDiscoveryServiceClient is the client API for ScopedRoutesDiscoveryService service.
ScopedRoutesDiscoveryServiceServer is the server API for ScopedRoutesDiscoveryService service.
No description provided by the author
No description provided by the author
VirtualHostDiscoveryServiceClient is the client API for VirtualHostDiscoveryService service.
VirtualHostDiscoveryServiceServer is the server API for VirtualHostDiscoveryService service.
# Type aliases
No description provided by the author
Refer to :ref:`service discovery type <arch_overview_service_discovery_types>` for an explanation on each type.
When V4_ONLY is selected, the DNS resolver will only perform a lookup for addresses in the IPv4 family.
Refer to :ref:`load balancer type <arch_overview_load_balancing_types>` architecture overview section for information on each type.
If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported.
Allows to override top level fallback policy per selector.
The hash function used to hash hosts onto the ketama ring.
No description provided by the author