How to implement a functional health endpoint with the weblate docker image?

[FSeidinger-XI]

Hey community,

we are running Weblate in a kubernetes environment where Redis and Postgres are external dependencies that are managed by a platform team. It can happen several times in a week that the Redis and Postgres services are restarted, upgraded or reconfigured.

Currently the weblate docker image has no good means to react to this changes. This is due to the fact that the healthz endpoint stays Ok no matter what the internal state of the application is. The platform would restart the pod when the healthz endpoint would indicate that the app is not functional anymore.

The user experience is currently bad here, because they see just an internal server error, if they access the weblate app, but no hint why. And our app stays in this state endlessly until we restart it manually.

Is there any way of refining or substituting the health endpoint if needed dependencies are not working anymore?

Especially the redis is a problem for us, because the platform team provides redis in a sentinel configuration. We have altered the entrypoint to discover the redis master through the sentinel protocol and set it as environment variables for weblate before starting.

Furthermore our platform supports a readiness endpoint. If a pod is healthy but not ready, the user will see a side that indicates that weblate cannot be used currently. The page is done through a redirect by some ISTIO rules. Is it possible to also implement a readiness endpoint for kubernetes?

Kind regards,
Frank

[nijel]

Presently the healthz endpoint only verifies that the wsgi is running, nothing more. It could certainly be extended to cover more things (such as cache and database connections).

[FSeidinger-XI]

Hi Michal,

I already checked the implementation. My question would be, if I can override or extend the implementation in a way that it can be easily injected into the docker image.

[nijel]

We can change the implementation; I think it makes sense to cover more aspects there. Please describe what you think it should check in https://github.com/WeblateOrg/weblate/issues/new?template=feature_request.yml