Chapter 1. Deploying your Red Hat build of Quarkus applications to OpenShift Container Platform

Procedure

1. 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. Set the Docker build strategy in your application.properties configuration file:

   quarkus.openshift.build-strategy=docker

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

3. 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
   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 -a "java" java -Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager -XX:MaxRAMPercentage=50.0 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:+ExitOnOutOfMemoryError -cp "." -jar /deployments/quarkus-run.jar
   __  ____  __  _____   ___  __ ____  ______
    --/ __ \/ / / / _ | / _ \/ //_/ / / / __/
    -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \
   --\___\_\____/_/ |_/_/|_/_/|_|\____/___/
   2024-03-27 17:13:25,254 INFO  [io.quarkus] (main) getting-started 1.0.0-SNAPSHOT on JVM (powered by Quarkus 3.8.3.Final-redhat-00003) started in 0.653s. Listening on: http://0.0.0.0:8080
   2024-03-27 17:13:25,281 INFO  [io.quarkus] (main) Profile prod activated.
   2024-03-27 17:13:25,281 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
   openshift-helloworld   ClusterIP   172.30.64.57     <none>        80/TCP                                14m

4. Get a URL to test your application.

   Note

   To create an OpenShift Container Platform route, ensure you have specified quarkus.openshift.route.expose=true in the application.properties file.

   oc get routes

   NAME                   HOST/PORT                                                                   PATH   SERVICES               PORT   TERMINATION   WILDCARD
   openshift-helloworld   openshift-helloworld-username-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.

   You can test the application demonstrated in this example with a web browser or a terminal by using curl and the complete URL output from oc get routes: http://openshift-helloworld-username-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com.

   For example: curl http://openshift-helloworld-username-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com.

Procedure

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

   quarkus.openshift.build-strategy=docker

2. Set the container runtime:

   quarkus.native.container-build=true

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 property:

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

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

4. Finally, build a native executable, package, and deploy your application to OpenShift Container Platform:

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

Verification

1. Verify that an image stream and a service resource is created and the Quarkus application is deployed by using the OpenShift web console. Alternatively, you can run the following OpenShift Container Platform command-line interface (CLI) commands:

   oc get is 1
   oc get pods 2
   oc get svc 3

   1

   List the image streams created.

   2

   View a list of pods associated with your current OpenShift project.

   3

   Get the list of Kubernetes services.

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>