mirror of
https://github.com/k3s-io/kubernetes.git
synced 2026-01-05 07:27:21 +00:00
Clarify behavior of publishNotReadyAddresses (#90783)
* Clarify behavior of publishNotReadyAddresses * gen docs after clarifying publishNotReadyAddresses
This commit is contained in:
committed by
GitHub
parent
b67e7d6e2c
commit
daa27c9b2e
@@ -3513,12 +3513,14 @@ type ServiceSpec struct {
|
||||
// +optional
|
||||
HealthCheckNodePort int32
|
||||
|
||||
// publishNotReadyAddresses, when set to true, indicates that DNS implementations
|
||||
// must publish the notReadyAddresses of subsets for the Endpoints associated with
|
||||
// the Service. The default value is false.
|
||||
// The primary use case for setting this field is to use a StatefulSet's Headless Service
|
||||
// to propagate SRV records for its Pods without respect to their readiness for purpose
|
||||
// of peer discovery.
|
||||
// publishNotReadyAddresses indicates that any agent which deals with endpoints for this
|
||||
// Service should disregard any indications of ready/not-ready.
|
||||
// The primary use case for setting this field is for a StatefulSet's Headless Service to
|
||||
// propagate SRV DNS records for its Pods for the purpose of peer discovery.
|
||||
// The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
|
||||
// Services interpret this to mean that all endpoints are considered "ready" even if the
|
||||
// Pods themselves are not. Agents which consume only Kubernetes generated endpoints
|
||||
// through the Endpoints or EndpointSlice resources can safely assume this behavior.
|
||||
// +optional
|
||||
PublishNotReadyAddresses bool
|
||||
|
||||
|
||||
Reference in New Issue
Block a user