Make a Health Check Configurable

[chloesoe]

Context

As an operator of Keycloak I want to have an endpoint, which I could query with our monitoring to see, whether keycloak is up and running.
Integrate a possibility for a health check.
E.g. something like discussed in https://issues.redhat.com/browse/KEYCLOAK-1578?_sscc=t and implemented in https://github.com/thomasdarimont/keycloak-health-checks.

Alternatives

For monitoring we can use a simple http check, to see whether keycloak is up and running.

[ccremer]

The Helm chart configures a liveness check to /auth and a readiness check to /auth/realms/master. Is checking for status code 200-399 not enough for your use case?

[megian]

Recently the livenessProbe (/auth)/health/live, readinessProbe (/auth)/health/ready, startupProbe (/auth)/health have been changed in #177. So we use the foreseen endpoints of Keycloak Quarkus for that purpose:

• /health
• /health/live
• /health/ready
• /metrics

@chloesoe Any objections to close this as it currently uses the official way to monitor Keycloak?

[megian]

@chloesoe As an addition you can always override the path via the helm variables:

parameters:
  keycloak:
    helm_values:
      livenessProbe: |
        httpGet:
          path: '/health/live'
          port: https
          scheme: HTTPS
        initialDelaySeconds: 0
        timeoutSeconds: 5
      readinessProbe: |
        httpGet:
          path: '/health/ready'
          port: https
          scheme: HTTPS
        initialDelaySeconds: 10
        timeoutSeconds: 1
      startupProbe: |
        httpGet:
          path: '/health'
          port: https
          scheme: HTTPS
        initialDelaySeconds: 15
        timeoutSeconds: 1
        failureThreshold: 60
        periodSeconds: 5