https://github.com/snowdrop/health-check-example

Quickstart to demonstrate OpenShift health probes working with Spring Boot Actuator
https://github.com/snowdrop/health-check-example

booster example health-check kubernetes openshift rhoar spring-boot

Last synced: 3 months ago
JSON representation

Quickstart to demonstrate OpenShift health probes working with Spring Boot Actuator

• Host: GitHub
• URL: https://github.com/snowdrop/health-check-example
• Owner: snowdrop
• License: apache-2.0
• Created: 2017-03-02T13:51:10.000Z (almost 8 years ago)
• Default Branch: sb-2.7.x
• Last Pushed: 2024-04-11T15:38:02.000Z (10 months ago)
• Last Synced: 2024-04-17T09:33:09.075Z (10 months ago)
• Topics: booster, example, health-check, kubernetes, openshift, rhoar, spring-boot
• Language: Java
• Homepage:
• Size: 1.13 MB
• Stars: 7
• Watchers: 6
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](#health-check-spring-boot-example)

    * [Prerequisites](#prerequisites)

    * [Deploying application on OpenShift using Dekorate](#deploying-application-on-openshift-using-dekorate)

    * [Deploying application on OpenShift using Helm](#deploying-application-on-openshift-using-helm)

    * [Deploying application on Kubernetes using Helm](#deploying-application-on-kubernetes-using-helm)

    * [Running Tests on OpenShift using Dekorate](#running-tests-on-openshift-using-dekorate)

    * [Running Tests on OpenShift using S2i from Source](#running-tests-on-openshift-using-s2i-from-source)

    * [Running Tests on OpenShift using Helm](#running-tests-on-openshift-using-helm)

    * [Running Tests on Kubernetes with Helm](#running-tests-on-kubernetes-using-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](https://helm.sh/docs/intro/install/) 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=

```

**note**: Replace `` 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](https://helm.sh/docs/intro/install/)

- Have connected/logged to a kubernetes cluster

You need to install the example by doing:

```

helm install healthcheck ./helm --set app.ingress.host=

```

And to uninstall the chart, execute:

```

helm uninstall healthcheck

```

## Running Tests on OpenShift using Dekorate

```bash

./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=value` parameter. For instance overriding both the Spring Boot and the Dekorate versions using their corresponding version properties is done the following way:

```bash

./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

```bash

./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

```bash

./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.

```bash

./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 

```

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

```

./run_tests_with_helm_in_k8s.sh  

```

For example:

```

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

```