Python package of reusable middleware for Django apps.
The django-middleware package is hosted as a private repository on GitHub, so a machine-user token will be necessary to import it with pip. Pinning this requirement from a release archive is recommended.
Allow Kubernetes liveness, readiness, and startup probes to make test your Django server container with healthz/ and readiness/ endpoints.
Add HealthCheckMiddleware to the Django settings module as early as is feasible, and especially before middleware that would access the databases (and cause an unpleasant server error).
MIDDLEWARE = (
"django_middleware.healthchecks.HealthCheckMiddleware",
# ...other middleware go after HealthCheckMiddleware...
)For more details on the available properties and proper use of status probes, see:
Example usage:
startupProbe:
# Protect pods from restarts until they can initialize.
# This should use the same command as livenessProbe.
httpGet:
path: /healthz
port: 8000
failureThreshold: 30
periodSeconds: 10
livenessProbe:
# Detect broken pods and restart them.
httpGet:
path: /healthz
port: 8000
initialDelaySeconds: 10
failureThreshold: 2
periodSeconds: 15
readinessProbe:
# Detect when pods are able to receive requests/connections.
httpGet:
path: /readiness
port: 8000
initialDelaySeconds: 10
failureThreshold: 2
periodSeconds: 10