Kubernetes Probes

Self-hosting Check Point AI Guardrails can be deployed to Kubernetes. For that purpose, we implemented several endpoints to serve as liveness, readiness and startup probes.

For detailed Kubernetes deployment instructions, see Self-hosting AI Guardrails.

Startup

Use /startupz to implement a startup probe for your K8s deployment. It is recommended to implement the startup probe if you are implementing readiness and/or liveness. That is because the latter ones require gunicorn workers to start.

Example usage:

1
startupProbe:
2
    httpGet:
3
        path: /startupz
4
        port: 8000
5
    periodSeconds: 10
6
    failureThreshold: 30

Readiness

Use /readyz to implement a readiness probe for your K8s deployment. If you are implementing both readiness and liveness probes, it is recommended to have a higher failureThreshold value for the latter one.

Example usage:

1
readinessProbe:
2
    httpGet:
3
        path: /readyz
4
        port: 8000
5
    periodSeconds: 5
6
    failureThreshold: 1

Liveness

Use /livez to implement a liveness probe for your K8s deployment. If you are implementing both readiness and liveness probes, it is recommended to have a higher failureThreshold value for the latter one.

Example usage:

1
livenessProbe:
2
    httpGet:
3
        path: /livez
4
        port: 8000
5
    periodSeconds: 5
6
    failureThreshold: 3