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
First, you need to install Postgres on Kubernetes, e.g. with Helm:
$ helm install person-db bitnami/postgresql -n sample-quarkus --set auth.username=quarkus --set auth.database=quarkus --set fullnameOverride=person-db --create-namespace
Then, you can build and deploy the app within one step with Maven by activating the kubernetes
profile:
$ QUARKUS_JIB_BASE_JVM_IMAGE=registry.access.redhat.com/ubi8/openjdk-17-runtime:latest mvn clean package -DskipTests -Pkubernetes
Or, with the minikube
profile for running on Minikube.
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
SmallRye Health
Monitor your application's health using SmallRye Health