remove deprecate readiness from healthcheck docs (#10659)

This commit is contained in:
Harshavardhana 2020-10-12 18:56:03 -07:00 committed by GitHub
parent 614060764d
commit 9c042a503b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 18 deletions

View File

@ -179,18 +179,19 @@ KEY:
api manage global HTTP API call specific features, such as throttling, authentication types, etc. api manage global HTTP API call specific features, such as throttling, authentication types, etc.
ARGS: ARGS:
requests_max (number) set the maximum number of concurrent requests, e.g. "1600" requests_max (number) set the maximum number of concurrent requests, e.g. "1600"
requests_deadline (duration) set the deadline for API requests waiting to be processed e.g. "1m" requests_deadline (duration) set the deadline for API requests waiting to be processed e.g. "1m"
ready_deadline (duration) set the deadline for health check API /minio/health/ready e.g. "1m" cors_allow_origin (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com"
cors_allow_origin (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com" remote_transport_deadline (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h"
``` ```
or environment variables or environment variables
``` ```
MINIO_API_REQUESTS_MAX (number) set the maximum number of concurrent requests, e.g. "1600" MINIO_API_REQUESTS_MAX (number) set the maximum number of concurrent requests, e.g. "1600"
MINIO_API_REQUESTS_DEADLINE (duration) set the deadline for API requests waiting to be processed e.g. "1m" MINIO_API_REQUESTS_DEADLINE (duration) set the deadline for API requests waiting to be processed e.g. "1m"
MINIO_API_CORS_ALLOW_ORIGIN (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com" MINIO_API_CORS_ALLOW_ORIGIN (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com"
MINIO_API_REMOTE_TRANSPORT_DEADLINE (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h"
``` ```
#### Notifications #### Notifications

View File

@ -1,22 +1,22 @@
## MinIO Healthcheck ## MinIO Healthcheck
MinIO server exposes three un-authenticated, healthcheck endpoints liveness probe and a cluster probe at `/minio/health/live`, `/minio/health/ready` and `/minio/health/cluster` respectively. MinIO server exposes three un-authenticated, healthcheck endpoints liveness probe and a cluster probe at `/minio/health/live` and `/minio/health/cluster` respectively.
### Liveness probe ### Liveness probe
This probe always responds with '200 OK'. When liveness probe fails, Kubernetes like platforms restart the container. This probe always responds with '200 OK'. When liveness probe fails, Kubernetes like platforms restart the container.
``` ```
livenessProbe: livenessProbe:
httpGet: httpGet:
path: /minio/health/live path: /minio/health/live
port: 9000 port: 9000
scheme: HTTP scheme: HTTP
initialDelaySeconds: 120 initialDelaySeconds: 120
periodSeconds: 15 periodSeconds: 15
timeoutSeconds: 10 timeoutSeconds: 10
successThreshold: 1 successThreshold: 1
failureThreshold: 3 failureThreshold: 3
``` ```
### Cluster probe ### Cluster probe