Red Hat JBoss Web Server for OpenShift

Procedure

1. Follow the instructions on the Red Hat Customer Portal to create an authentication token using a registry service account.
2. On the Token Information page for your token, click the OpenShift Secret tab and download the YAML file that contains the OpenShift secret for the token.

3. Use the YAML file that you have downloaded to create the authentication token secret for your OpenShift project.

   For example:

   oc create -f 1234567_myserviceaccount-secret.yaml

   Copy to Clipboard Toggle word wrap

4. To configure the secret for your OpenShift project, enter the following commands:

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

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding examples, replace 1234567-myserviceaccount with the name of the secret that you created in the previous step.

Procedure

1. Log in to the Red Hat Container Registry by using your Customer Portal credentials. For more information, see Red Hat Container Registry Authentication.

2. Depending on the JDK version that you are using, perform either of the following steps:

   • If you are using OpenJDK 8, enter the following command:

     for resource in \
     jws56-openjdk8-tomcat9-ubi8-basic-s2i.json \
     jws56-openjdk8-tomcat9-ubi8-https-s2i.json \
     jws56-openjdk8-tomcat9-ubi8-image-stream.json
     do
     oc replace -n openshift --force -f \
     https://raw.githubusercontent.com/jboss-container-images/jboss-webserver-5-openshift-image/jws56el8-v5.6.0/templates/${resource}
     done

     Copy to Clipboard Toggle word wrap

     The preceding command imports the UBI8 JDK 8 image stream, jboss-webserver56-openjdk8-tomcat9-openshift-ubi8, and all templates specified in the command.

   • If you are using OpenJDK 11, enter the following command:

     for resource in \
     jws56-openjdk11-tomcat9-ubi8-basic-s2i.json \
     jws56-openjdk11-tomcat9-ubi8-https-s2i.json \
     jws56-openjdk11-tomcat9-ubi8-image-stream.json
     do
     oc replace -n openshift --force -f \
     https://raw.githubusercontent.com/jboss-container-images/jboss-webserver-5-openshift-image/jws56el8-v5.6.0/templates/${resource}
     done

     Copy to Clipboard Toggle word wrap

     The preceding command imports the UBI8 JDK 11 image stream, jboss-webserver56-openjdk11-tomcat9-openshift-ubi8, and all templates specified in the command.

Procedure

1. On your local file system, create a source directory for the binary build and a deployments subdirectory.

   For example, to create a /ocp source directory and a /deployments subdirectory for the tomcat-websocket-chat application, enter the following commands:

   $ cd openshift-quickstarts/tomcat-websocket-chat/
   $ mkdir -p ocp/deployments

   Copy to Clipboard Toggle word wrap
   Note

   The source directory can contain any content required by your application that is not included in the Maven binary. For more information, see JWS for OpenShift S2I process.

2. Copy the .war,.ear, or .jar binary files to the deployments subdirectory.

   For example, to copy the .war file for the example tomcat-websocket-chat application, enter the following command:

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

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, target/websocket-chat.war is the path to the binary file you want to copy.

   Application archives in the deployments subdirectory of the source directory are copied to the $JWS_HOME/tomcat/webapps/ directory of the image that is being built on OpenShift. To allow the application to be deployed successfully, you must ensure that the directory hierarchy that contains the web application data is structured correctly. For more information, see JWS for OpenShift S2I process.

3. Log in to the OpenShift instance:

   $ oc login <url>

   Copy to Clipboard Toggle word wrap

4. Create a new project if required.

   For example:

   $ oc new-project jws-bin-demo

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, jws-bin-demo is the name of the project you want to create.

5. Identify the JWS for OpenShift image stream to use for your application:

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

   Copy to Clipboard Toggle word wrap

   The preceding command produces the following type of output:

   jboss-webserver56-openjdk8-tomcat9-openshift-ubi8

   Copy to Clipboard Toggle word wrap
   Note

   The -n openshift option specifies the project to use. The oc get is -n openshift command gets the image stream resources from the openshift project.

6. Create the new build configuration, and ensure that you specify the image stream and application name.

   For example, to create the new build configuration for the example tomcat-websocket-chat application:

   $ oc new-build --binary=true \
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8:latest\*
    --name=jws-wsch-app

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, jws-wsch-app is the name of the JWS for OpenShift application.

   The preceding command produces the following type of output:

   --> Found image 8c3b85b (4 weeks old) in image stream "openshift/jboss-webserver56-tomcat9-openshift" under tag "latest" for "jboss-webserver56"
   
       JBoss Web Server 5.6
       --------------------
       Platform for building and running web applications on JBoss Web Server 5.6 - 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

   Copy to Clipboard Toggle word wrap

7. Start the binary build.

   For example:

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

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, jws-wsch-app is the name of the JWS for OpenShift application, and ocp is the name of the source directory.

   The preceding command instructs OpenShift to use the source directory that you have created for binary input of the OpenShift image build.

   The preceding command produces the following type of output:

   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.6/tomcat/webapps` for later deployment...
   '/home/jboss/source/deployments/websocket-chat.war' -> '/opt/jws-5.6/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

   Copy to Clipboard Toggle word wrap

8. Create a new OpenShift application based on the image:

   For example:

   $ oc new-app jws-wsch-app

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, jws-wsch-app is the name of the JWS for OpenShift application.

   The preceding command produces the following type of output:

   --> 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.6
       --------------------
       Platform for building and running web applications on JBoss Web Server 5.6 - 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.

   Copy to Clipboard Toggle word wrap

9. Expose the service to make the application accessible to users:

   For example, to make the example jws-wsch-app application accessible, perform the following steps:

   1. Check the name of the service to expose:

      $ oc get svc -o name

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      service/jws-wsch-app

      Copy to Clipboard Toggle word wrap

   2. Expose the service:

      $ oc expose svc/jws-wsch-app

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      route "jws-wsch-app" exposed

      Copy to Clipboard Toggle word wrap

10. Retrieve the address of the exposed route:

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

    Copy to Clipboard Toggle word wrap

11. Open a web browser and enter the URL to access the application.

    For example, to access the example jws-wsch-app application, enter the following URL:

    \http://<address_of_exposed_route>/websocket-chat

    Note

    In the preceding example, replace <address_of_exposed_route> with the appropriate value for your deployment.

Procedure

1. Log in to the OpenShift instance:

   $ oc login <url>

   Copy to Clipboard Toggle word wrap

2. Create a new project if required:

   $ oc new-project <project-name>

   Copy to Clipboard Toggle word wrap
   Note

   In the preceding example, replace <project-name> with the name of the project you want to create.

3. Identify the JWS for OpenShift image stream to use for your application:

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

   Copy to Clipboard Toggle word wrap

   The preceding command produces the following type of output:

   jboss-webserver56-openjdk8-tomcat9-openshift-ubi8

   Copy to Clipboard Toggle word wrap
   Note

   The -n openshift option specifies the project to use. The oc get is -n openshift command gets the image stream resources from the openshift project.

4. Create the new OpenShift application from source code by using Red Hat JBoss Web Server for OpenShift images:

   $ oc new-app \
    _<source_code_location>_\
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8\
    --name=_<openshift_application_name>_

   Copy to Clipboard Toggle word wrap

   For example:

   $ oc new-app \
    \https://github.com/jboss-openshift/openshift-quickstarts.git#main \
    --image-stream=jboss-webserver56-openjdk8-tomcat9-openshift-ubi8\
    --context-dir='tomcat-websocket-chat' \
    --name=jws-wsch-app

   Copy to Clipboard Toggle word wrap

   The preceding command adds the source code to the image and compiles the source code. The preceding command also creates the build configuration and services.

5. To expose the application, perform the following steps:

   1. To check the name of the service to expose:

      $ oc get svc -o name

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      service/<openshift_application_name>

      Copy to Clipboard Toggle word wrap

   2. To expose the service:

      $ oc expose svc/<openshift_application_name>

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following type of output:

      route "<openshift_application_name>" exposed

      Copy to Clipboard Toggle word wrap

6. To retrieve the address of the exposed route:

   oc get routes --no-headers -o custom-columns='host:spec.host' <openshift_application_name>

   Copy to Clipboard Toggle word wrap

7. Open a web browser and enter the following URL to access the application:

   \http://<address_of_exposed_route>/<java_application_name>

   Note

   In the preceding example, replace <address_of_exposed_route> and <java_application_name> with appropriate values for your deployment.

Procedure

1. Start the image in Docker:

   docker run --network host -i -t -p 8080:8080 ImageURL

   Copy to Clipboard Toggle word wrap

2. Find the CONTAINER ID:

    docker ps | grep <ImageName>

   Copy to Clipboard Toggle word wrap

3. Copy the library to the tomcat/lib/ directory:

   docker cp <yourLibrary> <CONTAINER ID>:/opt/jws-5.6/tomcat/lib/

   Copy to Clipboard Toggle word wrap

4. Commit the changes to a new image:

   docker commit <CONTAINER ID> <NEW IMAGE NAME>

   Copy to Clipboard Toggle word wrap

5. Create a new image tag:

   docker tag <NEW IMAGE NAME>:latest <NEW IMAGE REGISTRY URL>:_<TAG>_

   Copy to Clipboard Toggle word wrap

6. Push the image to a registry:

   docker push <NEW IMAGE REGISTRY URL>

   Copy to Clipboard Toggle word wrap

Procedure

1. In your project namespace, create an image stream by using the oc import-image command to import the tag and other information for an image.

   For example:

   oc import-image <my-image>-imagestream:latest \
   --from=quay.io/$user/<my-image>:latest \
   --confirm

   Copy to Clipboard Toggle word wrap

   In the preceding example, replace each occurrence of <my-image> with the name of the image that you want to import.

   The preceding command creates an image stream named <my-image>-imagestream by importing information for the quay.io/$user/<my-image> image. For more information about the format and management of image streams, see Managing image streams.

2. Create a custom resource of the WebServer kind for the web application that you want the JWS Operator to deploy whenever the image stream is updated. You can define the custom resource in YAML file format.

   For example:

   apiVersion: web.servers.org/v1alpha1
   kind: WebServer
   metadata:
     name: <my-image>
   spec:
     # Add fields here
     applicationName: my-app
     useSessionClustering: true
     replicas: 2
     webImageStream:
       imageStreamNamespace: <project-name>
       imageStreamName: <my-image>-imagestream

   Copy to Clipboard Toggle word wrap

3. Trigger an update to the image stream by using the oc tag command.

   For example:

   oc tag quay.io/$user/<my-image> <my-image>-imagestream:latest --scheduled

   Copy to Clipboard Toggle word wrap

   The preceding command causes OpenShift Container Platform to update the specified image stream tag periodically. This period is a cluster-wide setting that is set to 15 minutes by default.

Procedure

1. Prepare your image and push it to the location where you want to display the image (for example, quay.io/<USERNAME>/tomcat-demo:latest).

2. To create a YAML file for a Custom Resource web server, perform the following steps:

   1. Create a file named, for example, webservers_cr.yaml.

   2. Enter details in the following format:

      apiVersion: web.servers.org/v1alpha1
      kind: WebServer
      metadata:
          name: example-image-webserver
      spec:
          # Add fields here
          applicationName: jws-app
          replicas: 2
      webImage:
         applicationImage: quay.io/<USERNAME>/tomcat-demo:latest

      Copy to Clipboard Toggle word wrap

3. To deploy your web application, perform the following steps:

   1. Go to the directory where you have created the web application.

   2. Enter the following command:

      $ oc apply -f webservers_cr.yaml

      Copy to Clipboard Toggle word wrap

      The preceding command produces the following output:

      webserver/example-image-webserver created

      Copy to Clipboard Toggle word wrap
      Note

      The Operator creates a route automatically.

4. Verify the route that the Operator creates:

   $ oc get routes

   Copy to Clipboard Toggle word wrap

5. Optional: Delete the webserver that you created in the preceding step:

   $ oc delete webserver example-image-webserver

   Copy to Clipboard Toggle word wrap
   Note

   Alternatively, you can delete the webserver by deleting the YAML file. For example:

   oc delete -f webservers_cr.yaml