readyz endpoint
The API server's built-in health check path, which reports whether it is ready to serve requests and, with verbose, lists each internal check.
In more detail
A failing etcd check points at persistence rather than the API server itself. livez answers whether the process should be restarted, and the older healthz is deprecated. Reaching it at all also proves network reachability and credentials.
Example
kubectl get --raw '/readyz?verbose'Related terms
- API server — The Kubernetes control plane component that serves the Kubernetes API; every read and change to the cluster goes through it.
- etcd — The distributed key-value store where Kubernetes keeps all cluster data, including every Secret.
- health check — A regular automated test of whether a program or service is working, such as a request to its health endpoint or a command run inside its container.
Taught in
- RBAC: Find The Path To Cluster Admin — Certified Kubernetes Security Specialist (CKS) Exam Prep
- Anonymous Access: The Fix That Kills The API Server — Certified Kubernetes Security Specialist (CKS) Exam Prep
- Eleven Months Of Yes: The API Server — Kubernetes and Cloud Native Security Associate (KCSA) Exam Prep
- Control Plane: etcd, API Server, Scheduler, Controllers — Kubernetes: Production-Grade Container Orchestration
- Troubleshooting: API Server And Control Plane Failures — Kubernetes: Production-Grade Container Orchestration