Quarkus is a microservice development framework designed for the cloud and containers.<\/p>\n
It is designed to have reduced memory usage and the shortest possible startup time.<\/p>\n
It is mainly based on standards (Jakarta EE, Eclipse MicroProfile, etc.) and allows the use of mature and widely used Java libraries via its extensions (Hibernate, RESTeasy, Vert.X, Kafka, etc.).<\/p>\n
Quarkus was designed for the cloud from the beginning, enabling the development of Cloud Ready applications (as defined by the 12 Factors principle) and Cloud Native applications (using the capabilities of public clouds to build your applications).<\/p>\n
Google Cloud Run is a Container As A Service solution that allows you to run interface and backend services, batch jobs, hosted LLMs, and queue processing workloads without having to manage the infrastructure.<\/p>\n
Quarkus is therefore a good solution for developing an application to deploy to Cloud Run.<\/p>\n
First step, create a Quarkus application:<\/p>\n
\nquarkus create app quarkus-cloud-run\n<\/pre>\nThe project will be generated in a
quarkus-cloud-run<\/code> directory. Move to the root of this directory and launch the application viaquarkus dev<\/code>.<\/p>\nYou can test the application via
curl localhost:8080\/hello<\/code>.<\/p>\nA Quarkus application can run in a JVM or as a native application. Here, we will choose a native image deployment, which is more suitable for cloud deployments.<\/p>\n
To build the application as a native image, you can use the following command:<\/p>\n
\ncp src\/main\/docker\/Dockerfile.native Dockerfile\nquarkus build --native\n<\/pre>\nDeploy to Google Cloud Run<\/h2>\n
By default,
gcloud<\/code> will send all files of your application except those defined in your.gitignore<\/code> to package your application. You can add directories or files to ignore in a.gcloudignore<\/code> file, for example, the application directory:src\/<\/code>.<\/p>\nTo create a container, we will use the Dockerfile provided by Quakus in
src\/main\/docker\/Dockerfile.native<\/code>. Simply copy it to the root directory so that it is used by default:<\/p>\n\ncp src\/main\/docker\/Dockerfile.native Dockerfile\n<\/pre>\nWarning<\/strong>: this Dockerfile contains a directive that is not compatible with Cloud Build. You must modify the
COPY<\/code> directive to remove the--chown<\/code> and--chmod<\/code> options:<\/p>\n\nCOPY target\/*-runner \/work\/application\n<\/pre>\nCloud Build can package your application and make it available to Cloud Run in the Google Cloud container registry. You can use the following command, which will use the
Dockerfile<\/code> located at the root of your application by default:<\/p>\n\ngcloud builds submit --tag gcr.io\/PROJECT-ID\/quarkus-cloud-run\n<\/pre>\nOnce the build is complete, you can launch your application via Cloud Run using the following command, which will use the container previously created by Cloud Build:<\/p>\n
\ngcloud run deploy --image gcr.io\/PROJECT-ID\/quarkus-cloud-run\n<\/pre>\nOnce the application is deployed,
gcloud<\/code> will display the Service URL<\/strong> in its logs, which allows us to access the application.<\/p>\nYou can test the application via
curl SERVICE_URL\/hello<\/code>.<\/p>\nAdd an Health Check<\/h2>\n
Cloud Run supports the use of Health Checks in the form of startup probes, liveness probes, and readiness probes.<\/p>\n
Quarkus supports Health Checks via the SmallRye Health extension, which you can add to your application using:<\/p>\n
\nquarkus extension add smallrye-health\n<\/pre>\nYou must then rebuild the application:<\/p>\n
\nquarkus build --native\ngcloud builds submit --tag gcr.io\/PROJECT-ID\/quarkus-cloud-run\n<\/pre>\nDuring deployment, you must specify the application’s health checks to Cloud Run. Here, I have only specified a startup probe:<\/p>\n
\ngcloud run deploy --image gcr.io\/PROJECT-ID\/quarkus-cloud-run \\\n --startup-probe httpGet.path=\/q\/health\/started,httpGet.port=8080\n<\/pre>\nQuarkus exposes different endpoints for health checks:<\/p>\n
\n
- \/q\/health\/started<\/li>\n
- \/q\/health\/live<\/li>\n
- \/q\/health\/ready<\/li>\n<\/ul>\n
You can use them for the different health checks supported by Cloud Run. More information on Cloud Run health checks and how to declare them can be found here<\/a>.<\/p>\n