Chapter 8. EAP Operator for Automating Application Deployment on OpenShift

Procedure

1. Import EAP images in OpenShift. For more information, see Importing the latest OpenShift image streams and templates for JBoss EAP XP.
2. Configure the imagestream to receive updates about the changes in the application imagestream and to trigger new builds. For more information, see Configuring periodic importing of imagestreamtags.

3. Create the eap-s2i-build template for building the application image using EAP S2I images:

   $ oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/master/eap-s2i-build.yaml

   This eap-s2i-build template creates two build configurations and two imagestreams corresponding to the intermediate build artifacts and the final application image.

4. Process the eap-s2i-build template with parameters to create the resources for the final application image. The following example creates an application image, my-app:

   $ oc process eap-s2i-build \
     -p APPLICATION_IMAGE=my-app \ 1
     \
     -p EAP_IMAGE=jboss-eap-xp1-openjdk11-openshift:1.0 \ 2
     -p EAP_RUNTIME_IMAGE=jboss-eap-xp1-openjdk11-runtime-openshift:1.0 \ 3
     -p EAP_IMAGESTREAM_NAMESPACE=$(oc project -q) \ 4
     \
     -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts.git \ 5
     -p SOURCE_REPOSITORY_REF=xp-1.0.x \ 6
     -p CONTEXT_DIR=microprofile-config | oc create -f - 7

   1

   The name for the application imagestream. The application image is tagged with the latest tag.

   2

   The imagestreamtag for EAP builder image.

   3

   The imagestreamtag for EAP runtime image.

   4

   The namespace in which the imagestreams for Red Hat Middleware images are installed. If omitted, the openshift namespace is used. Modify this only if you have installed the imagestreams in a namespace other than openshift.

   5

   The Git source URL of your application.

   6

   The Git branch or tag reference

   7

   The path within the Git repository that contains the application to build.

5. Prepare the application image for deployment using the EAP operator.

   1. Configure the WildFlyServer resource:

      $ cat > my-app.yaml<<EOF
      
      apiVersion: wildfly.org/v1alpha1
      kind: WildFlyServer
      metadata:
        name: my-app
      spec:
       applicationImage: 'my-app:latest'
       replicas: 1
      EOF

   2. Apply the settings and let the EAP operator create a new WildFlyServer resource that references this application image:

      $ oc apply -f my-app.yaml

   3. View the WildFlyServer resource with the following command:

      $ oc get wfly my-app

      Additional resources

      • For more information about importing an application imagestream, see Importing the latest OpenShift image streams and templates for JBoss EAP XP.
      • For more information about periodic importing of imagestreams, see Configuring periodic importing of imagestreamtags.

Procedure

1. Open your web browser and log on to OperatorHub.
2. Select the Project or namespace you want to use for your Java application.
3. Navigate to Installed Operator and select JBoss EAP operator.
4. On the Overview tab, click the Create Instance link.

5. Specify the application image details.

   The application image specifies the Docker image that contains the Java application. If the applicationImage field corresponds to an imagestreamtag, any change to the image triggers an automatic upgrade of the application.

   You can provide any of the references of the JBoss EAP for OpenShift application image as shown in the following example:

   • The name of the image: mycomp/myapp
   • A tag: mycomp/myapp:1.0
   • A digest: mycomp/myapp:@sha256:0af38bc38be93116b6a1d86a9c78bd14cd527121970899d719baf78e5dc7bfd2
   • An imagestreamtag: my-app:latest
   • An image hash: quay.io/bootable-jar/myapp@sha256:47c06c96e80d0defb777686cdb468c636d9b3b7081a35b784330a050a403e15b

6. Specify the size of the application. For example:

   spec:
     replicas:2

   • Optional: If you used the bootable JAR for packaging the application, indicate so as shown in the following example:

     spec:
       bootableJar: true

7. Configure the application environment using the env spec. The environment variables can come directly from values, such as POSTGRESQL_SERVICE_HOST or from Secret objects, such as POSTGRESQL_USER. For example:

   spec:
     env:
     - name: POSTGRESQL_SERVICE_HOST
       value: postgresql
     - name: POSTGRESQL_SERVICE_PORT
       value: '5432'
     - name: POSTGRESQL_DATABASE
       valueFrom:
         secretKeyRef:
           key: database-name
           name: postgresql
     - name: POSTGRESQL_USER
       valueFrom:
         secretKeyRef:
           key: database-user
           name: postgresql
     - name: POSTGRESQL_PASSWORD
       valueFrom:
         secretKeyRef:
           key: database-password
           name: postgresql

   Additional resources

   • For more information about completing the optional configurations while deploying your Java application on OpenShift, see Deploying a Java application using the EAP operator: Completing the optional configurations.
   • For more information about building your application image with eap-s2i-build template, see Building an application image using eap-s2i-build template.
   • For more information about packaging your application image as a bootable JAR, see Using a bootable JAR on a JBoss EAP OpenShift platform.
   • For a list of environment variables, see Environment Variables.

Procedure

1. Specify volumeClaimTemplate to configure resources requirements to store the JBoss EAP standalone data directory. The name of the template is derived from the name of JBoss EAP. The corresponding volume is mounted in ReadWriteOnce access mode.

   spec:
     storage:
       volumeClaimTemplate:
         spec:
           resources:
             requests:
               storage: 3Gi

   The persistent volume that meets this storage requirement is mounted on the /eap/standalone/data directory.

Procedure

1. Access your JBoss EAP instance using CLI.
2. Resolve all the heuristics transaction records in the transaction object store. For more information, see Recovering Heuristic Outcomes in the Managing Transactions on JBoss EAP.

3. Remove all records from the EJB client recovery folder.

   1. Remove all files from the pod EJB client recovery directory:

      $JBOSS_HOME/standalone/data/ejb-xa-recovery
      oc exec <podname> rm -rf $JBOSS_HOME/standalone/data/ejb-xa-recovery

4. The status of your pod changes to SCALING_DOWN_CLEAN and the pod is terminated.

Procedure

1. Create a user in the target server with permission to receive the EJB remote calls:

   $JBOSS_HOME/bin/add-user.sh

2. Configure the caller JBoss EAP application server.

   1. Create the eap-config.xml file in $JBOSS_HOME/standalone/configuration using the custom configuration functionality. For more information, see Custom Configuration.

   2. Configure the caller JBoss EAP application server with the wildfly.config.url property:

      JAVA_OPTS_APPEND="-Dwildfly.config.url=$JBOSS_HOME/standalone/configuration/eap-config.xml"

      Note

      If you use the following example for your configuration, replace the >>PASTE_…​_HERE<< with user and password you configured.

      Example Configuration

      <configuration>
        <authentication-client xmlns="urn:elytron:1.0">
        <authentication-rules>
                <rule use-configuration="jta">
                    <match-abstract-type name="jta" authority="jboss"/>
            </rule>
            </authentication-rules>
            <authentication-configurations>
             <configuration name="jta">
                     <sasl-mechanism-selector selector="DIGEST-MD5"/>
                     <providers>
                         <use-service-loader />
                 </providers>
             <set-user-name name=">>PASTE_USER_NAME_HERE<<"/>
                 <credentials>
                          <clear-password password=">>PASTE_PASSWORD_HERE<<"/>
                 </credentials>
                     <set-mechanism-realm name="ApplicationRealm" />
                 </configuration>
            </authentication-configurations>
        </authentication-client>
      </configuration>