libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Update health.adoc to link to the Quarkus SmallRye Health docs (#22324)

Browse source
This commit is contained in:
Steve Mokris 2023-08-25 12:48:52 -04:00 committed by GitHub
parent 062c0f75f8
commit b776746455
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/guides/server/health.adoc
View file

@ -10,15 +10,20 @@ includedOptions="health-enabled">
Keycloak has built in support for health checks. This {section} describes how to enable and use the Keycloak health checks. Keycloak has built in support for health checks. This {section} describes how to enable and use the Keycloak health checks.
== Keycloak Health checks == Keycloak health check endpoints
Keycloak exposed health endpoints are three: Keycloak exposes 4 health endpoints:
* `/health`
* `/health/live` * `/health/live`
* `/health/ready` * `/health/ready`
* `/health/started`
* `/health`
The result is returned in json format and it looks as follows: See the https://quarkus.io/guides/smallrye-health#running-the-health-check[Quarkus SmallRye Health docs] for information on the meaning of each endpoint.
These endpoints respond with HTTP status `200 OK` on success or `503 Service Unavailable` on failure, and a JSON object like the following:
.Successful response for endpoints without additional per-check information:
[source, json] [source, json]
---- ----
{ {
@ -27,6 +32,20 @@ The result is returned in json format and it looks as follows:
} }
---- ----
.Successful response for endpoints with information on the database connection:
[source, json]
----
{
"status": "UP",
"checks": [
{
"name": "Keycloak database connections health check",
"status": "UP"
}
]
}
----
== Enabling the health checks == Enabling the health checks
It is possible to enable the health checks using the build time option `health-enabled`: It is possible to enable the health checks using the build time option `health-enabled`: