From c082321e7462655a29a0fc010d3571b3130115d3 Mon Sep 17 00:00:00 2001 From: chrislusf Date: Tue, 2 Dec 2025 22:58:03 -0800 Subject: [PATCH] docs: add /healthz endpoint documentation for volume server Documents the healthz endpoint behavior after the fix for issue #6823. The endpoint now only checks local conditions (shutting down, master connectivity) and will not fail due to other volume servers being unavailable. --- Volume-Server-API.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Volume-Server-API.md b/Volume-Server-API.md index b0a29da..48de8eb 100644 --- a/Volume-Server-API.md +++ b/Volume-Server-API.md @@ -74,6 +74,19 @@ curl -X DELETE http://127.0.0.1:8080/3,01637037d6 curl http://127.0.0.1:8080/3,01637037d6?cm=false ``` +### Check Volume Server Health + +The `/healthz` endpoint checks if the volume server is healthy. It returns: +- `200 OK` - Server is healthy +- `503 Service Unavailable` - Server is unhealthy (shutting down or lost connection to master) + +```bash +curl -I "http://localhost:8080/healthz" +HTTP/1.1 200 OK +``` + +This endpoint is suitable for Kubernetes liveness and readiness probes. It only checks local server conditions and will not fail due to other volume servers being unavailable. + ### Check Volume Server Status ```bash