Chapter 2. Build and Run a Java Application on the JBoss EAP for OpenShift Image

1. Log in to your OpenShift instance using the oc login command.

2. Create a new project in OpenShift.

   A project allows a group of users to organize and manage content separately from other groups. You can create a project in OpenShift using the following command.

   $ oc new-project PROJECT_NAME

   For example, for the kitchensink quickstart, create a new project named eap-demo using the following command.

   $ oc new-project eap-demo

3. Optional: Create a keystore and a secret.

   Note

   Creating a keystore and a secret is required if you are using any HTTPS-enabled features in your OpenShift project. For example, if you are using the eap73-https-s2i template (for JDK 8) or the eap73-openjdk11-https-s2i template (for JDK 11), you must create a keystore and secret.

   This workflow demonstration for the kitchensink quickstart does not use an HTTPS template, so a keystore and secret are not required.

   1. Create a keystore.

      Warning

      The following commands generate a self-signed certificate, but for production environments Red Hat recommends that you use your own SSL certificate purchased from a verified Certificate Authority (CA) for SSL-encrypted connections (HTTPS).

      You can use the Java keytool command to generate a keystore using the following command.

      $ keytool -genkey -keyalg RSA -alias ALIAS_NAME -keystore KEYSTORE_FILENAME.jks -validity 360 -keysize 2048

      For example, for the kitchensink quickstart, use the following command to generate a keystore.

      $ keytool -genkey -keyalg RSA -alias eapdemo-selfsigned -keystore keystore.jks -validity 360 -keysize 2048

   2. Create a secret from the keystore.

      Create a secret from the previously created keystore using the following command.

      $ oc create secret SECRET_NAME KEYSTORE_FILENAME.jks

      For example, for the kitchensink quickstart, use the following command to create a secret.

      $ oc create secret eap7-app-secret keystore.jks

1. Follow the instructions on Red Hat Customer Portal to create an authentication token using a registry service account.
2. Download the YAML file containing the OpenShift secret for the token. You can download the YAML file from the OpenShift Secret tab on your token’s Token Information page.

3. Create the authentication token secret for your OpenShift project using the YAML file that you downloaded:

   oc create -f 1234567_myserviceaccount-secret.yaml

4. Configure the secret for your OpenShift project using the following commands, replacing the secret name below with the name of your secret created in the previous step.

   oc secrets link default 1234567-myserviceaccount-pull-secret --for=pull
   oc secrets link builder 1234567-myserviceaccount-pull-secret --for=pull

Procedure

1. Create a new OpenShift application that uses the JBoss EAP for OpenShift image and the source code of your Java application. You can use one of the provided JBoss EAP for OpenShift templates for S2I builds. You can also choose to provision a trimmed server.

   For example, to deploy the kitchensink quickstart using the JDK 8 builder image, enter the following command to use the eap73-basic-s2i template in the eap-demo project, created in Prepare OpenShift for Application Deployment, with the kitchensink source code on GitHub. This quickstart does not support the trimming capability.

   oc new-app --template=eap73-basic-s2i \

   1

   
    -p IMAGE_STREAM_NAMESPACE=eap-demo \

   2

   
    -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \

   3

   
    -p SOURCE_REPOSITORY_REF=7.3.x-openshift \

   4

   
    -p CONTEXT_DIR=kitchensink

   5

   1

   The template to use. The eap73 prefix specifies the JDK 8 template.

   2

   The latest imagestreams and templates were imported into the project’s namespace, so you must specify the namespace where to find the imagestream. This is usually the project’s name

   3

   URL to the repository containing the application source code.

   4

   The Git repository reference to use for the source code. This can be a Git branch or tag reference.

   5

   The directory within the source repository to build.

   Note

   Use a modified version of this command for the Eclipse OpenJ9 builder image on IBM Z and IBM Power Systems. Include the following image name parameters in the command. The JDK environment uses default values for these parameters.

   • EAP_IMAGE_NAME=jboss-eap-7-openj9-11-openshift \
   • EAP_RUNTIME_IMAGE_NAME=jboss-eap-7-openj9-11-runtime-openshift \

   As another example, to deploy the helloworld-html5 quickstart using the JDK 11 runtime image and trimming JBoss EAP to include only the jaxrs-server layer, enter the following command. The command uses the eap73-openjdk11-basic-s2i template in the eap-demo project, created in Prepare OpenShift for Application Deployment, with the helloworld-html5 source code on GitHub.

   oc new-app --template=eap73-openjdk11-basic-s2i \

   1

   
    -p IMAGE_STREAM_NAMESPACE=eap-demo \

   2

   
    -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \

   3

   
    -p SOURCE_REPOSITORY_REF=7.3.x-openshift \

   4

   
    -p GALLEON_PROVISION_LAYERS=jaxrs-server \

   5

   
    -p CONTEXT_DIR=helloworld-html5

   6

   1

   The template to use. The eap73-openjdk11 prefix specifies the JDK 11 template.

   2

   The latest imagestreams and templates were imported into the project’s namespace, so you must specify the namespace where to find the imagestream. This is usually the project’s name.

   3

   URL to the repository containing the application source code.

   4

   The Git repository reference to use for the source code. This can be a Git branch or tag reference.

   5

   Provision a trimmed server with only the jaxrs-server layer.

   6

   The directory within the source repository to build.

   Note

   You might also want to configure environment variables when creating your new OpenShift application.

   For example, if you are using an HTTPS template such as eap73-https-s2i, you must specify the required HTTPS environment variables HTTPS_NAME, HTTPS_PASSWORD, and HTTPS_KEYSTORE to match your keystore details.

   Note

   If the template uses AMQ, you must include the AMQ_IMAGE_NAME parameter with the appropriate value.

   If the template uses SSO, you must include the SSO_IMAGE_NAME parameter with the appropriate value.

2. Retrieve the name of the build configuration.

   $ oc get bc -o name

3. Use the name of the build configuration from the previous step to view the Maven progress of the build.

   $ oc logs -f buildconfig/BUILD_CONFIG_NAME

   For example, for the kitchensink quickstart, the following command shows the progress of the Maven build.

   $ oc logs -f buildconfig/eap-app

1. Get the service name of your application using the following command.

   $ oc get service

2. Expose the main service as a route so you can access your application from outside of OpenShift. For example, for the kitchensink quickstart, use the following command to expose the required service and port.

   $ oc expose service/eap-app --port=8080

   Note

   If you used a template to create the application, the route might already exist. If it does, continue on to the next step.

3. Get the URL of the route.

   $ oc get route

4. Access the application in your web browser using the URL. The URL is the value of the HOST/PORT field from previous command’s output.

   If your application does not use the JBoss EAP root context, append the context of the application to the URL. For example, for the kitchensink quickstart, the URL might be http://HOST_PORT_VALUE/kitchensink/.

5. Optionally, you can also scale up the application instance by running the following command. This increases the number of replicas to 3.

   $ oc scale deploymentconfig DEPLOYMENTCONFIG_NAME --replicas=3

   For example, for the kitchensink quickstart, use the following command to scale up the application.

   $ oc scale deploymentconfig eap-app --replicas=3