Health Check
Overview#
Health checks are used to determine if a container is working as it should or not. This is done in Kubernetes using probes.
Jans deployed components uses two types of probes:
-
Readiness probes: used to know when a container is ready to start accepting traffic
-
Liveness probes: used to know when to restart a container
Jans Liveness and Readiness probes#
Here is a list of the liveness and readiness probes of the deployed jans components
auth-server#
Auth-sever executes the python3 healthcheck.py in liveness and readiness probes. This python scripts parses the healthcheck endpoint to make sure the status is up.
livenessProbe:
# Executes the python3 healthcheck.
exec:
command:
- python3
- /app/scripts/healthcheck.py
# Configure the liveness healthcheck for the auth-server if needed.
initialDelaySeconds: 30
periodSeconds: 30
timeoutSeconds: 5
readinessProbe:
# Executes the python3 healthcheck.
exec:
command:
- python3
- /app/scripts/healthcheck.py
# Configure the readiness healthcheck for the auth-server if needed.
initialDelaySeconds: 25
periodSeconds: 25
timeoutSeconds: 5
config-api#
The health check of liveness and readiness probes is a HTTP GET request against a config-api endpoint
livenessProbe:
# http liveness probe endpoint
httpGet:
path: /jans-config-api/api/v1/health/live
port: 8074
# Configure the liveness healthcheck for the config-api if needed.
initialDelaySeconds: 30
periodSeconds: 30
timeoutSeconds: 5
readinessProbe:
# http readiness probe endpoint
httpGet:
path: jans-config-api/api/v1/health/ready
port: 8074
# Configure the readiness healthcheck for the config-api if needed.
initialDelaySeconds: 25
periodSeconds: 25
timeoutSeconds: 5
fido2#
The health check of liveness and readiness probes is a HTTP GET request against a fido2 endpoint
livenessProbe:
# http liveness probe endpoint
httpGet:
path: /jans-fido2/sys/health-check
port: http-fido2
# Configure the liveness healthcheck for the fido2 if needed.
initialDelaySeconds: 25
periodSeconds: 25
timeoutSeconds: 5
readinessProbe:
# http readiness probe endpoint
httpGet:
path: /jans-fido2/sys/health-check
port: http-fido2
# Configure the readiness healthcheck for the fido2 if needed.
initialDelaySeconds: 30
periodSeconds: 30
timeoutSeconds: 5
scim#
The health check of liveness and readiness probes is a HTTP GET request against a scim endpoint
livenessProbe:
httpGet:
# http liveness probe endpoint
path: /jans-scim/sys/health-check
port: 8080
# Configure the liveness healthcheck for the SCIM if needed.
initialDelaySeconds: 30
periodSeconds: 30
timeoutSeconds: 5
readinessProbe:
httpGet:
# http readiness probe endpoint
path: /jans-scim/sys/health-check
port: 8080
# Configure the readiness healthcheck for the SCIM if needed.
initialDelaySeconds: 25
periodSeconds: 25
timeoutSeconds: 5
Created: 2 years ago2022-07-21