strelok89 commented on code in PR #3832:
URL: https://github.com/apache/celeborn/pull/3832#discussion_r3944627958
##########
docs/restapi.md:
##########
@@ -34,6 +34,38 @@ The configuration of `<master-http-host>`,
`<master-http-port>`, `<worker-http-h
| celeborn.worker.http.host | 0.0.0.0 | Worker's http host. | 0.4.0 |
| celeborn.worker.http.port | 9096 | Worker's http port. | 0.4.0 |
+### Health Check API (Since 1.0.0)
+
+Both master and worker serve a health check endpoint at `/health`, intended to
back a Kubernetes
+readiness probe. It responds `200` when the service is able to serve and `503`
when it is not,
+so that it can be consumed with a plain `httpGet` probe.
+
+| Path | Method | Meaning
|
+|-----------|--------|-----------------------------------------------------------------------------------|
+| `/health` | GET | Whether the service is able to serve. Returns `200`
when healthy, `503` when not. |
Review Comment:
Renamed to `/healthz`. Updated the JAX-RS path, the auth bypass set, the
docs and the three test suites — behaviour is unchanged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
