Add some explanation of the difference between the livez and readyz endpoints of the kubernetes API #49283
Labels
kind/feature
Categorizes issue or PR as related to a new feature.
needs-triage
Indicates an issue or PR lacks a `triage/foo` label and requires one.
What would you like to be added
The current documentation page regarding the Kubernetes API health endpoint is not clear about where the /readyz and /livez differ and in which situations one or the other should be called. It was already a point raised before and the conversation around the commit adding the current version of the documentation indicate that those endpoints may not be relied upon: if it is the case it could be a good thing to add a note in the documentation.
Why is this needed
When setting up a kubernetes cluster on premise you want to have multiple nodes hosting the control plane to help with high availability. Then when setting up some load balancers on front having them able to check which nodes are down so people would expect some easy healthcheck.
Comments
More generally the documentation is not clear (or lack locality of information) regarding what happens when you scale the api server: if I have 3 nodes hosting the API, is the information those health endpoints return only for the node receiving the call or for every node? What happens when 1 of those 3 nodes is down?
The text was updated successfully, but these errors were encountered: