Using Kubernetes ConfigMaps to define your Quarkus application’s properties

Using Kubernetes ConfigMaps to define your Quarkus application’s properties - Printable Version

+- Sick Gaming (https://sickgaming.net)
+-- Forum: Programming (https://sickgaming.net/forum-76.html)
+--- Forum: Java & JVM Languages (https://sickgaming.net/forum-78.html)
+--- Thread: Using Kubernetes ConfigMaps to define your Quarkus application’s properties (/thread-95593.html)

Using Kubernetes ConfigMaps to define your Quarkus application’s properties - xSicKxBot - 06-09-2020

Using Kubernetes ConfigMaps to define your Quarkus application’s properties

So, you wrote your Quarkus application, and now you want to deploy it to a Kubernetes cluster. Good news: Deploying a Quarkus application to a Kubernetes cluster is easy. Before you do this, though, you need to straighten out your application’s properties. After all, your app probably has to connect with a database, call other services, and so on. These settings are already defined in your

Code:
application.properties

file, but the values match the ones for your local environment and won’t work once deployed onto your cluster.

So, how do you easily solve this problem? Let’s walk through an example.

Create the example Quarkus application

Instead of using a complex example, let’s take a simple use case that explains the concept well. Start by creating a new Quarkus app:

Code:
$ mvn io.quarkus:quarkus-maven-plugin:1.1.1.Final:create

You can keep all of the default values while creating the new application. In this example, the application is named

Code:
hello-app

. Now, open the

Code:
HelloResource.java

file and refactor it to look like this:

Code:
@Path("/hello") public class HelloResource { @ConfigProperty(name = "greeting.message") String message; @GET @Produces(MediaType.TEXT_PLAIN) public String hello() { return "hello " + message; } }

In your

Code:
application.properties

file, now add

Code:
greeting.message=localhost

. The

Code:
@ConfigProperty

annotation is not in the scope of this article, but here we can see how easy it is to inject properties inside our code using this annotation.

Now, let’s start our application to see if it works as expected:

Code:
$ mvn compile quarkus:dev

Browse to

Code:
http://localhost:8080/hello

, which should output

Code:
hello localhost

. That’s it for the Quarkus app. It’s ready to go.

Deploy the application to the Kubernetes cluster

The idea here is to deploy this application to our Kubernetes cluster and replace the value of our

Code:
greeting

property with one that will work on the cluster. It is important to know here that all of the properties from

Code:
application.properties

are exposed, and thus can be overridden with environment variables. The convention is to convert the name of the property to uppercase and replace every dot (

Code:
.

) with an underscore (

Code:
_

). So, for instance, our

Code:
greeting.message

will become

Code:
GREETING_MESSAGE

.

At this point, we are almost ready to deploy our app to Kubernetes, but we need to do three more things:

Create a Docker image of your application and push it to a repository that your cluster can access.
Define a ConfgMap resource.
Generate the Kubernetes resources for our application.

To create the Docker image, simply execute this command:

Code:
$ docker build -f src/main/docker/Dockerfile.jvm -t quarkus/hello-app .

Be sure to set the right Docker username and to also push to an image registry, like

Code:
docker-hub

Code:
quay

. If you are not able to push an image, you can use

Code:
sebi2706/hello-app:latest

.

Next, create the file

Code:
config-hello.yml

Code:
apiVersion: v1 data: greeting: "Kubernetes" kind: ConfigMap metadata: name: hello-config

Make sure that you are connected to a cluster and apply this file:

Code:
$ kubectl apply -f config-hello.yml

Quarkus comes with a useful extension,

Code:
quarkus-kubernetes

, that generates the Kubernetes resources for you. You can even tweak the generated resources by providing extra properties—for more details, check out this guide.

After installing the extension, add these properties to our

Code:
application.properties

file so it generates extra configuration arguments for our containers specification:

Code:
kubernetes.group=yourDockerUsername kubernetes.env-vars[0].name=GREETING_MESSAGE kubernetes.env-vars[0].value=greeting kubernetes.env-vars[0].configmap=hello-config

Run

Code:
mvn package

and view the generated resources in

Code:
target/kubernetes

. The interesting part is in

Code:
spec.containers.env

Code:
- name: "GREETING_MESSAGE"   valueFrom:   configMapKeyRef:     key: "greeting"    name: "hello-config"

Here, we see how to pass an environment variable to our container with a value coming from a ConfigMap. Now, simply apply the resources:

Code:
$ kubectl apply -f target/kubernetes/kubernetes.yml

Expose your service:

Code:
kubectl expose deployment hello --type=NodePort

Then, browse to the public URL or do a curl. For instance, with Minikube:

Code:
$ curl $(minikube service hello-app --url)/hello

This command should output:

Code:
hello Kubernetes

.

Conclusion

Now you know how to use a ConfigMap in combination with environment variables and your Quarkus’s

Code:
application.properties

. As we said in the introduction, this technique is particularly useful when defining a DB connection’s URL (like

Code:
QUARKUS_DATASOURCE_URL

) or when using the

Code:
quarkus-rest-client

(

Code:
ORG_SEBI_OTHERSERVICE_MP_REST_URL

).

https://www.addtoany.com/add_to/facebook?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/twitter?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/linkedin?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/email?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/print?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/reddit?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties https://www.addtoany.com/add_to/flipboard?linkurl=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2020%2F01%2F23%2Fusing-kubernetes-configmaps-to-define-your-quarkus-applications-properties%2F&linkname=Using%20Kubernetes%20ConfigMaps%20to%20define%20your%20Quarkus%20application%E2%80%99s%20properties

The post Using Kubernetes ConfigMaps to define your Quarkus application’s properties appeared first on Red Hat Developer.