Debug API "/health" and "/readiness" need more distinction in documentation

[tmm360]

I don't get differences between these two apis in documentation, and they look to be the same.

[acud]

They are not duplicates. The two are used to disambiguate whether the node has started successfully or not. If you'd look into the router endpoint setup, you'll see that the health endpoint gets setup first, and the readiness gets setup later. This is used mainly to ensure k8s allows for the pod to start up for a potentially long period of time, while retaining the correct state of the pod (which is inferred from the readiness endpoint response).

It is true that we can improve the documentation around the endpoints, so you can maybe amend the issue to be something along the lines of /health and /readiness endpoints need better API documentation (or submit the PR).

Thanks!

[github-actions[bot]]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[tmm360]

.