Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

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

As an application developer, you can deploy your Quarkus applications to Red Hat OpenShift Container Platform by using a single Maven command. This functionality is provided by the quarkus-openshift extension, which supports multiple deployment options, including the Docker build strategy and the Source-to-Image (S2I) strategy.

Here, you learn the recommended workflows to deploy your Quarkus applications to production environments. To learn about other ways to deploy Quarkus applications, see the Quarkus community documentation.

Prerequisites

  • You have OpenJDK 11 or 17 installed.
  • You have set the JAVA_HOME environment variable to the location of the Java SDK.
  • You have Apache Maven 3.8.6 or later installed.

  • You have a Quarkus Maven project that includes the quarkus-openshift extension.

  • You have access to an OpenShift Container Platform cluster and the latest compatible version of the oc tool installed.

Red Hat OpenShift Container Platform is a Kubernetes-based platform for developing and running containerized applications. Although the Kubernetes upstream project provides additional strategies, Red Hat supports only the following strategies in Quarkus:

Docker build
This strategy builds the artifacts outside the OpenShift Container Platform cluster, locally or in a CI environment, and provides them to the OpenShift Container Platform build system together with a Dockerfile. The artifacts include JAR files or a native executable. The container gets built inside the OpenShift Container Platform cluster and is provided as an image stream.
Note

The OpenShift Container Platform Docker build strategy is the preferred build strategy because it supports Quarkus applications targeted for JVM or compiled to native executables. However, for compatibility with earlier Quarkus versions, the default build strategy is S2I. To select the OpenShift Container Platform Docker build strategy, use the quarkus.openshift.build-strategy property.

Source to Image (S2I)
The build process is performed inside the OpenShift Container Platform cluster. Red Hat build of Quarkus fully supports using S2I to deploy Red Hat build of Quarkus as a JVM application.
Binary S2I
This strategy uses a JAR file as input to the S2I build process, which speeds up building and deploying your application.

1.1.2. Build strategies supported by Quarkus
Copy link

The following table outlines the build strategies that Red Hat build of Quarkus 3.2 supports:

Expand
Build strategySupport for Red Hat build of Quarkus toolsSupport for JVMSupport for nativeSupport for JVM ServerlessSupport for native Serverless

Docker build

YES

YES

YES

YES

YES

S2I Binary

YES

YES

NO

NO

NO

Source S2I

NO

YES

NO

NO

NO

To build and deploy your applications as a container image that runs inside your OpenShift Container Platform cluster, you must add the Red Hat build of Quarkus OpenShift extension quarkus-openshift as a dependency to your project.

The Quarkus OpenShift extension also generates OpenShift Container Platform resources such as image streams, build configuration, deployment configuration, and service definitions. If your Quarkus application includes the quarkus-smallrye-health extension, OpenShift Container Platform can access the health endpoint and verify the startup, liveness and, readiness of your application.

Prerequisites

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>
      Copy to Clipboard Toggle word wrap

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

      ./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-openshift"
      Copy to Clipboard Toggle word wrap

    • Enter the following command on the Quarkus CLI: 

      quarkus extension add 'quarkus-openshift'
      Copy to Clipboard Toggle word wrap

You can use the Red Hat OpenShift Container Platform command-line interface (CLI) to create applications and manage your OpenShift Container Platform projects. Use the information provided to create an OpenShift Container Platform project or to switch to an existing one.

Prerequisites

Procedure

  1. Log in to the oc tool: 

    oc login
    Copy to Clipboard Toggle word wrap

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

    oc project -q
    Copy to Clipboard Toggle word wrap

  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>
      Copy to Clipboard Toggle word wrap

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

      oc new-project <project_name>
      Copy to Clipboard Toggle word wrap

The Red Hat build of Quarkus OpenShift extension enables you to deploy your Quarkus application to OpenShift Container Platform by using the Docker build strategy. The container gets built inside the OpenShift Container Platform cluster and is provided as an image stream.

Your Quarkus project includes pregenerated Dockerfiles with instructions. When you want to use a custom Dockerfile, you must add the file in the src/main/docker directory or anywhere inside the module. Additionally, you need to set the path to your Dockerfile by using the quarkus.openshift.jvm-dockerfile property.

Prerequisites

Procedure

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

    quarkus.openshift.build-strategy=docker
    Copy to Clipboard Toggle word wrap

  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
      Copy to Clipboard Toggle word wrap

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

      quarkus.openshift.route.expose=true
      Copy to Clipboard Toggle word wrap

    3. Set the path to your custom Dockerfile: 

      quarkus.openshift.jvm-dockerfile=<path_to_your_dockerfile>
      Copy to Clipboard Toggle word wrap

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

      quarkus.openshift.jvm-dockerfile=src/main/resources/Dockerfile.custom-jvm
      Copy to Clipboard Toggle word wrap

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

    ./mvnw clean package -Dquarkus.kubernetes.deploy=true
    Copy to Clipboard Toggle word wrap

Verification

The verification steps and related terminal outputs are demonstrated on the openshift-helloworld example application.

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

    oc get pods
    Copy to Clipboard Toggle word wrap 
    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
    Copy to Clipboard Toggle word wrap

  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
    Copy to Clipboard Toggle word wrap 
    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
   _ _   _ --/  \/ / / / _ | / _ \/ /// / / / _/ -/ // / // /  |/ , / ,< / // /\ \ --\___// |//|//||\__/_/
2023-09-21 10:45:16,848 INFO [io.quarkus] (main) hello-world 1.0.0-SNAPSHOT on JVM (powered by Red Hat build of Quarkus 3.2.9) started in 1.739s. Listening on: http://0.0.0.0:8080
2023-09-21 10:45:16,852 INFO [io.quarkus] (main) Profile prod activated.
2023-09-21 10:45:16,852 INFO [io.quarkus] (main) Installed features: [cdi, kubernetes, resteasy-reactive, smallrye-context-propagation, vertx]
    Copy to Clipboard Toggle word wrap

  3. Retrieve a list of services: 

    oc get svc
    Copy to Clipboard Toggle word wrap 
    NAME                   TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)                               AGE
openshift-helloworld   ClusterIP   172.30.64.57     <none>        80/TCP                                14m
    Copy to Clipboard Toggle word wrap

  4. Get a URL to test your application: 

    oc get routes
    Copy to Clipboard Toggle word wrap 
    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
    Copy to Clipboard Toggle word wrap
    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-username-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com

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

You can deploy your native Red Hat build of Quarkus application to OpenShift Container Platform by using the Docker build strategy. You must create a native executable for your application that targets the Linux AMD64 operating system. If your host operating system is different from this, create a native Linux executable using a container runtime, for example, Docker or Podman.

Your Quarkus project includes pregenerated Dockerfiles with instructions. To use a custom Dockerfile, add the file in the src/main/docker directory or anywhere inside the module, and set the path to your Dockerfile using the quarkus.openshift.native-dockerfile property.

Prerequisites

  • You have a Linux AMD64 system or an Open Container Initiative (OCI) compatible container runtime, such as Podman or Docker.
  • You have a Quarkus Maven project that includes the quarkus-openshift extension.
  • You are working in the correct OpenShift project namespace, as outlined in Switching to the required OpenShift Container Platform project.

Procedure

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

    1. Set the Docker build strategy: 

      quarkus.openshift.build-strategy=docker
      Copy to Clipboard Toggle word wrap

    2. Set the container runtime: 

      quarkus.native.container-build=true
      Copy to Clipboard Toggle word wrap

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

      quarkus.kubernetes-client.trust-certs=true
      Copy to Clipboard Toggle word wrap

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

      quarkus.openshift.route.expose=true
      Copy to Clipboard Toggle word wrap

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

      quarkus.openshift.native-dockerfile=<path_to_your_dockerfile>
      Copy to Clipboard Toggle word wrap

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

      quarkus.openshift.jvm-dockerfile=src/main/docker/Dockerfile.custom-native
      Copy to Clipboard Toggle word wrap

    6. (Optional) Specify the container engine:

      • To build a native executable with Podman: 

        quarkus.native.container-runtime=podman
        Copy to Clipboard Toggle word wrap

      • To build a native executable with Docker: 

        quarkus.native.container-runtime=docker
        Copy to Clipboard Toggle word wrap

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

    ./mvnw clean package -Pnative -Dquarkus.kubernetes.deploy=true
    1
    Copy to Clipboard Toggle word wrap
1
Compile the application to a native executable and enable Kubernetes deployment.

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
    Copy to Clipboard Toggle word wrap
    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.

  1. 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>
    Copy to Clipboard Toggle word wrap

Additional resources

You can deploy your Red Hat build of Quarkus applications to OpenShift Container Platform using the Source-to-Image (S2I) method. With S2I, you must provide the source code to the build container through a Git repository or by uploading the source at build time.

Important

S2I is not supported for native deployments. For deploying Quarkus applications compiled to native executables, use the Docker build strategy.

The procedure for deploying your Quarkus applications to OpenShift Container Platform by using S2I differs depending on the Java version you are using.

You can deploy your Red Hat build of Quarkus applications running on Java 17 to OpenShift Container Platform by using the Source-to-Image (S2I) method.

Prerequisites

Procedure

  1. Open the pom.xml file, and change the Java configuration to version 17, as follows: 

    <maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
    Copy to Clipboard Toggle word wrap

  2. To package your Java 17 application, enter the following command: 

    ./mvnw clean package
    Copy to Clipboard Toggle word wrap
  3. Create a directory called .s2i at the same level as the pom.xml file.

  4. Create a file called environment in the .s2i directory and add the following content: 

    MAVEN_S2I_ARTIFACT_DIRS=target/quarkus-app
S2I_SOURCE_DEPLOYMENTS_FILTER=app lib quarkus quarkus-run.jar
JAVA_OPTIONS=-Dquarkus.http.host=0.0.0.0
AB_JOLOKIA_OFF=true
JAVA_APP_JAR=/deployments/quarkus-run.jar
    Copy to Clipboard Toggle word wrap
  5. Commit and push your changes to the remote Git repository.

  6. To import the supported OpenShift Container Platform image, enter the following command: 

    oc import-image ubi8/openjdk-17 --from=registry.access.redhat.com/ubi8/openjdk-17 --confirm
    Copy to Clipboard Toggle word wrap
    Note
    • If you are using the OpenShift image registry and pulling from image streams in the same project, your pod service account should already have the correct permissions.
    • If you are pulling images across other OpenShift Container Platform projects or from secured registries, additional configuration steps might be required.

    For more information, see Using image pull secrets in Red Hat OpenShift Container Platform documentation.

  7. To build the project, create the application, and deploy the OpenShift Container Platform service, enter the following command: 

    oc new-app registry.access.redhat.com/ubi8/openjdk-17~<git_path> --name=<project_name>
    Copy to Clipboard Toggle word wrap

    Where:

    • <git_path> is the path to the Git repository that hosts your Quarkus project. For example, oc new-app registry.access.redhat.com/ubi8/openjdk-17~https://github.com/johndoe/code-with-quarkus.git --name=code-with-quarkus.

      If you do not have SSH keys configured for the Git repository, when specifying the Git path, use the HTTPS URL instead of the SSH URL.

    • <project_name> is the name of your application.

  8. To deploy an updated version of the project, push any updates to the Git repository then enter the following command: 

    oc start-build <project_name>
    Copy to Clipboard Toggle word wrap

  9. To expose a route to the Quarkus application, enter the following command: 

    oc expose svc <project_name>
    Copy to Clipboard Toggle word wrap

Verification

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

    oc get pods
    Copy to Clipboard Toggle word wrap

  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>
    Copy to Clipboard Toggle word wrap

You can deploy your Red Hat build of Quarkus applications running on Java 11 to OpenShift Container Platform by using the Source-to-Image (S2I) method.

Prerequisites

Procedure

  1. Open the pom.xml file, and change the Java configuration to version 11, as follows: 

    <maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
    Copy to Clipboard Toggle word wrap

  2. To package your Java 11 application, enter the following command: 

    ./mvnw clean package
    Copy to Clipboard Toggle word wrap
  3. Create a directory called .s2i at the same level as the pom.xml file.

  4. Create a file called environment in the .s2i directory and add the following content: 

    MAVEN_S2I_ARTIFACT_DIRS=target/quarkus-app
S2I_SOURCE_DEPLOYMENTS_FILTER=app lib quarkus quarkus-run.jar
JAVA_OPTIONS=-Dquarkus.http.host=0.0.0.0
AB_JOLOKIA_OFF=true
JAVA_APP_JAR=/deployments/quarkus-run.jar
    Copy to Clipboard Toggle word wrap
  5. Commit and push your changes to the remote Git repository.

  6. To import the supported OpenShift Container Platform image, enter the following command: 

    oc import-image ubi8/openjdk-11 --from=registry.access.redhat.com/ubi8/openjdk-11 --confirm
    Copy to Clipboard Toggle word wrap
    Note
    • If you are using the OpenShift image registry and pulling from image streams in the same project, your pod service account should already have the correct permissions.

    • If you are pulling images across other OpenShift Container Platform projects or from secured registries, additional configuration steps might be required.

      For more information, see Using image pull secrets in Red Hat OpenShift Container Platform documentation.

    • If you are deploying on IBM Z infrastructure, enter oc import-image ubi8/openjdk-11 --from=registry.redhat.io/ubi8/openjdk-11 --confirm instead. For information about this image, see the Red Hat build of OpenJDK 11 page.

  7. To build the project, create the application, and deploy the OpenShift Container Platform service, enter the following command: 

    oc new-app registry.access.redhat.com/ubi8/openjdk-11~<git_path> --name=<project_name>
    Copy to Clipboard Toggle word wrap

    Where:

    • <git_path> is the path to the Git repository that hosts your Quarkus project. For example, oc new-app registry.access.redhat.com/ubi8/openjdk-17~https://github.com/johndoe/code-with-quarkus.git --name=code-with-quarkus.

      If you do not have SSH keys configured for the Git repository, when specifying the Git path, use the HTTPS URL instead of the SSH URL.

    • <project_name> is the name of your application.

      Note

      If you are deploying on IBM Z infrastructure, enter oc new-app ubi8/openjdk-11~<git_path> --name=<project_name> instead.

  8. To deploy an updated version of the project, push any updates to the Git repository then enter the following command: 

    oc start-build <project_name>
    Copy to Clipboard Toggle word wrap

  9. To expose a route to the Quarkus application, enter the following command: 

    oc expose svc <project_name>
    Copy to Clipboard Toggle word wrap

Verification

  1. To view a list of pods, enter the following command: 

    oc get pods
    Copy to Clipboard Toggle word wrap

  2. To retrieve the log output for your application’s pod, enter the following command: 

    oc logs -f <pod_name>
    Copy to Clipboard Toggle word wrap

You can customize your deployments on OpenShift Container Platform by defining optional configuration properties. You can configure your Red Hat build of Quarkus project in your applications.properties file or from the command line.

Expand
Table 1.1. Quarkus configuration properties and their default values:
PropertyDescriptionDefault

quarkus.container-image.group

The container image group. Must be set if the OpenShift Container Platform <project_name> is different from the username of the host system.

${user.name}

quarkus.container-image.registry

The container registry to use.

 

quarkus.kubernetes-client.trust-certs

Kubernetes client certificate authentication.

 

quarkus.kubernetes.deployment-target

Deployment target platform. For example, openshift or knative.

 

quarkus.native.container-build

Builds a native Linux executable by using a container runtime. Docker is used by default.

false

quarkus.native.container-runtime

The container runtime used to build the image, for example, Docker.

 

quarkus.openshift.build-strategy

The deployment strategy.

s2i

quarkus.openshift.route.expose

Exposes a route for the Quarkus application.

false

quarkus.native.debug.enabled

Enables debugging and generates debug symbols in a separate .debug file. When this property is used with quarkus.native.container-build=true, Red Hat build of Quarkus only supports Red Hat Enterprise Linux or other Linux distributions. The Red Hat Enterprise Linux and other Linux distributions contain the binutils package, which installs the objcopy utility to split the debug information from the native image.

false

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat