Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/snowdrop/rest-http-example

Quickstart to expose a REST Greeting endpoint using SpringBoot and Apache Tomcat in embedded mode
https://github.com/snowdrop/rest-http-example

booster example kubernetes openshift rest rhoar spring-boot

Last synced: about 1 month ago
JSON representation

Quickstart to expose a REST Greeting endpoint using SpringBoot and Apache Tomcat in embedded mode

Awesome Lists containing this project

README

        

# REST HTTP Spring Boot Example

https://appdev.openshift.io/docs/spring-boot-runtime.html#mission-http-api-spring-boot

## Table of Contents

* [REST HTTP Spring Boot Example](#rest-http-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 External Registry](#running-tests-on-kubernetes-with-external-registry)
* [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 rest-http ./helm --set app.route.expose=true --set app.s2i.source.repo=https://github.com/snowdrop/rest-http-example --set app.s2i.source.ref=
```

**note**: Replace `` with one branch from `https://github.com/snowdrop/rest-http-example/branches/all`.

And to uninstall the chart, execute:

```
helm uninstall rest-http
```

## 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 rest-http ./helm --set app.ingress.host=
```

And to uninstall the chart, execute:

```
helm uninstall rest-http
```

## 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=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

```
./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/rest-http-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_in_ocp.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/rest-http-example" branch-to-test
```

## Running Tests on Kubernetes with External Registry

```
mvn clean verify -Pkubernetes,kubernetes-it -Ddekorate.docker.registry= -Ddekorate.push=true
```

## 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"
```