networking.v1beta1.destinationRule
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withExportTo(exportTo)
fn withExportToMixin(exportTo)
fn withHost(host)
fn withSubsets(subsets)
fn withSubsetsMixin(subsets)
obj spec.subsets
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
obj spec.subsets.trafficPolicy
fn withPortLevelSettings(portLevelSettings)
fn withPortLevelSettingsMixin(portLevelSettings)
obj spec.subsets.trafficPolicy.connectionPool
obj spec.subsets.trafficPolicy.connectionPool.http
fn withH2UpgradePolicy(h2UpgradePolicy)
fn withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn withHttp2MaxRequests(http2MaxRequests)
fn withIdleTimeout(idleTimeout)
fn withMaxRequestsPerConnection(maxRequestsPerConnection)
fn withMaxRetries(maxRetries)
fn withUseClientProtocol(useClientProtocol)
obj spec.subsets.trafficPolicy.connectionPool.tcp
obj spec.subsets.trafficPolicy.loadBalancer
fn withSimple(simple)
fn withWarmupDurationSecs(warmupDurationSecs)
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash
fn withHttpHeaderName(httpHeaderName)
fn withHttpQueryParameterName(httpQueryParameterName)
fn withMinimumRingSize(minimumRingSize)
fn withUseSourceIp(useSourceIp)
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.httpCookie
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.maglev
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.ringHash
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting
fn withDistribute(distribute)
fn withDistributeMixin(distribute)
fn withEnabled(enabled)
fn withFailover(failover)
fn withFailoverMixin(failover)
fn withFailoverPriority(failoverPriority)
fn withFailoverPriorityMixin(failoverPriority)
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.distribute
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.failover
obj spec.subsets.trafficPolicy.outlierDetection
fn withBaseEjectionTime(baseEjectionTime)
fn withConsecutive5xxErrors(consecutive5xxErrors)
fn withConsecutiveErrors(consecutiveErrors)
fn withConsecutiveGatewayErrors(consecutiveGatewayErrors)
fn withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn withInterval(interval)
fn withMaxEjectionPercent(maxEjectionPercent)
fn withMinHealthPercent(minHealthPercent)
fn withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
obj spec.subsets.trafficPolicy.portLevelSettings
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http
fn withH2UpgradePolicy(h2UpgradePolicy)
fn withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn withHttp2MaxRequests(http2MaxRequests)
fn withIdleTimeout(idleTimeout)
fn withMaxRequestsPerConnection(maxRequestsPerConnection)
fn withMaxRetries(maxRetries)
fn withUseClientProtocol(useClientProtocol)
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer
fn withSimple(simple)
fn withWarmupDurationSecs(warmupDurationSecs)
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash
fn withHttpHeaderName(httpHeaderName)
fn withHttpQueryParameterName(httpQueryParameterName)
fn withMinimumRingSize(minimumRingSize)
fn withUseSourceIp(useSourceIp)
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting
fn withDistribute(distribute)
fn withDistributeMixin(distribute)
fn withEnabled(enabled)
fn withFailover(failover)
fn withFailoverMixin(failover)
fn withFailoverPriority(failoverPriority)
fn withFailoverPriorityMixin(failoverPriority)
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover
obj spec.subsets.trafficPolicy.portLevelSettings.outlierDetection
fn withBaseEjectionTime(baseEjectionTime)
fn withConsecutive5xxErrors(consecutive5xxErrors)
fn withConsecutiveErrors(consecutiveErrors)
fn withConsecutiveGatewayErrors(consecutiveGatewayErrors)
fn withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn withInterval(interval)
fn withMaxEjectionPercent(maxEjectionPercent)
fn withMinHealthPercent(minHealthPercent)
fn withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
obj spec.subsets.trafficPolicy.portLevelSettings.port
obj spec.subsets.trafficPolicy.portLevelSettings.tls
fn withCaCertificates(caCertificates)
fn withClientCertificate(clientCertificate)
fn withCredentialName(credentialName)
fn withInsecureSkipVerify(insecureSkipVerify)
fn withMode(mode)
fn withPrivateKey(privateKey)
fn withSni(sni)
fn withSubjectAltNames(subjectAltNames)
fn withSubjectAltNamesMixin(subjectAltNames)
obj spec.subsets.trafficPolicy.tls
fn withCaCertificates(caCertificates)
fn withClientCertificate(clientCertificate)
fn withCredentialName(credentialName)
fn withInsecureSkipVerify(insecureSkipVerify)
fn withMode(mode)
fn withPrivateKey(privateKey)
fn withSni(sni)
fn withSubjectAltNames(subjectAltNames)
fn withSubjectAltNamesMixin(subjectAltNames)
obj spec.subsets.trafficPolicy.tunnel
obj spec.trafficPolicy
fn withPortLevelSettings(portLevelSettings)
fn withPortLevelSettingsMixin(portLevelSettings)
obj spec.trafficPolicy.connectionPool
obj spec.trafficPolicy.connectionPool.http
fn withH2UpgradePolicy(h2UpgradePolicy)
fn withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn withHttp2MaxRequests(http2MaxRequests)
fn withIdleTimeout(idleTimeout)
fn withMaxRequestsPerConnection(maxRequestsPerConnection)
fn withMaxRetries(maxRetries)
fn withUseClientProtocol(useClientProtocol)
obj spec.trafficPolicy.connectionPool.tcp
obj spec.trafficPolicy.loadBalancer
fn withSimple(simple)
fn withWarmupDurationSecs(warmupDurationSecs)
obj spec.trafficPolicy.loadBalancer.consistentHash
fn withHttpHeaderName(httpHeaderName)
fn withHttpQueryParameterName(httpQueryParameterName)
fn withMinimumRingSize(minimumRingSize)
fn withUseSourceIp(useSourceIp)
obj spec.trafficPolicy.loadBalancer.consistentHash.httpCookie
obj spec.trafficPolicy.loadBalancer.consistentHash.maglev
obj spec.trafficPolicy.loadBalancer.consistentHash.ringHash
obj spec.trafficPolicy.loadBalancer.localityLbSetting
fn withDistribute(distribute)
fn withDistributeMixin(distribute)
fn withEnabled(enabled)
fn withFailover(failover)
fn withFailoverMixin(failover)
fn withFailoverPriority(failoverPriority)
fn withFailoverPriorityMixin(failoverPriority)
obj spec.trafficPolicy.loadBalancer.localityLbSetting.distribute
obj spec.trafficPolicy.loadBalancer.localityLbSetting.failover
obj spec.trafficPolicy.outlierDetection
fn withBaseEjectionTime(baseEjectionTime)
fn withConsecutive5xxErrors(consecutive5xxErrors)
fn withConsecutiveErrors(consecutiveErrors)
fn withConsecutiveGatewayErrors(consecutiveGatewayErrors)
fn withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn withInterval(interval)
fn withMaxEjectionPercent(maxEjectionPercent)
fn withMinHealthPercent(minHealthPercent)
fn withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
obj spec.trafficPolicy.portLevelSettings
obj spec.trafficPolicy.portLevelSettings.connectionPool
obj spec.trafficPolicy.portLevelSettings.connectionPool.http
fn withH2UpgradePolicy(h2UpgradePolicy)
fn withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn withHttp2MaxRequests(http2MaxRequests)
fn withIdleTimeout(idleTimeout)
fn withMaxRequestsPerConnection(maxRequestsPerConnection)
fn withMaxRetries(maxRetries)
fn withUseClientProtocol(useClientProtocol)
obj spec.trafficPolicy.portLevelSettings.connectionPool.tcp
obj spec.trafficPolicy.portLevelSettings.loadBalancer
fn withSimple(simple)
fn withWarmupDurationSecs(warmupDurationSecs)
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash
fn withHttpHeaderName(httpHeaderName)
fn withHttpQueryParameterName(httpQueryParameterName)
fn withMinimumRingSize(minimumRingSize)
fn withUseSourceIp(useSourceIp)
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting
fn withDistribute(distribute)
fn withDistributeMixin(distribute)
fn withEnabled(enabled)
fn withFailover(failover)
fn withFailoverMixin(failover)
fn withFailoverPriority(failoverPriority)
fn withFailoverPriorityMixin(failoverPriority)
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover
obj spec.trafficPolicy.portLevelSettings.outlierDetection
fn withBaseEjectionTime(baseEjectionTime)
fn withConsecutive5xxErrors(consecutive5xxErrors)
fn withConsecutiveErrors(consecutiveErrors)
fn withConsecutiveGatewayErrors(consecutiveGatewayErrors)
fn withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn withInterval(interval)
fn withMaxEjectionPercent(maxEjectionPercent)
fn withMinHealthPercent(minHealthPercent)
fn withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
obj spec.trafficPolicy.portLevelSettings.port
obj spec.trafficPolicy.portLevelSettings.tls
fn withCaCertificates(caCertificates)
fn withClientCertificate(clientCertificate)
fn withCredentialName(credentialName)
fn withInsecureSkipVerify(insecureSkipVerify)
fn withMode(mode)
fn withPrivateKey(privateKey)
fn withSni(sni)
fn withSubjectAltNames(subjectAltNames)
fn withSubjectAltNamesMixin(subjectAltNames)
obj spec.trafficPolicy.tls
fn withCaCertificates(caCertificates)
fn withClientCertificate(clientCertificate)
fn withCredentialName(credentialName)
fn withInsecureSkipVerify(insecureSkipVerify)
fn withMode(mode)
fn withPrivateKey(privateKey)
fn withSni(sni)
fn withSubjectAltNames(subjectAltNames)
fn withSubjectAltNamesMixin(subjectAltNames)
obj spec.trafficPolicy.tunnel
obj spec.workloadSelector
Fields
fn new
new(name)
new returns an instance of DestinationRule
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"Configuration affecting load balancing, outlier detection, etc. See more details at: https://istio.io/docs/reference/config/networking/destination-rule.html"
fn spec.withExportTo
withExportTo(exportTo)
"A list of namespaces to which this destination rule is exported."
fn spec.withExportToMixin
withExportToMixin(exportTo)
"A list of namespaces to which this destination rule is exported."
Note: This function appends passed data to existing values
fn spec.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.withSubsets
withSubsets(subsets)
fn spec.withSubsetsMixin
withSubsetsMixin(subsets)
Note: This function appends passed data to existing values
obj spec.subsets
fn spec.subsets.withLabels
withLabels(labels)
fn spec.subsets.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
fn spec.subsets.withName
withName(name)
"Name of the subset."
obj spec.subsets.trafficPolicy
"Traffic policies that apply to this subset."
fn spec.subsets.trafficPolicy.withPortLevelSettings
withPortLevelSettings(portLevelSettings)
"Traffic policies specific to individual ports."
fn spec.subsets.trafficPolicy.withPortLevelSettingsMixin
withPortLevelSettingsMixin(portLevelSettings)
"Traffic policies specific to individual ports."
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.connectionPool
obj spec.subsets.trafficPolicy.connectionPool.http
"HTTP connection pool settings."
fn spec.subsets.trafficPolicy.connectionPool.http.withH2UpgradePolicy
withH2UpgradePolicy(h2UpgradePolicy)
"Specify if http1.1 connection should be upgraded to http2 for the associated destination."
fn spec.subsets.trafficPolicy.connectionPool.http.withHttp1MaxPendingRequests
withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn spec.subsets.trafficPolicy.connectionPool.http.withHttp2MaxRequests
withHttp2MaxRequests(http2MaxRequests)
"Maximum number of active requests to a destination."
fn spec.subsets.trafficPolicy.connectionPool.http.withIdleTimeout
withIdleTimeout(idleTimeout)
"The idle timeout for upstream connection pool connections."
fn spec.subsets.trafficPolicy.connectionPool.http.withMaxRequestsPerConnection
withMaxRequestsPerConnection(maxRequestsPerConnection)
"Maximum number of requests per connection to a backend."
fn spec.subsets.trafficPolicy.connectionPool.http.withMaxRetries
withMaxRetries(maxRetries)
fn spec.subsets.trafficPolicy.connectionPool.http.withUseClientProtocol
withUseClientProtocol(useClientProtocol)
"If set to true, client protocol will be preserved while initiating connection to backend."
obj spec.subsets.trafficPolicy.connectionPool.tcp
"Settings common to both HTTP and TCP upstream connections."
fn spec.subsets.trafficPolicy.connectionPool.tcp.withConnectTimeout
withConnectTimeout(connectTimeout)
"TCP connection timeout."
fn spec.subsets.trafficPolicy.connectionPool.tcp.withMaxConnectionDuration
withMaxConnectionDuration(maxConnectionDuration)
"The maximum duration of a connection."
fn spec.subsets.trafficPolicy.connectionPool.tcp.withMaxConnections
withMaxConnections(maxConnections)
"Maximum number of HTTP1 /TCP connections to a destination host."
obj spec.subsets.trafficPolicy.connectionPool.tcp.tcpKeepalive
"If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives."
fn spec.subsets.trafficPolicy.connectionPool.tcp.tcpKeepalive.withInterval
withInterval(interval)
"The time duration between keep-alive probes."
fn spec.subsets.trafficPolicy.connectionPool.tcp.tcpKeepalive.withProbes
withProbes(probes)
fn spec.subsets.trafficPolicy.connectionPool.tcp.tcpKeepalive.withTime
withTime(time)
obj spec.subsets.trafficPolicy.loadBalancer
"Settings controlling the load balancer algorithms."
fn spec.subsets.trafficPolicy.loadBalancer.withSimple
withSimple(simple)
fn spec.subsets.trafficPolicy.loadBalancer.withWarmupDurationSecs
withWarmupDurationSecs(warmupDurationSecs)
"Represents the warmup duration of Service."
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.withHttpHeaderName
withHttpHeaderName(httpHeaderName)
"Hash based on a specific HTTP header."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.withHttpQueryParameterName
withHttpQueryParameterName(httpQueryParameterName)
"Hash based on a specific HTTP query parameter."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
"Deprecated."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.withUseSourceIp
withUseSourceIp(useSourceIp)
"Hash based on the source IP address."
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.httpCookie
"Hash based on HTTP cookie."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.httpCookie.withName
withName(name)
"Name of the cookie."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.httpCookie.withPath
withPath(path)
"Path to set for the cookie."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.httpCookie.withTtl
withTtl(ttl)
"Lifetime of the cookie."
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.maglev
"The Maglev load balancer implements consistent hashing to backend hosts."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.maglev.withTableSize
withTableSize(tableSize)
"The table size for Maglev hashing."
obj spec.subsets.trafficPolicy.loadBalancer.consistentHash.ringHash
"The ring/modulo hash load balancer implements consistent hashing to backend hosts."
fn spec.subsets.trafficPolicy.loadBalancer.consistentHash.ringHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withDistribute
withDistribute(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withDistributeMixin
withDistributeMixin(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withEnabled
withEnabled(enabled)
"enable locality load balancing, this is DestinationRule-level and will override mesh wide settings in entirety."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withFailover
withFailover(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withFailoverMixin
withFailoverMixin(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withFailoverPriority
withFailoverPriority(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.withFailoverPriorityMixin
withFailoverPriorityMixin(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.distribute
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.distribute.withFrom
withFrom(from)
"Originating locality, '/' separated, e.g."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.distribute.withTo
withTo(to)
"Map of upstream localities to traffic distribution weights."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.distribute.withToMixin
withToMixin(to)
"Map of upstream localities to traffic distribution weights."
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.failover
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.failover.withFrom
withFrom(from)
"Originating region."
fn spec.subsets.trafficPolicy.loadBalancer.localityLbSetting.failover.withTo
withTo(to)
obj spec.subsets.trafficPolicy.outlierDetection
fn spec.subsets.trafficPolicy.outlierDetection.withBaseEjectionTime
withBaseEjectionTime(baseEjectionTime)
"Minimum ejection duration."
fn spec.subsets.trafficPolicy.outlierDetection.withConsecutive5xxErrors
withConsecutive5xxErrors(consecutive5xxErrors)
"Number of 5xx errors before a host is ejected from the connection pool."
fn spec.subsets.trafficPolicy.outlierDetection.withConsecutiveErrors
withConsecutiveErrors(consecutiveErrors)
fn spec.subsets.trafficPolicy.outlierDetection.withConsecutiveGatewayErrors
withConsecutiveGatewayErrors(consecutiveGatewayErrors)
"Number of gateway errors before a host is ejected from the connection pool."
fn spec.subsets.trafficPolicy.outlierDetection.withConsecutiveLocalOriginFailures
withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn spec.subsets.trafficPolicy.outlierDetection.withInterval
withInterval(interval)
"Time interval between ejection sweep analysis."
fn spec.subsets.trafficPolicy.outlierDetection.withMaxEjectionPercent
withMaxEjectionPercent(maxEjectionPercent)
fn spec.subsets.trafficPolicy.outlierDetection.withMinHealthPercent
withMinHealthPercent(minHealthPercent)
fn spec.subsets.trafficPolicy.outlierDetection.withSplitExternalLocalOriginErrors
withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
"Determines whether to distinguish local origin failures from external errors."
obj spec.subsets.trafficPolicy.portLevelSettings
"Traffic policies specific to individual ports."
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http
"HTTP connection pool settings."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withH2UpgradePolicy
withH2UpgradePolicy(h2UpgradePolicy)
"Specify if http1.1 connection should be upgraded to http2 for the associated destination."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withHttp1MaxPendingRequests
withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withHttp2MaxRequests
withHttp2MaxRequests(http2MaxRequests)
"Maximum number of active requests to a destination."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withIdleTimeout
withIdleTimeout(idleTimeout)
"The idle timeout for upstream connection pool connections."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withMaxRequestsPerConnection
withMaxRequestsPerConnection(maxRequestsPerConnection)
"Maximum number of requests per connection to a backend."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withMaxRetries
withMaxRetries(maxRetries)
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.http.withUseClientProtocol
withUseClientProtocol(useClientProtocol)
"If set to true, client protocol will be preserved while initiating connection to backend."
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp
"Settings common to both HTTP and TCP upstream connections."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.withConnectTimeout
withConnectTimeout(connectTimeout)
"TCP connection timeout."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.withMaxConnectionDuration
withMaxConnectionDuration(maxConnectionDuration)
"The maximum duration of a connection."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.withMaxConnections
withMaxConnections(maxConnections)
"Maximum number of HTTP1 /TCP connections to a destination host."
obj spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive
"If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withInterval
withInterval(interval)
"The time duration between keep-alive probes."
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withProbes
withProbes(probes)
fn spec.subsets.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withTime
withTime(time)
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer
"Settings controlling the load balancer algorithms."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.withSimple
withSimple(simple)
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.withWarmupDurationSecs
withWarmupDurationSecs(warmupDurationSecs)
"Represents the warmup duration of Service."
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withHttpHeaderName
withHttpHeaderName(httpHeaderName)
"Hash based on a specific HTTP header."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withHttpQueryParameterName
withHttpQueryParameterName(httpQueryParameterName)
"Hash based on a specific HTTP query parameter."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
"Deprecated."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withUseSourceIp
withUseSourceIp(useSourceIp)
"Hash based on the source IP address."
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie
"Hash based on HTTP cookie."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withName
withName(name)
"Name of the cookie."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withPath
withPath(path)
"Path to set for the cookie."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withTtl
withTtl(ttl)
"Lifetime of the cookie."
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev
"The Maglev load balancer implements consistent hashing to backend hosts."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev.withTableSize
withTableSize(tableSize)
"The table size for Maglev hashing."
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash
"The ring/modulo hash load balancer implements consistent hashing to backend hosts."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withDistribute
withDistribute(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withDistributeMixin
withDistributeMixin(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withEnabled
withEnabled(enabled)
"enable locality load balancing, this is DestinationRule-level and will override mesh wide settings in entirety."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailover
withFailover(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverMixin
withFailoverMixin(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverPriority
withFailoverPriority(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverPriorityMixin
withFailoverPriorityMixin(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withFrom
withFrom(from)
"Originating locality, '/' separated, e.g."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withTo
withTo(to)
"Map of upstream localities to traffic distribution weights."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withToMixin
withToMixin(to)
"Map of upstream localities to traffic distribution weights."
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover.withFrom
withFrom(from)
"Originating region."
fn spec.subsets.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover.withTo
withTo(to)
obj spec.subsets.trafficPolicy.portLevelSettings.outlierDetection
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withBaseEjectionTime
withBaseEjectionTime(baseEjectionTime)
"Minimum ejection duration."
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withConsecutive5xxErrors
withConsecutive5xxErrors(consecutive5xxErrors)
"Number of 5xx errors before a host is ejected from the connection pool."
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveErrors
withConsecutiveErrors(consecutiveErrors)
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveGatewayErrors
withConsecutiveGatewayErrors(consecutiveGatewayErrors)
"Number of gateway errors before a host is ejected from the connection pool."
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveLocalOriginFailures
withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withInterval
withInterval(interval)
"Time interval between ejection sweep analysis."
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withMaxEjectionPercent
withMaxEjectionPercent(maxEjectionPercent)
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withMinHealthPercent
withMinHealthPercent(minHealthPercent)
fn spec.subsets.trafficPolicy.portLevelSettings.outlierDetection.withSplitExternalLocalOriginErrors
withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
"Determines whether to distinguish local origin failures from external errors."
obj spec.subsets.trafficPolicy.portLevelSettings.port
fn spec.subsets.trafficPolicy.portLevelSettings.port.withNumber
withNumber(number)
obj spec.subsets.trafficPolicy.portLevelSettings.tls
"TLS related settings for connections to the upstream service."
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withCaCertificates
withCaCertificates(caCertificates)
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withClientCertificate
withClientCertificate(clientCertificate)
"REQUIRED if mode is MUTUAL
."
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withCredentialName
withCredentialName(credentialName)
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withMode
withMode(mode)
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withPrivateKey
withPrivateKey(privateKey)
"REQUIRED if mode is MUTUAL
."
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withSni
withSni(sni)
"SNI string to present to the server during TLS handshake."
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withSubjectAltNames
withSubjectAltNames(subjectAltNames)
fn spec.subsets.trafficPolicy.portLevelSettings.tls.withSubjectAltNamesMixin
withSubjectAltNamesMixin(subjectAltNames)
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.tls
"TLS related settings for connections to the upstream service."
fn spec.subsets.trafficPolicy.tls.withCaCertificates
withCaCertificates(caCertificates)
fn spec.subsets.trafficPolicy.tls.withClientCertificate
withClientCertificate(clientCertificate)
"REQUIRED if mode is MUTUAL
."
fn spec.subsets.trafficPolicy.tls.withCredentialName
withCredentialName(credentialName)
fn spec.subsets.trafficPolicy.tls.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
fn spec.subsets.trafficPolicy.tls.withMode
withMode(mode)
fn spec.subsets.trafficPolicy.tls.withPrivateKey
withPrivateKey(privateKey)
"REQUIRED if mode is MUTUAL
."
fn spec.subsets.trafficPolicy.tls.withSni
withSni(sni)
"SNI string to present to the server during TLS handshake."
fn spec.subsets.trafficPolicy.tls.withSubjectAltNames
withSubjectAltNames(subjectAltNames)
fn spec.subsets.trafficPolicy.tls.withSubjectAltNamesMixin
withSubjectAltNamesMixin(subjectAltNames)
Note: This function appends passed data to existing values
obj spec.subsets.trafficPolicy.tunnel
fn spec.subsets.trafficPolicy.tunnel.withProtocol
withProtocol(protocol)
"Specifies which protocol to use for tunneling the downstream connection."
fn spec.subsets.trafficPolicy.tunnel.withTargetHost
withTargetHost(targetHost)
"Specifies a host to which the downstream connection is tunneled."
fn spec.subsets.trafficPolicy.tunnel.withTargetPort
withTargetPort(targetPort)
"Specifies a port to which the downstream connection is tunneled."
obj spec.trafficPolicy
fn spec.trafficPolicy.withPortLevelSettings
withPortLevelSettings(portLevelSettings)
"Traffic policies specific to individual ports."
fn spec.trafficPolicy.withPortLevelSettingsMixin
withPortLevelSettingsMixin(portLevelSettings)
"Traffic policies specific to individual ports."
Note: This function appends passed data to existing values
obj spec.trafficPolicy.connectionPool
obj spec.trafficPolicy.connectionPool.http
"HTTP connection pool settings."
fn spec.trafficPolicy.connectionPool.http.withH2UpgradePolicy
withH2UpgradePolicy(h2UpgradePolicy)
"Specify if http1.1 connection should be upgraded to http2 for the associated destination."
fn spec.trafficPolicy.connectionPool.http.withHttp1MaxPendingRequests
withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn spec.trafficPolicy.connectionPool.http.withHttp2MaxRequests
withHttp2MaxRequests(http2MaxRequests)
"Maximum number of active requests to a destination."
fn spec.trafficPolicy.connectionPool.http.withIdleTimeout
withIdleTimeout(idleTimeout)
"The idle timeout for upstream connection pool connections."
fn spec.trafficPolicy.connectionPool.http.withMaxRequestsPerConnection
withMaxRequestsPerConnection(maxRequestsPerConnection)
"Maximum number of requests per connection to a backend."
fn spec.trafficPolicy.connectionPool.http.withMaxRetries
withMaxRetries(maxRetries)
fn spec.trafficPolicy.connectionPool.http.withUseClientProtocol
withUseClientProtocol(useClientProtocol)
"If set to true, client protocol will be preserved while initiating connection to backend."
obj spec.trafficPolicy.connectionPool.tcp
"Settings common to both HTTP and TCP upstream connections."
fn spec.trafficPolicy.connectionPool.tcp.withConnectTimeout
withConnectTimeout(connectTimeout)
"TCP connection timeout."
fn spec.trafficPolicy.connectionPool.tcp.withMaxConnectionDuration
withMaxConnectionDuration(maxConnectionDuration)
"The maximum duration of a connection."
fn spec.trafficPolicy.connectionPool.tcp.withMaxConnections
withMaxConnections(maxConnections)
"Maximum number of HTTP1 /TCP connections to a destination host."
obj spec.trafficPolicy.connectionPool.tcp.tcpKeepalive
"If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives."
fn spec.trafficPolicy.connectionPool.tcp.tcpKeepalive.withInterval
withInterval(interval)
"The time duration between keep-alive probes."
fn spec.trafficPolicy.connectionPool.tcp.tcpKeepalive.withProbes
withProbes(probes)
fn spec.trafficPolicy.connectionPool.tcp.tcpKeepalive.withTime
withTime(time)
obj spec.trafficPolicy.loadBalancer
"Settings controlling the load balancer algorithms."
fn spec.trafficPolicy.loadBalancer.withSimple
withSimple(simple)
fn spec.trafficPolicy.loadBalancer.withWarmupDurationSecs
withWarmupDurationSecs(warmupDurationSecs)
"Represents the warmup duration of Service."
obj spec.trafficPolicy.loadBalancer.consistentHash
fn spec.trafficPolicy.loadBalancer.consistentHash.withHttpHeaderName
withHttpHeaderName(httpHeaderName)
"Hash based on a specific HTTP header."
fn spec.trafficPolicy.loadBalancer.consistentHash.withHttpQueryParameterName
withHttpQueryParameterName(httpQueryParameterName)
"Hash based on a specific HTTP query parameter."
fn spec.trafficPolicy.loadBalancer.consistentHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
"Deprecated."
fn spec.trafficPolicy.loadBalancer.consistentHash.withUseSourceIp
withUseSourceIp(useSourceIp)
"Hash based on the source IP address."
obj spec.trafficPolicy.loadBalancer.consistentHash.httpCookie
"Hash based on HTTP cookie."
fn spec.trafficPolicy.loadBalancer.consistentHash.httpCookie.withName
withName(name)
"Name of the cookie."
fn spec.trafficPolicy.loadBalancer.consistentHash.httpCookie.withPath
withPath(path)
"Path to set for the cookie."
fn spec.trafficPolicy.loadBalancer.consistentHash.httpCookie.withTtl
withTtl(ttl)
"Lifetime of the cookie."
obj spec.trafficPolicy.loadBalancer.consistentHash.maglev
"The Maglev load balancer implements consistent hashing to backend hosts."
fn spec.trafficPolicy.loadBalancer.consistentHash.maglev.withTableSize
withTableSize(tableSize)
"The table size for Maglev hashing."
obj spec.trafficPolicy.loadBalancer.consistentHash.ringHash
"The ring/modulo hash load balancer implements consistent hashing to backend hosts."
fn spec.trafficPolicy.loadBalancer.consistentHash.ringHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
obj spec.trafficPolicy.loadBalancer.localityLbSetting
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withDistribute
withDistribute(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withDistributeMixin
withDistributeMixin(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withEnabled
withEnabled(enabled)
"enable locality load balancing, this is DestinationRule-level and will override mesh wide settings in entirety."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withFailover
withFailover(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withFailoverMixin
withFailoverMixin(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withFailoverPriority
withFailoverPriority(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.withFailoverPriorityMixin
withFailoverPriorityMixin(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
Note: This function appends passed data to existing values
obj spec.trafficPolicy.loadBalancer.localityLbSetting.distribute
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.distribute.withFrom
withFrom(from)
"Originating locality, '/' separated, e.g."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.distribute.withTo
withTo(to)
"Map of upstream localities to traffic distribution weights."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.distribute.withToMixin
withToMixin(to)
"Map of upstream localities to traffic distribution weights."
Note: This function appends passed data to existing values
obj spec.trafficPolicy.loadBalancer.localityLbSetting.failover
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.failover.withFrom
withFrom(from)
"Originating region."
fn spec.trafficPolicy.loadBalancer.localityLbSetting.failover.withTo
withTo(to)
obj spec.trafficPolicy.outlierDetection
fn spec.trafficPolicy.outlierDetection.withBaseEjectionTime
withBaseEjectionTime(baseEjectionTime)
"Minimum ejection duration."
fn spec.trafficPolicy.outlierDetection.withConsecutive5xxErrors
withConsecutive5xxErrors(consecutive5xxErrors)
"Number of 5xx errors before a host is ejected from the connection pool."
fn spec.trafficPolicy.outlierDetection.withConsecutiveErrors
withConsecutiveErrors(consecutiveErrors)
fn spec.trafficPolicy.outlierDetection.withConsecutiveGatewayErrors
withConsecutiveGatewayErrors(consecutiveGatewayErrors)
"Number of gateway errors before a host is ejected from the connection pool."
fn spec.trafficPolicy.outlierDetection.withConsecutiveLocalOriginFailures
withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn spec.trafficPolicy.outlierDetection.withInterval
withInterval(interval)
"Time interval between ejection sweep analysis."
fn spec.trafficPolicy.outlierDetection.withMaxEjectionPercent
withMaxEjectionPercent(maxEjectionPercent)
fn spec.trafficPolicy.outlierDetection.withMinHealthPercent
withMinHealthPercent(minHealthPercent)
fn spec.trafficPolicy.outlierDetection.withSplitExternalLocalOriginErrors
withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
"Determines whether to distinguish local origin failures from external errors."
obj spec.trafficPolicy.portLevelSettings
"Traffic policies specific to individual ports."
obj spec.trafficPolicy.portLevelSettings.connectionPool
obj spec.trafficPolicy.portLevelSettings.connectionPool.http
"HTTP connection pool settings."
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withH2UpgradePolicy
withH2UpgradePolicy(h2UpgradePolicy)
"Specify if http1.1 connection should be upgraded to http2 for the associated destination."
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withHttp1MaxPendingRequests
withHttp1MaxPendingRequests(http1MaxPendingRequests)
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withHttp2MaxRequests
withHttp2MaxRequests(http2MaxRequests)
"Maximum number of active requests to a destination."
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withIdleTimeout
withIdleTimeout(idleTimeout)
"The idle timeout for upstream connection pool connections."
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withMaxRequestsPerConnection
withMaxRequestsPerConnection(maxRequestsPerConnection)
"Maximum number of requests per connection to a backend."
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withMaxRetries
withMaxRetries(maxRetries)
fn spec.trafficPolicy.portLevelSettings.connectionPool.http.withUseClientProtocol
withUseClientProtocol(useClientProtocol)
"If set to true, client protocol will be preserved while initiating connection to backend."
obj spec.trafficPolicy.portLevelSettings.connectionPool.tcp
"Settings common to both HTTP and TCP upstream connections."
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.withConnectTimeout
withConnectTimeout(connectTimeout)
"TCP connection timeout."
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.withMaxConnectionDuration
withMaxConnectionDuration(maxConnectionDuration)
"The maximum duration of a connection."
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.withMaxConnections
withMaxConnections(maxConnections)
"Maximum number of HTTP1 /TCP connections to a destination host."
obj spec.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive
"If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives."
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withInterval
withInterval(interval)
"The time duration between keep-alive probes."
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withProbes
withProbes(probes)
fn spec.trafficPolicy.portLevelSettings.connectionPool.tcp.tcpKeepalive.withTime
withTime(time)
obj spec.trafficPolicy.portLevelSettings.loadBalancer
"Settings controlling the load balancer algorithms."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.withSimple
withSimple(simple)
fn spec.trafficPolicy.portLevelSettings.loadBalancer.withWarmupDurationSecs
withWarmupDurationSecs(warmupDurationSecs)
"Represents the warmup duration of Service."
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withHttpHeaderName
withHttpHeaderName(httpHeaderName)
"Hash based on a specific HTTP header."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withHttpQueryParameterName
withHttpQueryParameterName(httpQueryParameterName)
"Hash based on a specific HTTP query parameter."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
"Deprecated."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.withUseSourceIp
withUseSourceIp(useSourceIp)
"Hash based on the source IP address."
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie
"Hash based on HTTP cookie."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withName
withName(name)
"Name of the cookie."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withPath
withPath(path)
"Path to set for the cookie."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.httpCookie.withTtl
withTtl(ttl)
"Lifetime of the cookie."
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev
"The Maglev load balancer implements consistent hashing to backend hosts."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.maglev.withTableSize
withTableSize(tableSize)
"The table size for Maglev hashing."
obj spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash
"The ring/modulo hash load balancer implements consistent hashing to backend hosts."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.consistentHash.ringHash.withMinimumRingSize
withMinimumRingSize(minimumRingSize)
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withDistribute
withDistribute(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withDistributeMixin
withDistributeMixin(distribute)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withEnabled
withEnabled(enabled)
"enable locality load balancing, this is DestinationRule-level and will override mesh wide settings in entirety."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailover
withFailover(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverMixin
withFailoverMixin(failover)
"Optional: only one of distribute, failover or failoverPriority can be set."
Note: This function appends passed data to existing values
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverPriority
withFailoverPriority(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.withFailoverPriorityMixin
withFailoverPriorityMixin(failoverPriority)
"failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing."
Note: This function appends passed data to existing values
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withFrom
withFrom(from)
"Originating locality, '/' separated, e.g."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withTo
withTo(to)
"Map of upstream localities to traffic distribution weights."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.distribute.withToMixin
withToMixin(to)
"Map of upstream localities to traffic distribution weights."
Note: This function appends passed data to existing values
obj spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover
"Optional: only one of distribute, failover or failoverPriority can be set."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover.withFrom
withFrom(from)
"Originating region."
fn spec.trafficPolicy.portLevelSettings.loadBalancer.localityLbSetting.failover.withTo
withTo(to)
obj spec.trafficPolicy.portLevelSettings.outlierDetection
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withBaseEjectionTime
withBaseEjectionTime(baseEjectionTime)
"Minimum ejection duration."
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withConsecutive5xxErrors
withConsecutive5xxErrors(consecutive5xxErrors)
"Number of 5xx errors before a host is ejected from the connection pool."
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveErrors
withConsecutiveErrors(consecutiveErrors)
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveGatewayErrors
withConsecutiveGatewayErrors(consecutiveGatewayErrors)
"Number of gateway errors before a host is ejected from the connection pool."
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withConsecutiveLocalOriginFailures
withConsecutiveLocalOriginFailures(consecutiveLocalOriginFailures)
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withInterval
withInterval(interval)
"Time interval between ejection sweep analysis."
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withMaxEjectionPercent
withMaxEjectionPercent(maxEjectionPercent)
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withMinHealthPercent
withMinHealthPercent(minHealthPercent)
fn spec.trafficPolicy.portLevelSettings.outlierDetection.withSplitExternalLocalOriginErrors
withSplitExternalLocalOriginErrors(splitExternalLocalOriginErrors)
"Determines whether to distinguish local origin failures from external errors."
obj spec.trafficPolicy.portLevelSettings.port
fn spec.trafficPolicy.portLevelSettings.port.withNumber
withNumber(number)
obj spec.trafficPolicy.portLevelSettings.tls
"TLS related settings for connections to the upstream service."
fn spec.trafficPolicy.portLevelSettings.tls.withCaCertificates
withCaCertificates(caCertificates)
fn spec.trafficPolicy.portLevelSettings.tls.withClientCertificate
withClientCertificate(clientCertificate)
"REQUIRED if mode is MUTUAL
."
fn spec.trafficPolicy.portLevelSettings.tls.withCredentialName
withCredentialName(credentialName)
fn spec.trafficPolicy.portLevelSettings.tls.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
fn spec.trafficPolicy.portLevelSettings.tls.withMode
withMode(mode)
fn spec.trafficPolicy.portLevelSettings.tls.withPrivateKey
withPrivateKey(privateKey)
"REQUIRED if mode is MUTUAL
."
fn spec.trafficPolicy.portLevelSettings.tls.withSni
withSni(sni)
"SNI string to present to the server during TLS handshake."
fn spec.trafficPolicy.portLevelSettings.tls.withSubjectAltNames
withSubjectAltNames(subjectAltNames)
fn spec.trafficPolicy.portLevelSettings.tls.withSubjectAltNamesMixin
withSubjectAltNamesMixin(subjectAltNames)
Note: This function appends passed data to existing values
obj spec.trafficPolicy.tls
"TLS related settings for connections to the upstream service."
fn spec.trafficPolicy.tls.withCaCertificates
withCaCertificates(caCertificates)
fn spec.trafficPolicy.tls.withClientCertificate
withClientCertificate(clientCertificate)
"REQUIRED if mode is MUTUAL
."
fn spec.trafficPolicy.tls.withCredentialName
withCredentialName(credentialName)
fn spec.trafficPolicy.tls.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
fn spec.trafficPolicy.tls.withMode
withMode(mode)
fn spec.trafficPolicy.tls.withPrivateKey
withPrivateKey(privateKey)
"REQUIRED if mode is MUTUAL
."
fn spec.trafficPolicy.tls.withSni
withSni(sni)
"SNI string to present to the server during TLS handshake."
fn spec.trafficPolicy.tls.withSubjectAltNames
withSubjectAltNames(subjectAltNames)
fn spec.trafficPolicy.tls.withSubjectAltNamesMixin
withSubjectAltNamesMixin(subjectAltNames)
Note: This function appends passed data to existing values
obj spec.trafficPolicy.tunnel
fn spec.trafficPolicy.tunnel.withProtocol
withProtocol(protocol)
"Specifies which protocol to use for tunneling the downstream connection."
fn spec.trafficPolicy.tunnel.withTargetHost
withTargetHost(targetHost)
"Specifies a host to which the downstream connection is tunneled."
fn spec.trafficPolicy.tunnel.withTargetPort
withTargetPort(targetPort)
"Specifies a port to which the downstream connection is tunneled."
obj spec.workloadSelector
fn spec.workloadSelector.withMatchLabels
withMatchLabels(matchLabels)
fn spec.workloadSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
Note: This function appends passed data to existing values