Health Check Spring Boot Example

https://appdev.openshift.io/docs/spring-boot-runtime.html#mission-health-check-spring-boot

Table of Contents

• Health Check Spring Boot Example
  • Prerequisites
  • Deploying application on OpenShift using Dekorate
  • Deploying application on OpenShift using Helm
  • Deploying application on Kubernetes using Helm
  • Running Tests on OpenShift using Dekorate
  • Running Tests on OpenShift using S2i from Source
  • Running Tests on OpenShift using Helm
  • Running Tests on Kubernetes with Helm

Prerequisites

• JDK 11+ installed with JAVA_HOME configured appropriately

Deploying application on OpenShift using Dekorate

mvn clean verify -Popenshift -Ddekorate.deploy=true

Deploying application on OpenShift using Helm

First, make sure you have installed the Helm command line and connected/logged to a kubernetes cluster.

Then, you need to install the example by doing:

helm install healthcheck ./helm --set app.route.expose=true --set app.s2i.source.repo=https://github.com/snowdrop/health-check-example --set app.s2i.source.ref=<branch-to-use>

note: Replace <branch-to-use> with one branch from https://github.com/snowdrop/health-check-example/branches/all.

And to uninstall the chart, execute:

helm uninstall healthcheck

Deploying application on Kubernetes using Helm

Requirements:

• Have installed the Helm command line
• Have connected/logged to a kubernetes cluster

You need to install the example by doing:

helm install healthcheck ./helm --set app.ingress.host=<your k8s domain>

And to uninstall the chart, execute:

helm uninstall healthcheck

Running Tests on OpenShift using Dekorate

./run_tests_with_dekorate_in_ocp.sh

Alternativelly, tests can be executed against a specific Spring Boot or Dekorate version by passing the version as a -D<variable property name>=value parameter. For instance overriding both the Spring Boot and the Dekorate versions using their corresponding version properties is done the following way:

./run_tests_with_dekorate_in_ocp.sh -Dspring-boot.version=2.7.3 -Ddekorate.version=2.11.1

Running Tests on OpenShift using S2i from Source

./run_tests_with_s2i.sh

This script can take up to 3 parameters which are:

• --repository-url: repository to use to source the images from
• --branch-to-test: branch to use to source the images from
• --maven-settings: custom maven settings file

./run_tests_with_s2i.sh --repository-url "https://github.com/snowdrop/health-check-example" --branch-to-test branch-to-test --maven-settings "${HOME}/.m2/my-custom-maven-settings.xml"

Running Tests on OpenShift using Helm

./run_tests_with_helm.sh

This script can take 2 parameters referring to the repository and the branch to use to source the images from.

./run_tests_with_helm_in_ocp.sh "https://github.com/snowdrop/health-check-example" branch-to-test

Running Tests on Kubernetes using Helm

First, you need to create the k8s namespace:

kubectl create namespace <the k8s namespace>

Then, run the tests by specifying the container registry and the kubernetes namespace:

./run_tests_with_helm_in_k8s.sh <your container registry: for example "quay.io/user"> <the k8s namespace>

For example:

./run_tests_with_helm_in_k8s.sh "quay.io/user" "myNamespace"