Chapter 2. Getting started with Red Hat JBoss Web Server for OpenShift
You can import the latest Red Hat JBoss Web Server for OpenShift image streams and templates from the Red Hat container registry. You can subsequently use the JWS for OpenShift Source-to-Image (S2I) process to create JBoss Web Server for OpenShift applications by using existing maven binaries or from source code.
Before you follow the instructions in this document, you must ensure that an OpenShift cluster is already installed and configured as a prerequisite. For more information about installing and configuring OpenShift clusters, see the OpenShift Container Platform Installing guide.
The JWS for OpenShift application templates are distributed for Tomcat 9.
2.1. Configuring an authentication token for the Red Hat Container Registry
Before you can import and use a Red Hat JBoss Web Server for OpenShift image, you must first ensure that you have configured an authentication token to access the Red Hat Container Registry.
You can create an authentication token by using a registry service account. This means that you do not have to use or store your Red Hat account username and password in your OpenShift configuration.
Procedure
- Follow the instructions on the Red Hat Customer Portal to create an authentication token using a registry service account.
- 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.
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
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
NoteIn the preceding examples, replace
1234567-myserviceaccount
with the name of the secret that you created in the previous step.
Additional resources
2.2. Importing JBoss Web Server image streams and templates
You can import Red Hat JBoss Web Server for OpenShift image streams and templates from the Red Hat Container Registry. You must import the latest JBoss Web Server image streams and templates for your JDK into the namespace of your OpenShift project.
Prerequisites
Procedure
- Log in to the Red Hat Container Registry by using your Customer Portal credentials. For more information, see Red Hat Container Registry Authentication.
Depending on the JDK version that you are using, perform one of the following steps:
OpenJDK 8
If you are using OpenJDK 8, enter the following command:
for resource in \ jws57-openjdk8-tomcat9-ubi8-basic-s2i.json \ jws57-openjdk8-tomcat9-ubi8-https-s2i.json \ jws57-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/jws57el8-v5.7.8/templates/${resource} done
The preceding command imports the UBI8 JDK 8 image stream,
jboss-webserver57-openjdk8-tomcat9-openshift-ubi8
, and all templates specified in the command.OpenJDK 11
If you are using OpenJDK 11, enter the following command:
for resource in \ jws57-openjdk11-tomcat9-ubi8-basic-s2i.json \ jws57-openjdk11-tomcat9-ubi8-https-s2i.json \ jws57-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/jws57el8-v5.7.8/templates/${resource} done
The preceding command imports the UBI8 JDK 11 image stream,
jboss-webserver57-openjdk11-tomcat9-openshift-ubi8
, and all templates specified in the command.OpenJDK 17
If you are using OpenJDK 17, enter the following command:
for resource in \ jws57-openjdk17-tomcat9-ubi8-basic-s2i.json \ jws57-openjdk17-tomcat9-ubi8-https-s2i.json \ jws57-openjdk17-tomcat9-ubi8-image-stream.json do oc replace -n openshift --force -f \ https://raw.githubusercontent.com/jboss-container-images/jboss-webserver-5-openshift-image/jws57el8-v5.7.8/templates/${resource} done
The preceding command imports the UBI8 JDK 17 image stream,
jboss-webserver57-openjdk17-tomcat9-openshift-ubi8
, and all templates specified in the command.
In the preceding commands, ensure that you specify the latest release of JBoss Web Server 5.7 that you want to import (for example, 5.7.8).
2.3. Importing the latest JWS for OpenShift image
You can import the latest available JWS for OpenShift image by using the import-image
command. Red Hat provides separate JWS for OpenShift images for OpenJDK 8, OpenJDK 11, and OpenJDK 17.
Prerequisites
- You are logged in to the Red Hat Container Registry.
- You have imported image streams and templates.
Procedure
Depending on the JDK version that you are using, perform one of the following steps:
To update the core JBoss Web Server 5.7 tomcat 9 with OpenJDK 8 OpenShift image, enter the following command:
$ oc -n openshift import-image \ jboss-webserver57-openjdk8-tomcat9-openshift-ubi8:5.7.8
To update the core JBoss Web Server 5.7 tomcat 9 with OpenJDK 11 OpenShift image, enter the following command:
$ oc -n openshift import-image \ jboss-webserver57-openjdk11-tomcat9-openshift-ubi8:5.7.8
To update the core JBoss Web Server 5.7 tomcat 9 with OpenJDK 17 OpenShift image, enter the following command:
$ oc -n openshift import-image \ jboss-webserver57-openjdk17-tomcat9-openshift-ubi8:5.7.8
The 5.7.8
tag at the end of each image you import refers to the stream version that is set in the image stream.
2.4. JWS for OpenShift S2I process
You can run and configure the JWS for OpenShift images by using the OpenShift source-to-image (S2I) process with the application template parameters and environment variables.
The S2I process for the JWS for OpenShift images works as follows:
-
If the
configuration
source directory contains a Mavensettings.xml
file, thesettings.xml
file is moved to the$HOME/.m2/
directory of the new image. If the source repository contains a
pom.xml
file, a Maven build is triggered using the contents of the$MAVEN_ARGS
environment variable.By default, the
package
goal is used with theopenshift
profile, which includes the-DskipTests
argument to skip tests, and the-Dcom.redhat.xpaas.repo.redhatga
argument to enable the Red Hat GA repository.The results of a successful Maven build are copied to the
/opt/jws-5.7/tomcat/webapps
directory. This includes all WAR files from the source directory that is specified by the$ARTIFACT_DIR
environment variable. The default value of$ARTIFACT_DIR
is thetarget/
directory.You can use the
$MAVEN_ARGS_APPEND
environment variable to modify the Maven arguments.-
All WAR files from the
deployments
source directory are copied to the/opt/jws-5.7/tomcat/webapps
directory. -
All files in the
configuration
source directory are copied to the/opt/jws-5.7/tomcat/conf/
directory, excluding the Maven settings.xml file. All files in the
lib
source directory are copied to the/opt/jws-5.7/tomcat/lib/
directory.NoteIf you want to use custom Tomcat configuration files, use the same file names that are used for a normal Tomcat installation such as
context.xml
andserver.xml
.
For more information about configuring the S2I process to use a custom Maven artifacts repository mirror, see Maven artifact repository mirrors and JWS for OpenShift.
Additional resources
2.5. Creating a JWS for OpenShift application by using existing Maven binaries
You can create a JWS for OpenShift application by using existing Maven binaries. You can use the oc start-build
command to deploy existing applications on OpenShift.
This procedure shows how to create an example application that is based on the tomcat-websocket-chat quickstart example.
Prerequisites
You have an existing
.war
,.ear
, or.jar
file for the application that you want to deploy on JWS for OpenShift or you have built the application locally.For example, to build the
tomcat-websocket-chat
application locally, perform the following steps:To clone the source code, enter the following command:
$ git clone https://github.com/web-servers/tomcat-websocket-chat-quickstart.git
Configure the Red Hat JBoss Middleware Maven repository, as described in Configure the Red Hat JBoss Middleware Maven Repository.
For more information about the Maven repository, see the Red Hat JBoss Enerprise Maven Repository web page.
To build the application, enter the following commands:
$ cd tomcat-websocket-chat-quickstart/tomcat-websocket-chat/ $ mvn clean package
The preceding command produces the following output:
[INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building Tomcat websocket example 1.2.0.Final [INFO] ------------------------------------------------------------------------ ... [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 01:28 min [INFO] Finished at: 2018-01-16T15:59:16+10:00 [INFO] Final Memory: 19M/271M [INFO] ------------------------------------------------------------------------
Procedure
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 thetomcat-websocket-chat
application, enter the following commands:$ cd tomcat-websocket-chat-quickstart/tomcat-websocket-chat/ $ mkdir -p ocp/deployments
NoteThe 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.
Copy the
.war
,.ear
, or.jar
binary files to thedeployments
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/
NoteIn 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.Log in to the OpenShift instance:
$ oc login <url>
Create a new project if required.
For example:
$ oc new-project jws-bin-demo
NoteIn the preceding example,
jws-bin-demo
is the name of the project you want to create.Identify the JWS for OpenShift image stream to use for your application:
$ oc get is -n openshift | grep ^jboss-webserver | cut -f1 -d ' '
The preceding command produces the following type of output:
jboss-webserver57-openjdk8-tomcat9-openshift-ubi8
NoteThe
-n openshift
option specifies the project to use. Theoc get is -n openshift
command gets the image stream resources from theopenshift
project.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-webserver57-openjdk8-tomcat9-openshift-ubi8:latest \ --name=jws-wsch-app
NoteIn 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-webserver57-tomcat9-openshift" under tag "latest" for "jboss-webserver57" JBoss Web Server 5.7 -------------------- Platform for building and running web applications on JBoss Web Server 5.7 - 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.
For example:
$ oc start-build jws-wsch-app --from-dir=./ocp --follow
NoteIn the preceding example,
jws-wsch-app
is the name of the JWS for OpenShift application, andocp
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.7/tomcat/webapps` for later deployment... '/home/jboss/source/deployments/websocket-chat.war' -> '/opt/jws-5.7/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:
For example:
$ oc new-app jws-wsch-app
NoteIn 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.7 -------------------- Platform for building and running web applications on JBoss Web Server 5.7 - 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:
For example, to make the example
jws-wsch-app
application accessible, perform the following steps:Check the name of the service to expose:
$ oc get svc -o name
The preceding command produces the following type of output:
service/jws-wsch-app
Expose the service:
$ oc expose svc/jws-wsch-app
The preceding command produces the following type of output:
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
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
NoteIn the preceding example, replace
<address_of_exposed_route>
with the appropriate value for your deployment.
Additional resources
-
oc start-build
command
2.6. Creating a JWS for OpenShift application from source code
You can create a JWS for OpenShift application from source code.
For detailed information about creating new OpenShift applications from source code, see OpenShift.com - Creating an application from source code.
Prerequisites
- The application data is structured correctly. For more information, see JWS for OpenShift S2I process.
Procedure
Log in to the OpenShift instance:
$ oc login <url>
Create a new project if required:
$ oc new-project <project-name>
NoteIn the preceding example, replace
<project-name>
with the name of the project you want to create.Identify the JWS for OpenShift image stream to use for your application:
$ oc get is -n openshift | grep ^jboss-webserver | cut -f1 -d ' '
The preceding command produces the following type of output:
jboss-webserver57-openjdk8-tomcat9-openshift-ubi8
NoteThe
-n openshift
option specifies the project to use. Theoc get is -n openshift
command gets the image stream resources from theopenshift
project.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-webserver57-openjdk8-tomcat9-openshift-ubi8:latest \ --name=<openshift_application_name>
For example:
$ oc new-app \ https://github.com/web-servers/tomcat-websocket-chat-quickstart.git#main \ --image-stream=jboss-webserver57-openjdk8-tomcat9-openshift-ubi8:latest \ --context-dir='tomcat-websocket-chat' \ --name=jws-wsch-app
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.
To expose the application, perform the following steps:
To check the name of the service to expose:
$ oc get svc -o name
The preceding command produces the following type of output:
service/<openshift_application_name>
To expose the service:
$ oc expose svc/<openshift_application_name>
The preceding command produces the following type of output:
route "<openshift_application_name>" exposed
To retrieve the address of the exposed route:
oc get routes --no-headers -o custom-columns='host:spec.host' <openshift_application_name>
Open a web browser and enter the following URL to access the application:
http://<address_of_exposed_route>/<java_application_name>
NoteIn the preceding example, replace
<address_of_exposed_route>
and<java_application_name>
with appropriate values for your deployment.
2.7. Adding additional JAR files in the tomcat/lib
directory
You can use Docker to add additional Java Archive (JAR) files in the tomcat/lib
directory.
Procedure
Start the image in Docker:
docker run --network host -i -t -p 8080:8080 ImageURL
Find the
CONTAINER ID
:docker ps | grep <ImageName>
Copy the library to the
tomcat/lib/
directory:docker cp <yourLibrary> <CONTAINER ID>:/opt/jws-5.7/tomcat/lib/
Commit the changes to a new image:
docker commit <CONTAINER ID> <NEW IMAGE NAME>
Create a new image tag:
docker tag <NEW IMAGE NAME>:latest <NEW IMAGE REGISTRY URL>:<TAG>
Push the image to a registry:
docker push <NEW IMAGE REGISTRY URL>