fixup! fixup! fixup! enhancement: add livez endpoint

README.md

@@ -349,6 +349,14 @@ The following probes are available, and follow the [Kubernetes best practices](h
 * `livenessProbe`: Checks if the application is not affected by an outage, and is able to access the Kube API by querying the cluster's `/livez` endpoint.
 * `readinessProbe`: Checks if the application is ready to serve metrics by querying its own telemetry metrics.
 
+#### Healthcheck Endpoints
+
+The following healthcheck endpoints are available, some of which are used to determine the result of the aforementioned probes:
+
+* `/livez`: Returns a 200 status code if the application is not affected by an outage. This is used to determine the result of the liveness probe.
+* `/metrics`: Returns a 200 status code if the application is able to serve metrics. While this is available for both ports, only self metrics are used to determine the result of the readiness probe.
+* `/healthz`: Returns a 200 status code if the application is running.
+
 #### Limited privileges environment
 
 If you want to run kube-state-metrics in an environment where you don't have cluster-reader role, you can:

README.md.tpl

@@ -350,6 +350,14 @@ The following probes are available, and follow the [Kubernetes best practices](h
 * `livenessProbe`: Checks if the application is not affected by an outage, and is able to access the Kube API by querying the cluster's `/livez` endpoint.
 * `readinessProbe`: Checks if the application is ready to serve metrics by querying its own telemetry metrics.
 
+#### Healthcheck Endpoints
+
+The following healthcheck endpoints are available, some of which are used to determine the result of the aforementioned probes:
+
+* `/livez`: Returns a 200 status code if the application is not affected by an outage. This is used to determine the result of the liveness probe.
+* `/metrics`: Returns a 200 status code if the application is able to serve metrics. While this is available for both ports, only self metrics are used to determine the result of the readiness probe.
+* `/healthz`: Returns a 200 status code if the application is running.
+
 #### Limited privileges environment
 
 If you want to run kube-state-metrics in an environment where you don't have cluster-reader role, you can: