{"id":20381535,"url":"https://github.com/snowdrop/health-check-example","last_synced_at":"2025-07-13T09:33:56.542Z","repository":{"id":41987812,"uuid":"83683008","full_name":"snowdrop/health-check-example","owner":"snowdrop","description":"Quickstart to demonstrate OpenShift health probes working with Spring Boot Actuator","archived":false,"fork":false,"pushed_at":"2024-04-11T15:38:02.000Z","size":1184,"stargazers_count":7,"open_issues_count":4,"forks_count":19,"subscribers_count":5,"default_branch":"sb-2.7.x","last_synced_at":"2025-06-12T01:07:55.826Z","etag":null,"topics":["booster","example","health-check","kubernetes","openshift","rhoar","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snowdrop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-03-02T13:51:10.000Z","updated_at":"2024-03-18T14:32:06.000Z","dependencies_parsed_at":"2023-02-14T07:01:32.787Z","dependency_job_id":"36bf6285-87d6-4ede-b9eb-aca2f52efa9c","html_url":"https://github.com/snowdrop/health-check-example","commit_stats":null,"previous_names":[],"tags_count":278,"template":false,"template_full_name":null,"purl":"pkg:github/snowdrop/health-check-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdrop%2Fhealth-check-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdrop%2Fhealth-check-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdrop%2Fhealth-check-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdrop%2Fhealth-check-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snowdrop","download_url":"https://codeload.github.com/snowdrop/health-check-example/tar.gz/refs/heads/sb-2.7.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdrop%2Fhealth-check-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265120114,"owners_count":23714488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["booster","example","health-check","kubernetes","openshift","rhoar","spring-boot"],"created_at":"2024-11-15T02:14:13.581Z","updated_at":"2025-07-13T09:33:56.526Z","avatar_url":"https://github.com/snowdrop.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Health Check Spring Boot Example\n\nhttps://appdev.openshift.io/docs/spring-boot-runtime.html#mission-health-check-spring-boot\n\n## Table of Contents\n\n* [Health Check Spring Boot Example](#health-check-spring-boot-example)\n    * [Prerequisites](#prerequisites)\n    * [Deploying application on OpenShift using Dekorate](#deploying-application-on-openshift-using-dekorate)\n    * [Deploying application on OpenShift using Helm](#deploying-application-on-openshift-using-helm)\n    * [Deploying application on Kubernetes using Helm](#deploying-application-on-kubernetes-using-helm)\n    * [Running Tests on OpenShift using Dekorate](#running-tests-on-openshift-using-dekorate)\n    * [Running Tests on OpenShift using S2i from Source](#running-tests-on-openshift-using-s2i-from-source)\n    * [Running Tests on OpenShift using Helm](#running-tests-on-openshift-using-helm)\n    * [Running Tests on Kubernetes with Helm](#running-tests-on-kubernetes-using-helm)\n\n## Prerequisites\n\n- JDK 11+ installed with JAVA_HOME configured appropriately\n\n## Deploying application on OpenShift using Dekorate\n\n```\nmvn clean verify -Popenshift -Ddekorate.deploy=true\n```\n\n## Deploying application on OpenShift using Helm\n\nFirst, make sure you have installed [the Helm command line](https://helm.sh/docs/intro/install/) and connected/logged to a kubernetes cluster.\n\nThen, you need to install the example by doing:\n\n```\nhelm 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=\u003cbranch-to-use\u003e\n```\n\n**note**: Replace `\u003cbranch-to-use\u003e` with one branch from `https://github.com/snowdrop/health-check-example/branches/all`.\n\nAnd to uninstall the chart, execute:\n\n```\nhelm uninstall healthcheck\n```\n\n## Deploying application on Kubernetes using Helm\n\nRequirements:\n- Have installed [the Helm command line](https://helm.sh/docs/intro/install/)\n- Have connected/logged to a kubernetes cluster\n\nYou need to install the example by doing:\n\n```\nhelm install healthcheck ./helm --set app.ingress.host=\u003cyour k8s domain\u003e\n```\n\nAnd to uninstall the chart, execute:\n\n```\nhelm uninstall healthcheck\n```\n\n\n## Running Tests on OpenShift using Dekorate\n\n```bash\n./run_tests_with_dekorate_in_ocp.sh\n```\n\nAlternativelly, tests can be executed against a specific Spring Boot or Dekorate version by passing the\nversion as a `-D\u003cvariable property name\u003e=value` parameter. For instance overriding both the Spring Boot and the Dekorate versions using their corresponding version properties is done the following way:\n\n```bash\n./run_tests_with_dekorate_in_ocp.sh -Dspring-boot.version=2.7.3 -Ddekorate.version=2.11.1\n```\n\n\n## Running Tests on OpenShift using S2i from Source\n\n```bash\n./run_tests_with_s2i.sh\n```\n\nThis script can take up to 3 parameters which are:\n\n* `--repository-url`: repository to use to source the images from\n* `--branch-to-test`: branch to use to source the images from\n* `--maven-settings`: custom maven settings file\n\n```bash\n./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\"\n```\n\n## Running Tests on OpenShift using Helm\n\n```\n./run_tests_with_helm.sh\n```\n\nThis script can take 2 parameters referring to the repository and the branch to use to source the images from.\n\n```bash\n./run_tests_with_helm_in_ocp.sh \"https://github.com/snowdrop/health-check-example\" branch-to-test\n```\n\n## Running Tests on Kubernetes using Helm\n\nFirst, you need to create the k8s namespace:\n\n```\nkubectl create namespace \u003cthe k8s namespace\u003e\n```\n\nThen, run the tests by specifying the container registry and the kubernetes namespace:\n```\n./run_tests_with_helm_in_k8s.sh \u003cyour container registry: for example \"quay.io/user\"\u003e \u003cthe k8s namespace\u003e\n```\n\nFor example:\n\n```\n./run_tests_with_helm_in_k8s.sh \"quay.io/user\" \"myNamespace\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdrop%2Fhealth-check-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnowdrop%2Fhealth-check-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdrop%2Fhealth-check-example/lists"}