Destination Rule

    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. simple: LEAST_REQUEST

    Version specific policies can be specified by defining a named subset and overriding the settings specified at the service level. The following rule uses a round robin load balancing policy for all traffic going to a subset named testversion that is composed of endpoints (e.g., pods) with labels (version:v3).

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. simple: LEAST_REQUEST
    10. subsets:
    11. - name: testversion
    12. labels:
    13. version: v3
    14. trafficPolicy:
    15. loadBalancer:
    16. simple: ROUND_ROBIN
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. simple: LEAST_REQUEST
    10. subsets:
    11. - name: testversion
    12. labels:
    13. version: v3
    14. trafficPolicy:
    15. loadBalancer:
    16. simple: ROUND_ROBIN

    Note: Policies specified for subsets will not take effect until a route rule explicitly sends traffic to this subset.

    Traffic policies can be customized to specific ports as well. The following rule uses the least connection load balancing policy for all traffic to port 80, while uses a round robin load balancing setting for traffic to the port 9080.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings-port
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy: # Apply to all ports
    8. portLevelSettings:
    9. - port:
    10. number: 80
    11. loadBalancer:
    12. simple: LEAST_REQUEST
    13. - port:
    14. number: 9080
    15. loadBalancer:
    16. simple: ROUND_ROBIN
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings-port
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy: # Apply to all ports
    8. portLevelSettings:
    9. - port:
    10. number: 80
    11. loadBalancer:
    12. simple: LEAST_REQUEST
    13. - port:
    14. number: 9080
    15. loadBalancer:
    16. simple: ROUND_ROBIN

    Destination Rules can be customized to specific workloads as well. The following example shows how a destination rule can be applied to a specific workload using the workloadSelector configuration.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: configure-client-mtls-dr-with-workloadselector
    5. spec:
    6. workloadSelector:
    7. matchLabels:
    8. app: ratings
    9. trafficPolicy:
    10. loadBalancer:
    11. simple: ROUND_ROBIN
    12. portLevelSettings:
    13. - port:
    14. number: 31443
    15. tls:
    16. mode: MUTUAL
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: configure-client-mtls-dr-with-workloadselector
    5. spec:
    6. workloadSelector:
    7. matchLabels:
    8. app: ratings
    9. trafficPolicy:
    10. loadBalancer:
    11. simple: ROUND_ROBIN
    12. portLevelSettings:
    13. - port:
    14. number: 31443
    15. tls:
    16. credentialName: client-credential
    17. mode: MUTUAL

    DestinationRule defines policies that apply to traffic intended for a service after routing has occurred.

    TrafficPolicy

    Traffic policies to apply for a specific destination, across all destination ports. See DestinationRule for examples.

    FieldTypeDescriptionRequired
    loadBalancer

    Settings controlling the load balancer algorithms.

    No
    connectionPoolConnectionPoolSettings

    Settings controlling the volume of connections to an upstream service

    No
    outlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool

    No
    tlsClientTLSSettings

    TLS related settings for connections to the upstream service.

    No
    portLevelSettings

    Traffic policies specific to individual ports. Note that port level settings will override the destination-level settings. Traffic settings specified at the destination-level will not be inherited when overridden by port-level settings, i.e. default values will be applied to fields omitted in port-level traffic policies.

    No
    tunnelTunnelSettings

    Configuration of tunneling TCP over other transport or application layers for the host configured in the DestinationRule. Tunnel settings can be applied to TCP or TLS routes and can’t be applied to HTTP routes.

    No

    Subset

    A subset of endpoints of a service. Subsets can be used for scenarios like A/B testing, or routing to a specific version of a service. Refer to VirtualService documentation for examples of using subsets in these scenarios. In addition, traffic policies defined at the service-level can be overridden at a subset-level. The following rule uses a round robin load balancing policy for all traffic going to a subset named testversion that is composed of endpoints (e.g., pods) with labels (version:v3).

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. simple: LEAST_REQUEST
    10. subsets:
    11. - name: testversion
    12. labels:
    13. version: v3
    14. trafficPolicy:
    15. loadBalancer:
    16. simple: ROUND_ROBIN

    Note: Policies specified for subsets will not take effect until a route rule explicitly sends traffic to this subset.

    One or more labels are typically required to identify the subset destination, however, when the corresponding DestinationRule represents a host that supports multiple SNI hosts (e.g., an egress gateway), a subset without labels may be meaningful. In this case a traffic policy with can be used to identify a specific SNI host corresponding to the named subset.

    FieldTypeDescriptionRequired
    namestring

    Name of the subset. The service name and the subset name can be used for traffic splitting in a route rule.

    Yes
    labelsmap<string, string>

    Labels apply a filter over the endpoints of a service in the service registry. See route rules for examples of usage.

    No
    trafficPolicyTrafficPolicy

    Traffic policies that apply to this subset. Subsets inherit the traffic policies specified at the DestinationRule level. Settings specified at the subset level will override the corresponding settings specified at the DestinationRule level.

    No

    LoadBalancerSettings

    Load balancing policies to apply for a specific destination. See Envoy’s load balancing documentation for more details.

    For example, the following rule uses a round robin load balancing policy for all traffic going to the ratings service.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. simple: ROUND_ROBIN
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. name: bookinfo-ratings
    4. spec:
    5. host: ratings.prod.svc.cluster.local
    6. trafficPolicy:
    7. loadBalancer:
    8. simple: ROUND_ROBIN

    The following example sets up sticky sessions for the ratings service hashing-based load balancer for the same ratings service using the the User cookie as the hash key.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. consistentHash:
    10. httpCookie:
    11. name: user
    12. ttl: 0s
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-ratings
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. loadBalancer:
    9. consistentHash:
    10. httpCookie:
    11. name: user
    12. ttl: 0s
    FieldTypeDescriptionRequired
    simpleNo
    consistentHashConsistentHashLB (oneof)No
    localityLbSetting

    Locality load balancer settings, this will override mesh wide settings in entirety, meaning no merging would be performed between this object and the object one in MeshConfig

    No
    warmupDurationSecsDuration

    Represents the warmup duration of Service. If set, the newly created endpoint of service remains in warmup mode starting from its creation time for the duration of this window and Istio progressively increases amount of traffic for that endpoint instead of sending proportional amount of traffic. This should be enabled for services that require warm up time to serve full production load with reasonable latency. Currently this is only supported for ROUND_ROBIN and LEAST_CONN load balancers.

    No

    ConnectionPoolSettings

    Connection pool settings for an upstream host. The settings apply to each individual host in the upstream service. See Envoy’s circuit breaker for more details. Connection pool settings can be applied at the TCP level as well as at HTTP level.

    For example, the following rule sets a limit of 100 connections to redis service called myredissrv with a connect timeout of 30ms

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-redis
    5. spec:
    6. host: myredissrv.prod.svc.cluster.local
    7. trafficPolicy:
    8. connectionPool:
    9. tcp:
    10. maxConnections: 100
    11. connectTimeout: 30ms
    12. tcpKeepalive:
    13. time: 7200s
    14. interval: 75s
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: bookinfo-redis
    5. spec:
    6. host: myredissrv.prod.svc.cluster.local
    7. trafficPolicy:
    8. connectionPool:
    9. tcp:
    10. maxConnections: 100
    11. connectTimeout: 30ms
    12. tcpKeepalive:
    13. time: 7200s
    14. interval: 75s
    FieldTypeDescriptionRequired
    tcp

    Settings common to both HTTP and TCP upstream connections.

    No
    httpHTTPSettings

    HTTP connection pool settings.

    No

    OutlierDetection

    A Circuit breaker implementation that tracks the status of each individual host in the upstream service. Applicable to both HTTP and TCP services. For HTTP services, hosts that continually return 5xx errors for API calls are ejected from the pool for a pre-defined period of time. For TCP services, connection timeouts or connection failures to a given host counts as an error when measuring the consecutive errors metric. See Envoy’s outlier detection for more details.

    The following rule sets a connection pool size of 100 HTTP1 connections with no more than 10 req/connection to the “reviews” service. In addition, it sets a limit of 1000 concurrent HTTP2 requests and configures upstream hosts to be scanned every 5 mins so that any host that fails 7 consecutive times with a 502, 503, or 504 error code will be ejected for 15 minutes.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: reviews-cb-policy
    5. spec:
    6. trafficPolicy:
    7. connectionPool:
    8. tcp:
    9. maxConnections: 100
    10. http:
    11. http2MaxRequests: 1000
    12. maxRequestsPerConnection: 10
    13. outlierDetection:
    14. consecutive5xxErrors: 7
    15. interval: 5m
    16. baseEjectionTime: 15m
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: reviews-cb-policy
    5. spec:
    6. host: reviews.prod.svc.cluster.local
    7. trafficPolicy:
    8. connectionPool:
    9. tcp:
    10. maxConnections: 100
    11. http:
    12. http2MaxRequests: 1000
    13. maxRequestsPerConnection: 10
    14. outlierDetection:
    15. consecutive5xxErrors: 7
    16. interval: 5m
    17. baseEjectionTime: 15m
    FieldTypeDescriptionRequired
    splitExternalLocalOriginErrorsbool

    Determines whether to distinguish local origin failures from external errors. If set to true consecutive_local_origin_failure is taken into account for outlier detection calculations. This should be used when you want to derive the outlier detection status based on the errors seen locally such as failure to connect, timeout while connecting etc. rather than the status code retuned by upstream service. This is especially useful when the upstream service explicitly returns a 5xx for some requests and you want to ignore those responses from upstream service while determining the outlier detection status of a host. Defaults to false.

    No
    consecutiveLocalOriginFailures

    The number of consecutive locally originated failures before ejection occurs. Defaults to 5. Parameter takes effect only when split_external_local_origin_errors is set to true.

    No
    consecutiveGatewayErrorsUInt32Value

    Number of gateway errors before a host is ejected from the connection pool. When the upstream host is accessed over HTTP, a 502, 503, or 504 return code qualifies as a gateway error. When the upstream host is accessed over an opaque TCP connection, connect timeouts and connection error/failure events qualify as a gateway error. This feature is disabled by default or when set to the value 0.

    Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

    No
    consecutive5xxErrors

    Number of 5xx errors before a host is ejected from the connection pool. When the upstream host is accessed over an opaque TCP connection, connect timeouts, connection error/failure and request failure events qualify as a 5xx error. This feature defaults to 5 but can be disabled by setting the value to 0.

    Note that consecutive_gateway_errors and consecutive_5xx_errors can be used separately or together. Because the errors counted by consecutive_gateway_errors are also included in consecutive_5xx_errors, if the value of consecutive_gateway_errors is greater than or equal to the value of consecutive_5xx_errors, consecutive_gateway_errors will have no effect.

    No
    intervalDuration

    Time interval between ejection sweep analysis. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 10s.

    No
    baseEjectionTimeNo
    maxEjectionPercentint32

    Maximum % of hosts in the load balancing pool for the upstream service that can be ejected. Defaults to 10%.

    No
    minHealthPercentint32

    Outlier detection will be enabled as long as the associated load balancing pool has at least min_health_percent hosts in healthy mode. When the percentage of healthy hosts in the load balancing pool drops below this threshold, outlier detection will be disabled and the proxy will load balance across all hosts in the pool (healthy and unhealthy). The threshold can be disabled by setting it to 0%. The default is 0% as it’s not typically applicable in k8s environments with few pods per service.

    No

    ClientTLSSettings

    SSL/TLS related settings for upstream connections. See Envoy’s for more details. These settings are common to both HTTP and TCP upstreams.

    For example, the following rule configures a client to use mutual TLS for connections to upstream database cluster.

    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: db-mtls
    5. spec:
    6. host: mydbserver.prod.svc.cluster.local
    7. trafficPolicy:
    8. tls:
    9. mode: MUTUAL
    10. clientCertificate: /etc/certs/myclientcert.pem
    11. privateKey: /etc/certs/client_private_key.pem
    12. caCertificates: /etc/certs/rootcacerts.pem

    The following rule configures a client to use TLS when talking to a foreign service whose domain matches *.foo.com.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: tls-foo
    5. spec:
    6. host: "*.foo.com"
    7. trafficPolicy:
    8. tls:
    9. mode: SIMPLE
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: tls-foo
    5. spec:
    6. host: "*.foo.com"
    7. trafficPolicy:
    8. tls:
    9. mode: SIMPLE

    The following rule configures a client to use Istio mutual TLS when talking to rating services.

    1. apiVersion: networking.istio.io/v1alpha3
    2. kind: DestinationRule
    3. metadata:
    4. name: ratings-istio-mtls
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. tls:
    9. mode: ISTIO_MUTUAL
    1. apiVersion: networking.istio.io/v1beta1
    2. kind: DestinationRule
    3. metadata:
    4. name: ratings-istio-mtls
    5. spec:
    6. host: ratings.prod.svc.cluster.local
    7. trafficPolicy:
    8. mode: ISTIO_MUTUAL
    FieldTypeDescriptionRequired
    modeTLSmode

    Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced.

    Yes
    clientCertificatestring

    REQUIRED if mode is MUTUAL. The path to the file holding the client-side TLS certificate to use. Should be empty if mode is ISTIO_MUTUAL.

    No
    privateKeystring

    REQUIRED if mode is MUTUAL. The path to the file holding the client’s private key. Should be empty if mode is ISTIO_MUTUAL.

    No
    caCertificatesstring

    OPTIONAL: The path to the file containing certificate authority certificates to use in verifying a presented server certificate. If omitted, the proxy will not verify the server’s certificate. Should be empty if mode is ISTIO_MUTUAL.

    No
    credentialNamestring

    The name of the secret that holds the TLS certs for the client including the CA certificates. Secret must exist in the same namespace with the proxy using the certificates. The secret (of type generic)should contain the following keys and values: key: <privateKey>, cert: <clientCert>, cacert: <CACertificate>. Here CACertificate is used to verify the server certificate. Secret of type tls for client certificates along with ca.crt key for CA certificates is also supported. Only one of client certificates and CA certificate or credentialName can be specified.

    NOTE: This field is applicable at sidecars only if DestinationRule has a workloadSelector specified. Otherwise the field will be applicable only at gateways, and sidecars will continue to use the certificate paths.

    No
    subjectAltNamesstring[]

    A list of alternate names to verify the subject identity in the certificate. If specified, the proxy will verify that the server certificate’s subject alt name matches one of the specified values. If specified, this list overrides the value of subject_alt_names from the ServiceEntry.

    No
    snistring

    SNI string to present to the server during TLS handshake. If unspecified, SNI will be automatically set based on downstream HTTP host/authority header for SIMPLE and MUTUAL TLS modes, provided ENABLE_AUTO_SNI environmental variable is set to true.

    No
    insecureSkipVerify

    InsecureSkipVerify specifies whether the proxy should skip verifying the CA signature and SAN for the server certificate corresponding to the host. This flag should only be set if global CA signature verifcation is enabled, VerifyCertAtClient environmental variable is set to true, but no verification is desired for a specific host. If enabled with or without VerifyCertAtClient enabled, verification of the CA signature and SAN will be skipped.

    InsecureSkipVerify is false by default. VerifyCertAtClient is false by default in Istio version 1.9 but will be true by default in a later version where, going forward, it will be enabled by default.

    No

    Locality-weighted load balancing allows administrators to control the distribution of traffic to endpoints based on the localities of where the traffic originates and where it will terminate. These localities are specified using arbitrary labels that designate a hierarchy of localities in {region}/{zone}/{sub-zone} form. For additional detail refer to Locality Weight The following example shows how to setup locality weights mesh-wide.

    Given a mesh with workloads and their service deployed to “us-west/zone1/” and “us-west/zone2/”. This example specifies that when traffic accessing a service originates from workloads in “us-west/zone1/”, 80% of the traffic will be sent to endpoints in “us-west/zone1/”, i.e the same zone, and the remaining 20% will go to endpoints in “us-west/zone2/”. This setup is intended to favor routing traffic to endpoints in the same locality. A similar setting is specified for traffic originating in “us-west/zone2/”.

    1. distribute:
    2. - from: us-west/zone1/*
    3. to:
    4. "us-west/zone1/*": 80
    5. "us-west/zone2/*": 20
    6. - from: us-west/zone2/*
    7. to:
    8. "us-west/zone1/*": 20
    9. "us-west/zone2/*": 80

    If the goal of the operator is not to distribute load across zones and regions but rather to restrict the regionality of failover to meet other operational requirements an operator can set a ‘failover’ policy instead of a ‘distribute’ policy.

    The following example sets up a locality failover policy for regions. Assume a service resides in zones within us-east, us-west & eu-west this example specifies that when endpoints within us-east become unhealthy traffic should failover to endpoints in any zone or sub-zone within eu-west and similarly us-west should failover to us-east.

    1. failover:
    2. - from: us-east
    3. to: eu-west
    4. - from: us-west
    5. to: us-east

    Locality load balancing settings.

    TrafficPolicy.PortTrafficPolicy

    Traffic policies that apply to specific ports of the service

    FieldTypeDescriptionRequired
    portPortSelector

    Specifies the number of a port on the destination service on which this policy is being applied.

    No
    loadBalancer

    Settings controlling the load balancer algorithms.

    No
    connectionPoolConnectionPoolSettings

    Settings controlling the volume of connections to an upstream service

    No
    outlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool

    No
    tlsClientTLSSettings

    TLS related settings for connections to the upstream service.

    No

    TrafficPolicy.TunnelSettings

    FieldTypeDescriptionRequired
    protocolstring

    Specifies which protocol to use for tunneling the downstream connection. Supported protocols are: connect - uses HTTP CONNECT; post - uses HTTP POST. HTTP version for upstream requests is determined by the service protocol defined for the proxy.

    Yes
    targetHoststring

    Specifies a host to which the downstream connection is tunneled. Target host must be an FQDN or IP address.

    Yes
    targetPortuint32

    Specifies a port to which the downstream connection is tunneled.

    Yes

    LoadBalancerSettings.ConsistentHashLB

    Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service.

    FieldTypeDescriptionRequired
    httpHeaderNamestring (oneof)

    Hash based on a specific HTTP header.

    No
    httpCookie

    Hash based on HTTP cookie.

    No
    useSourceIpbool (oneof)

    Hash based on the source IP address. This is applicable for both TCP and HTTP connections.

    No
    httpQueryParameterNamestring (oneof)

    Hash based on a specific HTTP query parameter.

    No
    minimumRingSizeuint64

    The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

    No

    LoadBalancerSettings.ConsistentHashLB.HTTPCookie

    Describes a HTTP cookie that will be used as the hash key for the Consistent Hash load balancer. If the cookie is not present, it will be generated.

    FieldTypeDescriptionRequired
    namestringYes
    pathstring

    Path to set for the cookie.

    No
    ttl

    Lifetime of the cookie.

    Yes

    ConnectionPoolSettings.TCPSettings

    Settings common to both HTTP and TCP upstream connections.

    FieldTypeDescriptionRequired
    maxConnectionsint32

    Maximum number of HTTP1 /TCP connections to a destination host. Default 2^32-1.

    No
    connectTimeout

    TCP connection timeout. format: 1h/1m/1s/1ms. MUST BE >=1ms. Default is 10s.

    No
    tcpKeepaliveTcpKeepalive

    If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.

    No

    ConnectionPoolSettings.HTTPSettings

    Settings applicable to HTTP1.1/HTTP2/GRPC connections.

    FieldTypeDescriptionRequired
    http1MaxPendingRequestsint32

    Maximum number of pending HTTP requests to a destination. Default 2^32-1.

    No
    http2MaxRequestsint32

    Maximum number of requests to a backend. Default 2^32-1.

    No
    maxRequestsPerConnectionint32

    Maximum number of requests per connection to a backend. Setting this parameter to 1 disables keep alive. Default 0, meaning “unlimited”, up to 2^29.

    No
    maxRetriesint32

    Maximum number of retries that can be outstanding to all hosts in a cluster at a given time. Defaults to 2^32-1.

    No
    idleTimeoutDuration

    The idle timeout for upstream connection pool connections. The idle timeout is defined as the period in which there are no active requests. If not set, the default is 1 hour. When the idle timeout is reached, the connection will be closed. If the connection is an HTTP/2 connection a drain sequence will occur prior to closing the connection. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive. Applies to both HTTP1.1 and HTTP2 connections.

    No
    h2UpgradePolicy

    Specify if http1.1 connection should be upgraded to http2 for the associated destination.

    No
    useClientProtocolbool

    If set to true, client protocol will be preserved while initiating connection to backend. Note that when this is set to true, h2_upgrade_policy will be ineffective i.e. the client connections will not be upgraded to http2.

    No

    TCP keepalive.

    LocalityLoadBalancerSetting.Distribute

    Describes how traffic originating in the ‘from’ zone or sub-zone is distributed over a set of ‘to’ zones. Syntax for specifying a zone is {region}/{zone}/{sub-zone} and terminal wildcards are allowed on any segment of the specification. Examples:

    * - matches all localities

    us-west/* - all zones and sub-zones within the us-west region

    us-west/zone-1/* - all sub-zones within us-west/zone-1

    FieldTypeDescriptionRequired
    fromstring

    Originating locality, ‘/’ separated, e.g. ‘region/zone/sub_zone’.

    No
    tomap<string, uint32>

    Map of upstream localities to traffic distribution weights. The sum of all weights should be 100. Any locality not present will receive no traffic.

    No

    LocalityLoadBalancerSetting.Failover

    Specify the traffic failover policy across regions. Since zone and sub-zone failover is supported by default this only needs to be specified for regions when the operator needs to constrain traffic failover so that the default behavior of failing over to any endpoint globally does not apply. This is useful when failing over traffic across regions would not improve service health or may need to be restricted for other reasons like regulatory controls.

    FieldTypeDescriptionRequired
    fromstring

    Originating region.

    No
    tostring

    Destination region the traffic will fail over to when endpoints in the ‘from’ region becomes unhealthy.

    No

    google.protobuf.UInt32Value

    Wrapper message for uint32.

    The JSON representation for UInt32Value is JSON number.

    FieldTypeDescriptionRequired
    valueuint32

    The uint32 value.

    No

    LoadBalancerSettings.SimpleLB

    Standard load balancing algorithms that require no tuning.

    NameDescription
    UNSPECIFIED

    No load balancing algorithm has been specified by the user. Istio will select an appropriate default.

    RANDOM

    The random load balancer selects a random healthy host. The random load balancer generally performs better than round robin if no health checking policy is configured.

    PASSTHROUGH

    This option will forward the connection to the original IP address requested by the caller without doing any form of load balancing. This option must be used with care. It is meant for advanced use cases. Refer to Original Destination load balancer in Envoy for further details.

    ROUND_ROBIN

    A basic round robin load balancing policy. This is generally unsafe for many scenarios (e.g. when enpoint weighting is used) as it can overburden endpoints. In general, prefer to use LEAST_REQUEST as a drop-in replacement for ROUND_ROBIN.

    LEAST_REQUEST

    The least request load balancer spreads load across endpoints, favoring endpoints with the least outstanding requests. This is generally safer and outperforms ROUND_ROBIN in nearly all cases. Prefer to use LEAST_REQUEST as a drop-in replacement for ROUND_ROBIN.

    LEAST_CONN

    Deprecated. Use LEAST_REQUEST instead.

    ConnectionPoolSettings.HTTPSettings.H2UpgradePolicy

    Policy for upgrading http1.1 connections to http2.

    NameDescription
    DEFAULT

    Use the global default.

    DO_NOT_UPGRADE

    Do not upgrade the connection to http2. This opt-out option overrides the default.

    UPGRADE

    Upgrade the connection to http2. This opt-in option overrides the default.

    ClientTLSSettings.TLSmode

    TLS connection mode

    NameDescription
    DISABLE

    Do not setup a TLS connection to the upstream endpoint.

    SIMPLE

    Originate a TLS connection to the upstream endpoint.

    MUTUAL

    Secure connections to the upstream using mutual TLS by presenting client certificates for authentication.

    ISTIO_MUTUAL