Health check endpoint usage

Airlock IAM provides health check HTTP endpoints that can be used to check if IAM is running (liveness) or ready to process requests (readiness).

Usage of health checks in Kubernetes

The following code block is an example of a health check for Kubernetes:

Example

env: 
  - name: IAM_HEALTH_ADDRESS 
    value: .* 
livenessProbe: 
  httpGet: 
    path: /health/live 
    port: 8443 
    scheme: HTTPS 
  initialDelaySeconds: 120 
readinessProbe: 
  httpGet: 
    path: /health/ready 
    port: 8443 
    scheme: HTTPS 
  initialDelaySeconds: 120

Usage of health checks with Docker Compose

The following code block is an example of a health check for Docker Compose:

Example

healthcheck: 
  test: "curl -fksS 'https://localhost:8443/health/live' || exit 1"

Usage of health checks in a dockerfile

The following code block is an example of a health check for dockerfile:

Example

HEALTHCHECK CMD curl -fksS 'https://localhost:8443/health/live' || exit 1

Usage of health checks for Loginapp with Airlock Gateway

See Configure health checks for Loginapp for examples of IAM health checks using Airlock Gateway.