Chapter 1. Deploying your Quarkus applications to OpenShift Container Platform

Procedure

1. Log in to OpenShift by using the oc tool, then change to the directory that has your Quarkus Maven project.

2. To add the quarkus-openshift extension to your project, use one of the following methods:

   • Configure the pom.xml file:

     pom.xml

     <dependency>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-openshift</artifactId>
     </dependency>

   • Enter the following command on the OpenShift Container Platform CLI:

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

   • Enter the following command on the Quarkus CLI:

     quarkus extension add 'quarkus-openshift'

Procedure

1. Log in to the oc tool:

   oc login

2. To, show the current project space, enter the following command:

   oc project -q

3. Use one of the following steps to go to the required OpenShift Container Platform project:

   1. If the project already exists, switch to the project:

      oc project <project_name>

   2. If the project does not exist, create a new project:

      oc new-project <project_name>

Procedure

1. Log in to OpenShift Container Platform by using the oc tool, then change to the directory that has your Quarkus Maven project.

2. Set the Docker build strategy in your application.properties configuration file:

   quarkus.openshift.build-strategy=docker

3. (Optional) Set the following properties in the application.properties file, as required by your environment:

   1. If you are using an untrusted certificate, configure the KubernetesClient:

      quarkus.kubernetes-client.trust-certs=true

   2. Expose the service to create an OpenShift Container Platform route:

      quarkus.openshift.route.expose=true

   3. Set the path to your custom Dockerfile:

      quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>

      The following example shows the path to the Dockerfile.custom-jvm:

      quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm

4. Package and deploy your Quarkus application to the current OpenShift project:

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

1. Display the list of pods associated with your current OpenShift project:

   oc get pods

   NAME                            READY   STATUS      RESTARTS   AGE
   getting-started-1-build         0/1     Completed   0          96m
   openshift-helloworld-1-build    0/1     Completed   0          11m
   openshift-helloworld-1-deploy   0/1     Completed   0          10m
   openshift-helloworld-1-gzzrx    1/1     Running     0          10m

2. To retrieve the log output for your application’s pod, use the oc logs -f command with the <pod_name> value of the pod you are interested in. In this example, we use the openshift-helloworld-1-gzzrx pod name that corresponds with the latest pod prefixed with the name of your application:

   oc logs -f openshift-helloworld-1-gzzrx

   Starting the Java application using /opt/jboss/container/java/run/run-java.sh ...
   INFO exec  java -Xms125m -Xmx500m -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:+ExitOnOutOfMemoryError -cp "." -jar /deployments/quarkus-run.jar
   
   2023-02-10 11:58:49,077 INFO  [io.quarkus] (main) openshift-helloworld 1.0.0-SNAPSHOT on JVM (powered by Quarkus 2.13.9.Final) started in 1.399s. Listening on: http://0.0.0.0:8080
   2023-02-10 11:58:49,168 INFO  [io.quarkus] (main) Profile prod activated.
   2023-02-10 11:58:49,168 INFO  [io.quarkus] (main) Installed features: [cdi, kubernetes, resteasy-reactive, smallrye-context-propagation, vertx]

3. Retrieve a list of services:

   oc get svc

   NAME                   TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)                               AGE
   getting-started        ClusterIP   172.30.178.154   <none>        80/TCP                                98m
   modelmesh-serving      ClusterIP   None             <none>        8033/TCP,8008/TCP,8443/TCP,2112/TCP   25h
   openshift-helloworld   ClusterIP   172.30.64.57     <none>        80/TCP                                14m

4. Get a URL to test your application:

   oc get routes

   NAME                   HOST/PORT                                                                   PATH   SERVICES               PORT   TERMINATION   WILDCARD
   openshift-helloworld   openshift-helloworld-mmaler-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com          openshift-helloworld   http                 None

   Note

   Be aware that the route is now listening on port 80 and no longer at port 8080.

   The application demonstrated in this example can be tested with a web browser or a terminal by using curl and the complete URL output from oc get routes:

   • http://openshift-helloworld-mmaler-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com
   • curl http://openshift-helloworld-mmaler-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com

Procedure

1. Log in to OpenShift Container Platform by using the oc tool, and change to the directory that has your Quarkus Maven project.

2. Configure the following properties in your application.properties file:

   1. Set the Docker build strategy:

      quarkus.openshift.build-strategy=docker

   2. Set the container runtime:

      quarkus.native.container-build=true

   3. Optional: If you are using an untrusted certificate, configure the KubernetesClient property:

      quarkus.kubernetes-client.trust-certs=true

   4. Optional: Expose the service to create an OpenShift Container Platform route:

      quarkus.openshift.route.expose=true

   5. Optional: Set the path to your custom Dockerfile:

      quarkus.openshift.native-dockerfile=<path_to_your_dockerfile>

      The following example shows the path to the Dockerfile.custom-native:

      quarkus.openshift.jvm-dockerfile=src/main/docker/Dockerfile.custom-native

   6. (Optional) Specify the container engine:

      • To build a native executable with Podman:

        quarkus.native.container-runtime=podman

      • To build a native executable with Docker:

        quarkus.native.container-runtime=docker

3. Build a native executable, package, and deploy your application to OpenShift Container Platform:

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

Verification

1. To view a list of pods associated with your current OpenShift project, enter the following command:

   oc get pods

2. To retrieve the log output for your application’s pod, enter the following command where <pod_name> is the name of the latest pod prefixed with the name of your application:

   oc logs -f <pod_name>

Procedure

1. Log in to OpenShift Container Platform by using the oc tool, and change to the directory that has your Quarkus Maven project.

2. Configure the following properties in your application.properties file:

   1. Set Knative as a deployment target:

      quarkus.kubernetes.deployment-target=knative

   2. Set the Docker build strategy:

      quarkus.openshift.build-strategy=docker

   3. Direct OpenShift Serverless to pull your container image from the OpenShift internal registry:

      quarkus.container-image.registry=image-registry.openshift-image-registry.svc:5000

      Note

      If your OpenShift Container Platform <project_name> is different from the username of the host system, set the group for the container image otherwise Quarkus cannot pull the image from the image registry.

      quarkus.container-image.group=<project_name>

   4. (Optional) If you are using an untrusted certificate, configure the KubernetesClient:

      quarkus.kubernetes-client.trust-certs=true

   5. (Optional) Expose the service to create an OpenShift Container Platform route:

      quarkus.openshift.route.expose=true

   6. (Optional) Set the path to your custom Dockerfile:

      quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>

      The following example shows the path to the Dockerfile.custom-jvm:

      quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm

3. Optional: To deploy a Serverless application compiled to a native executable, configure the following properties:

   1. Set the container runtime:

      quarkus.native.container-build=true

   2. Specify the container engine:

      • To build a native executable with Podman:

        quarkus.native.container-runtime=podman

      • To build a native executable with Docker:

        quarkus.native.container-runtime=docker

   3. (Optional) Set the path to your custom Dockerfile:

      quarkus.openshift.native-dockerfile=<path_to_your_dockerfile>

4. Package and deploy your Serverless application to OpenShift Container Platform using one of the following options:

   1. Deploy a Quarkus Java application:

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

   2. Deploy a Quarkus native application:

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

Verification

1. To view a list of pods associated with your current OpenShift project:

   oc get pods

2. To retrieve the log output for your application’s pod, enter the following command where <pod_name> is the name of the latest pod prefixed with the name of your application:

   oc logs -f <pod_name>