Uploaded image for project: 'Keycloak'
  1. Keycloak
  2. KEYCLOAK-12398

Implement Healthcheck Endpoint

    XMLWordPrintable

Details

    • Healthcheck
    • NEW
    • NEW

    Description

      Motivation

      Currently, Keycloak Server doesn't provide a Healthcheck Endpoint, which could be used by Kubernetes. Instead, we use custom CLI or HTTP calls against the Management URI and check multiple things manually. The ultimate solution is to provide this kind of functionality directly in the Keycloak Server.

      Design

      https://github.com/keycloak/keycloak-community/pull/55

      Risks/Limitations

      The implementation should be reviewed by the Integreately Team.

      Rough Estimate

      1 sprint for 1 person for the Server implementation
      1 week for 1 person for Keycloak Container and Keycloak Operator

      Open Questions

      None.

      Attachments

        Issue Links

          is blocked by

          Enhancement - An enhancement or refactoring of existing functionality KEYCLOAK-12399 Keycloak container should crash on unrecoverable error

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          is duplicated by

          Task - A task that needs to be done. KEYCLOAK-13646 Reimplement Readiness and Liveness Probes in Keycloak Operator

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          is related to

          Feature Request - Feature requests from customers and/or users WFLY-13931 Allow defining HealthChecks without CDI

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. KEYCLOAK-13244 Readiness check failing for longer than needed during external DB downtime

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          relates to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. KEYCLOAK-8288 Observability

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Plan

          Task - A task that needs to be done. KEYCLOAK-13703 Multiple errors: readiness and shutdown checks

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          links to

          Web Link Github issue

          Web Link What to avoid in readiness/liveness probes?

          Activity

            Public project attachment banner

              context keys: [headless, issue, helper, isAsynchronousRequest, project, action, user]
              current Project key: KEYCLOAK

              People

                slaskawi@redhat.com Sebastian Łaskawiec
                slaskawi@redhat.com Sebastian Łaskawiec
                Votes:
                4 Vote for this issue
                Watchers:
                14 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: