Data Grid for OpenShift

Verify the token is added to the Docker configuration file.

$ cat ~/.docker/config.json
...
"registry.redhat.io": {
			"auth": "MTEwMDkx..."
		}

On your master host(s), log in as a cluster administrator or a user with project administrator access to the openshift namespace.

$ oc login -u system:admin

Import a specific template or all templates.

Verify the templates are available on OpenShift.

$ oc get templates -n openshift | grep datagrid72

Set openshift.KUBE_PING as the value for the JGROUPS_PING_PROTOCOL environment variable.

JGROUPS_PING_PROTOCOL=openshift.KUBE_PING

Specify the OpenShift project name as the value for the OPENSHIFT_KUBE_PING_NAMESPACE environment variable. If you do not set this variable, the server behaves like a single-node cluster.

OPENSHIFT_KUBE_PING_NAMESPACE=PROJECT_NAME

Specify the label that is set at the service level as the value for the OPENSHIFT_KUBE_PING_LABELS environment variable. If you do not set this variable, pods outside the application but in the same namespace attempt to join.

OPENSHIFT_KUBE_PING_LABELS=app=APP_NAME

Grant authorization to the service account the pod is running under so that it can access the Kubernetes REST API. You grant this authorization using the OpenShift CLI, as follows:

oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default -n $(oc project -q)

oc policy add-role-to-user view system:serviceaccount:$(oc project -q):eap-service-account -n $(oc project -q)

Ensure port 8888 is defined as a ping port on the pod container, as follows:

ports:
    - containerPort: 8888
      name: ping
      protocol: TCP

Set openshift.DNS_PING as the value for the JGROUPS_PING_PROTOCOL environment variable.

JGROUPS_PING_PROTOCOL=openshift.DNS_PING

Specify the name of the ping service for the cluster as the value for the OPENSHIFT_DNS_PING_SERVICE_NAME environment variable.

OPENSHIFT_DNS_PING_SERVICE_NAME=PING_SERVICE_NAME

Specify the port number where the ping service is exposed as the value for the OPENSHIFT_DNS_PING_SERVICE_PORT environment variable. The default value is 8888.

OPENSHIFT_DNS_PING_SERVICE_PORT=PING_PORT

Define a ping service that exposes the ping port, as in the following example:

apiVersion: v1
kind: Service
spec:
  clusterIP: None
  ports:
    - name: ping
      port: 8888
      protocol: TCP
      targetPort: 8888
  selector: deploymentConfig=datagrid-app
metadata:
  annotations:
    description: The JGroups ping port for clustering.
    service.alpha.kubernetes.io/tolerate-unready-endpoints: 'true'

Create a JKS keystore (.jks) to encrypt traffic.

You can use OpenSSL and the Java keytool to generate a JKS keystore. When you generate a TLS certificate for the keystore, specify the domain name for the deployment.

Deploy the JKS keystore to OpenShift as a secret.

Configure your deployment to use the JKS keystore with these environment variables:

Specify the CUSTOM_INSTALL_DIRECTORIES environment variable in the image template JSON. This variable defines the location where S2I artifacts reside, as in the following example:

{
    "name": "CUSTOM_INSTALL_DIRECTORIES",
    "value": "extensions/*"
}

Create an install.sh script in that directory. This script installs the modules and drivers for the external datasource in the image.

The following is an example install.sh script:

#!/bin/bash

# Import the common functions for installing modules and configuring drivers
source /usr/local/s2i/install-common.sh

# Directory where this script is located
injected_dir=$1

# Install the modules for the datasource
install_modules ${injected_dir}/modules

# Configure the drivers for the datasource
configure_drivers ${injected_dir}/drivers.properties

Include a modules subdirectory that contains a module.xml file and the driver for the datasource. The resulting image uses the module to load classes and define dependencies.

As an example, you plan to use Derby as an external datasource. You need to obtain a driver such as derby-10.12.1.1.jar and place it in the following directory: modules/org/apache/derby/main/

In the same directory, you also need to create a module.xml file that defines the driver as a resource and declares dependencies.

The following is an example module.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.3" name="org.apache.derby">
 <resources>
   <resource-root path="derby-10.12.1.1.jar"/>
   <resource-root path="derbyclient-10.12.1.1.jar"/>
 </resources>

 <dependencies>
   <module name="javax.api"/>
   <module name="javax.transaction.api"/>
 </dependencies>
</module>

Define the driver configuration properties in a drivers.property environment variable file.

The following is an example drivers.property file:

#DRIVERS
DRIVERS=DERBY

DERBY_DRIVER_NAME=derby
DERBY_DRIVER_MODULE=org.apache.derby
DERBY_DRIVER_CLASS=org.apache.derby.jdbc.EmbeddedDriver
DERBY_XA_DATASOURCE_CLASS=org.apache.derby.jdbc.EmbeddedXADataSource

After you build and deploy the image, specify environment variables for the datasource.

The following example shows a datasource definition with the DATASOURCES environment variable:

# Set a unique prefix for the datasource
DATASOURCES=ACCOUNTS_DERBY
# Specify other environment variables using the prefix
ACCOUNTS_DERBY_DATABASE=accounts
ACCOUNTS_DERBY_JNDI=java:/accounts-ds
ACCOUNTS_DERBY_DRIVER=derby
ACCOUNTS_DERBY_JTA=true
ACCOUNTS_DERBY_NONXA=false
ACCOUNTS_DERBY_USERNAME=username
ACCOUNTS_DERBY_PASSWORD=password
ACCOUNTS_DERBY_XA_CONNECTION_PROPERTY_DatabaseName=/opt/eap/standalone/data/databases/derby/accounts
# _HOST and _PORT are required but not used
ACCOUNTS_ORACLE_HOST=dummy
ACCOUNTS_ORACLE_PORT=1527

The results of a successful Maven build are copied to JDG_HOME/standalone/deployments. This includes all JAR files from the directory within the source repository specified by $ARTIFACT_DIR environment variable. The default value of $ARTIFACT_DIR is the target directory.

Mount your configuration files, the ConfigMap content, in the following directory:

/opt/datagrid/standalone/configuration/user

At a minimum, this directory must contain standalone.xml to configure JBoss Data Grid. This directory can also contain logging.properties, application-role.properties, and other properties files that are available with the JBoss Data Grid distribution.

Note the following requirements for your custom configuration:

Create a custom template for your JBoss Data Grid for OpenShift deployment.

On your master host(s), log in as a cluster administrator or a user with project administrator access to the openshift namespace.

$ oc login -u system:admin

Import your custom template into the openshift namespace.

$ oc create -n openshift -f path/to/template.yaml

Create a ConfigMap from the directory where your custom configuration resides.

Deploy JBoss Data Grid for OpenShift with your custom configuration.

$ oc new-app user-config

The application name should match the name that you specify in your custom template. The example template uses the name user-config.

When you deploy JBoss Data Grid for OpenShift, the configuration files are copied to the /opt/datagrid/standalone/configuration directory for the application.

Clone the source code.

$ git clone https://github.com/jboss-openshift/openshift-quickstarts.git

Build the datagrid/carmart application.

$ cd openshift-quickstarts/datagrid71/carmart/

$ mvn clean package -Premote-jbossas,openshift
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building JBoss JDG Quickstart: carmart 1.2.0.Final
[INFO] ------------------------------------------------------------------------
...
[INFO] Building war: /tmp/openshift-quickstarts/datagrid/carmart/target/ROOT.war
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.360 s
[INFO] Finished at: 2017-06-27T19:11:46+02:00
[INFO] Final Memory: 34M/310M
[INFO] ------------------------------------------------------------------------

Verify the directory structure on the local file system.

Application archives in the deployments/ subdirectory of the main binary build directory are copied directly to the deployments folder of the image being built on OpenShift. For the application to deploy, the directory hierarchy that contains the web application data must be correctly structured.

However, the carmart application already includes the correct directory structure after building:

$ ls
deployments pom.xml  README.md  README-openshift.md  README-tomcat.md  src  target

$ ls deployments
ROOT.war

Identify the image stream for the EAP 6.4 / EAP 7.1 image.

$ oc get is -n openshift | grep eap | cut -d ' ' -f 1
jboss-eap64-openshift
jboss-eap71-openshift

Create new binary build, specifying image stream and application name.

$ oc new-build --binary=true \
--image-stream=jboss-eap64-openshift:1.8 \
--name=eap-app
--> Found image 8fbf0f7 (2 months old) in image stream "openshift/jboss-eap64-openshift" under tag "latest" for "jboss-eap64-openshift"

    JBoss EAP 6.4
    -------------
    Platform for building and running JavaEE applications on JBoss EAP 6.4

    Tags: builder, javaee, eap, eap6

    * A source build using binary input will be created
      * The resulting image will be pushed to image stream "eap-app:latest"
      * A binary build was created, use 'start-build --from-dir' to trigger a new build

--> Creating resources with label build=eap-app ...
    imagestream "eap-app" created
    buildconfig "eap-app" created
--> Success

Start the binary build. Instruct the oc executable to use the main directory of the binary build from the previous step as the directory that contains binary input for the OpenShift build.

$ oc start-build eap-app --from-dir=deployments/ --follow
Uploading directory "deployments" as binary input for the build ...
build "eap-app-1" started
Receiving source from STDIN as archive ...
Copying all war artifacts from /home/jboss/source/. directory into /opt/eap/standalone/deployments for later deployment...
Copying all ear artifacts from /home/jboss/source/. directory into /opt/eap/standalone/deployments for later deployment...
Copying all rar artifacts from /home/jboss/source/. directory into /opt/eap/standalone/deployments for later deployment...
Copying all jar artifacts from /home/jboss/source/. directory into /opt/eap/standalone/deployments for later deployment...
Copying all war artifacts from /home/jboss/source/deployments directory into /opt/eap/standalone/deployments for later deployment...
'/home/jboss/source/deployments/jboss-carmart.war' -> '/opt/eap/standalone/deployments/jboss-carmart.war'
Copying all ear artifacts from /home/jboss/source/deployments directory into /opt/eap/standalone/deployments for later deployment...
Copying all rar artifacts from /home/jboss/source/deployments directory into /opt/eap/standalone/deployments for later deployment...
Copying all jar artifacts from /home/jboss/source/deployments directory into /opt/eap/standalone/deployments for later deployment...
Pushing image 172.30.82.129:5000/jdg-bin-demo/eap-app:latest ...
Pushed 0/7 layers, 1% complete
Pushed 1/7 layers, 17% complete
Pushed 2/7 layers, 31% complete
Pushed 3/7 layers, 46% complete
Pushed 4/7 layers, 81% complete
Pushed 5/7 layers, 84% complete
Pushed 6/7 layers, 99% complete
Pushed 7/7 layers, 100% complete
Push successful

Create a new OpenShift application based on the build.

$ oc new-app eap-app
--> Found image ee25340 (3 minutes old) in image stream "jdg-bin-demo/eap-app" under tag "latest" for "eap-app"

    jdg-bin-demo/eap-app-1:4bab3f63
    -------------------------------
    Platform for building and running JavaEE applications on JBoss EAP 6.4

    Tags: builder, javaee, eap, eap6

    * This image will be deployed in deployment config "eap-app"
    * Ports 8080/tcp, 8443/tcp, 8778/tcp will be load balanced by service "eap-app"
      * Other containers can access this service through the hostname "eap-app"

--> Creating resources ...
    deploymentconfig "eap-app" created
    service "eap-app" created
--> Success
    Run 'oc status' to view your app.

Expose the service as route.

$ oc get svc -o name
service/carcache
service/eap-app

$ oc get route
No resources found.

$ oc expose svc/eap-app
route "eap-app" exposed

$ oc get route
NAME      HOST/PORT                                    PATH      SERVICES   PORT       TERMINATION   WILDCARD
eap-app   eap-app-jdg-bin-demo.openshift.example.com             eap-app    8080-tcp                 None

Access the application.

Access the CarMart application in your browser using the URL http://eap-app-jdg-bin-demo.openshift.example.com/. You can view and remove existing cars from the Home tab or add new cars from the New car tab.

Identify the name of the build configuration to apply MAVEN_MIRROR_URL variable against:

oc get bc -o name
buildconfig/jdg

Update build configuration of jdg with a MAVEN_MIRROR_URL environment variable

oc env bc/jdg MAVEN_MIRROR_URL="http://10.0.0.1:8080/repository/internal/"
buildconfig "jdg" updated

Verify the setting

oc env bc/jdg --list
# buildconfigs jdg
MAVEN_MIRROR_URL=http://10.0.0.1:8080/repository/internal/