Deploying your Quarkus applications as OpenShift Serverless services

Procedure

1. Change to the directory that contains your Quarkus project.

2. Add the OpenShift extension to an existing project:

   ./mvnw quarkus:add-extension -Dextensions="openshift"

   Copy to Clipboard Toggle word wrap

   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>

   Copy to Clipboard Toggle word wrap

3. 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

   Copy to Clipboard Toggle word wrap

4. 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

   Copy to Clipboard Toggle word wrap

5. 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

   Copy to Clipboard Toggle word wrap

6. To enable the creation of deployment descriptors for Knative Serving, add the following line to the application.properties file:

   quarkus.kubernetes.deployment-target=knative

   Copy to Clipboard Toggle word wrap
7. Save the changes to the application.properties file.

8. Log in to the OpenShift CLI (oc):

   oc login

   Copy to Clipboard Toggle word wrap

9. 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>

   Copy to Clipboard Toggle word wrap
   Note

   The <project_name> should be the same as the username 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 the application.properties file:

   quarkus.container-image.group=<project_name>

   Copy to Clipboard Toggle word wrap

10. To deploy your project to OpenShift, enter the following command:

    ./mvnw clean package -Dquarkus.kubernetes.deploy=true

    Copy to Clipboard Toggle word wrap

11. To verify that the application was deployed correctly, run the following command:

    kn service list

    Copy to Clipboard Toggle word wrap

12. 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}'

    Copy to Clipboard Toggle word wrap

Procedure

1. Change to the directory that contains your Quarkus project.

2. Build a Linux executable using one of the following methods:

   1. 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

      Copy to Clipboard Toggle word wrap

   2. 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

      Copy to Clipboard Toggle word wrap

3. Open the src/main/docker/Dockerfile.native file and set the <image_name> and <version> parameters:

   1. For Docker use:

      docker build -f src/main/docker/Dockerfile.native -t <image_name>:<version> .

      Copy to Clipboard Toggle word wrap

   2. For Podman use:

      podman build -f src/main/docker/Dockerfile.native -t <image_name>:<version>.

      Copy to Clipboard Toggle word wrap

4. Push the container to a repository that your CI environment and your OpenShift environment can access, where <registry> is your registry URL:

   1. For Docker use:

      docker tag <image_name>:<version> <registry>/<image_name>:<version>
      docker push <registry>/<image_name>:<version>

      Copy to Clipboard Toggle word wrap

   2. For Podman use:

      podman tag <image_name>:<version> <registry>/<image_name>:<version>
      podman push <registry>/<image_name>:<version>

      Copy to Clipboard Toggle word wrap

5. Log in to the OpenShift CLI (oc):

   oc login

   Copy to Clipboard Toggle word wrap

6. 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>

   Copy to Clipboard Toggle word wrap

7. 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>

   Copy to Clipboard Toggle word wrap

8. To verify that the service is ready, enter the following command.

   kn service list <service_name>

   Copy to Clipboard Toggle word wrap

   The output in the column called "READY" reads true if the service is ready.

   Note

   The kn service command returns true when the necessary components are created, not when the image is pulled down and ready.