- Type
object
Specification
.spec
- Description
- Configuration affecting load balancing, outlier detection, etc. See more details at: https://istio.io/docs/reference/config/networking/destination-rule.html
- Type
object
.spec.exportTo
- Description
- A list of namespaces to which this destination rule is exported.
- Type
array
.spec.exportTo[]
- Type
string
.spec.subsets
- Type
array
.spec.subsets[]
- Type
object
.spec.subsets[].labels
- Type
object
.spec.subsets[].trafficPolicy
- Description
- Traffic policies that apply to this subset.
- Type
object
.spec.subsets[].trafficPolicy.connectionPool
- Type
object
.spec.subsets[].trafficPolicy.connectionPool.http
- Description
- HTTP connection pool settings.
- Type
object
.spec.subsets[].trafficPolicy.connectionPool.tcp
- Description
- Settings common to both HTTP and TCP upstream connections.
- Type
object
.spec.subsets[].trafficPolicy.connectionPool.tcp.tcpKeepalive
- Description
- If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer
- Description
- Settings controlling the load balancer algorithms.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.consistentHash
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.consistentHash.httpCookie
- Description
- Hash based on HTTP cookie.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.consistentHash.maglev
- Description
- The Maglev load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.consistentHash.ringHash
- Description
- The ring/modulo hash load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.distribute
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.distribute[]
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.distribute[].to
- Description
- Map of upstream localities to traffic distribution weights.
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.failover
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.failover[]
- Type
object
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.failoverPriority
- Description
- failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing.
- Type
array
.spec.subsets[].trafficPolicy.loadBalancer.localityLbSetting.failoverPriority[]
- Type
string
.spec.subsets[].trafficPolicy.outlierDetection
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings
- Description
- Traffic policies specific to individual ports.
- Type
array
.spec.subsets[].trafficPolicy.portLevelSettings[]
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].connectionPool
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].connectionPool.http
- Description
- HTTP connection pool settings.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].connectionPool.tcp
- Description
- Settings common to both HTTP and TCP upstream connections.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].connectionPool.tcp.tcpKeepalive
- Description
- If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer
- Description
- Settings controlling the load balancer algorithms.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.consistentHash
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.httpCookie
- Description
- Hash based on HTTP cookie.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.maglev
- Description
- The Maglev load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.ringHash
- Description
- The ring/modulo hash load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute[]
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute[].to
- Description
- Map of upstream localities to traffic distribution weights.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failover
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failover[]
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failoverPriority
- Description
- failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing.
- Type
array
.spec.subsets[].trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failoverPriority[]
- Type
string
.spec.subsets[].trafficPolicy.portLevelSettings[].outlierDetection
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].port
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].tls
- Description
- TLS related settings for connections to the upstream service.
- Type
object
.spec.subsets[].trafficPolicy.portLevelSettings[].tls.subjectAltNames
- Type
array
.spec.subsets[].trafficPolicy.portLevelSettings[].tls.subjectAltNames[]
- Type
string
.spec.subsets[].trafficPolicy.tls
- Description
- TLS related settings for connections to the upstream service.
- Type
object
.spec.subsets[].trafficPolicy.tls.subjectAltNames
- Type
array
.spec.subsets[].trafficPolicy.tls.subjectAltNames[]
- Type
string
.spec.subsets[].trafficPolicy.tunnel
- Type
object
.spec.trafficPolicy
- Type
object
.spec.trafficPolicy.connectionPool
- Type
object
.spec.trafficPolicy.connectionPool.http
- Description
- HTTP connection pool settings.
- Type
object
.spec.trafficPolicy.connectionPool.tcp
- Description
- Settings common to both HTTP and TCP upstream connections.
- Type
object
.spec.trafficPolicy.connectionPool.tcp.tcpKeepalive
- Description
- If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.
- Type
object
.spec.trafficPolicy.loadBalancer
- Description
- Settings controlling the load balancer algorithms.
- Type
object
.spec.trafficPolicy.loadBalancer.consistentHash
- Type
object
.spec.trafficPolicy.loadBalancer.consistentHash.httpCookie
- Description
- Hash based on HTTP cookie.
- Type
object
.spec.trafficPolicy.loadBalancer.consistentHash.maglev
- Description
- The Maglev load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.trafficPolicy.loadBalancer.consistentHash.ringHash
- Description
- The ring/modulo hash load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.trafficPolicy.loadBalancer.localityLbSetting
- Type
object
.spec.trafficPolicy.loadBalancer.localityLbSetting.distribute
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.trafficPolicy.loadBalancer.localityLbSetting.distribute[]
- Type
object
.spec.trafficPolicy.loadBalancer.localityLbSetting.distribute[].to
- Description
- Map of upstream localities to traffic distribution weights.
- Type
object
.spec.trafficPolicy.loadBalancer.localityLbSetting.failover
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.trafficPolicy.loadBalancer.localityLbSetting.failover[]
- Type
object
.spec.trafficPolicy.loadBalancer.localityLbSetting.failoverPriority
- Description
- failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing.
- Type
array
.spec.trafficPolicy.loadBalancer.localityLbSetting.failoverPriority[]
- Type
string
.spec.trafficPolicy.outlierDetection
- Type
object
.spec.trafficPolicy.portLevelSettings
- Description
- Traffic policies specific to individual ports.
- Type
array
.spec.trafficPolicy.portLevelSettings[]
- Type
object
.spec.trafficPolicy.portLevelSettings[].connectionPool
- Type
object
.spec.trafficPolicy.portLevelSettings[].connectionPool.http
- Description
- HTTP connection pool settings.
- Type
object
.spec.trafficPolicy.portLevelSettings[].connectionPool.tcp
- Description
- Settings common to both HTTP and TCP upstream connections.
- Type
object
.spec.trafficPolicy.portLevelSettings[].connectionPool.tcp.tcpKeepalive
- Description
- If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer
- Description
- Settings controlling the load balancer algorithms.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.consistentHash
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.httpCookie
- Description
- Hash based on HTTP cookie.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.maglev
- Description
- The Maglev load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.consistentHash.ringHash
- Description
- The ring/modulo hash load balancer implements consistent hashing to backend hosts.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute[]
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.distribute[].to
- Description
- Map of upstream localities to traffic distribution weights.
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failover
- Description
- Optional: only one of distribute, failover or failoverPriority can be set.
- Type
array
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failover[]
- Type
object
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failoverPriority
- Description
- failoverPriority is an ordered list of labels used to sort endpoints to do priority based load balancing.
- Type
array
.spec.trafficPolicy.portLevelSettings[].loadBalancer.localityLbSetting.failoverPriority[]
- Type
string
.spec.trafficPolicy.portLevelSettings[].outlierDetection
- Type
object
.spec.trafficPolicy.portLevelSettings[].port
- Type
object
.spec.trafficPolicy.portLevelSettings[].tls
- Description
- TLS related settings for connections to the upstream service.
- Type
object
.spec.trafficPolicy.portLevelSettings[].tls.subjectAltNames
- Type
array
.spec.trafficPolicy.portLevelSettings[].tls.subjectAltNames[]
- Type
string
.spec.trafficPolicy.tls
- Description
- TLS related settings for connections to the upstream service.
- Type
object
.spec.trafficPolicy.tls.subjectAltNames
- Type
array
.spec.trafficPolicy.tls.subjectAltNames[]
- Type
string
.spec.trafficPolicy.tunnel
- Type
object
.spec.workloadSelector
- Type
object
.spec.workloadSelector.matchLabels
- Type
object
.status
- Type
object
API Endpoints
The following API endpoints are available:
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrulesDELETE: delete collection of DestinationRuleGET: list objects of kind DestinationRulePOST: create a new DestinationRule
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrules/{name}DELETE: delete the specified DestinationRuleGET: read the specified DestinationRulePATCH: partially update the specified DestinationRulePUT: replace the specified DestinationRule
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrules/{name}/statusGET: read status of the specified DestinationRulePATCH: partially update status of the specified DestinationRulePUT: replace status of the specified DestinationRule
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrules
- HTTP method
DELETE- Description
- delete collection of DestinationRule
- HTTP responses
- HTTP method
GET- Description
- list objects of kind DestinationRule
- HTTP responses
- HTTP method
POST- Description
- create a new DestinationRule
- Query parameters
- Body parameters
- HTTP responses
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrules/{name}
- HTTP method
DELETE- Description
- delete the specified DestinationRule
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified DestinationRule
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified DestinationRule
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified DestinationRule
- Query parameters
- Body parameters
- HTTP responses
/apis/networking.istio.io/v1alpha3/namespaces/{namespace}/destinationrules/{name}/status
- HTTP method
GET- Description
- read status of the specified DestinationRule
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified DestinationRule
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified DestinationRule
- Query parameters
- Body parameters
- HTTP responses