Red Hat JBoss Web Server for OpenShift

Get the WAR application archive or build the application locally.

Prepare the directory structure on the local file system.

Create the source directory for the binary build on your local file system and the deployments/ subdirectory. Copy the WAR archive to deployments/:

[tomcat-websocket-chat]$ ls

pom.xml  README.md  src/  target/

$ mkdir -p ocp/deployments

$ cp target/websocket-chat.war ocp/deployments/

Log in to the OpenShift instance:

$ oc login <url>

Create a new project if required:

$ oc new-project jws-bin-demo

Identify the JWS for OpenShift image stream to use for your application with oc get is -n openshift:

$ oc get is -n openshift | grep ^jboss-webserver | cut -f1 -d ' '

jboss-webserver50-tomcat9-openshift

Create new build configuration, specifying image stream and application name:

$ oc new-build --binary=true \
 --image-stream=jboss-webserver<version>-openjdk8-tomcat9-openshift-rhel8:latest\
 --name=jws-wsch-app

--> Found image 8c3b85b (4 weeks old) in image stream "openshift/jboss-webserver<version>-tomcat9-openshift" under tag "latest" for "jboss-webserver<version>"

    JBoss Web Server 5.0
    --------------------
    Platform for building and running web applications on JBoss Web Server 5.0 - Tomcat v9

    Tags: builder, java, tomcat9

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

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

Start the binary build. Instruct OpenShift to use source directory for the binary input for the OpenShift image build:

$ *oc start-build jws-wsch-app --from-dir=./ocp --follow*

Uploading directory "ocp" as binary input for the build ...
build "jws-wsch-app-1" started
Receiving source from STDIN as archive ...

Copying all deployments war artifacts from /home/jboss/source/deployments directory into `/opt/jws-5.5/tomcat/webapps` for later deployment...
'/home/jboss/source/deployments/websocket-chat.war' -> '/opt/jws-5.5/tomcat/webapps/websocket-chat.war'

Pushing image 172.30.202.111:5000/jws-bin-demo/jws-wsch-app:latest ...
Pushed 0/7 layers, 7% complete
Pushed 1/7 layers, 14% complete
Pushed 2/7 layers, 29% complete
Pushed 3/7 layers, 49% complete
Pushed 4/7 layers, 62% complete
Pushed 5/7 layers, 92% complete
Pushed 6/7 layers, 100% complete
Pushed 7/7 layers, 100% complete
Push successful

Create a new OpenShift application based on the image:

$ oc new-app jws-wsch-app

--> Found image e5f3a6b (About a minute old) in image stream "jws-bin-demo/jws-wsch-app" under tag "latest" for "jws-wsch-app"

    JBoss Web Server 5.0
    --------------------
    Platform for building and running web applications on JBoss Web Server 5.0 - Tomcat v9

    Tags: builder, java, tomcat9

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

--> Creating resources ...
    deploymentconfig "jws-wsch-app" created
    service "jws-wsch-app" created
--> Success
    Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
     'oc expose svc/jws-wsch-app'
    Run 'oc status' to view your app.

Expose the service to make the application accessible to users:

# to check the name of the service to expose
$ oc get svc -o name

service/jws-wsch-app

# to expose the service
$ oc expose svc/jws-wsch-app

route "jws-wsch-app" exposed

Retrieve the address of the exposed route:

oc get routes --no-headers -o custom-columns='host:spec.host' jws-wsch-app

You are now able to set up the operator installation. You will specify the following 3 options:

Inspect the JWS operator to verify its supported installModes and available channels using the following commands:

$   oc get packagemanifests -n openshift-marketplace | grep jws
    jws-operator    Red Hat Operators   16h

$   oc describe packagemanifests jws-operator -n openshift-marketplace | grep "Catalog Source"
    Catalog Source:     redhat-operators

An OperatorGroup is an OLM resource that selects target namespaces in which to generate required RBAC access for all Operators in the same namespace as the OperatorGroup.

The namespace to which you subscribe the Operator must have an OperatorGroup that matches the InstallMode of the Operator, either the AllNamespaces or SingleNamespace mode. If the Operator you intend to install uses the AllNamespaces, then the openshift-operators namespace already has an appropriate OperatorGroup in place.

However, if the Operator uses the SingleNamespace mode, exactly one OperatorGroup has to be created in that namespace. To check actual list of OperatorGroups use the following command:

$ oc get operatorgroups -n <project_name>

Example of an output for OperatorGroup listing:

NAME       AGE
mygroup    17h

Create a subscription object YAML file, for example jws-operator-sub.yaml. Configure your Subscription object YAML file to look as follows:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
    name: jws-operator
    namespace: <project_name>
spec:
    channel: alpha
    name: jws-operator
    source: redhat-operators
    sourceNamespace: openshift-marketplace

<project_name> is the namespace of the project where you install the operator (oc project -q). to install in all namespace use openshift-operators.

The source is the Catalog Source. This is the value from the $ oc describe packagemanifests jws-operator -n openshift-marketplace | grep "Catalog Source:" command we ran in step 1 of this section. The value should be redhat-operators.

Create the Subscription object from the YAML file with the following command:

$   oc apply -f jws-operator-sub.yaml

To verify a successful installation, run the following command:

$   oc get csv -n <project_name>

Check the current version of the subscribed operator in the currentCSV field by using the following command:

$   oc get subscription jws-operator -n <project_name> -o yaml | grep currentCSV
    f:currentCSV: {}
    currentCSV: jws-operator.v1.0.0

Delete the operator’s subscription using the following command:

$   oc delete subscription jws-operator -n <project_name>

Delete the CSV for the operator in the target namespace using the currentCSV value from the previous step, using the following command:

$   oc delete clusterserviceversion <currentCSV> -n <project_name>

where <currentCSV> is the value obtained in step 1

$   oc delete clusterserviceversion jws-operator.v1.0.0
    clusterserviceversion.operators.coreos.com "jws-operator.v1.0.0" deleted