Deploying your Quarkus applications as OpenShift Serverless services
Abstract
Preface
As an application developer, you can deploy a Quarkus application on Red Hat OpenShift Container Platform using OpenShift Serverless Knative Serving.
By using OpenShift Serverless Knative Serving, you can scale services up and down depending on the load size. Scaling down services that are currently not requested improves memory capabilities.
Quarkus is supported to run as a native executable or as a Java application using an OpenJDK. For native executables, use the Red Hat UBI 8 minimal image. For OpenJDK, use the Red Hat 8 UBI Java image.
Prerequisites
-
OpenJDK 11 is installed and the
JAVA_HOME
environment variable specifies the location of the Java SDK. Red Hat build of Open JDK is available from the Software Downloads page in the Red Hat Customer Portal (login required). - Apache Maven 3.6.2 or higher is installed. Maven is available from the Apache Maven Project website.
You have a Quarkus Maven project. For instructions on building a simple Quarkus application with Maven, see Getting started with Quarkus.
NoteFor a completed example of a Quarkus Maven project, download the Quarkus quickstart archive or clone the
Quarkus Quickstarts
Git repository. The example is in thegetting-started
directory.- You have access to a Red Hat OpenShift Container Platform cluster and the latest version of the OpenShift CLI (oc) is installed. For information about installing oc, see the "Installing the CLI" section of the Installing and configuring OpenShift Container Platform clusters guide.
- OpenShift Serverless operator is installed and verified. See the Installing OpenShift Serverless guide for more details.
- OpenShift Knative Serving is installed and verified. See the Installing Knative Serving section of the Installing OpenShift Serverless guide for more details.
- For native compilation, a container environment like Podman or Docker is required.
-
Optionally install the
kn
CLI tool.
Currently, only Knative Serving is supported in the Red Hat build of Quarkus. Knative Eventing is currently tech preview.
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Chapter 1. Deploying a Serverless Quarkus Java application to OpenShift using the OpenShift extension
The traditional source-to-image (S2I) source workflow generates the deployable artifacts of your application inside OpenShift. The Quarkus OpenShift extension uses the S2I binary workflow to provide a more streamlined deployment process. Instead of building from the source, the extension uploads the JAR files from the local file system. As a result, the build process is up to ten times faster than the traditional S2I method. You can use the Quarkus OpenShift extension when developing locally as well as from a build server or continuous integration (CI) system to perform repeatable builds from source.
The following procedure demonstrates how to deploy a Serverless Quarkus Java application to OpenShift using the Quarkus OpenShift extension.
Prerequisites
- You have a Quarkus Maven project.
- OpenShift Serverless operator is installed.
- OpenShift Knative Serving is installed.
- You have access to a Red Hat OpenShift Container Platform cluster and the latest version of the OpenShift CLI (oc) is installed.
-
OpenJDK 11 is installed and the
JAVA_HOME
environment variable specifies the location of the Java SDK. - Apache Maven 3.6.2 or higher is installed. Maven is available from the Apache Maven Project website.
- For native compilation, a container environment like Podman or Docker is required.
-
The
kn
CLI tool is installed.
Procedure
- Change to the directory that contains your Quarkus project.
Add the OpenShift extension to an existing project:
./mvnw quarkus:add-extension -Dextensions="openshift"
When you add the OpenShift extension, the script adds the following dependency to the
pom.xml
file:<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-openshift</artifactId> </dependency>
If you are using an untrusted certificate while in a development or testing environment, add the following line to the
src/main/resources/application.properties
file:quarkus.kubernetes-client.trust-certs=true
To direct OpenShift to use the Open JDK 11 Red Hat Enterprise Linux 8 image, add the following line to the
application.properties
file:quarkus.s2i.base-jvm-image=registry.access.redhat.com/ubi8/openjdk-11
To direct OpenShift Serverless to pull your container image from the OpenShift internal registry, add the following line to the
application.properties
file:quarkus.container-image.registry=image-registry.openshift-image-registry.svc:5000
To enable the creation of deployment descriptors for Knative Serving, add the following line to the
application.properties
file:quarkus.kubernetes.deployment-target=knative
-
Save the changes to the
application.properties
file. Log in to the OpenShift CLI (oc):
oc login
To create a new OpenShift project, enter the following command where
<project_name>
is the name of your new project:oc new-project <project_name>
NoteThe
<project_name>
should be the same as theusername
of the host system otherwise Quarkus cannot pull the image from the image registry. If you set a different<project_name>
, make sure to add the following line to theapplication.properties
file:quarkus.container-image.group=<project_name>
To deploy your project to OpenShift, enter the following command:
./mvnw clean package -Dquarkus.kubernetes.deploy=true
To verify that the application was deployed correctly, run the following command:
kn service list
To view the full URL to the application, enter the following command where
<application_name>
is the name of an application deployed in your OpenShift project:kn route describe <application_name> -o jsonpath='{.status.url}'
Chapter 2. Deploying a container image for a Quarkus native application in a continuous integration as a serverless application
You can separate the native build, container build, and deployment steps when deploying a native serverless application. The following procedure demonstrates how to deploy a container image for a Quarkus native application in a continuous integration (CI) as a serverless application.
Prerequisites
- OpenShift Serverless operator is installed.
- OpenShift Knative Serving is installed.
- For native compilation, a container environment like Podman or Docker is required.
-
The
kn
CLI tool is installed.
Procedure
- Change to the directory that contains your Quarkus project.
Build a Linux executable using one of the following methods:
For Docker use:
./mvnw package -Pnative -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=registry.access.redhat.com/quarkus/mandrel-20-rhel8:20.3
For Podman use:
./mvnw package -Pnative -Dquarkus.native.container-build=true -Dquarkus.native.container-runtime=podman -Dquarkus.native.builder-image=registry.access.redhat.com/quarkus/mandrel-20-rhel8:20.3
Open the
src/main/docker/Dockerfile.native
file and set the<image_name>
and<version>
parameters:For Docker use:
docker build -f src/main/docker/Dockerfile.native -t <image_name>:<version> .
For Podman use:
podman build -f src/main/docker/Dockerfile.native -t <image_name>:<version>.
Push the container to a repository that your CI environment and your OpenShift environment can access, where
<registry>
is your registry URL:For Docker use:
docker tag <image_name>:<version> <registry>/<image_name>:<version> docker push <registry>/<image_name>:<version>
For Podman use:
podman tag <image_name>:<version> <registry>/<image_name>:<version> podman push <registry>/<image_name>:<version>
Log in to the OpenShift CLI (oc):
oc login
To create a new OpenShift project, enter the following command where
<project_name>
is the name of your new project:oc new-project <project_name>
To deploy your container as a serverless application using the OpenShift Serverless CLI (kn), enter the following command where
<service_name>
is the name for your service:kn service create <service_name> --image REPOSITORY/<image_name>:<version>
To verify that the service is ready, enter the following command.
kn service list <service_name>
The output in the column called "READY" reads
true
if the service is ready.NoteThe
kn service
command returnstrue
when the necessary components are created, not when the image is pulled down and ready.
Chapter 3. Additional resources
- For information about creating Quarkus applications with Maven, see Developing and compiling your Quarkus applications with Apache Maven.
- For more information on how to compile the Quarkus applications to native executables and native executable testing, see Compiling your Quarkus applications to native executables
- For information about deploying Quarkus Maven applications on Red Hat OpenShift Container Platform, see Deploying your Quarkus applications on Red Hat OpenShift Container Platform.
Revised on 2021-04-19 12:03:15 UTC