Skip to content

Commit

Permalink
Clarify EPSlice docs wrt the Ready conditions
Browse files Browse the repository at this point in the history
`publishNotReadyAddresses` is an explicit override, so this makes it
clear that is OK.

Kubernetes-commit: 78530ec0a8ada5c1301d2c7a8ce122a9ec398610
  • Loading branch information
thockin authored and k8s-publishing-bot committed Mar 19, 2023
1 parent bad7d34 commit c5c9df1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion discovery/v1/generated.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion discovery/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,9 @@ type EndpointConditions struct {
// according to whatever system is managing the endpoint. A nil value
// indicates an unknown state. In most cases consumers should interpret this
// unknown state as ready. For compatibility reasons, ready should never be
// "true" for terminating endpoints.
// "true" for terminating endpoints, except when the normal readiness
// behavior is being explicitly overridden, for example when the associated
// Service has set the publishNotReadyAddresses flag.
// +optional
Ready *bool `json:"ready,omitempty" protobuf:"bytes,1,name=ready"`

Expand Down
2 changes: 1 addition & 1 deletion discovery/v1/types_swagger_doc_generated.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func (Endpoint) SwaggerDoc() map[string]string {

var map_EndpointConditions = map[string]string{
"": "EndpointConditions represents the current condition of an endpoint.",
"ready": "ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be \"true\" for terminating endpoints.",
"ready": "ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be \"true\" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.",
"serving": "serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition.",
"terminating": "terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating.",
}
Expand Down

0 comments on commit c5c9df1

Please sign in to comment.