# 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
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
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
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.
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
# 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.
ClusterDiscoveryService_ServiceDesc is the grpc.ServiceDesc for ClusterDiscoveryService service.
EndpointDiscoveryService_ServiceDesc is the grpc.ServiceDesc 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
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.
ListenerDiscoveryService_ServiceDesc is the grpc.ServiceDesc for ListenerDiscoveryService service.
RouteDiscoveryService_ServiceDesc is the grpc.ServiceDesc for RouteDiscoveryService service.
ScopedRoutesDiscoveryService_ServiceDesc is the grpc.ServiceDesc for ScopedRoutesDiscoveryService service.
VirtualHostDiscoveryService_ServiceDesc is the grpc.ServiceDesc for VirtualHostDiscoveryService service.
# Structs
[#not-implemented-hide:] Not configuration.
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.).
Configuration for :ref:`locality weighted load balancing <arch_overview_load_balancing_locality_weighted_lb>`.
No description provided by the author
Configuration for :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>`.
No description provided by the author
Extended cluster type.
Only valid when discovery type is EDS.
Optionally divide the endpoints in this cluster into subsets defined by endpoint metadata and selected by route and weighted cluster metadata.
Specifications for subsets.
Specific configuration for the LeastRequest load balancing policy.
No description provided by the author
Specific configuration for the :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>` load balancing policy.
No description provided by the author
No description provided by the author
Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.
No description provided by the author
TransportSocketMatch specifies what transport socket config will be used when the match conditions are satisfied.
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:].
DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.
[#next-free-field: 7].
A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API.
[#next-free-field: 7].
[#not-implemented-hide:] Not configuration.
[#not-implemented-hide:] Not configuration.
[#next-free-field: 23].
Configuration for listener connection balancing.
A connection balancer implementation that does exact balancing.
No description provided by the author
[#not-implemented-hide:].
[#not-implemented-hide:] Extensible load balancing policy configuration.
No description provided by the author
[#not-implemented-hide:] Not configuration.
No description provided by the author
[#next-free-field: 11].
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
[#not-implemented-hide:] Not configuration.
UnimplementedClusterDiscoveryServiceServer must be embedded to have forward compatible implementations.
UnimplementedEndpointDiscoveryServiceServer must be embedded to have forward compatible implementations.
UnimplementedListenerDiscoveryServiceServer must be embedded to have forward compatible implementations.
UnimplementedRouteDiscoveryServiceServer must be embedded to have forward compatible implementations.
UnimplementedScopedRoutesDiscoveryServiceServer must be embedded to have forward compatible implementations.
UnimplementedVirtualHostDiscoveryServiceServer must be embedded to have forward compatible implementations.
An extensible structure containing the address Envoy should bind to when establishing upstream connections.
No description provided by the author
No description provided by the author
# Interfaces
ClusterDiscoveryServiceClient is the client API for ClusterDiscoveryService service.
ClusterDiscoveryServiceServer is the server API for ClusterDiscoveryService service.
EndpointDiscoveryServiceClient is the client API for EndpointDiscoveryService service.
EndpointDiscoveryServiceServer is the server API for EndpointDiscoveryService service.
ListenerDiscoveryServiceClient is the client API for ListenerDiscoveryService service.
ListenerDiscoveryServiceServer is the server API for ListenerDiscoveryService service.
RouteDiscoveryServiceClient is the client API for RouteDiscoveryService service.
RouteDiscoveryServiceServer is the server API for RouteDiscoveryService service.
ScopedRoutesDiscoveryServiceClient is the client API for ScopedRoutesDiscoveryService service.
ScopedRoutesDiscoveryServiceServer is the server API for ScopedRoutesDiscoveryService service.
UnsafeClusterDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeEndpointDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeListenerDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeRouteDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeScopedRoutesDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeVirtualHostDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service.
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