Deploying your Quarkus applications on Red Hat OpenShift Container Platform

Procedure

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

2. To add the OpenShift extension to an existing project, enter the following command:

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

   Copy to Clipboard Toggle word wrap
   Note

   You can include the -Dextensions="openshift" argument to add the Quarkus OpenShift extension when you create a new project.

   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, 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 7 image, add the following line to the application.properties file:

   quarkus.s2i.base-jvm-image=registry.access.redhat.com/openjdk/openjdk-11-rhel7

   Copy to Clipboard Toggle word wrap
   Note

   If you are deploying on IBM Z infrastructure, add quarkus.s2i.base-jvm-image=registry.access.redhat.com/openj9/openj9-11-rhel8 to the application.properties file.

5. To create an OpenShift route, add the following line to the application.properties file:

   quarkus.openshift.expose=true

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

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

   oc login

   Copy to Clipboard Toggle word wrap

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

9. To deploy your project to OpenShift, enter the following command in your Quarkus Maven project directory:

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

   Copy to Clipboard Toggle word wrap

10. To display the names and routes of all deployed applications in the OpenShift project, enter the following command:

    oc get route

    Copy to Clipboard Toggle word wrap

11. To view the full URL to the application, where APPLICATION_NAME is the name of an application deployed in your OpenShift project, enter the following command:

    export URL="http://$(oc get route APPLICATION_NAME -o jsonpath='{.spec.host}')"
    echo "Application URL: $URL"
    curl $URL/hello

    Copy to Clipboard Toggle word wrap

12. To create an HTTP request on the route’s hello endpoint, enter the following command:

    curl $URL/hello

    Copy to Clipboard Toggle word wrap

Procedure

1. Change to the directory that contains your Quarkus Maven project.
2. Create a hidden directory called .s2i at the same level as the pom.xml file.

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

   ARTIFACT_COPY_ARGS=-p -r lib/ *-runner.jar

   Copy to Clipboard Toggle word wrap
4. Commit and push your changes to the remote Git repository.

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 import the supported OpenShift image, enter the following command:

   oc import-image --confirm openjdk/openjdk-11-rhel7 --from=registry.access.redhat.com/openjdk/openjdk-11-rhel7

   Copy to Clipboard Toggle word wrap
   Note

   If you are deploying on IBM Z infrastructure, enter oc import-image --confirm openj9/openj9-11-rhel8 --from=registry.access.redhat.com/openj9/openj9-11-rhel8.

   For information about this image, see the Red Hat OpenJDK 11 Java Applications page.

8. To build the project in OpenShift, enter the following command where GIT_PATH is the path to the Git repository that hosts your Quarkus project and PROJECT_NAME is the OpenShift project that you created.

   oc new-app openjdk-11-rhel7 GIT_PATH --name=PROJECT_NAME

   Copy to Clipboard Toggle word wrap
   Note

   If you are deploying on IBM Z infrastructure, enter oc new-app openj9/openj9-11-rhel8 GIT_PATH --name=PROJECT_NAME.

   This command builds the project, creates the application, and deploys the OpenShift service.

9. To create an OpenShift route, enter the following command:

   oc expose service/PROJECT_NAME

   Copy to Clipboard Toggle word wrap

10. To view the new route, enter the following command where APPLICATION_NAME is the name of an application deployed in your OpenShift project:

    export URL="http://$(oc get route APPLICATION_NAME -o jsonpath='{.spec.host}}')"
    echo "Application URL: $URL"

    Copy to Clipboard Toggle word wrap

11. To create an HTTP request on the route’s hello endpoint, enter the following command:

    curl $URL/hello

    Copy to Clipboard Toggle word wrap
12. To use your application, enter the URL returned in the preceding command in a web browser.

13. 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
14. Refresh your browser page after the build completes to see the changes.