Update docs for deprecation of Endpoints API #49831
Conversation
- FQDN is not a supported AddressType - Update documentation around `serving` vs `ready` to just explain how it works now, without the historical context. (In particular, describe `serving` first, and then explain `ready` as being almost the same thing as `serving` rather than vice versa). - Fix feature-state version macro for `terminating` - Remove a note about some deprecated v1beta1 EndpointSlice fields that is just confusing if you didn't know that v1beta1 had a different topology API. - Remove the "Comparison with Endpoints"/"Motivation" section.
…Slice, delete Endpoints
k8s-ci-robot
added
tide/merge-method-squash
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/L
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
| [Endpoints](/docs/reference/kubernetes-api/service-resources/endpoints-v1/) | ||
| (the resource kind is plural) defines a list of network endpoints, typically | ||
| referenced by a Service to define which Pods the traffic can be sent to. | ||
| API. The Endpoints API is now deprecated, and has several problems |
There was a problem hiding this comment.
| API. The Endpoints API is now deprecated, and has several problems | |
| API. The deprecated Endpoints API has several problems |
There was a problem hiding this comment.
Don't drop this glossary entry; it's useful even if we've deprecated it.
There was a problem hiding this comment.
ok... I removed all the existing links to it though...
There was a problem hiding this comment.
There will still be hyperlinks to https://kubernetes.io/docs/reference/glossary/
| @@ -1,17 +0,0 @@ | |||
| --- | |||
| title: Endpoints | |||
There was a problem hiding this comment.
Maybe we could have a glossary entry for endpoint rather than Endpoints?
And then the revised entry could mention EndpointSlice.
There was a problem hiding this comment.
So, effectively replace both existing glossary entries with the new combined one? Is there any way to make the old ones redirect? Or should I keep the old ones too, but just have basically the same information in all three?
There was a problem hiding this comment.
Well, the glossary entry id is endpoint. So we / you could:
- explain what we mean by the term endpoint
- mention EndpointSlices
- find everywhere this glossary term is used within English docs, and check that the changes haven't made the page misleading
- minimum viable rewrites where needed
Updates documentation to reflect the fact that Endpoints are now officially deprecated in 1.33 (KEP-4974).
This includes some updates to the EndpointSlice documentation to get rid of some historical baggage and focus on describing the API as it is now. (It does not add any of the missing information to the section about topology because that will need to be updated for KEP-3015 anyway so I'll just fix it all then.)
There are a lot of instances of the word "endpoints" in the documentation, but a lot of them refer to the generic concept. I think I've fixed most of them at least...
/label tide/merge-method-squash