reference-spring-boot-mvn-jkube

A reference application that is built and unit tested with Maven that can be run through the Ploigos workflows.

Configured to run the following workflows:

• Jenkins
  • minimal
  • typical
  • everything
• Tekton
  • minimal

Tested with:

• Ploigos v0.21.0

Source

This is a copy/paste/fork of jkube/spring-boot-helm maintained specifically do integration testing for Ploigos.

Eclipse JKube Spring Boot with YAML Quickstart

This is a quickstart project to use Eclipse JKube plugin with customized yaml configurations.

Requirements:

• JDK 8 or 11+
• Kubernetes Cluster (Minikube, OpenShift, CRC, etc.)

Helm chart generation

To generate the helm chart with defaults run:

mvn k8s:resource k8s:helm -Pkubernetes

Customize Chart via Maven properties

Helm chart properties can be overridden through command line:

mvn k8s:resource k8s:helm -Pkubernetes -Djkube.helm.chart="Custom Chart Name"  -Djkube.helm.home=https://custom.home

Customize Chart using configuration

Helm chart can also be customized through pom.xml plugin configuration:

<plugin>
    <groupId>org.eclipse.jkube</groupId>
    <artifactId>kubernetes-maven-plugin</artifactId>
    <configuration>
        <helm>
          <chart>Custom chart name</chart>
          <type>kubernetes</type>
          <icon>This is the icon</icon>
          <description>A customized description for the chart</description>
          <sources>
            <source>https://different.source/yaml.yml</source>
          </sources>
          <maintainers>
            <maintainer>
                <name>John</name>
                <email>[email protected]</email>
            </maintainer>
          </maintainers>
        </helm>
    </configuration>
</plugin>

Development environment

This quickstart assumes the scenario where you have a project that will be deployed to production (Outer loop) using Helm charts. For this purpose you would run the previously mentioned goals (k8s:resource k8s:helm) to generate the charts. You might even want to configure your CI pipeline to publish the charts for you (k8s:helm-push)

However, developer might want to use JKube to test and deploy your project to a development environment cluster (Inner loop). For this purpose, the placeholders defined for your Helm variables need to be completed with some values. This showcases the power of JKube, because the same fragments and generated YAMLs can be used for those purposes.

In this example you'll find an additional Maven profile dev that includes the values for those placeholders, so in case you are using this in a development environment, you can also take advantage of JKube.

$ mvn k8s:resource k8s:apply -Pdev -Pkubernetes

How to test

Docker build strategy (default)

With Minikube running, perform the following commands:

$ eval $(minikube docker-env)
$ mvn -Pkubernetes clean package
$ helm install spring-boot-helm target/jkube/helm/spring-boot-helm/kubernetes/
$ minikube service spring-boot-helm

JIB build strategy

With Minikube running, perform the following commands:

$ mvn -Pkubernetes clean package -Djkube.build.strategy=jib
$ eval $(minikube docker-env)
$ docker load -i target/docker/maven/spring-boot-helm/latest/tmp/docker-build.tar
$ helm install spring-boot-helm target/jkube/helm/spring-boot-helm/kubernetes/
$ minikube service spring-boot-helm

OpenShift (S2I build)

With a valid OpenShift cluster, perform the following commands:

$ mvn -Popenshift clean package
$ helm install spring-boot-helm target/jkube/helm/spring-boot-helm/openshift/
$ oc expose svc/spring-boot-helm
$ curl ${route-url}