diff --git a/cmd/root.go b/cmd/root.go index 0caa9cc0e..f696163c9 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -179,10 +179,7 @@ Health checks - /readiness: Returns 200 status when the Proxy has started, has available connections if max connections have been set with the --max-connections flag, and when the Proxy can connect to all registered instances. Otherwise, - returns a 503 status. Optionally supports a min-ready query param (e.g., - /readiness?min-ready=3) where the Proxy will return a 200 status if the - Proxy can connect successfully to at least min-ready number of instances. If - min-ready exceeds the number of registered instances, returns a 400. + returns a 503 status. - /liveness: Always returns 200 status. If this endpoint is not responding, the Proxy is in a bad state and should be restarted. diff --git a/docs/cmd/cloud-sql-proxy.md b/docs/cmd/cloud-sql-proxy.md index 242442188..ac81f02b7 100644 --- a/docs/cmd/cloud-sql-proxy.md +++ b/docs/cmd/cloud-sql-proxy.md @@ -90,10 +90,7 @@ Health checks - /readiness: Returns 200 status when the Proxy has started, has available connections if max connections have been set with the --max-connections flag, and when the Proxy can connect to all registered instances. Otherwise, - returns a 503 status. Optionally supports a min-ready query param (e.g., - /readiness?min-ready=3) where the Proxy will return a 200 status if the - Proxy can connect successfully to at least min-ready number of instances. If - min-ready exceeds the number of registered instances, returns a 400. + returns a 503 status. - /liveness: Always returns 200 status. If this endpoint is not responding, the Proxy is in a bad state and should be restarted. diff --git a/examples/k8s-health-check/README.md b/examples/k8s-health-check/README.md index 867300a4f..0f8800edb 100644 --- a/examples/k8s-health-check/README.md +++ b/examples/k8s-health-check/README.md @@ -24,10 +24,7 @@ the proxy is in a bad state and should be restarted. - `/readiness`: Returns 200 status when the proxy has started, has available connections if max connections have been set with the `--max-connections` flag, and when the proxy can connect to all registered instances. Otherwise, - returns a 503 status. Optionally supports a min-ready query param (e.g., - `/readiness?min-ready=3`) where the proxy will return a 200 status if the - proxy can connect successfully to at least min-ready number of instances. If - min-ready exceeds the number of registered instances, returns a 400. + returns a 503 status. To configure the address, use `--http-address`. To configure the port, use