Quarkus Microservice Demo Project

This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

First run your Docker Daemon. The following command should be succeeded:

docker ps

You can run your application in dev mode that enables live coding using:

mvn compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

mvn clean package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

Creating a native executable

You can create a native executable using:

mvn package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

mvn package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/sample-quarkus-microservice-1.0.0-SNAPSHOT-runner

Running on Kubernetes

This section provides detailed instructions for deploying the Person Service application on Kubernetes with PostgreSQL database.

Prerequisites

Before deploying the application, ensure you have the following tools installed:

• Java: JDK 17 or later (recommended: OpenJDK 17+)
• Maven: 3.8.1 or later
• Docker: 20.10 or later (for building container images)
• Kubernetes CLI (kubectl): 1.25 or later
• Helm: 3.x (for PostgreSQL installation)
• Kubernetes Cluster: One of the following:
  • Minikube 1.30+ (for local development)
  • Docker Desktop with Kubernetes enabled
  • Any managed Kubernetes cluster (GKE, EKS, AKS, etc.)

Verify your installations:

java -version
mvn -version
docker --version
kubectl version --client
helm version

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

Related Guides

• OpenShift (guide): Generate OpenShift resources from annotations
• Micrometer Registry Prometheus (guide): Enable Prometheus support for Micrometer
• SmallRye OpenAPI (guide): Document your REST APIs with OpenAPI - comes with Swagger UI
• Hibernate ORM with Panache (guide): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern
• SmallRye Health (guide): Monitor service health
• JDBC Driver - PostgreSQL (guide): Connect to the PostgreSQL database via JDBC

Provided Code

RESTEasy JAX-RS

Easily start your RESTful Web Services

Related guide section...

SmallRye Health

Monitor your application's health using SmallRye Health

Related guide section...