search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.51k stars 14.46k forks source link

"Configure Liveness, Readiness and Startup Probes" unclear #46886

Open wardvandriessche-centrica opened 5 months ago

wardvandriessche-centrica commented 5 months ago

It is not clear from the documentation which ServiceStatus fields are used from the gRPC Health Check Protocol and also if it's possible to customize.

For example: is it possible to set up the liveliness/readiness probes in such a way that a SERVING response is considered "ready" and a SERVING or NOT_SERVING is considered "alive". An UNKNOWN response would then fail both ready and alive.

dipesh-rawat commented 5 months ago

Page reported in issue (based on issue title): https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

/language en

sftim commented 3 months ago

/retitle "Configure Liveness, Readiness and Startup Probes" unclear

sftim commented 3 months ago

How I would fix this: add a new page with very detailed information about probes and their specifics, within https://kubernetes.io/docs/reference/node/

Then update existing pages to link to the new page, including:

Any fix that addresses the issue is welcome

/triage accepted /priority backlog

sftim commented 3 months ago

/kind feature

tengqm commented 3 months ago

Probes are an essential mechanism for ensuring that Pods (workloads) are working as expected. I'd suggest adding a concept page under https://kubernetes.io/docs/concepts/workloads/pods/ for them. For example, https://kubernetes.io/docs/concepts/workloads/pods/probes/.

sftim commented 3 months ago

Sold (as in, I'm convinced). Based on https://github.com/kubernetes/website/issues/46886#issuecomment-2303297634 I now suggest adding two new pages: