b7e9ae266d
# Which Problems Are Solved - Fixed a typo in docs/docs/apis/observability/health.md where `Enpoints` should be `Endpoints` <!-- # How the Problems Are Solved # Additional Changes # Additional Context --> Co-authored-by: Fabi <[email protected]> Co-authored-by: Livio Spring <[email protected]>
1.1 KiB
title, sidebar_label
| title | sidebar_label |
|---|---|
| ZITADEL Ready and Health Endpoints | Ready and Health Endpoints |
ZITADEL exposes a Ready- and Healthy endpoint to allow external systems like load balancers, orchestration systems, uptime probes and others to check the status.
Ready
The Ready endpoint is located on the path /debug/ready and allows systems to probe if a ZITADEL process is ready to serve and accept traffic.
This endpoint is useful for operations like zero downtime upgrade since it allows systems like Kubernetes to verify that ZITADEL is working on something (e.g. database schema migration) but is not yet ready to accept traffic.
:::info
In Kubernetes this is called the readinessProbe.
:::
Healthy
The Health endpoint is located on the path /debug/healthz and allows systems to probe if a ZITADEL process is still alive.
This helps system like kubernetes or a load balancer to observe if the process is still alive to accept traffic.
:::info
In Kubernetes this is called the livenessProbe.
:::