Quickstart MP

This guide describes a basic example of an Helidon MP application using Docker and Kubernetes.

What you need

About 5 minutes
Helidon Prerequisites

Generate The Project

Generate the project sources using one (or both) of the Helidon Maven archetypes. The result is a simple project that shows the basics of configuring the WebServer and implementing basic routing rules.

Run the Maven archetype
mvn archetype:generate -DinteractiveMode=false \
    -DarchetypeGroupId=io.helidon.archetypes \
    -DarchetypeArtifactId=helidon-quickstart-mp \
    -DarchetypeVersion=1.4.12 \
    -DgroupId=io.helidon.examples \
    -DartifactId=helidon-quickstart-mp \
    -Dpackage=io.helidon.examples.quickstart.mp
Copied

The archetype generates a Maven project in your current directory (for example, helidon-quickstart-mp). Change into this directory.

cd helidon-quickstart-mp
Copied

If you want to use the generated project as a starter for your own application, then you can replace groupId, artifactId and package with values appropriate for your application.

Build the Application
mvn package
Copied

The project builds an application jar for the example and saves all runtime dependencies in the target/libs directory. This means you can easily start the application by running the application jar file:

Run the application
java -jar target/helidon-quickstart-mp.jar
Copied

The example is a very simple "Hello World" greeting service. It supports GET requests for generating a greeting message, and a PUT request for changing the greeting itself. The response is encoded using JSON. For example:

Try the Application
curl -X GET http://localhost:8080/greet
{"message":"Hello World!"}

curl -X GET http://localhost:8080/greet/Joe
{"message":"Hello Joe!"}

curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting

curl -X GET http://localhost:8080/greet/Jose
{"message":"Hola Jose!"}
Copied

Health and Metrics

Helidon provides built-in support for health and metrics endpoints.

Health
curl -s -X GET http://localhost:8080/health
Copied
Metrics in Prometheus Format
curl -s -X GET http://localhost:8080/metrics
Copied
Metrics in JSON Format
curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics
Copied

Build a Docker Image

The project also contains a Dockerfile so that you can easily build and run a Docker image. To build the Docker image, you need to have Docker installed and running on your system.

Docker build
docker build -t helidon-quickstart-mp .
Copied
Run Docker Image
docker run --rm -p 8080:8080 helidon-quickstart-mp:latest
Copied

Then you can try the application as you did before.

Deploy the application to Kubernetes

If you don’t have access to a Kubernetes cluster, you can install one on your desktop. Then deploy the example:

Verify connectivity to cluster
kubectl cluster-info
kubectl get nodes
Copied
Deploy the application to Kubernetes
kubectl create -f app.yaml
kubectl get pods                    # Wait for quickstart pod to be RUNNING
Copied

The step above created a service that is exposed into any node port. Lookup the service to find the port.

Lookup the service
kubectl get service helidon-quickstart-mp
Copied

Note the PORTs. You can now exercise the application as you did before but use the second port number (the NodePort) instead of 8080. For example:

curl -X GET http://localhost:31431/greet
Copied

After you’re done, cleanup.

Remove the application from Kubernetes
kubectl delete -f app.yaml
Copied