mirror of
https://github.com/minio/minio.git
synced 2024-12-26 23:25:54 -05:00
abffa00b76
- Add head method for healthcheck endpoint. Some platforms/users may use the HTTP Head method to check for health status. - Add liveness and readiness probe examples in Kubernetes yaml example docs. Note that readiness probe not added to StatefulSet example due to https://github.com/kubernetes/kubernetes/issues/27114
24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
## Minio Healthcheck
|
|
|
|
Minio server exposes two un-authenticated, healthcheck endpoints - liveness probe and readiness probe at `/minio/health/live` and `/minio/health/ready` respectively.
|
|
|
|
### Liveness probe
|
|
|
|
This probe is used to identify situations where the server is running but may not behave optimally, i.e. sluggish response or corrupt backend. Such problems can be *only* fixed by a restart.
|
|
|
|
Internally, Minio liveness probe handler does a ListBuckets call. If successful, the server returns 200 OK, otherwise 503 Service Unavailable.
|
|
|
|
When liveness probe fails, Kubernetes like platforms restart the container.
|
|
|
|
### Readiness probe
|
|
|
|
This probe is used to identify situations where the server is not ready to accept requests yet. In most cases, such conditions recover in some time.
|
|
|
|
Internally, Minio readiness probe handler checks for total go-routines. If the number of go-routines is less than 1000 (threshold), the server returns 200 OK, otherwise 503 Service Unavailable.
|
|
|
|
Platforms like Kubernetes *do not* forward traffic to a pod until its readiness probe is successful.
|
|
|
|
### Configuration example
|
|
|
|
Sample `liveness` and `readiness` probe configuration in a Kubernetes `yaml` file can be found [here](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml).
|