Skip to content

Commit fa249f4

Browse files
lordofthejarslordofthejars
committed
feat(#6): Adds custom health checks
i# Fix mispelling words
1 parent 65dbb9e commit fa249f4

File tree

5 files changed

+214
-12
lines changed

5 files changed

+214
-12
lines changed

‎buildDocs.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
[[ -d gh-pages ]] && rm -rf gh-pages
44

5-
docker run -it --rm -v `pwd`:/antora antora/antora site.yml --stacktrace
5+
docker run -it --rm -v `pwd`:/antora antora/antora:2.0.0 site.yml --stacktrace

‎dev-site.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ asciidoc:
2424
- ./lib/tab-block.js
2525
ui:
2626
bundle:
27-
url: ../rhd-tutorial-ui/build/ui-bundle.zip
27+
url: https://github.com/redhat-developer-demos/rhd-tutorial-ui/releases/download/v0.0.4/ui-bundle.zip
2828
snapshot: true
2929
supplemental_files: ./supplemental-ui
3030
output:

‎documentation/modules/ROOT/nav.adoc

+11-6
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,17 @@
2626
** xref:04-quarkus-extensions.adoc#qext-intro[What are Extensions ?]
2727
** xref:04-quarkus-extensions.adoc#qext-list-extensions[List Extensions]
2828
** xref:04-quarkus-extensions.adoc#qext-health-checks[Health Checks]
29-
** xref:04-quarkus-extensions.adoc#qext-add-extensions[Add Extensions]
30-
** xref:04-quarkus-extensions.adoc#qext-rebuild-container-images[Rebuild Container Images]
31-
** xref:04-quarkus-extensions.adoc#qext-check-health-endpoint[Check Health Endpoint]
32-
** xref:04-quarkus-extensions.adoc#qext-call-health-ep[Invoke Health Endpoint]
33-
** xref:04-quarkus-extensions.adoc#qext-add-probes-to-k8s[Add Health Probes to Kubernetes Application]
34-
** xref:04-quarkus-extensions.adoc#qext-invoke-k8s-svc[Invoke Service]
29+
*** xref:04-quarkus-extensions.adoc#qext-add-extensions[Add Extension]
30+
*** xref:04-quarkus-extensions.adoc#qext-rebuild-container-images[Rebuild Container Images]
31+
*** xref:04-quarkus-extensions.adoc#qext-check-health-endpoint[Check Health Endpoint]
32+
*** xref:04-quarkus-extensions.adoc#qext-call-health-ep[Invoke Health Endpoint]
33+
*** xref:04-quarkus-extensions.adoc#qext-add-probes-to-k8s[Add Health Probes to Kubernetes Application]
34+
*** xref:04-quarkus-extensions.adoc#qext-invoke-k8s-svc[Invoke Service]
35+
*** xref:04-quarkus-extensions.adoc#qext-custom-health-check[Customizing Health Checks]
36+
*** xref:04-quarkus-extensions.adoc#qext-rebuild-container-images-custom-check[Rebuild Container Images]
37+
*** xref:04-quarkus-extensions.adoc#qext-check-custom-health-endpoint[Check Health Endpoint]
38+
*** xref:04-quarkus-extensions.adoc#qext-call-health-custom[Invoke Health Endpoint]
39+
*** xref:04-quarkus-extensions.adoc#qext-add-custom-probes-to-k8s[Add Health Probes to Kubernetes Application]
3540
3641
* xref:05-quarkus-panache.adoc[5. Hibernate with Quarkus]
3742
** xref:05-quarkus-panache.adoc#quarkusp-demo-overview[Demo Overview]

‎documentation/modules/ROOT/pages/04-quarkus-extensions.adoc

+188-4
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ copyToClipboard::qext-mvn-list-extensions[]
4343

4444
If you had observed, the quarkus application deployed on Kubernetes does not have any health checks on it. As Kubernetes best practice its highly recommended that health checks be added to the all the deployments.
4545

46-
Health checks in Kubernetes can be added using https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/[Liveliness and Readiness] probes.
46+
Health checks in Kubernetes can be added using https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/[Liveness and Readiness] probes.
4747

4848
:quarkus-health-ext-name: quarkus-smallrye-health
4949

5050
[#qext-add-extensions]
51-
=== Adding new extensions
51+
=== Adding Health Check extension
5252

5353
We can add `{quarkus-health-ext-name}` extension to allow Quarkus application to be probed on the REST endpoint called `health` to know about its current health.
5454

@@ -114,7 +114,7 @@ The REST call about should return an response like:
114114
----
115115
116116
[#qext-add-probes-to-k8s]
117-
== Add probes to Kubernetes Quarkus Application
117+
=== Add probes to Kubernetes Quarkus Application
118118
119119
Before we add the probes to the Kubernetes application, we need to push the rebuilt containers to the container registry.
120120
@@ -161,7 +161,7 @@ ifndef::workshop[]
161161
endif::[]
162162
163163
[#qext-invoke-k8s-svc]
164-
== Invoke the Kubernetes Service
164+
=== Invoke the Kubernetes Service
165165
166166
Adding probes will cause the redeployment of the Kubernetes application. Wait for the application to be in `Running` state before you can xref:03-containers-kubernetes.adoc#conk8s-invoke-k8s-svc[Invoke the Service]. The status of the application can be checked with the command:
167167
ifndef::workshop[]
@@ -191,3 +191,187 @@ ifndef::workshop[]
191191
--
192192
====
193193
endif::[]
194+
[#qext-custom-health-check]
195+
=== Customizing Health Checks
196+
197+
So far, you've seen that some a default health check is provided but in most cases, you'd like to customize this logic providing custom logic.
198+
Moreover, Kubernetes provides the concept of liveness and readiness probe to regularly check the health of the application.
199+
200+
liveness:: Checks if the application is up and running.
201+
readiness:: Checks if the application can receive public requests.
202+
203+
Let's create a custom check for both liveness and readiness checks.
204+
Add new Java file in `$PROJECT_HOME/src/main/java/com/example` called `FruitHealthCheck` with the following contents:
205+
206+
[#quarkusp-fruit-checks]
207+
[source,java,subs="+macros,+attributes"]
208+
----
209+
package com.example;
210+
211+
import javax.enterprise.context.ApplicationScoped;
212+
import javax.enterprise.inject.Produces;
213+
214+
import org.eclipse.microprofile.health.HealthCheck;
215+
import org.eclipse.microprofile.health.Liveness;
216+
import org.eclipse.microprofile.health.Readiness;
217+
218+
import io.smallrye.health.HealthStatus;
219+
220+
@ApplicationScoped
221+
public class FruitHealthCheck {
222+
223+
@Produces
224+
@ApplicationScoped
225+
@Liveness
226+
HealthCheck liveCheck() {
227+
return HealthStatus.up("successful-live");
228+
}
229+
230+
@Produces
231+
@ApplicationScoped
232+
@Readiness
233+
HealthCheck readyCheck() {
234+
return HealthStatus.state("successful-read", this::isReady)
235+
}
236+
237+
private boolean isReady() {
238+
return true;
239+
}
240+
}
241+
----
242+
copyToClipboard::quarkusp-fruit-checks[]
243+
244+
[#qext-rebuild-container-images-custom-check]
245+
=== Rebuild container images
246+
247+
Let us rebuild the application after adding the health check extensions
248+
249+
include::ROOT:partial$build-containers.adoc[tag=build]
250+
251+
[#qext-check-custom-health-endpoint]
252+
=== Checking health check endpoint
253+
254+
Lets start the newly built container:
255+
256+
include::ROOT:partial$build-containers.adoc[tag=run]
257+
258+
After adding `smallrye-health` extension we should have REST endpoint called `/health` available. Lets invoke the `/health` endpoint to check the health of the Quarkus application and you'll see both health checks.
259+
260+
[#qext-call-health-custom]
261+
=== Invoke Service
262+
:doc-sec: custom-health
263+
:k8s-cli: k8s
264+
:path: health
265+
:k8s-env: minikube
266+
:cli-tool: curl
267+
:address: localhost
268+
269+
The simple `{path}` REST URI can be called via browser using http://localhost:8080/{path} or using CLI like:
270+
271+
include::ROOT:partial$invoke-service.adoc[tag=call]
272+
273+
The REST call about should return an response like:
274+
275+
[source,json]
276+
----
277+
{
278+
"status": "UP",
279+
"checks": [
280+
{
281+
"name": "successful-live",
282+
"status": "UP"
283+
},
284+
{
285+
"name": "successful-read",
286+
"status": "UP"
287+
}
288+
]
289+
}
290+
----
291+
292+
But also you can invoke them individually by calling `/health/live` and `/health/ready`.
293+
294+
:doc-sec: custom-health-live
295+
:path: health/live
296+
include::ROOT:partial$invoke-service.adoc[tag=call]
297+
298+
The REST call about should return an response like:
299+
300+
[source, json]
301+
----
302+
{
303+
"status": "UP",
304+
"checks": [
305+
{
306+
"name": "successful-live",
307+
"status": "UP"
308+
}
309+
]
310+
}
311+
----
312+
313+
:doc-sec: custom-health-ready
314+
:path: health/ready
315+
include::ROOT:partial$invoke-service.adoc[tag=call]
316+
317+
The REST call about should return an response like:
318+
319+
[source, json]
320+
----
321+
{
322+
"status": "UP",
323+
"checks": [
324+
{
325+
"name": "successful-read",
326+
"status": "UP"
327+
}
328+
]
329+
}
330+
----
331+
332+
[#qext-add-custom-probes-to-k8s]
333+
=== Add probes to Kubernetes Quarkus Application
334+
335+
Before we add the probes to the Kubernetes application, we need to push the rebuilt containers to the container registry.
336+
337+
include::ROOT:partial$build-containers.adoc[tag=tag-push]
338+
339+
Once the rebuilt containers has been successfully pushed to the container registry run the following command to add the probes to the kubernetes deployment.
340+
341+
ifndef::workshop[]
342+
[tabs]
343+
====
344+
kubectl::
345+
+
346+
--
347+
[#qext-copy-k8s-custom-probes-file]
348+
[source,bash,subs="+macros,+attributes"]
349+
----
350+
cp pass:[$TUTORIAL_HOME]/templates/custom-probes.yaml pass:[$TUTORIAL_HOME]/work/{quarkus-project-name}/custom-probes.yaml
351+
----
352+
copyToClipboard::qext-copy-k8s-custom-probes-file[]
353+
354+
Apply the probes to the existing `pass:[$APP_NAME]` Kubernetes deployment:
355+
356+
[#qext-k8s-set-cusotm-probes]
357+
[source,bash,subs="+macros,+attributes"]
358+
----
359+
kubectl patch deployment pass:[$APP_NAME] -p "$(cat pass:[$TUTORIAL_HOME]/work/{quarkus-project-name}/custom-probes.yaml)"
360+
----
361+
copyToClipboard::qext-k8s-set-custom-probes[]
362+
--
363+
oc::
364+
+
365+
--
366+
endif::[]
367+
[#qext-oc-set-custom-probes]
368+
[source,bash,subs="+macros,+attributes"]
369+
----
370+
oc set probe deployment pass:[$APP_NAME] --liveness --get-url=http://:8080/health/live
371+
oc set probe deployment pass:[$APP_NAME] --readiness --get-url=http://:8080/health/ready
372+
----
373+
copyToClipboard::qext-oc-set-custom-probes[]
374+
ifndef::workshop[]
375+
--
376+
====
377+
endif::[]

‎templates/custom-probes.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
spec:
2+
template:
3+
spec:
4+
containers:
5+
- name: quarkus
6+
livenessProbe:
7+
httpGet:
8+
path: /health/live
9+
port: 8080
10+
readinessProbe:
11+
httpGet:
12+
path: /health/ready
13+
port: 8080

0 commit comments

Comments
 (0)