access.redhat.com.... .R. . . .A. . .E

Red Hat Process Automation Manager7.3

Deploying a Red Hat Process AutomationManager immutable server environment on

Red Hat OpenShift Container Platform

Last Updated: 2021-03-29

Red Hat Process Automation Manager 7.3 Deploying a Red Hat ProcessAutomation Manager immutable server environment on Red HatOpenShift Container Platform

Red Hat Customer Content [email protected]

Legal Notice

Copyright © 2021 Red Hat, Inc.

The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United Statesand other countries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.

Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by theofficial Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and othercountries and are used with the OpenStack Foundation's permission. We are not affiliated with,endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Abstract

This document describes how to deploy a Red Hat Process Automation Manager 7.3 immutableserver environment on Red Hat OpenShift Container Platform.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Table of Contents

PREFACE

CHAPTER 1. OVERVIEW OF RED HAT PROCESS AUTOMATION MANAGER ON RED HAT OPENSHIFTCONTAINER PLATFORM

CHAPTER 2. PREPARING TO DEPLOY RED HAT PROCESS AUTOMATION MANAGER IN YOUR OPENSHIFTENVIRONMENT

2.1. ENSURING THE AVAILABILITY OF IMAGE STREAMS AND THE IMAGE REGISTRY2.2. CREATING THE SECRETS FOR PROCESS SERVER2.3. CREATING THE SECRETS FOR BUSINESS CENTRAL2.4. CREATING THE SECRETS FOR SMART ROUTER2.5. CHANGING GLUSTERFS CONFIGURATION2.6. EXTRACTING THE SOURCE CODE FROM BUSINESS CENTRAL FOR USE IN AN S2I BUILD2.7. PREPARING A MAVEN MIRROR REPOSITORY FOR OFFLINE USE

CHAPTER 3. ENVIRONMENT WITH IMMUTABLE SERVERS3.1. DEPLOYING MONITORING AND SMART ROUTER FOR AN ENVIRONMENT WITH IMMUTABLE SERVERS

3.2. DEPLOYING AN IMMUTABLE PROCESS SERVER FROM SERVICE SOURCE CODE3.3. DEPLOYING AN IMMUTABLE PROCESS SERVER FROM KJAR SERVICES3.4. PROVIDING THE LDAP ROLE MAPPING FILE3.5. MODIFYING THE SERVER CONFIGURATION BUILT FROM SOURCE CODE FOR AN IMMUTABLE SERVERENVIRONMENT3.6. BUILDING A CUSTOM PROCESS SERVER IMAGE FOR AN EXTERNAL DATABASE

CHAPTER 4. OPENSHIFT TEMPLATE REFERENCE INFORMATION4.1. RHPAM73-PROD-IMMUTABLE-MONITOR.YAML TEMPLATE

4.1.1. Parameters4.1.2. Objects

4.1.2.1. Services4.1.2.2. Routes4.1.2.3. Deployment Configurations

4.1.2.3.1. Triggers4.1.2.3.2. Replicas4.1.2.3.3. Pod Template

4.1.2.3.3.1. Service Accounts4.1.2.3.3.2. Image4.1.2.3.3.3. Readiness Probe4.1.2.3.3.4. Liveness Probe4.1.2.3.3.5. Exposed Ports4.1.2.3.3.6. Image Environment Variables4.1.2.3.3.7. Volumes

4.1.2.4. External Dependencies4.1.2.4.1. Volume Claims4.1.2.4.2. Secrets

4.2. RHPAM73-PROD-IMMUTABLE-KIESERVER.YAML TEMPLATE4.2.1. Parameters4.2.2. Objects

4.2.2.1. Services4.2.2.2. Routes4.2.2.3. Build Configurations4.2.2.4. Deployment Configurations

4.2.2.4.1. Triggers

5

6

8899

101011

12

13

13172227

2829

32323246464646474747474747484848595959595959777777777878

Table of Contents

1

4.2.2.4.2. Replicas4.2.2.4.3. Pod Template



4.3. RHPAM73-KIESERVER-EXTERNALDB.YAML TEMPLATE4.3.1. Parameters4.3.2. Objects




4.3.2.4. External Dependencies4.3.2.4.1. Secrets

4.4. RHPAM73-KIESERVER-MYSQL.YAML TEMPLATE4.4.1. Parameters4.4.2. Objects





4.5. RHPAM73-KIESERVER-POSTGRESQL.YAML TEMPLATE4.5.1. Parameters4.5.2. Objects

4.5.2.1. Services

7878787979797979929292929292112112112112112113113113113113113113114

128128129129129145145146146146146146146147147147147148160160160161161161177177

Red Hat Process Automation Manager 7.3 Deploying a Red Hat Process Automation Manager immutable server environment on Red Hat OpenShift Container Platform

2

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.5.2.2. Routes4.5.2.3. Deployment Configurations




4.6. OPENSHIFT USAGE QUICK REFERENCE

APPENDIX A. VERSIONING INFORMATION

178178178178178178179179179179180192192193193193

195

Table of Contents

3


4

PREFACEAs a system engineer, you can deploy a Red Hat Process Automation Manager immutable serverenvironment on Red Hat OpenShift Container Platform to provide an infrastructure to execute services,process applications, and other business assets. You can use standard integration tools to manage theimmutable Process Server image. You can create new server images to add and update the businessassets.

Prerequisites

At least four gigabytes of memory must be available in the OpenShift cluster/namespace.

If you do not deploy monitoring infrastructure but only deploy an immutable Process Server,three gigabytes can be sufficient.

The OpenShift project for the deployment must be created.

You must be logged in to the project using the oc command. For more information about the oc command-line tool, see the OpenShift CLI Reference. If you want to use the OpenShift Webconsole to deploy templates, you must also be logged on using the Web console.

Dynamic persistent volume (PV) provisioning must be enabled. Alternatively, if dynamic PVprovisioning is not enabled, enough persistent volumes must be available. By default, thefollowing sizes are required:

Each immutable server deployment includes a replicated set of Process Server pods, which,by default, requires one 1Gi PV for the database. You can change the database PV size inthe template parameters. You can deploy multiple immutable servers; each requires aseparate database PV. This requirement does not apply if you use an external databaseserver.

If you deploy the immutable monitoring template, two 64Mi PVs are also required (one forBusiness Central Monitoring and one for Smart Router).

If you intend to deploy the immutable monitoring template, your OpenShift environmentsupports persistent volumes with ReadWriteMany mode. For information about access modesupport in OpenShift Online volume plug-ins, see Access Modes.

PREFACE

5

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/cli_reference/

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/architecture/#pv-access-modes

CHAPTER 1. OVERVIEW OF RED HAT PROCESS AUTOMATIONMANAGER ON RED HAT OPENSHIFT CONTAINER PLATFORMYou can deploy Red Hat Process Automation Manager into a Red Hat OpenShift Container Platformenvironment.

In this solution, components of Red Hat Process Automation Manager are deployed as separateOpenShift pods. You can scale each of the pods up and down individually, providing as few or as manycontainers as necessary for a particular component. You can use standard OpenShift methods tomanage the pods and balance the load.

The following key components of Red Hat Process Automation Manager are available on OpenShift:

Process Server, also known as Execution Server or KIE Server , is the infrastructure element thatruns decision services, process applications, and other deployable assets (collectively referredto as services) . All logic of the services runs on execution servers.A database server is normally required for Process Server. You can provide a database server inanother OpenShift pod or configure an execution server on OpenShift to use any otherdatabase server. Alternatively, Process Server can use an H2 database; in this case, the podcannot be scaled.

You can freely scale up a Process Server pod, providing as many copies as necessary, running onthe same host or different hosts. As you scale a pod up or down, all its copies use the samedatabase server and run the same services. OpenShift provides load balancing and a requestcan be handled by any of the pods.

You can deploy a separate Process Server pod to run a different group of services. That podcan also be scaled up or down. You can have as many separate replicated Process Server podsas necessary.

Business Central is a web-based interactive environment for authoring services. It also providesa management and monitoring console. You can use Business Central to develop services anddeploy them to Process Servers. You can also use Business Central to monitor the execution ofprocesses.Business Central is a centralized application. However, you can configure it for high availability,where multiple pods run and share the same data.

Business Central includes a Git repository that holds the source for the services that youdevelop on it. It also includes a built-in Maven repository. Depending on configuration, BusinessCentral can place the compiled services (KJAR files) into the built-in Maven repository or (ifconfigured) into an external Maven repository.

IMPORTANT

In the current version, high-availability Business Central functionality is forTechnology Preview only. For more information on Red Hat Technology Previewfeatures, see Technology Preview Features Scope .

Business Central Monitoring is a web-based management and monitoring console. It canmanage deployment of services to Process Servers and provide monitoring information, butdoes not include authoring capabilities. You can use this component to manage staging andproduction environments.

Smart Router is an optional layer between Process Servers and other components that interactwith them. It is required if you want Business Central or Business Central Monitoring to interact


6

https://access.redhat.com/support/offerings/techpreview/

with several different Process Servers. Also, when your environment includes many servicesrunning on different Process Servers, Smart Router provides a single endpoint to all clientapplications. A client application can make a REST API call requiring any service. Smart Routerautomatically determines which Process Server must be called for any particular request.

You can arrange these and other components into various environment configurations within OpenShift.

The following environment types are typical:

Authoring: An environment for creating and modifying services using Business Central. Itconsists of pods that provide Business Central for the authoring work and a Process Server fortest execution of the services. For instructions about deploying this environment, see Deployinga Red Hat Process Automation Manager authoring environment on Red Hat OpenShift ContainerPlatform.

Managed deployment : An environment for running existing services for staging and productionpurposes. This environment includes several groups of Process Server pods; you can deploy andundeploy services on every such group and also scale the group up or down as necessary. UseBusiness Central Monitoring to deploy, run, and stop the services and to monitor their execution.For instructions about deploying this environment, see Deploying a Red Hat Process AutomationManager managed server environment on Red Hat OpenShift Container Platform.

Deployment with immutable servers : An alternate environment for running existing services forstaging and production purposes. In this environment, when you deploy a Process Server pod, itbuilds an image that loads and starts a service or group of services. You cannot stop any serviceon the pod or add any new service to the pod. If you want to use another version of a service ormodify the configuration in any other way, you deploy a new server image and displace the oldone. In this system, the Process Server runs like any other pod on the OpenShift environment;you can use any container-based integration workflows and do not need to use any other toolsto manage the pods. Optionally, you can use Business Central Monitoring to monitor theperformance of the environment and to stop and restart some of the service instances, but notto deploy additional services to any Process Server or undeploy any existing ones (you can notadd or remove containers). For instructions about deploying this environment, see Deploying aRed Hat Process Automation Manager immutable server environment on Red Hat OpenShiftContainer Platform.

You can also deploy a trial or evaluation environment. This environment includes Business Central and aProcess Server. You can set it up quickly and use it to evaluate or demonstrate developing and runningassets. However, the environment does not use any persistent storage, and any work you do in theenvironment is not saved. For instructions about deploying this environment, see Deploying a Red HatProcess Automation Manager trial environment on Red Hat OpenShift Container Platform.

To deploy a Red Hat Process Automation Manager environment on OpenShift, you can use thetemplates that are provided with Red Hat Process Automation Manager. You can modify the templatesto ensure that the configuration suits your environment.

CHAPTER 1. OVERVIEW OF RED HAT PROCESS AUTOMATION MANAGER ON RED HAT OPENSHIFT CONTAINER PLATFORM

7

https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.3/html-single/deploying_a_red_hat_process_automation_manager_authoring_environment_on_red_hat_openshift_container_platform

https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.3/html-single/deploying_a_red_hat_process_automation_manager_managed_server_environment_on_red_hat_openshift_container_platform

https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.3/html-single/deploying_a_red_hat_process_automation_manager_immutable_server_environment_on_red_hat_openshift_container_platform

https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.3/html-single/deploying_a_red_hat_process_automation_manager_trial_environment_on_red_hat_openshift_container_platform

CHAPTER 2. PREPARING TO DEPLOY RED HAT PROCESSAUTOMATION MANAGER IN YOUR OPENSHIFT

ENVIRONMENTBefore deploying Red Hat Process Automation Manager in your OpenShift environment, you need tocomplete several preparatory tasks. You do not need to repeat these tasks if you want to deployadditional images, for example, for new versions of processes or for other processes.

2.1. ENSURING THE AVAILABILITY OF IMAGE STREAMS AND THEIMAGE REGISTRY

To deploy Red Hat Process Automation Manager components on Red Hat OpenShift ContainerPlatform, you must ensure that OpenShift can download the correct images from the Red Hat registry.To download the images, OpenShift requires the information about their location (known as imagestreams). OpenShift also must be configured to authenticate with the Red Hat registry using yourservice account user name and password.

Some versions of the OpenShift environment include the required image streams. You must check ifthey are available. If image streams are available in OpenShift by default, you can use them if theOpenShift infrastructure is configured for registry authentication server. The administrator mustcomplete the registry authentication configuration when installing the OpenShift environment.

Otherwise, you can configure registry authentication in your own project and install the image streamsin the same project.

Procedure

1. Determine whether Red Hat OpenShift Container Platform is configured with the user nameand password for Red Hat registry access. For details about the required configuration, seeConfiguring a Registry Location . If you are using an OpenShift Online subscription, it isconfigured for Red Hat registry access.

2. If Red Hat OpenShift Container Platform is configured with the user name and password forRed Hat registry access, run the following commands:

$ oc get imagestreamtag -n openshift | grep rhpam73-businesscentral$ oc get imagestreamtag -n openshift | grep rhpam73-kieserver

If the outputs of both commands are not empty, the required image streams are available in the openshift namespace and no further action is required.

3. If the output of one or both of the commands is empty or if OpenShift is not configured withthe user name and password for Red Hat registry access, complete the following steps:

a. Ensure you are logged in to OpenShift with the oc command and that your project is active.

b. Complete the steps documented in Registry Service Accounts for Shared Environments .You must log in to Red Hat Customer Portal to access the document and to complete thesteps to create a registry service account.

c. Select the OpenShift Secret tab and click the link under Download secret to download theYAML secret file.

d. View the downloaded file and note the name that is listed in the name: entry.


8

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/installing_clusters/install-config-configuring-inventory-file#advanced-install-configuring-registry-location

https://access.redhat.com/RegistryAuthentication#registry-service-accounts-for-shared-environments-4

e. Run the following commands:

oc create -f <file_name>.yamloc secrets link default <secret_name> --for=pulloc secrets link builder <secret_name> --for=pull

Where <file_name> is the name of the downloaded file and <secret_name> is the namethat is listed in the name: entry of the file.

f. Download the rhpam-7.3.0-openshift-templates.zip product deliverable file from theSoftware Downloads page and extract the rhpam73-image-streams.yaml file.

g. Complete one of the following actions:

Run the following command:

$ oc create -f rhpam73-image-streams.yaml

Using the OpenShift Web UI, select Add to Project → Import YAML / JSON and thenchoose the file or paste its contents.

NOTE

If you complete these steps, you install the image streams into thenamespace of your project. If you install the image streams using thesesteps, you must set the IMAGE_STREAM_NAMESPACE parameter tothe name of this project when deploying templates.

2.2. CREATING THE SECRETS FOR PROCESS SERVER

OpenShift uses objects called Secrets to hold sensitive information, such as passwords or keystores.For more information about OpenShift secrets, see the Secrets chapter in the OpenShiftdocumentation.

You must create an SSL certificate for Process Server and provide it to your OpenShift environment asa secret.

Procedure

1. Generate an SSL keystore with a private and public key for SSL encryption for Process Server.In a production environment, generate a valid signed certificate that matches the expected URLof the Process Server. Save the keystore in a file named keystore.jks. Record the name of thecertificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSLcertificates, see Generate a SSL Encryption Key and Certificate .

2. Use the oc command to generate a secret named kieserver-app-secret from the new keystorefile:

$ oc create secret generic kieserver-app-secret --from-file=keystore.jks

2.3. CREATING THE SECRETS FOR BUSINESS CENTRAL

If you are planning to deploy Business Central or Business Central Monitoring in your OpenShift

CHAPTER 2. PREPARING TO DEPLOY RED HAT PROCESS AUTOMATION MANAGER IN YOUR OPENSHIFT ENVIRONMENT

9

https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=rhpam&productChanged=yes

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/dev-guide-secrets

https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.1/html-single/Security_Guide/index.html#Generate_a_SSL_Encryption_Key_and_Certificate

environment, you must create an SSL certificate for Business Central and provide it to your OpenShiftenvironment as a secret. Do not use the same certificate and keystore for Business Central and forProcess Server.

Procedure

1. Generate an SSL keystore with a private and public key for SSL encryption for Business Central.In a production environment, generate a valid signed certificate that matches the expected URLof the Business Central. Save the keystore in a file named keystore.jks. Record the name of thecertificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSLcertificates, see Generate a SSL Encryption Key and Certificate .

2. Use the oc command to generate a secret named businesscentral-app-secret from the newkeystore file:

$ oc create secret generic businesscentral-app-secret --from-file=keystore.jks

2.4. CREATING THE SECRETS FOR SMART ROUTER

If you are planning to deploy Smart Router in your OpenShift environment, you must create an SSLcertificate for Smart Router and provide it to your OpenShift environment as a secret. Do not use thesame certificate and keystore for Smart Router as the ones used for Process Server or Business Central.

Procedure

1. Generate an SSL keystore with a private and public key for SSL encryption for Smart Router. Ina production environment, generate a valid signed certificate that matches the expected URLof the Smart Router. Save the keystore in a file named keystore.jks. Record the name of thecertificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSLcertificates, see Generate a SSL Encryption Key and Certificate .

2. Use the oc command to generate a secret named smartrouter-app-secret from the newkeystore file:

$ oc create secret generic smartrouter-app-secret --from-file=keystore.jks

2.5. CHANGING GLUSTERFS CONFIGURATION

Check whether your OpenShift environment uses GlusterFS to provide permanent storage volumes. If ituses GlusterFS, to ensure optimal performance, tune your GlusterFS storage by changing the storageclass configuration.

Procedure

1. To check whether your environment uses GlusterFS, run the following command:

oc get storageclass

In the results, check whether the (default) marker is on the storage class that lists glusterfs. Forexample, in the following output the default storage class is gluster-container, which does list glusterfs:


10



NAME PROVISIONER AGEgluster-block gluster.org/glusterblock 8dgluster-container (default) kubernetes.io/glusterfs 8d

If the result has a default storage class that does not list glusterfs or if the result is empty, youdo not need to make any changes. In this case, skip the rest of this procedure.

2. To save the configuration of the default storage class into a YAML file, run the followingcommand:

oc get storageclass <class-name> -o yaml >storage_config.yaml

Replace <class-name> with the name of the default storage class. For example:

oc get storageclass gluster-container -o yaml >storage_config.yaml

3. Edit the storage_config.yaml file:

a. Remove the lines with the following keys:

creationTimestamp

resourceVersion

selfLink

uid

b. On the line with the volumeoptions key, add the following two options: features.cache-invalidation on, performance.nl-cache on. For example:

volumeoptions: client.ssl off, server.ssl off, features.cache-invalidation on, performance.nl-cache on

4. To remove the existing default storage class, run the following command:

oc delete storageclass <class-name>

Replace <class-name> with the name of the default storage class. For example:

oc delete storageclass gluster-container

5. To re-create the storage class using the new configuration, run the following command:

oc create -f storage_config.yaml

2.6. EXTRACTING THE SOURCE CODE FROM BUSINESS CENTRALFOR USE IN AN S2I BUILD

If you are using Business Central for authoring services, you can extract the source code for your serviceand place it into a separate Git repository (such as GitHub or an on-premise installation of GitLab) foruse in the S2I build.

CHAPTER 2. PREPARING TO DEPLOY RED HAT PROCESS AUTOMATION MANAGER IN YOUR OPENSHIFT ENVIRONMENT

11

Procedure

1. Use the following command to extract the source code:

git clone ssh://adminUser@business-central-host:8001/MySpace/MyProject

Replace:

adminUser with the administrative user for Business Central

business-central-host with the host on which Business Central is running

MySpace with the name of the Business Central space in which the project is located

MyProject with the name of the project

2. Upload the source code to another Git repository for the S2I build.

2.7. PREPARING A MAVEN MIRROR REPOSITORY FOR OFFLINE USE

If your Red Hat OpenShift Container Platform environment does not have outgoing access to the publicInternet, you must prepare a Maven repository with a mirror of all the necessary artifacts and make thisrepository available to your environment.

Skip this procedure if your Red Hat OpenShift Container Platform environment is connected to theInternet.

Procedure

1. Prepare a Maven release repository to which you can write. The repository must allow readaccess without authentication. Your OpenShift environment must have access to thisrepository. You can deploy a Nexus repository manager in the OpenShift environment. Forinstructions about setting up Nexus on OpenShift, see Setting up Nexus.

2. Complete the following actions on a computer that has an outgoing connection to the publicInternet:

a. Clear the local Maven cache directory (~/.m2/repository).

b. Build the source of your services using the mvn clean install command.

c. Upload all artifacts from the local Maven cache directory (~/.m2/repository) to the Mavenrepository that you prepared. You can use the Maven Repository Provisioner utility toupload the artifacts.


12

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/tutorials#nexus-setting-up-nexus

https://github.com/simpligility/maven-repository-tools/tree/master/maven-repository-provisioner

CHAPTER 3. ENVIRONMENT WITH IMMUTABLE SERVERSYou can deploy an environment that includes one or more pods running Process Server with preloadedservices. The database servers are, by default, also run in pods. Each Process Server pod can beseparately scaled as necessary.

In this case, any services (KJAR files) must be loaded onto a Process Server at the time the image iscreated. You cannot load or unload services on a running Process Server. The advantage of thisapproach is that the Process Server with the services in it runs like any other containerized service anddoes not require specialized management. The Process Server runs like any other pod on the OpenShiftenvironment; you can use any container-based integration workflows as necessary.

Optionally, you can also deploy a pod with Business Central Monitoring and a pod with Smart Router.You can use Business Central Monitoring to start and stop (but not deploy) services on your ProcessServers and to view monitoring data.

Smart Router is a single endpoint that can receive calls from client applications to any of your servicesand route each call automatically to the server that runs the service.

When you create a Process Server image, you can build your services using S2I (Source to Image).Provide a Git repository with the source of your services and other business assets; if you develop theservices or assets in Business Central, copy the source into a separate repository for the S2I build.OpenShift automatically builds the source, installs the services into the Process Server image, and startsthe containers with the services.

If you are using Business Central for authoring services, you can extract the source for your process andplace it into a separate Git repository (such as GitHub or an on-premise installation of GitLab) for use inthe S2I build.

Alternatively, you can create a similar Process Server deployment using services that are already built asKJAR files. In this case, you must provide the services in a Maven repository; you can use the built-inrepository of the Business Central or your own repository (for example, a Nexus deployment). The KJARfiles are retrieved from the Maven repository during the startup of the pod and not updated or changedafter that. The files are retrieved at every restart or scaling of the pod, so you must ensure they do notchange on the Maven repository to keep the deployment immutable.

With both methods of creating immutable images, no further management of the image is required. Ifyou want to use a new version of a service, you can build a new image.

If you want to use Business Central Monitoring, you must install the Monitoring and Smart Routertemplate before creating any Process Server images. You must also provide a Maven repository. Yourintegration process must ensure that all the versions of KJAR files built into any Process Server imageare also available in the Maven repository.

3.1. DEPLOYING MONITORING AND SMART ROUTER FOR ANENVIRONMENT WITH IMMUTABLE SERVERS

If you want to use Business Central Monitoring and Smart Router for an environment with immutableservers, you must deploy them before deploying any Process Servers. If you do not want to use thesecomponents, skip this procedure.

To deploy Business Central Monitoring and Smart Router for an environment with immutable servers,use the rhpam73-prod-immutable-monitor.yaml template file. You can extract this file from the rhpam-7.3.0-openshift-templates.zip product deliverable file. You can download the file from theSoftware Downloads page.

CHAPTER 3. ENVIRONMENT WITH IMMUTABLE SERVERS

13


Procedure

1. Use one of the following methods to deploy the template:

In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select orpaste the rhpam73-prod-immutable-monitor.yaml file. In the Add Template window,ensure Process the template is selected and click Continue.

To use the OpenShift command line console, prepare the following command line:

oc new-app -f <template-path>/rhpam73-prod-immutable-monitor.yaml -p BUSINESS_CENTRAL_HTTPS_SECRET=businesscentral-app-secret -p KIE_SERVER_ROUTER_HTTPS_SECRET=smartrouter-app-secret

In this command line:

Replace <template-path> with the path to the downloaded template file.

Use as many -p PARAMETER=value pairs as needed to set the required parameters.You can view the template file to see descriptions for all parameters.

2. Set the following parameters as necessary:

Business Central Server Keystore Secret Name(BUSINESS_CENTRAL_HTTPS_SECRET): The name of the secret for Business Central,as created in Section 2.3, “Creating the secrets for Business Central” .

Smart Router Keystore Secret Name (KIE_SERVER_ROUTER_HTTPS_SECRET): Thename of the secret for Smart Router, as created in Section 2.4, “Creating the secrets forSmart Router”.

Application Name (APPLICATION_NAME): The name of the OpenShift application. It isused in the default URLs for Business Central Monitoring and Smart Router. OpenShift alsouses the application name to create a separate set of deployment configurations, services,routes, labels, and artifacts. You can deploy several applications using the same templateinto the same project, as long as you use different application names.

Maven repository URL (MAVEN_REPO_URL): A URL for a Maven repository. You mustupload all the processes (KJAR files) that are to be deployed in your environment into thisrepository.

Maven repository username (MAVEN_REPO_USERNAME): The username for the Mavenrepository.

Maven repository password (MAVEN_REPO_PASSWORD): The username for the Mavenrepository.

Business Central Server Certificate Name (BUSINESS_CENTRAL_HTTPS_NAME): Thename of the certificate in the keystore that you created in Section 2.3, “Creating the secretsfor Business Central”.

Business Central Server Keystore Password(BUSINESS_CENTRAL_HTTPS_PASSWORD): The password for the keystore that youcreated in Section 2.3, “Creating the secrets for Business Central” .

Smart Router Certificate Name (KIE_SERVER_ROUTER_HTTPS_NAME): The name of


14

Smart Router Certificate Name (KIE_SERVER_ROUTER_HTTPS_NAME): The name ofthe certificate in the keystore that you created in Section 2.4, “Creating the secrets forSmart Router”.

Smart Router Keystore Password (KIE_SERVER_ROUTER_HTTPS_PASSWORD): Thepassword for the keystore that you created in Section 2.4, “Creating the secrets for SmartRouter”.

ImageStream Namespace (IMAGE_STREAM_NAMESPACE): The namespace where theimage streams are available. If the image streams were already available in your OpenShiftenvironment (see Section 2.1, “Ensuring the availability of image streams and the imageregistry”), the namespace is openshift. If you have installed the image streams file, thenamespace is the name of the OpenShift project.You can also set other parameters as necessary.

3. If you want to use RH-SSO or LDAP authentication, complete the following additionalconfiguration. Do not configure LDAP authentication and RH-SSO authentication in the samedeployment.

a. In the RH-SSO or LDAP service, create all user names in the deployment parameters. If youdo not set any of the parameters, create users with the default user names. The createdusers must also be assigned to roles:

KIE_ADMIN_USER: default user name adminUser, roles: kie-server,rest-all,admin

KIE_SERVER_MONITOR_USER: user name monitorUser. You must not change thisuser name. You also must configure the KIE_SERVER_MONITOR_PASSWORDparameter to the same value as the password for this user in the RH-SSO service.Otherwise, the suggested parameter settings for the server deployments will beincorrect. Roles: kie-server,rest-all,guest

b. If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSOrealm that applies to Red Hat Process Automation Manager must exist. A client within RH-SSO must also exist for Business Central Monitoring. If the client does not yet exist, thetemplate can create it during deployment.For the user roles that you can configure in RH-SSO, see Roles and users.

Use one of the following procedures:

i. If the client for Red Hat Process Automation Manager within RH-SSO already exists,set the following parameters in the template:

RH-SSO URL (SSO_URL): The URL for RH-SSO.

RH-SSO Realm name (SSO_REALM): The RH-SSO realm for Red Hat ProcessAutomation Manager.

Business Central Monitoring RH-SSO Client name(BUSINESS_CENTRAL_SSO_CLIENT): The RH-SSO client name for BusinessCentral Monitoring.

Business Central Monitoring RH-SSO Client Secret(BUSINESS_CENTRAL_SSO_SECRET): The secret string that is set in RH-SSOfor the client for Business Central Monitoring.

RH-SSO Disable SSL Certificate Validation


15

https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.3/html-single/installing_and_configuring_red_hat_process_automation_manager_on_red_hat_jboss_eap_7.2/roles-users-con#roles-users-con

RH-SSO Disable SSL Certificate Validation(SSO_DISABLE_SSL_CERTIFICATE_VALIDATION): Set to true if your RH-SSOinstallation does not use a valid HTTPS certificate.

ii. To create the client for Red Hat Process Automation Manager within RH-SSO, set thefollowing parameters in the template:



Business Central Monitoring RH-SSO Client name(BUSINESS_CENTRAL_SSO_CLIENT): The name of the client to create in RH-SSO for Business Central Monitoring.

Business Central Monitoring RH-SSO Client Secret(BUSINESS_CENTRAL_SSO_SECRET): The secret string to set in RH-SSO forthe client for Business Central Monitoring.

Business Central Monitoring Custom http Route Hostname(BUSINESS_CENTRAL_HOSTNAME_HTTP): The fully qualified host name to usefor the HTTP endpoint for Business Central Monitoring. If you need to create aclient in RH-SSO, you can not leave this parameter blank.

Business Central Monitoring Custom https Route Hostname(BUSINESS_CENTRAL_HOSTNAME_HTTPS): The fully qualified host name touse for the HTTPS endpoint for Business Central Monitoring. If you need to createa client in RH-SSO, you can not leave this parameter blank.

RH-SSO Realm Admin Username (SSO_USERNAME) and RH-SSO RealmAdmin Password (SSO_PASSWORD): The user name and password for the realmadministrator user for the RH-SSO realm for Red Hat Process AutomationManager.


c. To configure LDAP, set the AUTH_LDAP* parameters of the template. These parameterscorrespond to the settings of the LdapExtended Login module of Red Hat JBoss EAP. Forinstructions about using these settings, see LdapExtended Login Module .If the LDAP server does not define all the roles required for your deployment, you can mapLDAP groups to Red Hat Process Automation Manager roles. To enable LDAP rolemapping, set the following parameters:

RoleMapping rolesProperties file path(AUTH_ROLE_MAPPER_ROLES_PROPERTIES): The fully qualified pathname of afile that defines role mapping, for example, /opt/eap/standalone/configuration/rolemapping/rolemapping.properties. You mustprovide this file and mount it at this path in all applicable deployment configurations; forinstructions, see Section 3.4, “Providing the LDAP role mapping file” .

RoleMapping replaceRole property (AUTH_ROLE_MAPPER_REPLACE_ROLE): Ifset to true, mapped roles replace the roles defined on the LDAP server; if set to false,both mapped roles and roles defined on the LDAP server are set as user applicationroles. The default setting is false.


16

https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/login_module_reference/#ldapextended_login_module

4. Complete the creation of the environment, depending on the method that you are using:

In the OpenShift Web UI, click Create.

If the This will create resources that may have security or project behavior implications message appears, click Create Anyway.

Complete and run the command line.

5. Record the suggested command line that is displayed. This command line includes theparameters that you must set when deploying the immutable servers.

3.2. DEPLOYING AN IMMUTABLE PROCESS SERVER FROM SERVICESOURCE CODE

To deploy an immutable Process Server from service source code, use the rhpam73-prod-immutable-kieserver.yaml template file. You can extract this file from the rhpam-7.3.0-openshift-templates.zipproduct deliverable file. You can download the file from the Software Downloads page.

If you want to modify the environment defined by the template file, see Section 3.5, “Modifying theserver configuration built from source code for an immutable server environment”.

When you deploy an immutable Process Server, the deployment procedure retrieves the source codefor any services that must run on this server, builds the services, and includes them in the server image.

You can configure the Process Server to connect to Smart Router and to Business Central Monitoring.If you use the server with Business Central Monitoring, you must ensure that the same versions of KJARfiles are uploaded to the Maven repository that the Business Central Monitoring instance uses.

Procedure


In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select orpaste the rhpam73-prod-immutable-kieserver.yaml file. In the Add Template window,ensure Process the template is selected and click Continue.


oc new-app -f <template-path>/rhpam73-prod-immutable-kieserver.yaml -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret


Replace <template-path> with the path to the downloaded template file.

Use as many -p PARAMETER=value pairs as needed to set the required parameters.You can view the template file to see descriptions for all parameters.Alternatively, if you have deployed the monitoring infrastructure (see Section 3.1,“Deploying monitoring and Smart Router for an environment with immutable servers”),use the command line that was displayed when you deployed the infrastructure and addthe -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret parameter.


KIE Server Keystore Secret Name (KIE_SERVER_HTTPS_SECRET): The name of thesecret for Process Server, as created in Section 2.2, “Creating the secrets for Process


17


secret for Process Server, as created in Section 2.2, “Creating the secrets for ProcessServer”.

Application Name (APPLICATION_NAME): The name of the OpenShift application. It isused in the default URL for Process Server. OpenShift uses the application name to createa separate set of deployment configurations, services, routes, labels, and artifacts. You candeploy several applications using the same template into the same project, as long as youuse different application names. Also, the application name determines the name of theserver configuration (server template) on the Business Central that the Process Server is tojoin. If you are deploying several Process Servers, you must ensure each of the servers has adifferent application name.

KIE Server Certificate Name (KIE_SERVER_HTTPS_NAME): The name of the certificatein the keystore that you created in Section 2.2, “Creating the secrets for Process Server” .

KIE Server Keystore Password (KIE_SERVER_HTTPS_PASSWORD): The password forthe keystore that you created in Section 2.2, “Creating the secrets for Process Server” .

KIE Server Container Deployment (KIE_SERVER_CONTAINER_DEPLOYMENT): Theidentifying information of the decision service (KJAR file) that is built from your source. Theformat is: <containerId>=<groupId>:<artifactId>:<version>. You can provide two or moreKJAR files using the | separator, for example: containerId=groupId:artifactId:version|c2=g2:a2:v2. The Maven build process mustproduce all these files from the source in the Git repository.

Git Repository URL (SOURCE_REPOSITORY_URL): The URL for the Git repository thatcontains the source for your decision service.

Git Reference (SOURCE_REPOSITORY_REF): The branch in the Git repository

Context Directory (CONTEXT_DIR): The path to the source within the projectdownloaded from the Git repository

Artifact Directory (ARTIFACT_DIR): The path within the project that contains therequired binary files (KJAR files and any other necessary files) after a successful Mavenbuild. Normally this directory is the target directory of the build. However, you can provideprebuilt binaries in this directory in the Git repository

ImageStream Namespace (IMAGE_STREAM_NAMESPACE): The namespace where theimage streams are available. If the image streams were already available in your OpenShiftenvironment (see Section 2.1, “Ensuring the availability of image streams and the imageregistry”), the namespace is openshift. If you have installed the image streams file, thenamespace is the name of the OpenShift project.

3. If your build includes dependencies that are not available on the public Maven tree and require aseparate repository, set the parameters to provide this repository:

Maven repository URL (MAVEN_REPO_URL): The URL for the Maven repository.


Maven repository password (MAVEN_REPO_PASSWORD): The password for the Mavenrepository.

4. If your OpenShift environment does not have outgoing access to the public Internet, set thefollowing parameters:

Maven mirror URL (MAVEN_MIRROR_URL): The URL for the Maven mirror repository


18

Maven mirror URL (MAVEN_MIRROR_URL): The URL for the Maven mirror repositorythat you set up in Section 2.7, “Preparing a Maven mirror repository for offline use” . ThisURL must be accessible from a pod in your OpenShift environment.

Maven mirror of (MAVEN_MIRROR_OF): The Maven mirrorOf value that determineswhich artifacts are to be retrieved from the mirror. For instructions about setting the mirrorOf value, see Mirror Settings in the Apache Maven documentation. The default valueis external:*. With this value, Maven retrieves every required artifact from the mirror anddoes not query any other repositories.

If you configure an external Maven repository (MAVEN_REPO_URL), change MAVEN_MIRROR_OF to exclude the artifacts in this repository from the mirror, forexample, external:*,!repo-custom. Replace repo-custom with the ID that youconfigured in MAVEN_REPO_ID.

If you configure a built-in Business Central Maven repository(BUSINESS_CENTRAL_MAVEN_SERVICE), change MAVEN_MIRROR_OF toexclude the artifacts in this repository from the mirror: external:*,!repo-rhpamcentr.

If you configure both repositories, change MAVEN_MIRROR_OF to exclude theartifacts in both repositories from the mirror: external:*,!repo-rhpamcentr,!repo-custom. Replace repo-custom with the ID that you configured in MAVEN_REPO_ID.

5. If you want to use Business Central Monitoring or Smart Router, set the parameters that weredisplayed in the sample command line after you deployed the monitoring infrastructure (seeSection 3.1, “Deploying monitoring and Smart Router for an environment with immutableservers”).




KIE_SERVER_USER: default user name executionUser, roles kie-server,rest-all,guest

b. If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSOrealm that applies to Red Hat Process Automation Manager must exist. A client within RH-SSO must also exist forFor the user roles that you can configure in RH-SSO, see Roles and users.





KIE Server RH-SSO Client name (KIE_SERVER_SSO_CLIENT): The RH-SSOclient name for Process Server.


19

https://maven.apache.org/guides/mini/guide-mirror-settings.html


KIE Server RH-SSO Client Secret (KIE_SERVER_SSO_SECRET): The secretstring that is set in RH-SSO for the client for Process Server.





KIE Server RH-SSO Client name (KIE_SERVER_SSO_CLIENT): The name of theclient to create in RH-SSO for Process Server.

KIE Server RH-SSO Client Secret (KIE_SERVER_SSO_SECRET): The secretstring to set in RH-SSO for the client for Process Server.

KIE Server Custom http Route Hostname (KIE_SERVER_HOSTNAME_HTTP):The fully qualified host name to use for the HTTP endpoint for Process Server. Ifyou need to create a client in RH-SSO, you can not leave this parameter blank.

KIE Server Custom https Route Hostname(KIE_SERVER_HOSTNAME_HTTPS): The fully qualified host name to use for theHTTPS endpoint for Process Server. If you need to create a client in RH-SSO, youcan not leave this parameter blank.







20


7. If you modified the template to use an external database server for the Process Server, asdescribed in Section 3.5, “Modifying the server configuration built from source code for animmutable server environment”, set the following parameters:

KIE Server External Database Driver (KIE_SERVER_EXTERNALDB_DRIVER): Thedriver for the server, depending on the server type:

mysql

postgresql

mariadb

mssql

db2

oracle

sybase

KIE Server External Database User (KIE_SERVER_EXTERNALDB_USER) and KIEServer External Database Password (KIE_SERVER_EXTERNALDB_PWD): The user nameand password for the external database server.

KIE Server External Database URL (KIE_SERVER_EXTERNALDB_HOST): The JDBCURL for the external database server.

KIE Server External Database Dialect (KIE_SERVER_EXTERNALDB_DIALECT): TheHibernate dialect for the server, depending on the server type:

org.hibernate.dialect.MySQL5Dialect (used for MySQL and MariaDB)

org.hibernate.dialect.PostgreSQLDialect

org.hibernate.dialect.SQLServer2012Dialect (used for MS SQL)

org.hibernate.dialect.DB2Dialect

org.hibernate.dialect.Oracle12cDialect

org.hibernate.dialect.SybaseASE15Dialect

KIE Server External Database Host (KIE_SERVER_EXTERNALDB_HOST): The hostname of the external database server.

KIE Server External Database Port (KIE_SERVER_EXTERNALDB_PORT): The portnumber of the external database server.

KIE Server External Database name (KIE_SERVER_EXTERNALDB_DB): The databasename to use on the external database server.

8. If you created a custom image for using an external database server other than MySQL orPostgreSQL, as described in Section 3.6, “Building a custom Process Server image for anexternal database”, set the KIE Server Image Stream Name(KIE_SERVER_IMAGE_STREAM_NAME) parameter to the following value:

For Microsoft SQL Server, rhpam73-kieserver-mssql-openshift


21

For MariaDB, rhpam73-kieserver-mariadb-openshift

For IBM DB2, rhpam73-kieserver-db2-openshift

For Oracle Database, rhpam73-kieserver-oracle-openshift

For Sybase, rhpam73-kieserver-sybase-openshift





3.3. DEPLOYING AN IMMUTABLE PROCESS SERVER FROM KJARSERVICES

To deploy an immutable Process Server from KJAR services, use one of the following template files:

rhpam73-kieserver-postgresql.yaml to use a PostgreSQL pod for persistent storage. Use thistemplate unless there is a sufficient reason to use another template.

rhpam73-kieserver-mysql.yaml to use a MySQL pod for persistent storage.

rhpam73-kieserver-externaldb.yaml to use an external database server for persistent storage.

IMPORTANT

The standard Process Server image for an external database server includesdrivers for MySQL and PostgreSQL external database servers. If you want to useanother database server, you must build a custom Process Server image. Forinstructions, see Section 3.6, “Building a custom Process Server image for anexternal database”.

You can extract these template files from the rhpam-7.3.0-openshift-templates.zip productdeliverable file. You can download the file from the Software Downloads page.

In this method of deployment, the Process Server retrieves all the required KJAR files during the startupof the pod.

You can configure the Process Server to connect to Smart Router and to Business Central Monitoring.If you use the server with Business Central Monitoring, you must ensure that the same versions of KJARfiles are uploaded to the Maven repository that the Business Central Monitoring instance uses.

Procedure


In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select orpaste the template file. In the Add Template window, ensure Process the template isselected and click Continue.



22


oc new-app -f <template-path>/<template-file-name>.yaml -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret


Replace <template-path> with the path to the template file.

Replace <template-file-name> with the name of the template file.

Use as many -p PARAMETER=value pairs as needed to set the required parameters.You can view the template file to see descriptions for all parameters.


KIE Server Keystore Secret Name (KIE_SERVER_HTTPS_SECRET): The name of thesecret for Process Server, as created in Section 2.2, “Creating the secrets for ProcessServer”.

Application Name (APPLICATION_NAME): The name of the OpenShift application. It isused in the default URL for Process Server. OpenShift uses the application name to createa separate set of deployment configurations, services, routes, labels, and artifacts. You candeploy several applications using the same template into the same project, as long as youuse different application names. Also, the application name determines the name of theserver configuration (server template) on the Business Central that the Process Server is tojoin. If you are deploying several Process Servers, you must ensure each of the servers has adifferent application name.

KIE Server Certificate Name (KIE_SERVER_HTTPS_NAME): The name of the certificatein the keystore that you created in Section 2.2, “Creating the secrets for Process Server” .

KIE Server Keystore Password (KIE_SERVER_HTTPS_PASSWORD): The password forthe keystore that you created in Section 2.2, “Creating the secrets for Process Server” .

KIE Server Mode (KIE_SERVER_MODE): Set to DEVELOPMENT if you need to deploy a SNAPSHOT version of a KJAR artifact. In the rhpam73-kieserver-*.yaml templates thedefault value is PRODUCTION, which does not allow deployment of SNAPSHOT versions.

KIE Server Container Deployment (KIE_SERVER_CONTAINER_DEPLOYMENT): Theidentifying information of the decision services (KJAR files) that the deployment must pullfrom the Maven repository. The format is: <containerId>=<groupId>:<artifactId>:<version>. You can provide two or more KJAR files using the | separator, for example: containerId=groupId:artifactId:version|c2=g2:a2:v2.

Maven repository URL (MAVEN_REPO_URL): The URL for the Maven repository.


Maven repository password (MAVEN_REPO_PASSWORD): The password for the Mavenrepository.

Disable KIE server management (KIE_SERVER_MGMT_DISABLED): You must set thisparameter to true for an immutable deployment.

KIE Server Startup Strategy (KIE_SERVER_STARTUP_STRATEGY): You must set thisparameter to LocalContainersStartupStrategy for an immutable deployment.

ImageStream Namespace (IMAGE_STREAM_NAMESPACE): The namespace where the


23

ImageStream Namespace (IMAGE_STREAM_NAMESPACE): The namespace where theimage streams are available. If the image streams were already available in your OpenShiftenvironment (see Section 2.1, “Ensuring the availability of image streams and the imageregistry”), the namespace is openshift. If you have installed the image streams file, thenamespace is the name of the OpenShift project.

3. If your OpenShift environment does not have outgoing access to the public Internet, set thefollowing parameters:

Maven mirror URL (MAVEN_MIRROR_URL): The URL for the Maven mirror repositorythat you set up in Section 2.7, “Preparing a Maven mirror repository for offline use” . ThisURL must be accessible from a pod in your OpenShift environment.

Maven mirror of (MAVEN_MIRROR_OF): The Maven mirrorOf value that determineswhich artifacts are to be retrieved from the mirror. For instructions about setting the mirrorOf value, see Mirror Settings in the Apache Maven documentation. The default valueis external:*. With this value, Maven retrieves every required artifact from the mirror anddoes not query any other repositories.

If you configure an external Maven repository (MAVEN_REPO_URL), change MAVEN_MIRROR_OF to exclude the artifacts in this repository from the mirror, forexample, external:*,!repo-custom. Replace repo-custom with the ID that youconfigured in MAVEN_REPO_ID.

If you configure a built-in Business Central Maven repository(BUSINESS_CENTRAL_MAVEN_SERVICE), change MAVEN_MIRROR_OF toexclude the artifacts in this repository from the mirror: external:*,!repo-rhpamcentr.

If you configure both repositories, change MAVEN_MIRROR_OF to exclude theartifacts in both repositories from the mirror: external:*,!repo-rhpamcentr,!repo-custom. Replace repo-custom with the ID that you configured in MAVEN_REPO_ID.

4. If you want to use Business Central Monitoring or Smart Router, set some of the parametersthat were displayed in the sample command line after you deployed the monitoringinfrastructure (see Section 3.1, “Deploying monitoring and Smart Router for an environment withimmutable servers”), namely:

Set KIE_ADMIN_USER, KIE_ADMIN_PWD, KIE_SERVER_USER, KIE_SERVER_PWD,and KIE_SERVER_ROUTER_SERVICE to the values that were displayed for theseparameters.

Set KIE_SERVER_CONTROLLER_USER to the value that was displayed for KIE_SERVER_MONITOR_USER.

Set KIE_SERVER_CONTROLLER_PWD to the value that was displayed for KIE_SERVER_MONITOR_PWD.

Set KIE_SERVER_CONTROLLER_SERVICE to the value that was displayed for KIE_SERVER_MONITOR_SERVICE.




24

https://maven.apache.org/guides/mini/guide-mirror-settings.html


KIE_SERVER_USER: default user name executionUser, roles kie-server,rest-all,guest

b. If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSOrealm that applies to Red Hat Process Automation Manager must exist. A client within RH-SSO must also exist forFor the user roles that you can configure in RH-SSO, see Roles and users.





KIE Server RH-SSO Client name (KIE_SERVER_SSO_CLIENT): The RH-SSOclient name for Process Server.

KIE Server RH-SSO Client Secret (KIE_SERVER_SSO_SECRET): The secretstring that is set in RH-SSO for the client for Process Server.





KIE Server RH-SSO Client name (KIE_SERVER_SSO_CLIENT): The name of theclient to create in RH-SSO for Process Server.

KIE Server RH-SSO Client Secret (KIE_SERVER_SSO_SECRET): The secretstring to set in RH-SSO for the client for Process Server.

KIE Server Custom http Route Hostname (KIE_SERVER_HOSTNAME_HTTP):The fully qualified host name to use for the HTTP endpoint for Process Server. Ifyou need to create a client in RH-SSO, you can not leave this parameter blank.

KIE Server Custom https Route Hostname(KIE_SERVER_HOSTNAME_HTTPS): The fully qualified host name to use for theHTTPS endpoint for Process Server. If you need to create a client in RH-SSO, youcan not leave this parameter blank.


RH-SSO Disable SSL Certificate Validation


25






6. If you are using the rhpam73-kieserver-externaldb.yaml template to use an external databaseserver for the Process Server, set the following parameters:

KIE Server External Database Driver (KIE_SERVER_EXTERNALDB_DRIVER): Thedriver for the server, depending on the server type:

mysql

postgresql

mariadb

mssql

db2

oracle

sybase

KIE Server External Database User (KIE_SERVER_EXTERNALDB_USER) and KIEServer External Database Password (KIE_SERVER_EXTERNALDB_PWD): The user nameand password for the external database server.

KIE Server External Database URL (KIE_SERVER_EXTERNALDB_HOST): The JDBCURL for the external database server.

KIE Server External Database Dialect (KIE_SERVER_EXTERNALDB_DIALECT): TheHibernate dialect for the server, depending on the server type:

org.hibernate.dialect.MySQL5Dialect (used for MySQL and MariaDB)


org.hibernate.dialect.SQLServer2012Dialect (used for MS SQL)


26


org.hibernate.dialect.DB2Dialect

org.hibernate.dialect.Oracle12cDialect

org.hibernate.dialect.SybaseASE15Dialect

KIE Server External Database Host (KIE_SERVER_EXTERNALDB_HOST): The hostname of the external database server.

KIE Server External Database Port (KIE_SERVER_EXTERNALDB_PORT): The portnumber of the external database server.

KIE Server External Database name (KIE_SERVER_EXTERNALDB_DB): The databasename to use on the external database server.

7. If you created a custom image for using an external database server other than MySQL orPostgreSQL, as described in Section 3.6, “Building a custom Process Server image for anexternal database”, set the KIE Server Image Stream Name(KIE_SERVER_IMAGE_STREAM_NAME) parameter to the following value:

For Microsoft SQL Server, rhpam73-kieserver-mssql-openshift

For MariaDB, rhpam73-kieserver-mariadb-openshift

For IBM DB2, rhpam73-kieserver-db2-openshift

For Oracle Database, rhpam73-kieserver-oracle-openshift

For Sybase, rhpam73-kieserver-sybase-openshift





3.4. PROVIDING THE LDAP ROLE MAPPING FILE

If you configure the AUTH_ROLE_MAPPER_ROLES_PROPERTIES parameter, you must provide a filethat defines the role mapping. Mount this file on all affected deployment configurations.

Procedure

1. Create the role mapping properties file, for example, my-role-map. The file must contain entriesin the following format:

ldap_role = product_role1, product_role2...

For example:

admins = kie-server,rest-all,admin

2. Create an OpenShift configuration map from the file by entering the following command:


27

oc create configmap ldap-role-mapping --from-file=<new_name>=<existing_name>

Replace <new_name> with the name that the file is to have on the pods (it must be the sameas the name specified in the AUTH_ROLE_MAPPER_ROLES_PROPERTIES file) and <existing_name> with the name of the file that you created. For example:

oc create configmap ldap-role-mapping --from-file=rolemapping.properties=my-role-map

3. Mount the configuration map on every deployment configuration that is configured for rolemapping.The following deployment configurations can be affected in this environment:

myapp-rhpamcentrmon: Business Central Monitoring

myapp-kieserver: Process Server

Replace myapp with the application name. Sometimes, several Process Server deployments canbe present under different application names.

For every deployment configuration, run the command:

oc set volume dc/<deployment_config_name> --add --type configmap --configmap-name ldap-role-mapping --mount-path=<mapping_dir> --name=ldap-role-mapping

Replace <mapping_dir> with the directory name (without file name) set in the AUTH_ROLE_MAPPER_ROLES_PROPERTIES parameter, for example, /opt/eap/standalone/configuration/rolemapping .

3.5. MODIFYING THE SERVER CONFIGURATION BUILT FROM SOURCECODE FOR AN IMMUTABLE SERVER ENVIRONMENT

By default, the immutable server configuration built from source code creates a separate PostgreSQLpod to provide the database server for each replicable Process Server. If you prefer to use MySQL or touse an external server (outside the OpenShift project), you must modify the rhpam73-prod-immutable-kieserver.yaml template before deploying the server.

An OpenShift template defines a set of objects that can be created by OpenShift. To change anenvironment configuration, you need to modify, add, or delete these objects. To simplify this task,comments are provided in the Red Hat Process Automation Manager templates.

Some comments mark blocks within the template, staring with BEGIN and ending with END. Forexample, the following block is named Sample block:

## Sample block BEGINsample line 1sample line 2sample line 3## Sample block END

For some changes, you might need to replace a block in one template file with a block from anothertemplate file provided with Red Hat Process Automation Manager. In this case, delete the block, thenpaste the new block in its exact location.


28

Procedure

If you want to use MySQL instead of PostgreSQL, replace several blocks of the file, marked withcomments from BEGIN to END, with blocks from the rhpam73-kieserver-mysql.yaml file:

1. Replace the block named PostgreSQL database parameters with the block named MySQL database parameters. (Take this block and all subsequent replacement blocksfrom the rhpam73-kieserver-postgresql.yaml file.)

2. Replace the block named PostgreSQL service with the block named MySQL service.

3. Replace the block named PostgreSQL driver settings with the block named MySQL driver settings.

4. Replace the block named PostgreSQL deployment config with the block named MySQL deployment config.

5. Replace the block named PostgreSQL persistent volume claim with the block named MySQL persistent volume claim.

If you want to use an external database server, replace several blocks of the file, marked withcomments from BEGIN to END, with blocks from the rhpam73-kieserver-externaldb.yaml file,and also remove some blocks:

1. Replace the block named PostgreSQL database parameters with the block named External database parameters. (Take this block and all subsequent replacement blocksfrom the rhpam73-kieserver-externaldb.yaml file.)

2. Replace the block named PostgreSQL driver settings with the block named External database driver settings.

3. Remove the following blocks of the file, marked with comments from BEGIN to END:

PostgreSQL service

PostgreSQL deployment config

PostgreSQL persistent volume claim

IMPORTANT

The standard Process Server image includes drivers for MySQL and PostgreSQLexternal database servers. If you want to use another database server, you must build acustom Process Server image. For instructions, see Section 3.6, “Building a customProcess Server image for an external database”.

3.6. BUILDING A CUSTOM PROCESS SERVER IMAGE FOR ANEXTERNAL DATABASE

If you want to use an external database server for a Process Server and this server is neither MySQL norPostgreSQL, you must build a custom Process Server image with drivers for this server beforedeploying your environment.

You can use this build procedure to provide drivers for the following database servers:

Microsoft SQL Server


29

MariaDB

IBM DB2

Oracle Database

Sybase

For the tested versions of the database servers, see Red Hat Process Automation Manager 7Supported Configurations.

The build procedure creates a custom image that extends the existing Process Server image. It pushesthis custom image into a new ImageStream in the openshift namespace with the same version tag asthe original image.

Prerequisites

You have logged on to your project in the OpenShift environment using the oc command as auser with the cluster-admin role.

For IBM DB2, Oracle Database, or Sybase, you have downloaded the JDBC driver from thedatabase server vendor.

Procedure

1. For IBM DB2, Oracle Database, or Sybase, provide the JDBC driver JAR in a local directory oron an HTTP server. Within the local directory or HTTP server, the following paths are expected:

For IBM DB2, <local_path_or_url>/com/ibm/db2/jcc/db2jcc4/10.5/db2jcc4-10.5.jar

For Oracle Database, <local_path_or_url>/com/oracle/ojdbc7/12.1.0.1/ojdbc7-12.1.0.1.jar

For Sybase, <local_path_or_url>/com/sysbase/jconn4/16.0_PL05/jconn4-16.0_PL05.jarWhere <local_path_or_url> is the path to the local directory or the URL for the HTTPserver where the driver is provided.

2. To install the source code for the custom build, download the rhpam-7.3.0-openshift-templates.zip product deliverable file from the Software Downloads page. Unzip the file and,using the command line, change to the templates/contrib/jdbc directory of the unzipped file.

3. Change to the following subdirectory:

For Microsoft SQL Server, mssql-driver-image

For MariaDB, mariadb-driver-image

For IBM DB2, db2-driver-image

For Oracle Database, oracle-driver-image

For Sybase, sybase-driver-image

4. Run the following command:

For Microsoft SQL Server or MariaDB:


30

https://access.redhat.com/articles/3405381#TestedConfigurations70


../build.sh

For IBM DB2, Oracle Database, or Sybase:

../build.sh --artifact-repo=<local_path_or_url>

Where <local_path_or_url> is the path to the local directory or the URL for the HTTP serverwhere the driver is provided. For example:

../build.sh --artifact-repo=/home/builder/drivers

../build.sh --artifact-repo=http://nexus.example.com/nexus/content/groups/public

If you want to configure your OpenShift docker registry address in the process, add also the --registry=<registry_name.domain_name:port> parameter to your build command.

Examples:

../build.sh --registry=docker-registry.custom-domain:80

../build.sh --artifact-repo=/home/builder/drivers --registry=docker-registry.custom-domain:80


31

CHAPTER 4. OPENSHIFT TEMPLATE REFERENCEINFORMATION

Red Hat Process Automation Manager provides the following OpenShift templates. To access thetemplates, download and extract the rhpam-7.3.0-openshift-templates.zip product deliverable filefrom the Software Downloads page of the Red Hat customer portal.

rhpam73-prod-immutable-monitor.yaml provides a Business Central Monitoring instance anda Smart Router that you can use with immutable Process Servers. When you deploy thistemplate, OpenShift displays the settings that you must then use for deploying the rhpam73-prod-immutable-kieserver.yaml template. For details about this template, see Section 4.1,“rhpam73-prod-immutable-monitor.yaml template”.

rhpam73-prod-immutable-kieserver.yaml provides an immutable Process Server. When youdeploy this template, a source-to-image (S2I) build is triggered for one or several services thatare to run on the Process Server. The Process Server can optionally be configured to connectto the Business Central Monitoring and Smart Router provided by rhpam73-prod-immutable-monitor.yaml. For details about this template, see Section 4.2, “rhpam73-prod-immutable-kieserver.yaml template”.

rhpam73-kieserver-externaldb.yaml provides a Process Server that uses an external database.You can configure the Process Server to connect to a Business Central. Also, you can copysections from this template into another template to configure a Process Server in the othertemplate to use an external database. For details about this template, see Section 4.3,“rhpam73-kieserver-externaldb.yaml template”.

rhpam73-kieserver-mysql.yaml provides a Process Server and a MySQL instance that theProcess Server uses. You can configure the Process Server to connect to a Business Central.Also, you can copy sections from this template into another template to configure a ProcessServer in the other template to use MySQL and to provide the MySQL instance. For detailsabout this template, see Section 4.4, “rhpam73-kieserver-mysql.yaml template” .

rhpam73-kieserver-postgresql.yaml provides a Process Server and a PostgreSQL instancethat the Process Server uses. You can configure the Process Server to connect to a BusinessCentral. Also, you can copy sections from this template into another template to configure aProcess Server in the other template to use PostgreSQL and to provide the PostgreSQLinstance. For details about this template, see Section 4.4, “rhpam73-kieserver-mysql.yamltemplate”.

4.1. RHPAM73-PROD-IMMUTABLE-MONITOR.YAML TEMPLATE

Application template for a router and monitoring console in a production environment, for Red HatProcess Automation Manager 7.3

4.1.1. Parameters

Templates allow you to define parameters which take on a value. That value is then substituted whereverthe parameter is referenced. References can be defined in any text field in the objects list field. Refer tothe Openshift documentation for more information.


32


https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#dev-guide-templates

Variable name ImageEnvironmentVariable

Description Example value Required

APPLICATION_NAME

— The name for theapplication.

myapp True

MAVEN_REPO_ID

EXTERNAL_MAVEN_REPO_ID

The id to use forthe mavenrepository, if set.Default isgeneratedrandomly.

repo-custom False

MAVEN_REPO_URL

EXTERNAL_MAVEN_REPO_URL

Fully qualified URLto a Mavenrepository orservice.

http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/

False

MAVEN_REPO_USERNAME

EXTERNAL_MAVEN_REPO_USERNAME

Username toaccess the Mavenrepository, ifrequired.

— False

MAVEN_REPO_PASSWORD

EXTERNAL_MAVEN_REPO_PASSWORD

Password toaccess the Mavenrepository, ifrequired.

— False

BUSINESS_CENTRAL_MAVEN_SERVICE

RHPAMCENTR_MAVEN_REPO_SERVICE

The service namefor the optionalbusiness central,where it can bereached, to allowservice lookups(for maven repousage), if required

myapp-rhpamcentr

False

BUSINESS_CENTRAL_MAVEN_USERNAME

RHPAMCENTR_MAVEN_REPO_USERNAME

Username toaccess the Mavenservice hosted byBusiness Centralinside EAP.

mavenUser False

BUSINESS_CENTRAL_MAVEN_PASSWORD

RHPAMCENTR_MAVEN_REPO_PASSWORD

Password toaccess the Mavenservice hosted byBusiness Centralinside EAP.

maven1! False

CHAPTER 4. OPENSHIFT TEMPLATE REFERENCE INFORMATION

33


KIE_ADMIN_USER

KIE_ADMIN_USER

KIE administratorusername

adminUser False

KIE_ADMIN_PWD

KIE_ADMIN_PWD

KIE administratorpassword

— False

KIE_SERVER_USER

KIE_SERVER_USER

KIE serverusername (Setstheorg.kie.server.usersystem property)

executionUser False

KIE_SERVER_PWD

KIE_SERVER_PWD

KIE serverpassword, used toconnect to KIEservers. Generatedvalue can be asuggestion to usefor thew s2ivarious (Sets theorg.kie.server.pwdsystem property)

— False

KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE


If OpenShiftintegration ofBusiness Central isturned on, settingthis parameter totrue enablesconnection to KIEServer via anOpenShift internalService endpoint.(Sets theorg.kie.server.controller.openshift.prefer.kieserver.service system property)

false False

KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL


KIEServerTemplateCache TTL inmilliseconds (Setstheorg.kie.server.controller.template.cache.ttl systemproperty)

60000 False




34

KIE_WORKBENCH_CONTROLLER_OPENSHIFT_ENABLED


If set to true, turnson OpenShiftintegration featurein BusinessCentral. WithOpenShiftintegration,Business Centralautomaticallydiscovers andconnects to anyKIE server in thesame namespace,provided thatOpenShiftintegration(OpenShiftStartupStrategy) isenabled on the KIEserver. (Sets theorg.kie.workbench.controller.openshift.enabled systemproperty)

false False

IMAGE_STREAM_NAMESPACE

— Namespace inwhich theImageStreams forRed HatMiddlewareimages areinstalled. TheseImageStreams arenormally installedin the openshiftnamespace. Youshould only needto modify this ifyou installed theImageStreams in adifferentnamespace/project.

openshift True

IMAGE_STREAM_TAG

— A named pointerto an image in animage stream.Default is "1.1".

1.1 False




35

SMART_ROUTER_HOSTNAME_HTTP

— Custom hostnamefor http serviceroute. Leave blankfor defaulthostname, e.g.:<application-name>-smartrouter-<project>.<default-domain-suffix>

— False

SMART_ROUTER_HOSTNAME_HTTPS

— Custom hostnamefor https serviceroute. Leave blankfor defaulthostname, e.g.:secure-<application-name>-smartrouter-<project>.<default-domain-suffix>

— False

KIE_SERVER_ROUTER_ID


Router ID usedwhen connectingto the controller.(Router propertyorg.kie.server.router.id)

kie-server-router True

KIE_SERVER_ROUTER_PROTOCOL


KIE server routerprotocol. (Used tobuild theorg.kie.server.router.url.externalproperty)

http False

KIE_SERVER_ROUTER_URL_EXTERNAL


Public URL wherethe router can befound. Formathttp://<host>:<port> (Routerpropertyorg.kie.server.router.url.external)

— False




36

KIE_SERVER_ROUTER_NAME


Router name usedwhen connectingto the controller.(Router propertyorg.kie.server.router.name)

KIE Server Router True

KIE_SERVER_ROUTER_HTTPS_SECRET

— The name of thesecret containingthe keystore file.

smartrouter-app-secret

True

KIE_SERVER_ROUTER_HTTPS_KEYSTORE

— The name of thekeystore file withinthe secret.

keystore.jks False

KIE_SERVER_ROUTER_HTTPS_NAME

KIE_SERVER_ROUTER_TLS_KEYSTORE_KEYALIAS

The nameassociated withthe servercertificate.

jboss False

KIE_SERVER_ROUTER_HTTPS_PASSWORD

KIE_SERVER_ROUTER_TLS_KEYSTORE_PASSWORD

The password forthe keystore andcertificate.

mykeystorepass False

KIE_SERVER_MONITOR_USER

KIE_SERVER_CONTROLLER_USER

KIE server monitorusername. (Setstheorg.kie.server.controller.user systemproperty)

monitorUser False

KIE_SERVER_MONITOR_PWD

KIE_SERVER_CONTROLLER_PWD

KIE server monitorpassword. (Setstheorg.kie.server.controller.pwd systemproperty)

— False

KIE_SERVER_MONITOR_TOKEN

KIE_SERVER_CONTROLLER_TOKEN

KIE server monitortoken for bearerauthentication.(Sets theorg.kie.server.controller.token systemproperty)

— False




37

BUSINESS_CENTRAL_HOSTNAME_HTTP

HOSTNAME_HTTP

Custom hostnamefor http serviceroute. Leave blankfor defaulthostname, e.g.:<application-name>-rhpamcentrmon-<project>.<default-domain-suffix>

— False

BUSINESS_CENTRAL_HOSTNAME_HTTPS

HOSTNAME_HTTPS

Custom hostnamefor https serviceroute. Leave blankfor defaulthostname, e.g.:secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix>

— False

BUSINESS_CENTRAL_HTTPS_SECRET


businesscentral-app-secret

True

BUSINESS_CENTRAL_HTTPS_KEYSTORE

HTTPS_KEYSTORE

The name of thekeystore file withinthe secret.

keystore.jks False

BUSINESS_CENTRAL_HTTPS_NAME

HTTPS_NAME The nameassociated withthe servercertificate.

jboss False

BUSINESS_CENTRAL_HTTPS_PASSWORD

HTTPS_PASSWORD



BUSINESS_CENTRAL_MEMORY_LIMIT

— Business CentralContainer memorylimit.

2Gi False




38

SMART_ROUTER_MEMORY_LIMIT

— Smart RouterContainer memorylimit.

512Mi False

SSO_URL SSO_URL RH-SSO URL. https://rh-sso.example.com/auth

False

SSO_REALM SSO_REALM RH-SSO Realmname.

— False

BUSINESS_CENTRAL_SSO_CLIENT

SSO_CLIENT Business CentralMonitoring RH-SSO Client name.

— False

BUSINESS_CENTRAL_SSO_SECRET

SSO_SECRET Business CentralMonitoring RH-SSO Client Secret.

252793ed-7118-4ca8-8dab-5622fa97d892

False

SSO_USERNAME

SSO_USERNAME

RH-SSO RealmAdmin Usernameused to create theClient if it doesn’texist.

— False

SSO_PASSWORD

SSO_PASSWORD

RH-SSO RealmAdmin Passwordused to create theClient.

— False

SSO_DISABLE_SSL_CERTIFICATE_VALIDATION


RH-SSO DisableSSL CertificateValidation.

false False

SSO_PRINCIPAL_ATTRIBUTE


RH-SSO PrincipalAttribute to use asusername.

preferred_username

False

AUTH_LDAP_URL

AUTH_LDAP_URL

LDAP Endpoint toconnect forauthentication.

ldap://myldap.example.com

False

AUTH_LDAP_BIND_DN

AUTH_LDAP_BIND_DN

Bind DN used forauthentication.

uid=admin,ou=users,ou=exmample,ou=com

False




39

https://rh-sso.example.com/auth

AUTH_LDAP_BIND_CREDENTIAL


LDAP Credentialsused forauthentication.

Password False

AUTH_LDAP_JAAS_SECURITY_DOMAIN


The JMXObjectName oftheJaasSecurityDomain used to decryptthe password.

— False

AUTH_LDAP_BASE_CTX_DN


LDAP Base DN ofthe top-levelcontext to beginthe user search.

ou=users,ou=example,ou=com

False

AUTH_LDAP_BASE_FILTER


LDAP search filterused to locate thecontext of the userto authenticate.The inputusername oruserDN obtainedfrom the loginmodule callback issubstituted intothe filter anywherea {0} expression isused. A commonexample for thesearch filter is(uid={0}).

(uid={0}) False

AUTH_LDAP_SEARCH_SCOPE


The search scopeto use.

SUBTREE_SCOPE

False

AUTH_LDAP_SEARCH_TIME_LIMIT


The timeout inmilliseconds foruser or rolesearches.

10000 False




40

AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE


The name of theattribute in theuser entry thatcontains the DN ofthe user. This maybe necessary if theDN of the useritself containsspecial characters,backslash forexample, thatprevent correctuser mapping. Ifthe attribute doesnot exist, theentry’s DN is used.

distinguishedName

False

AUTH_LDAP_PARSE_USERNAME


A flag indicating ifthe DN is to beparsed for theusername. If set totrue, the DN isparsed for theusername. If set tofalse the DN is notparsed for theusername. Thisoption is usedtogether withusernameBeginString andusernameEndString.

true False

AUTH_LDAP_USERNAME_BEGIN_STRING


Defines the Stringwhich is to beremoved from thestart of the DN toreveal theusername. Thisoption is usedtogether withusernameEndString and only takeninto account ifparseUsername isset to true.

— False




41

AUTH_LDAP_USERNAME_END_STRING


Defines the Stringwhich is to beremoved from theend of the DN toreveal theusername. Thisoption is usedtogether withusernameEndString and only takeninto account ifparseUsername isset to true.

— False

AUTH_LDAP_ROLE_ATTRIBUTE_ID


Name of theattributecontaining the userroles.

memberOf False

AUTH_LDAP_ROLES_CTX_DN


The fixed DN ofthe context tosearch for userroles. This is notthe DN where theactual roles are,but the DN wherethe objectscontaining the userroles are. Forexample, in aMicrosoft ActiveDirectory server,this is the DNwhere the useraccount is.

ou=groups,ou=example,ou=com

False




42

AUTH_LDAP_ROLE_FILTER


A search filterused to locate theroles associatedwith theauthenticateduser. The inputusername oruserDN obtainedfrom the loginmodule callback issubstituted intothe filter anywherea {0} expression isused. TheauthenticateduserDN issubstituted intothe filter anywherea {1} is used. Anexample searchfilter that matcheson the inputusername is(member={0}). Analternative thatmatches on theauthenticateduserDN is(member={1}).

(memberOf={1}) False

AUTH_LDAP_ROLE_RECURSION


The number oflevels of recursionthe role search willgo below amatching context.Disable recursionby setting this to 0.

1 False

AUTH_LDAP_DEFAULT_ROLE


A role included forall authenticatedusers.

guest False




43

AUTH_LDAP_ROLE_NAME_ATTRIBUTE_ID


Name of theattribute within theroleCtxDN contextwhich contains therole name. If theroleAttributeIsDNproperty is set totrue, this propertyis used to find therole object’s nameattribute.

name False

AUTH_LDAP_PARSE_ROLE_NAME_FROM_DN


A flag indicating ifthe DN returnedby a querycontains theroleNameAttributeID. If set to true,the DN is checkedfor theroleNameAttributeID. If set to false,the DN is notchecked for theroleNameAttributeID. This flag canimprove theperformance ofLDAP queries.

false False

AUTH_LDAP_ROLE_ATTRIBUTE_IS_DN


Whether or not theroleAttributeIDcontains the fully-qualified DN of arole object. If false,the role name istaken from thevalue of theroleNameAttributeId attribute of thecontext name.Certain directoryschemas, such asMicrosoft ActiveDirectory, requirethis attribute to beset to true.

false False




44

AUTH_LDAP_REFERRAL_USER_ATTRIBUTE_ID_TO_CHECK


If you are not usingreferrals, you canignore this option.When usingreferrals, thisoption denotes theattribute namewhich containsusers defined for acertain role, forexample member,if the role object isinside the referral.Users are checkedagainst thecontent of thisattribute name. Ifthis option is notset, the check willalways fail, so roleobjects cannot bestored in a referraltree.

— False

AUTH_ROLE_MAPPER_ROLES_PROPERTIES


When present, theRoleMappingLogin Module willbe configured touse the providedfile. Thisparameter definesthe fully-qualifiedfile path and nameof a properties fileor resource whichmaps roles toreplacement roles.The format isoriginal_role=role1,role2,role3

— False

AUTH_ROLE_MAPPER_REPLACE_ROLE


Whether to add tothe current roles,or replace thecurrent roles withthe mapped ones.Replaces if set totrue.

— False




45

4.1.2. Objects

The CLI supports various object types. A list of these object types as well as their abbreviations can befound in the Openshift documentation.

4.1.2.1. Services

A service is an abstraction which defines a logical set of pods and a policy by which to access them. Referto the container-engine documentation for more information.

Service Port Name Description

${APPLICATION_NAME}-rhpamcentrmon

8080 http All the Business CentralMonitoring web server’sports.8443 https

${APPLICATION_NAME}-rhpamcentrmon-ping

8888 ping The JGroups ping portfor clustering.

${APPLICATION_NAME}-smartrouter

9000 http The smart router serverhttp and https ports.

9443 https

4.1.2.2. Routes

A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by arouter to provide named connectivity from external clients to your applications. Each route consists of aroute name, service selector, and (optionally) security configuration. Refer to the Openshiftdocumentation for more information.

Service Security Hostname

${APPLICATION_NAME}-rhpamcentrmon-http

none ${BUSINESS_CENTRAL_HOSTNAME_HTTP}

${APPLICATION_NAME}-rhpamcentrmon-https

TLS passthrough ${BUSINESS_CENTRAL_HOSTNAME_HTTPS}

${APPLICATION_NAME}-smartrouter-http

none ${SMART_ROUTER_HOSTNAME_HTTP}

${APPLICATION_NAME}-smartrouter-https

TLS passthrough ${SMART_ROUTER_HOSTNAME_HTTPS}

4.1.2.3. Deployment Configurations

A deployment in OpenShift is a replication controller based on a user defined template called a


46

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/cli_reference/cli-reference-basic-cli-operations#object-types

https://cloud.google.com/container-engine/docs/services/

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.2/html/architecture/core-concepts#architecture-core-concepts-routes

A deployment in OpenShift is a replication controller based on a user defined template called adeployment configuration. Deployments are created manually or in response to triggered events. Referto the Openshift documentation for more information.

4.1.2.3.1. Triggers

A trigger drives the creation of new deployments in response to events, both inside and outsideOpenShift. Refer to the Openshift documentation for more information.

Deployment Triggers

${APPLICATION_NAME}-rhpamcentrmon ImageChange

${APPLICATION_NAME}-smartrouter ImageChange

4.1.2.3.2. Replicas

A replication controller ensures that a specified number of pod "replicas" are running at any one time. Ifthere are too many, the replication controller kills some pods. If there are too few, it starts more. Refer tothe container-engine documentation for more information.

Deployment Replicas

${APPLICATION_NAME}-rhpamcentrmon 1

${APPLICATION_NAME}-smartrouter 2

4.1.2.3.3. Pod Template

4.1.2.3.3.1. Service Accounts

Service accounts are API objects that exist within each project. They can be created or deleted like anyother API object. Refer to the Openshift documentation for more information.

Deployment Service Account

${APPLICATION_NAME}-rhpamcentrmon ${APPLICATION_NAME}-rhpamsvc

4.1.2.3.3.2. Image

Deployment Image

${APPLICATION_NAME}-rhpamcentrmon rhpam73-businesscentral-monitoring-openshift

${APPLICATION_NAME}-smartrouter rhpam73-smartrouter-openshift

4.1.2.3.3.3. Readiness Probe


47

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/deployments#dev-guide-how-deployments-work

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/deployments#triggers

https://cloud.google.com/container-engine/docs/replicationcontrollers/

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/dev-guide-service-accounts#dev-managing-service-accounts


/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/kie-wb.jsp

4.1.2.3.3.4. Liveness Probe


/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/kie-wb.jsp

4.1.2.3.3.5. Exposed Ports

Deployments Name Port Protocol


jolokia 8778 TCP

http 8080 TCP

https 8443 TCP

ping 8888 TCP


http 9000 TCP

4.1.2.3.3.6. Image Environment Variables

Deployment Variable name Description Example value


KIE_ADMIN_PWD KIE administratorpassword

${KIE_ADMIN_PWD}

KIE_ADMIN_USER KIE administratorusername

${KIE_ADMIN_USER}

KIE_SERVER_PWD KIE server password,used to connect to KIEservers. Generatedvalue can be asuggestion to use forthew s2i various (Setsthe org.kie.server.pwdsystem property)

${KIE_SERVER_PWD}


48

KIE_SERVER_USER KIE server username(Sets theorg.kie.server.usersystem property)

${KIE_SERVER_USER}

MAVEN_REPOS — RHPAMCENTR,EXTERNAL

RHPAMCENTR_MAVEN_REPO_ID

— repo-rhpamcentr


The service name for theoptional businesscentral, where it can bereached, to allow servicelookups (for maven repousage), if required

${BUSINESS_CENTRAL_MAVEN_SERVICE}

RHPAMCENTR_MAVEN_REPO_PATH

— /maven2/


Username to access theMaven service hosted byBusiness Central insideEAP.

${BUSINESS_CENTRAL_MAVEN_USERNAME}


Password to access theMaven service hosted byBusiness Central insideEAP.

${BUSINESS_CENTRAL_MAVEN_PASSWORD}


The id to use for themaven repository, if set.Default is generatedrandomly.

${MAVEN_REPO_ID}


Fully qualified URL to aMaven repository orservice.

${MAVEN_REPO_URL}


Username to access theMaven repository, ifrequired.

${MAVEN_REPO_USERNAME}


Password to access theMaven repository, ifrequired.

${MAVEN_REPO_PASSWORD}



49


If OpenShift integrationof Business Central isturned on, setting thisparameter to trueenables connection toKIE Server via anOpenShift internalService endpoint. (Setstheorg.kie.server.controller.openshift.prefer.kieserver.service systemproperty)

${KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE}


KIE ServerTemplateCache TTL inmilliseconds (Sets theorg.kie.server.controller.template.cache.ttlsystem property)

${KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL}


If set to true, turns onOpenShift integrationfeature in BusinessCentral. With OpenShiftintegration, BusinessCentral automaticallydiscovers and connectsto any KIE server in thesame namespace,provided that OpenShiftintegration(OpenShiftStartupStrategy) is enabled on theKIE server. (Sets theorg.kie.workbench.controller.openshift.enabledsystem property)

${KIE_WORKBENCH_CONTROLLER_OPENSHIFT_ENABLED}


KIE server monitorusername. (Sets theorg.kie.server.controller.user system property)

${KIE_SERVER_MONITOR_USER}


KIE server monitorpassword. (Sets theorg.kie.server.controller.pwd system property)

${KIE_SERVER_MONITOR_PWD}



50


KIE server monitor tokenfor bearerauthentication. (Sets theorg.kie.server.controller.token system property)

${KIE_SERVER_MONITOR_TOKEN}

HTTPS_KEYSTORE_DIR

— /etc/businesscentral-secret-volume

HTTPS_KEYSTORE The name of thekeystore file within thesecret.

${BUSINESS_CENTRAL_HTTPS_KEYSTORE}

HTTPS_NAME The name associatedwith the servercertificate.

${BUSINESS_CENTRAL_HTTPS_NAME}

HTTPS_PASSWORD The password for thekeystore and certificate.

${BUSINESS_CENTRAL_HTTPS_PASSWORD}

JGROUPS_PING_PROTOCOL

— openshift.DNS_PING

OPENSHIFT_DNS_PING_SERVICE_NAME

— ${APPLICATION_NAME}-rhpamcentrmon-ping

OPENSHIFT_DNS_PING_SERVICE_PORT

— 8888

SSO_URL RH-SSO URL. ${SSO_URL}

SSO_OPENIDCONNECT_DEPLOYMENTS

— ROOT.war

SSO_REALM RH-SSO Realm name. ${SSO_REALM}

SSO_SECRET Business CentralMonitoring RH-SSOClient Secret.

${BUSINESS_CENTRAL_SSO_SECRET}

SSO_CLIENT Business CentralMonitoring RH-SSOClient name.

${BUSINESS_CENTRAL_SSO_CLIENT}



51

SSO_USERNAME RH-SSO Realm AdminUsername used tocreate the Client if itdoesn’t exist.

${SSO_USERNAME}

SSO_PASSWORD RH-SSO Realm AdminPassword used to createthe Client.

${SSO_PASSWORD}


RH-SSO Disable SSLCertificate Validation.

${SSO_DISABLE_SSL_CERTIFICATE_VALIDATION}



${SSO_PRINCIPAL_ATTRIBUTE}

HOSTNAME_HTTP Custom hostname forhttp service route.Leave blank for defaulthostname, e.g.:<application-name>-rhpamcentrmon-<project>.<default-domain-suffix>

${BUSINESS_CENTRAL_HOSTNAME_HTTP}

HOSTNAME_HTTPS Custom hostname forhttps service route.Leave blank for defaulthostname, e.g.: secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix>

${BUSINESS_CENTRAL_HOSTNAME_HTTPS}

AUTH_LDAP_URL LDAP Endpoint toconnect forauthentication.

${AUTH_LDAP_URL}

AUTH_LDAP_BIND_DN


${AUTH_LDAP_BIND_DN}


LDAP Credentials usedfor authentication.

${AUTH_LDAP_BIND_CREDENTIAL}



52


The JMX ObjectNameof theJaasSecurityDomainused to decrypt thepassword.

${AUTH_LDAP_JAAS_SECURITY_DOMAIN}


LDAP Base DN of thetop-level context tobegin the user search.

${AUTH_LDAP_BASE_CTX_DN}


LDAP search filter usedto locate the context ofthe user to authenticate.The input username oruserDN obtained fromthe login modulecallback is substitutedinto the filter anywhere a{0} expression is used. Acommon example forthe search filter is (uid={0}).

${AUTH_LDAP_BASE_FILTER}


The search scope to use. ${AUTH_LDAP_SEARCH_SCOPE}


The timeout inmilliseconds for user orrole searches.

${AUTH_LDAP_SEARCH_TIME_LIMIT}


The name of theattribute in the userentry that contains theDN of the user. This maybe necessary if the DNof the user itselfcontains specialcharacters, backslash forexample, that preventcorrect user mapping. Ifthe attribute does notexist, the entry’s DN isused.

${AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE}



53


A flag indicating if theDN is to be parsed forthe username. If set totrue, the DN is parsedfor the username. If setto false the DN is notparsed for the username.This option is usedtogether withusernameBeginStringand usernameEndString.

${AUTH_LDAP_PARSE_USERNAME}


Defines the String whichis to be removed fromthe start of the DN toreveal the username.This option is usedtogether withusernameEndString andonly taken into accountif parseUsername is setto true.

${AUTH_LDAP_USERNAME_BEGIN_STRING}


Defines the String whichis to be removed fromthe end of the DN toreveal the username.This option is usedtogether withusernameEndString andonly taken into accountif parseUsername is setto true.

${AUTH_LDAP_USERNAME_END_STRING}


Name of the attributecontaining the userroles.

${AUTH_LDAP_ROLE_ATTRIBUTE_ID}


The fixed DN of thecontext to search foruser roles. This is not theDN where the actualroles are, but the DNwhere the objectscontaining the user rolesare. For example, in aMicrosoft ActiveDirectory server, this isthe DN where the useraccount is.

${AUTH_LDAP_ROLES_CTX_DN}



54


A search filter used tolocate the rolesassociated with theauthenticated user. Theinput username oruserDN obtained fromthe login modulecallback is substitutedinto the filter anywhere a{0} expression is used.The authenticateduserDN is substitutedinto the filter anywhere a{1} is used. An examplesearch filter thatmatches on the inputusername is (member={0}). An alternative thatmatches on theauthenticated userDN is(member={1}).

${AUTH_LDAP_ROLE_FILTER}


The number of levels ofrecursion the role searchwill go below a matchingcontext. Disablerecursion by setting thisto 0.

${AUTH_LDAP_ROLE_RECURSION}


A role included for allauthenticated users.

${AUTH_LDAP_DEFAULT_ROLE}


Name of the attributewithin the roleCtxDNcontext which containsthe role name. If theroleAttributeIsDNproperty is set to true,this property is used tofind the role object’sname attribute.

${AUTH_LDAP_ROLE_NAME_ATTRIBUTE_ID}



55


A flag indicating if theDN returned by a querycontains theroleNameAttributeID. Ifset to true, the DN ischecked for theroleNameAttributeID. Ifset to false, the DN isnot checked for theroleNameAttributeID.This flag can improvethe performance ofLDAP queries.

${AUTH_LDAP_PARSE_ROLE_NAME_FROM_DN}


Whether or not theroleAttributeID containsthe fully-qualified DN ofa role object. If false, therole name is taken fromthe value of theroleNameAttributeIdattribute of the contextname. Certain directoryschemas, such asMicrosoft ActiveDirectory, require thisattribute to be set totrue.

${AUTH_LDAP_ROLE_ATTRIBUTE_IS_DN}


If you are not usingreferrals, you can ignorethis option. When usingreferrals, this optiondenotes the attributename which containsusers defined for acertain role, for examplemember, if the roleobject is inside thereferral. Users arechecked against thecontent of this attributename. If this option isnot set, the check willalways fail, so roleobjects cannot bestored in a referral tree.

${AUTH_LDAP_REFERRAL_USER_ATTRIBUTE_ID_TO_CHECK}



56


When present, theRoleMapping LoginModule will beconfigured to use theprovided file. Thisparameter defines thefully-qualified file pathand name of aproperties file orresource which mapsroles to replacementroles. The format isoriginal_role=role1,role2,role3

${AUTH_ROLE_MAPPER_ROLES_PROPERTIES}


Whether to add to thecurrent roles, or replacethe current roles withthe mapped ones.Replaces if set to true.

${AUTH_ROLE_MAPPER_REPLACE_ROLE}


KIE_SERVER_ROUTER_HOST

— —

KIE_SERVER_ROUTER_PORT

— 9000

KIE_SERVER_ROUTER_PORT_TLS

— 9443


Public URL where therouter can be found.Format http://<host>:<port> (Router propertyorg.kie.server.router.url.external)

${KIE_SERVER_ROUTER_URL_EXTERNAL}


Router ID used whenconnecting to thecontroller. (Routerpropertyorg.kie.server.router.id)

${KIE_SERVER_ROUTER_ID}


Router name used whenconnecting to thecontroller. (Routerpropertyorg.kie.server.router.name)

${KIE_SERVER_ROUTER_NAME}



57


KIE server routerprotocol. (Used to buildtheorg.kie.server.router.url.external property)

${KIE_SERVER_ROUTER_PROTOCOL}

KIE_SERVER_ROUTER_TLS_KEYSTORE_KEYALIAS

The name associatedwith the servercertificate.

${KIE_SERVER_ROUTER_HTTPS_NAME}

KIE_SERVER_ROUTER_TLS_KEYSTORE_PASSWORD

The password for thekeystore and certificate.

${KIE_SERVER_ROUTER_HTTPS_PASSWORD}

KIE_SERVER_ROUTER_TLS_KEYSTORE

— /etc/smartrouter-secret-volume/${KIE_SERVER_ROUTER_HTTPS_KEYSTORE}


KIE server monitorusername. (Sets theorg.kie.server.controller.user system property)



KIE server monitorpassword. (Sets theorg.kie.server.controller.pwd system property)





KIE_SERVER_CONTROLLER_SERVICE

— ${APPLICATION_NAME}-rhpamcentrmon

KIE_SERVER_CONTROLLER_PROTOCOL

— http

KIE_SERVER_ROUTER_REPO

— /opt/rhpam-smartrouter/data

KIE_SERVER_ROUTER_CONFIG_WATCHER_ENABLED

— true



58

4.1.2.3.3.7. Volumes

Deployment Name mountPath Purpose readOnly


businesscentral-keystore-volume

/etc/businesscentral-secret-volume

ssl certs True



/opt/rhpam-smartrouter/data

— false

4.1.2.4. External Dependencies

4.1.2.4.1. Volume Claims

A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by anadministrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWSElastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for moreinformation.

Name Access Mode

${APPLICATION_NAME}-smartrouter-claim ReadWriteMany

${APPLICATION_NAME}-rhpamcentr-claim ReadWriteMany

4.1.2.4.2. Secrets

This template requires the following secrets to be installed for the application to run.

smartrouter-app-secret businesscentral-app-secret

4.2. RHPAM73-PROD-IMMUTABLE-KIESERVER.YAML TEMPLATE

Application template for an immutable KIE server in a production environment, for Red Hat ProcessAutomation Manager 7.3

4.2.1. Parameters



59

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/dev-guide-persistent-volumes




APPLICATION_NAME


myapp True

KIE_ADMIN_USER

KIE_ADMIN_USER

KIE administratorusername.

adminUser False

KIE_ADMIN_PWD

KIE_ADMIN_PWD

KIE administratorpassword.

— False

KIE_SERVER_USER

KIE_SERVER_USER

KIE serverusername. (Setstheorg.kie.server.usersystem property)

executionUser False

KIE_SERVER_PWD

KIE_SERVER_PWD

KIE serverpassword, used toconnect to KIEservers. Value isautomaticallygenerated bydefault. (Sets theorg.kie.server.pwdsystem property)

— False



openshift True


60

KIE_SERVER_IMAGE_STREAM_NAME

— The name of theimage stream touse for KIE server.Default is"rhpam73-kieserver-openshift".

rhpam73-kieserver-openshift

True

IMAGE_STREAM_TAG


1.1 True

KIE_SERVER_MONITOR_USER


KIE server monitorusername, foroptional use ofBusiness CentralMonitoring. (Setstheorg.kie.server.controller.user systemproperty)

monitorUser False

KIE_SERVER_MONITOR_PWD


KIE server monitorpassword, foroptional use ofBusiness CentralMonitoring. (Setstheorg.kie.server.controller.pwd systemproperty)

— False

KIE_SERVER_MONITOR_TOKEN


KIE server monitortoken for bearerauthentication.(Sets theorg.kie.server.controller.token systemproperty)

— False




61

KIE_SERVER_MONITOR_SERVICE


The service namefor the optionalBusiness CentralMonitoring. Theapplication usesthis service nameto register with themonitoringconsole. (If set, willbe used todiscover host andport)

— False

KIE_SERVER_ROUTER_SERVICE


The service namefor the optionalsmart router.

— False



The host name ofthe smart router,which can be theservice nameresolved byOpenShift or aglobally resolvabledomain name.

myapp-smartrouter

False



Port on which thesmart router serverlistens. (Routerpropertyorg.kie.server.router.port)

9000 False




http False

KIE_SERVER_PERSISTENCE_DS


KIE serverpersistencedatasource. (Setstheorg.kie.server.persistence.ds systemproperty)

java:/jboss/datasources/rhpam

False




62

POSTGRESQL_IMAGE_STREAM_NAMESPACE

— Namespace inwhich theImageStream forthe PostgreSQLimage is installed.The ImageStreamis already installedin the openshiftnamespace. Youshould only needto modify this ifyou installed theImageStream in adifferentnamespace/project. Default is"openshift".

openshift False

POSTGRESQL_IMAGE_STREAM_TAG

— The PostgreSQLimage version,which is intendedto correspond tothe PostgreSQLversion. Default is"10".

10 False

KIE_SERVER_POSTGRESQL_USER

RHPAM_USERNAME

KIE serverPostgreSQLdatabaseusername.

rhpam False

KIE_SERVER_POSTGRESQL_PWD

RHPAM_PASSWORD

KIE serverPostgreSQLdatabasepassword.

— False

KIE_SERVER_POSTGRESQL_DB

RHPAM_DATABASE

KIE serverPostgreSQLdatabase name.

rhpam7 False

POSTGRESQL_MAX_PREPARED_TRANSACTIONS


Allows thePostgreSQL tohandle XAtransactions.

100 True




63

DB_VOLUME_CAPACITY

— Size of persistentstorage for thedatabase volume.

1Gi True

KIE_SERVER_POSTGRESQL_DIALECT

KIE_SERVER_PERSISTENCE_DIALECT

KIE serverPostgreSQLHibernate dialect.


True

KIE_MBEANS KIE_MBEANS KIE server mbeansenabled/disabled.(Sets thekie.mbeans andkie.scanner.mbeans systemproperties)

enabled False

DROOLS_SERVER_FILTER_CLASSES


KIE server classfiltering. (Sets theorg.drools.server.filter.classes systemproperty)

true False

KIE_SERVER_HOSTNAME_HTTP

HOSTNAME_HTTP

Custom hostnamefor http serviceroute. Leave blankfor defaulthostname, e.g.:<application-name>-kieserver-<project>.<default-domain-suffix>

— False

KIE_SERVER_HOSTNAME_HTTPS

HOSTNAME_HTTPS

Custom hostnamefor https serviceroute. Leave blankfor defaulthostname, e.g.:secure-<application-name>-kieserver-<project>.<default-domain-suffix>

— False




64

KIE_SERVER_USE_SECURE_ROUTE_NAME


If true, the KIEserver will usesecure-<application-name>-kieservervs. <application-name>-kieserveras the KIE serverroute endpoint forBusiness Centralto report.Therefore,Business Centraldisplays the securelink to the user.

false False

KIE_SERVER_HTTPS_SECRET


kieserver-app-secret

True

KIE_SERVER_HTTPS_KEYSTORE

HTTPS_KEYSTORE


keystore.jks False

KIE_SERVER_HTTPS_NAME


jboss False

KIE_SERVER_HTTPS_PASSWORD

HTTPS_PASSWORD



KIE_SERVER_BYPASS_AUTH_USER


Allows the KIEserver to bypassthe authenticateduser for taskrelated operationse.g. queries. (Setstheorg.kie.server.bypass.auth.usersystem property)

false False




65

KIE_SERVER_CONTAINER_DEPLOYMENT


KIE ServerContainerdeploymentconfiguration informat:containerId=groupId:artifactId:version|c2=g2:a2:v2

rhpam-kieserver-library=org.openshift.quickstarts:rhpam-kieserver-library:1.4.0-SNAPSHOT

True

SOURCE_REPOSITORY_URL

— Git source URI forapplication.

https://github.com/jboss-container-images/rhpam-7-openshift-image.git

True

SOURCE_REPOSITORY_REF

— Git branch/tagreference.

master False

CONTEXT_DIR — Path within Gitproject to build;empty for rootproject directory.

quickstarts/library-process/library

False

GITHUB_WEBHOOK_SECRET

— GitHub triggersecret.

— True

GENERIC_WEBHOOK_SECRET

— Generic buildtrigger secret.

— True

MAVEN_MIRROR_URL

MAVEN_MIRROR_URL

Maven mirror touse for S2I builds.If enabled, themirror mustcontain all theartifacts necessaryfor building andrunning therequired services.

— False

MAVEN_MIRROR_OF

MAVEN_MIRROR_OF

Maven mirrorconfiguration forKIE server.

external:* False




66

https://github.com/jboss-container-images/rhpam-7-openshift-image.git

MAVEN_REPO_ID


The id to use forthe mavenrepository. If set, itcan be excludedfrom the optionallyconfigured mirrorby adding it toMAVEN_MIRROR_OF. For example:external:*,!repo-rhpamcentr,!repo-custom. IfMAVEN_MIRROR_URL is set butMAVEN_MIRROR_ID is not set, an idwill be generatedrandomly, butwon’t be usable inMAVEN_MIRROR_OF.

repo-custom False

MAVEN_REPO_URL


Fully qualified URLto a Mavenrepository.

— False

MAVEN_REPO_USERNAME



— False

MAVEN_REPO_PASSWORD



— False



The service namefor the optionalBusiness Central,where it can bereached, to allowservice lookups(for maven repousage), if required.

myapp-rhpamcentr

False




67




mavenUser False




maven1! False

ARTIFACT_DIR — List of directoriesfrom whicharchives will becopied into thedeployment folder.If unspecified, allarchives in /targetwill be copied.

— False

TIMER_SERVICE_DATA_STORE_REFRESH_INTERVAL


Sets refresh-interval for theEJB timer servicedatabase-data-store.

30000 False

KIE_SERVER_MEMORY_LIMIT

— KIE serverContainer memorylimit.

1Gi False

KIE_SERVER_MGMT_DISABLED


Disablemanagement apiand don’t allow KIEcontainers to bedeployed/undeployed orstarted/stoppedsets the propertyorg.kie.server.mgmt.api.disabled totrue andorg.kie.server.startup.strategy toLocalContainersStartupStrategy.

true True




68

KIE_SERVER_STARTUP_STRATEGY


When set toOpenShiftStartupStrategy, allowsKIE server to startup independentlyusing shared statefrom OpenShiftAPI service and toconnect to aBusiness Centralthat usesOpenShiftintegration. Whenset toLocalContainersStartupStrategy,allows KIE serverto start up andfunction with localconfig, even whena controller isconfigured andunavailable.

LocalContainersStartupStrategy

True


False


— False

KIE_SERVER_SSO_CLIENT

SSO_CLIENT KIE Server RH-SSO Client name.

— False

KIE_SERVER_SSO_SECRET

SSO_SECRET KIE Server RH-SSO Client Secret.

252793ed-7118-4ca8-8dab-5622fa97d892

False

SSO_USERNAME

SSO_USERNAME


— False

SSO_PASSWORD

SSO_PASSWORD


— False




69





false False




preferred_username

False

AUTH_LDAP_URL

AUTH_LDAP_URL



False

AUTH_LDAP_BIND_DN

AUTH_LDAP_BIND_DN



False




Password False




— False





False




70




(uid={0}) False




SUBTREE_SCOPE

False




10000 False




distinguishedName

False




71




true False




— False




— False




72




memberOf False





False




73








1 False



A role included forall authenticatedusers

guest False




74




name False




false False




false False




75




— False




— False




— False




76

4.2.2. Objects


4.2.2.1. Services



${APPLICATION_NAME}-kieserver

8080 http All the KIE server webserver’s ports.

8443 https

${APPLICATION_NAME}-kieserver-ping


${APPLICATION_NAME}-postgresql

5432 — The database server’sport.

4.2.2.2. Routes



${APPLICATION_NAME}-kieserver-http

none ${KIE_SERVER_HOSTNAME_HTTP}

${APPLICATION_NAME}-kieserver-https

TLS passthrough ${KIE_SERVER_HOSTNAME_HTTPS}

4.2.2.3. Build Configurations

A buildConfig describes a single build definition and a set of triggers for when a new build should becreated. A buildConfig is a REST object, which can be used in a POST to the API server to create a newinstance. Refer to the Openshift documentation for more information.

S2I image link Build output BuildTriggers andSettings


77




https://docs.okd.io/latest/dev_guide/builds/index.html#defining-a-buildconfig

rhpam73-kieserver-openshift:1.1

rhpam-7/rhpam73-kieserver-openshift

${APPLICATION_NAME}-kieserver:latest

GitHub, Generic,ImageChange,ConfigChange

S2I image link Build output BuildTriggers andSettings



4.2.2.4.1. Triggers


Deployment Triggers

${APPLICATION_NAME}-kieserver ImageChange

${APPLICATION_NAME}-postgresql ImageChange

4.2.2.4.2. Replicas


Deployment Replicas

${APPLICATION_NAME}-kieserver 2

${APPLICATION_NAME}-postgresql 1





${APPLICATION_NAME}-kieserver ${APPLICATION_NAME}-kieserver


78

../../../kieserver/image.yaml





4.2.2.4.3.2. Image

Deployment Image


${APPLICATION_NAME}-postgresql postgresql



/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck


/usr/libexec/check-container



/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/healthcheck


/usr/libexec/check-container --live




jolokia 8778 TCP

http 8080 TCP

https 8443 TCP

ping 8888 TCP


— 5432 TCP



79



KIE_ADMIN_USER KIE administratorusername.

${KIE_ADMIN_USER}

KIE_ADMIN_PWD KIE administratorpassword.

${KIE_ADMIN_PWD}

KIE_SERVER_MODE — DEVELOPMENT

KIE_MBEANS KIE server mbeansenabled/disabled. (Setsthe kie.mbeans andkie.scanner.mbeanssystem properties)

${KIE_MBEANS}


KIE server class filtering.(Sets theorg.drools.server.filter.classes system property)

${DROOLS_SERVER_FILTER_CLASSES}


Allows the KIE server tobypass theauthenticated user fortask related operationse.g. queries. (Sets theorg.kie.server.bypass.auth.user system property)

${KIE_SERVER_BYPASS_AUTH_USER}


KIE server monitorusername, for optionaluse of Business CentralMonitoring. (Sets theorg.kie.server.controller.user system property)



KIE server monitorpassword, for optionaluse of Business CentralMonitoring. (Sets theorg.kie.server.controller.pwd system property)






80


The service name for theoptional BusinessCentral Monitoring. Theapplication uses thisservice name to registerwith the monitoringconsole. (If set, will beused to discover hostand port)

${KIE_SERVER_MONITOR_SERVICE}


— ws

KIE_SERVER_ID — ${APPLICATION_NAME}-kieserver

KIE_SERVER_ROUTE_NAME

— ${APPLICATION_NAME}-kieserver


If true, the KIE server willuse secure-<application-name>-kieserver vs.<application-name>-kieserver as the KIEserver route endpointfor Business Central toreport. Therefore,Business Centraldisplays the secure linkto the user.

${KIE_SERVER_USE_SECURE_ROUTE_NAME}

KIE_SERVER_USER KIE server username.(Sets theorg.kie.server.usersystem property)

${KIE_SERVER_USER}

KIE_SERVER_PWD KIE server password,used to connect to KIEservers. Value isautomatically generatedby default. (Sets theorg.kie.server.pwdsystem property)

${KIE_SERVER_PWD}



81


KIE Server Containerdeploymentconfiguration in format:containerId=groupId:artifactId:version

c2=g2:a2:v2

${KIE_SERVER_CONTAINER_DEPLOYMENT}

MAVEN_MIRROR_URL

Maven mirror to use forS2I builds. If enabled,the mirror must containall the artifactsnecessary for buildingand running the requiredservices.

${MAVEN_MIRROR_URL}

MAVEN_MIRROR_OF

Maven mirrorconfiguration for KIEserver.

${MAVEN_MIRROR_OF}

MAVEN_REPOS —

RHPAMCENTR,EXTERNAL


—

repo-rhpamcentr RHPAMCENTR_MAVEN_REPO_SERVICE

The service name for theoptional BusinessCentral, where it can bereached, to allow servicelookups (for maven repousage), if required.



—

/maven2/ RHPAMCENTR_MAVEN_REPO_USERNAME







82



The id to use for themaven repository. If set,it can be excluded fromthe optionallyconfigured mirror byadding it toMAVEN_MIRROR_OF.For example:external:*,!repo-rhpamcentr,!repo-custom. IfMAVEN_MIRROR_URLis set butMAVEN_MIRROR_ID isnot set, an id will begenerated randomly, butwon’t be usable inMAVEN_MIRROR_OF.

${MAVEN_REPO_ID} EXTERNAL_MAVEN_REPO_URL

Fully qualified URL to aMaven repository.

${MAVEN_REPO_URL}








The service name for theoptional smart router.

${KIE_SERVER_ROUTER_SERVICE}


The host name of thesmart router, which canbe the service nameresolved by OpenShiftor a globally resolvabledomain name.

${KIE_SERVER_ROUTER_HOST}


Port on which the smartrouter server listens.(Router propertyorg.kie.server.router.port)



83

${KIE_SERVER_ROUTER_PORT}





KIE server persistencedatasource. (Sets theorg.kie.server.persistence.ds system property)

${KIE_SERVER_PERSISTENCE_DS}

DATASOURCES —

RHPAM RHPAM_DATABASE KIE server PostgreSQLdatabase name.

${KIE_SERVER_POSTGRESQL_DB}

RHPAM_JNDI KIE server persistencedatasource. (Sets theorg.kie.server.persistence.ds system property)


RHPAM_JTA —

true RHPAM_DRIVER —

postgresql KIE_SERVER_PERSISTENCE_DIALECT

KIE server PostgreSQLHibernate dialect.

${KIE_SERVER_POSTGRESQL_DIALECT}

RHPAM_USERNAME KIE server PostgreSQLdatabase username.

${KIE_SERVER_POSTGRESQL_USER}

RHPAM_PASSWORD KIE server PostgreSQLdatabase password.

${KIE_SERVER_POSTGRESQL_PWD}

RHPAM_SERVICE_HOST

—


RHPAM_SERVICE_PORT

—

5432 TIMER_SERVICE_DATA_STORE_REFRESH_INTERVAL

Sets refresh-interval forthe EJB timer servicedatabase-data-store.



84

${TIMER_SERVICE_DATA_STORE_REFRESH_INTERVAL}

HTTPS_KEYSTORE_DIR

—

/etc/kieserver-secret-volume


${KIE_SERVER_HTTPS_KEYSTORE}


${KIE_SERVER_HTTPS_NAME}


${KIE_SERVER_HTTPS_PASSWORD}


Disable management apiand don’t allow KIEcontainers to bedeployed/undeployedor started/stopped setsthe propertyorg.kie.server.mgmt.api.disabled to true andorg.kie.server.startup.strategy toLocalContainersStartupStrategy.

${KIE_SERVER_MGMT_DISABLED}


When set toOpenShiftStartupStrategy, allows KIE server tostart up independentlyusing shared state fromOpenShift API serviceand to connect to aBusiness Central thatuses OpenShiftintegration. When set toLocalContainersStartupStrategy, allows KIEserver to start up andfunction with localconfig, even when acontroller is configuredand unavailable.

${KIE_SERVER_STARTUP_STRATEGY}


—



85

openshift.DNS_PING OPENSHIFT_DNS_PING_SERVICE_NAME

—



—

8888 SSO_URL RH-SSO URL.

${SSO_URL} SSO_OPENIDCONNECT_DEPLOYMENTS

—

ROOT.war SSO_REALM RH-SSO Realm name.

${SSO_REALM} SSO_SECRET KIE Server RH-SSOClient Secret.

${KIE_SERVER_SSO_SECRET}

SSO_CLIENT KIE Server RH-SSOClient name.

${KIE_SERVER_SSO_CLIENT}


${SSO_USERNAME} SSO_PASSWORD RH-SSO Realm AdminPassword used to createthe Client.

${SSO_PASSWORD} SSO_DISABLE_SSL_CERTIFICATE_VALIDATION






HOSTNAME_HTTP Custom hostname forhttp service route.Leave blank for defaulthostname, e.g.:<application-name>-kieserver-<project>.<default-domain-suffix>



86

${KIE_SERVER_HOSTNAME_HTTP}

HOSTNAME_HTTPS Custom hostname forhttps service route.Leave blank for defaulthostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix>

${KIE_SERVER_HOSTNAME_HTTPS}


${AUTH_LDAP_URL} AUTH_LDAP_BIND_DN
















The search scope to use.

${AUTH_LDAP_SEARCH_SCOPE}





87















88















A role included for allauthenticated users



89












90












POSTGRESQL_USER

KIE server PostgreSQLdatabase username.


POSTGRESQL_PASSWORD

KIE server PostgreSQLdatabase password.


POSTGRESQL_DATABASE

KIE server PostgreSQLdatabase name.



91



Allows the PostgreSQLto handle XAtransactions.


4.2.2.4.3.7. Volumes



kieserver-keystore-volume


ssl certs True


${APPLICATION_NAME}-postgresql-pvol

/var/lib/pgsql/data

postgresql false




Name Access Mode

${APPLICATION_NAME}-postgresql-claim ReadWriteOnce

4.2.2.5.2. Secrets



4.3. RHPAM73-KIESERVER-EXTERNALDB.YAML TEMPLATE

Application template for a managed KIE Server with an external database, for Red Hat ProcessAutomation Manager 7.3

4.3.1. Parameters



92





APPLICATION_NAME


myapp True

MAVEN_MIRROR_URL

MAVEN_MIRROR_URL

Maven mirror thatthe KIE servermust use. If youconfigure a mirror,this mirror mustcontain all artifactsthat are requiredfor building anddeploying yourservices.

— False

MAVEN_MIRROR_OF

MAVEN_MIRROR_OF


external:* False

MAVEN_REPO_ID



repo-custom False

MAVEN_REPO_URL




True


93


MAVEN_REPO_USERNAME



— False

MAVEN_REPO_PASSWORD



— False



The service namefor the optionalbusiness central,where it can bereached, to allowservice lookups(for maven repousage), if required.

myapp-rhpamcentr

False




mavenUser False




maven1! False

KIE_ADMIN_USER

KIE_ADMIN_USER


adminUser False

KIE_ADMIN_PWD

KIE_ADMIN_PWD


— False

KIE_SERVER_USER

KIE_SERVER_USER


executionUser False

KIE_SERVER_PWD

KIE_SERVER_PWD

KIE serverpassword. (Setstheorg.kie.server.pwdsystem property)

— False




94



openshift True




True

IMAGE_STREAM_TAG


1.1 True




— False




myapp-smartrouter

False




95




9000 False




http False



KIE servercontrollerusername. (Setstheorg.kie.server.controller.user systemproperty)

controllerUser False



KIE servercontrollerpassword. (Setstheorg.kie.server.controller.pwd systemproperty)

— False



KIE servercontroller tokenfor bearerauthentication.(Sets theorg.kie.server.controller.token systemproperty)

— False




96




— False

KIE_SERVER_CONTROLLER_HOST


KIE servercontroller host.(Used to set theorg.kie.server.controller systemproperty)

my-app-controller-ocpuser.os.example.com

False

KIE_SERVER_CONTROLLER_PORT


KIE servercontroller port.(Used to set theorg.kie.server.controller systemproperty)

8080 False

KIE_SERVER_PERSISTENCE_SCHEMA


Hibernatepersistenceschema.

bd.schema False

KIE_SERVER_EXTERNALDB_DIALECT


KIE server externaldatabaseHibernate dialect.

org.hibernate.dialect.MySQL57Dialect

True




97

KIE_SERVER_EXTERNALDB_SERVICE_HOST

RHPAM_SERVICE_HOST

Sets thedatasource servicehost. Use this ifyou want to usethe predefinedmysql orpostgresqldatasourceproperties. Leaveblank if theKIE_SERVER_EXTERNALDB_URL isset.

10.10.10.1 False

KIE_SERVER_EXTERNALDB_SERVICE_PORT

RHPAM_SERVICE_PORT

Sets thedatasource serviceport. Use this ifyou want to usethe predefinedmysql orpostgresqldatasourceproperties. Leaveblank if theKIE_SERVER_EXTERNALDB_URL isset.

4321 False

KIE_SERVER_EXTERNALDB_NONXA

RHPAM_NONXA

Sets thedatasources type.It can be XA orNONXA. For nonXA set it to true.Default value isfalse.

True False




98

KIE_SERVER_EXTERNALDB_URL

RHPAM_URL Sets thedatasource jdbcconnection url.Note that, if youare usingPostgreSQL donot use this field,use theSERVICE_HOSTand PORT. If usingSERVICE_PORTand HOST there isno need to fill thisparameter.

jdbc:mysql://127.0.0.1:3306/rhpam

False

KIE_SERVER_EXTERNALDB_DRIVER

RHPAM_DRIVER

The predefineddriver name,available valuesare mysql,postgresql or thepreferred name forthe external driver.

mysql True

KIE_SERVER_EXTERNALDB_JNDI


Database JNDIname used byapplication toresolve thedatasource, e.g.java:/jboss/datasources/ExampleDS.

java:jboss/datasources/jbpmDS

True

KIE_SERVER_EXTERNALDB_DB

RHPAM_DATABASE

KIE server externaldatabase name.Leave blank if theKIE_SERVER_EXTERNALDB_URL isset.

rhpam False

KIE_SERVER_EXTERNALDB_USER

RHPAM_USERNAME

KIE server externaldatabaseusername.

rhpam True

KIE_SERVER_EXTERNALDB_PWD

RHPAM_PASSWORD

KIE server externaldatabasepassword.

— True




99

KIE_SERVER_EXTERNALDB_MIN_POOL_SIZE

RHPAM_MIN_POOL_SIZE

Sets xa-pool/min-pool-size for theconfigureddatasource.

— False

KIE_SERVER_EXTERNALDB_MAX_POOL_SIZE

RHPAM_MAX_POOL_SIZE

Sets xa-pool/max-pool-size for theconfigureddatasource.

— False

KIE_SERVER_EXTERNALDB_CONNECTION_CHECKER

RHPAM_CONNECTION_CHECKER

Anorg.jboss.jca.adapters.jdbc.ValidConnectionCheckerthat provides aSQLExceptionisValidConnection(Connection e)method to validateif a connection isvalid.

org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker

False

KIE_SERVER_EXTERNALDB_EXCEPTION_SORTER

RHPAM_EXCEPTION_SORTER

Anorg.jboss.jca.adapters.jdbc.ExceptionSorter thatprovides a booleanisExceptionFatal(SQLException e)method to validateif an exceptionshould bebroadcast to alljavax.resource.spi.ConnectionEventListener as aconnectionErrorOccurred.

org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter

False

KIE_SERVER_EXTERNALDB_BACKGROUND_VALIDATION

RHPAM_BACKGROUND_VALIDATION

Sets the sqlvalidation methodto background-validation, if set tofalse the validate-on-match methodwill be used.

true False




100

KIE_SERVER_EXTERNALDB_BACKGROUND_VALIDATION_MILLIS

RHPAM_VALIDATION_MILLIS

Defines theinterval for thebackground-validation checkfor the jdbcconnections.

10000 False

KIE_SERVER_EXTERNALDB_DRIVER_TYPE

RHPAM_DRIVER_TYPE

KIE server externaldatabase drivertype, applicableonly for DB2,possible values are4 (default) or 2.

4 False

KIE_SERVER_MODE

KIE_SERVER_MODE

The KIE Servermode. Valid valuesare'DEVELOPMENT'or 'PRODUCTION'.In productionmode, you can notdeploySNAPSHOTversions ofartifacts on the KIEserver and can notchange the versionof an artifact in anexisting container.(Sets theorg.kie.server.mode systemproperty).

PRODUCTION False

KIE_MBEANS KIE_MBEANS KIE server mbeansenabled/disabled(Sets thekie.mbeans andkie.scanner.mbeans systemproperties).

enabled False



KIE server classfiltering (Sets theorg.drools.server.filter.classes systemproperty).

true False




101


HOSTNAME_HTTP


— False


HOSTNAME_HTTPS


— False




false False




True


HTTPS_KEYSTORE


keystore.jks False



jboss False




102


HTTPS_PASSWORD






false False



Sets refresh-interval for theEJB timerdatabase data-store service.

30000 False



1Gi False





False




103



Disablemanagement apiand don’t allow KIEcontainers to bedeployed/undeployed orstarted/stopped.Sets the propertyorg.kie.server.mgmt.api.disabled totrue andorg.kie.server.startup.strategy toLocalContainersStartupStrategy.

true False





False


False


— False



— False




104




252793ed-7118-4ca8-8dab-5622fa97d892

False

SSO_USERNAME

SSO_USERNAME


— False

SSO_PASSWORD

SSO_PASSWORD


— False




false False




preferred_username

False

AUTH_LDAP_URL

AUTH_LDAP_URL



False

AUTH_LDAP_BIND_DN

AUTH_LDAP_BIND_DN



False




Password False




— False





False




105




(uid={0}) False




SUBTREE_SCOPE

False




10000 False




distinguishedName

False




106




true False




— False




— False




107




memberOf False





False




108








1 False




guest False




109




name False




false False




false False




110




— False



When present, theRoleMappingLogin Module willbe configured touse the providedfile. This propertydefines the fully-qualified file pathand name of aproperties file orresource whichmaps roles toreplacement roles.The format isoriginal_role=role1,role2,role3

— False




— False




111

4.3.2. Objects


4.3.2.1. Services





8443 https



4.3.2.2. Routes









4.3.2.3.1. Triggers


Deployment Triggers



112






4.3.2.3.2. Replicas


Deployment Replicas







4.3.2.3.3.2. Image

Deployment Image

${APPLICATION_NAME}-kieserver ${KIE_SERVER_IMAGE_STREAM_NAME}









113





jolokia 8778 TCP

http 8080 TCP

https 8443 TCP

ping 8888 TCP





${KIE_ADMIN_USER}


${KIE_ADMIN_PWD}

KIE_SERVER_MODE The KIE Server mode.Valid values are'DEVELOPMENT' or'PRODUCTION'. Inproduction mode, youcan not deploySNAPSHOT versions ofartifacts on the KIEserver and can notchange the version of anartifact in an existingcontainer. (Sets theorg.kie.server.modesystem property).

${KIE_SERVER_MODE}

KIE_MBEANS KIE server mbeansenabled/disabled (Setsthe kie.mbeans andkie.scanner.mbeanssystem properties).

${KIE_MBEANS}


KIE server class filtering(Sets theorg.drools.server.filter.classes system property).



114





KIE server controllerusername. (Sets theorg.kie.server.controller.user system property)

${KIE_SERVER_CONTROLLER_USER}


KIE server controllerpassword. (Sets theorg.kie.server.controller.pwd system property)

${KIE_SERVER_CONTROLLER_PWD}


KIE server controllertoken for bearerauthentication. (Sets theorg.kie.server.controller.token system property)

${KIE_SERVER_CONTROLLER_TOKEN}



${KIE_SERVER_CONTROLLER_SERVICE}


— ws


KIE server controllerhost. (Used to set theorg.kie.server.controllersystem property)

${KIE_SERVER_CONTROLLER_HOST}


KIE server controllerport. (Used to set theorg.kie.server.controllersystem property)

${KIE_SERVER_CONTROLLER_PORT}



115








${KIE_SERVER_USER}

KIE_SERVER_PWD KIE server password.(Sets theorg.kie.server.pwdsystem property)

${KIE_SERVER_PWD}



c2=g2:a2:v2


MAVEN_MIRROR_URL

Maven mirror that theKIE server must use. Ifyou configure a mirror,this mirror must containall artifacts that arerequired for building anddeploying your services.

${MAVEN_MIRROR_URL}

MAVEN_MIRROR_OF


${MAVEN_MIRROR_OF}

MAVEN_REPOS —



116

RHPAMCENTR,EXTERNAL


—


The service name for theoptional businesscentral, where it can bereached, to allow servicelookups (for maven repousage), if required.



—













117

${MAVEN_REPO_URL}




















Disable management apiand don’t allow KIEcontainers to bedeployed/undeployedor started/stopped. Setsthe propertyorg.kie.server.mgmt.api.disabled to true andorg.kie.server.startup.strategy toLocalContainersStartupStrategy.



118






Database JNDI nameused by application toresolve the datasource,e.g.java:/jboss/datasources/ExampleDS.

${KIE_SERVER_EXTERNALDB_JNDI}


Hibernate persistenceschema.

${KIE_SERVER_PERSISTENCE_SCHEMA}


KIE server externaldatabase Hibernatedialect.

${KIE_SERVER_EXTERNALDB_DIALECT}

DATASOURCES —

RHPAM RHPAM_DATABASE KIE server externaldatabase name. Leaveblank if theKIE_SERVER_EXTERNALDB_URL is set.



119

${KIE_SERVER_EXTERNALDB_DB}

RHPAM_SERVICE_HOST

Sets the datasourceservice host. Use this ifyou want to use thepredefined mysql orpostgresql datasourceproperties. Leave blankif theKIE_SERVER_EXTERNALDB_URL is set.

${KIE_SERVER_EXTERNALDB_SERVICE_HOST}

RHPAM_SERVICE_PORT

Sets the datasourceservice port. Use this ifyou want to use thepredefined mysql orpostgresql datasourceproperties. Leave blankif theKIE_SERVER_EXTERNALDB_URL is set.

${KIE_SERVER_EXTERNALDB_SERVICE_PORT}

RHPAM_JNDI Database JNDI nameused by application toresolve the datasource,e.g.java:/jboss/datasources/ExampleDS.

${KIE_SERVER_EXTERNALDB_JNDI}

RHPAM_DRIVER The predefined drivername, available valuesare mysql, postgresql orthe preferred name forthe external driver.

${KIE_SERVER_EXTERNALDB_DRIVER}

RHPAM_USERNAME KIE server externaldatabase username.

${KIE_SERVER_EXTERNALDB_USER}

RHPAM_PASSWORD KIE server externaldatabase password.

${KIE_SERVER_EXTERNALDB_PWD}

RHPAM_NONXA Sets the datasourcestype. It can be XA orNONXA. For non XA setit to true. Default valueis false.



120

${KIE_SERVER_EXTERNALDB_NONXA}

RHPAM_URL Sets the datasource jdbcconnection url. Notethat, if you are usingPostgreSQL do not usethis field, use theSERVICE_HOST andPORT. If usingSERVICE_PORT andHOST there is no needto fill this parameter.

${KIE_SERVER_EXTERNALDB_URL}

RHPAM_XA_CONNECTION_PROPERTY_URL

Sets the datasource jdbcconnection url. Notethat, if you are usingPostgreSQL do not usethis field, use theSERVICE_HOST andPORT. If usingSERVICE_PORT andHOST there is no needto fill this parameter.

${KIE_SERVER_EXTERNALDB_URL}

RHPAM_MIN_POOL_SIZE

Sets xa-pool/min-pool-size for the configureddatasource.

${KIE_SERVER_EXTERNALDB_MIN_POOL_SIZE}

RHPAM_MAX_POOL_SIZE

Sets xa-pool/max-pool-size for the configureddatasource.

${KIE_SERVER_EXTERNALDB_MAX_POOL_SIZE}

RHPAM_CONNECTION_CHECKER

Anorg.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides aSQLExceptionisValidConnection(Connection e) method tovalidate if a connectionis valid.



121

${KIE_SERVER_EXTERNALDB_CONNECTION_CHECKER}

RHPAM_EXCEPTION_SORTER

Anorg.jboss.jca.adapters.jdbc.ExceptionSorter thatprovides a booleanisExceptionFatal(SQLException e) method tovalidate if an exceptionshould be broadcast toalljavax.resource.spi.ConnectionEventListener as aconnectionErrorOccurred.

${KIE_SERVER_EXTERNALDB_EXCEPTION_SORTER}

RHPAM_BACKGROUND_VALIDATION

Sets the sql validationmethod to background-validation, if set to falsethe validate-on-matchmethod will be used.

${KIE_SERVER_EXTERNALDB_BACKGROUND_VALIDATION}

RHPAM_VALIDATION_MILLIS

Defines the interval forthe background-validation check for thejdbc connections.

${KIE_SERVER_EXTERNALDB_BACKGROUND_VALIDATION_MILLIS}

RHPAM_DRIVER_TYPE

KIE server externaldatabase driver type,applicable only for DB2,possible values are 4(default) or 2.

${KIE_SERVER_EXTERNALDB_DRIVER_TYPE}

RHPAM_JTA —

true TIMER_SERVICE_DATA_STORE_REFRESH_INTERVAL

Sets refresh-interval forthe EJB timer databasedata-store service.


HTTPS_KEYSTORE_DIR

—





122







—


—



—



—















123























124


















125















126


















127






When present, theRoleMapping LoginModule will beconfigured to use theprovided file. Thisproperty defines thefully-qualified file pathand name of aproperties file orresource which mapsroles to replacementroles. The format isoriginal_role=role1,role2,role3





4.3.2.3.3.7. Volumes





ssl certs True



128

4.3.2.4.1. Secrets



4.4. RHPAM73-KIESERVER-MYSQL.YAML TEMPLATE

Application template for a managed KIE Server with a MySQL database, for Red Hat ProcessAutomation Manager 7.3

4.4.1. Parameters




APPLICATION_NAME


myapp True

MAVEN_MIRROR_URL

MAVEN_MIRROR_URL


— False

MAVEN_MIRROR_OF

MAVEN_MIRROR_OF


external:* False


129


MAVEN_REPO_ID



repo-custom False

MAVEN_REPO_URL




True

MAVEN_REPO_USERNAME



— False

MAVEN_REPO_PASSWORD



— False



The service namefor the optionalbusiness central,where it can bereached, to allowservice lookups(for maven repousage), if required

myapp-rhpamcentr

False




130





mavenUser False




maven1! False

KIE_ADMIN_USER

KIE_ADMIN_USER


adminUser False

KIE_ADMIN_PWD

KIE_ADMIN_PWD


— False

KIE_SERVER_USER

KIE_SERVER_USER


executionUser False

KIE_SERVER_PWD

KIE_SERVER_PWD


— False



openshift True




131




True

IMAGE_STREAM_TAG


1.1 True




— False




myapp-smartrouter

False




9000 False




http False








132




— False




— False




— False





False




8080 False




133





False

MYSQL_IMAGE_STREAM_NAMESPACE

— Namespace inwhich theImageStream forthe MySQL imageis installed. TheImageStream isalready installed inthe openshiftnamespace. Youshould only needto modify this ifyou installed theImageStream in adifferentnamespace/project. Default is"openshift".

openshift False

MYSQL_IMAGE_STREAM_TAG

— The MySQL imageversion, which isintended tocorrespond to theMySQL version.Default is "5.7".

5.7 False

KIE_SERVER_MYSQL_USER

RHPAM_USERNAME

KIE server MySQLdatabaseusername.

rhpam False

KIE_SERVER_MYSQL_PWD

RHPAM_PASSWORD

KIE server MySQLdatabasepassword.

— False

KIE_SERVER_MYSQL_DB

RHPAM_DATABASE

KIE server MySQLdatabase name.

rhpam7 False

DB_VOLUME_CAPACITY


1Gi True




134

KIE_SERVER_MYSQL_DIALECT


KIE server MySQLHibernate dialect.

org.hibernate.dialect.MySQL57Dialect

True

KIE_SERVER_MODE

KIE_SERVER_MODE


PRODUCTION False


enabled False




true False


HOSTNAME_HTTP


— False




135


HOSTNAME_HTTPS


— False




false False




True


HTTPS_KEYSTORE


keystore.jks False



jboss False


HTTPS_PASSWORD






136




false False




30000 False



1Gi False





False




true False




137





False


False


— False



— False



252793ed-7118-4ca8-8dab-5622fa97d892

False

SSO_USERNAME

SSO_USERNAME


— False




138


SSO_PASSWORD

SSO_PASSWORD


— False




false False




preferred_username

False

AUTH_LDAP_URL

AUTH_LDAP_URL



False

AUTH_LDAP_BIND_DN

AUTH_LDAP_BIND_DN



False




Password False




— False





False




139




(uid={0}) False




SUBTREE_SCOPE

False




10000 False




distinguishedName

False




140




true False




— False




— False




memberOf False




141





False








142




1 False




guest False




name False




false False




143




false False




— False




144




— False




— False



4.4.2. Objects


4.4.2.1. Services





8443 https



${APPLICATION_NAME}-mysql



145



4.4.2.2. Routes









4.4.2.3.1. Triggers


Deployment Triggers


${APPLICATION_NAME}-mysql ImageChange

4.4.2.3.2. Replicas


Deployment Replicas


${APPLICATION_NAME}-mysql 1



Service accounts are API objects that exist within each project. They can be created or deleted like any


146








4.4.2.3.3.2. Image

Deployment Image


${APPLICATION_NAME}-mysql mysql





/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1'





tcpSocket on port 3306




jolokia 8778 TCP

http 8080 TCP


147


https 8443 TCP

ping 8888 TCP


— 3306 TCP






${KIE_ADMIN_USER}


${KIE_ADMIN_PWD}


${KIE_SERVER_MODE}


${KIE_MBEANS}





148

















— ws









149








${KIE_SERVER_USER}


${KIE_SERVER_PWD}



c2=g2:a2:v2


MAVEN_MIRROR_URL


${MAVEN_MIRROR_URL}

MAVEN_MIRROR_OF


${MAVEN_MIRROR_OF}

MAVEN_REPOS —



150

RHPAMCENTR,EXTERNAL


—


The service name for theoptional businesscentral, where it can bereached, to allow servicelookups (for maven repousage), if required



—













151

${MAVEN_REPO_URL}























152








DATASOURCES —

RHPAM RHPAM_JNDI KIE server persistencedatasource. (Sets theorg.kie.server.persistence.ds system property)


RHPAM_DATABASE KIE server MySQLdatabase name.

${KIE_SERVER_MYSQL_DB}

RHPAM_DRIVER —

mysql KIE_SERVER_PERSISTENCE_DIALECT

KIE server MySQLHibernate dialect.

${KIE_SERVER_MYSQL_DIALECT}

RHPAM_USERNAME KIE server MySQLdatabase username.

${KIE_SERVER_MYSQL_USER}

RHPAM_PASSWORD KIE server MySQLdatabase password.

${KIE_SERVER_MYSQL_PWD}

RHPAM_SERVICE_HOST

—



153


RHPAM_SERVICE_PORT

—

3306 RHPAM_JTA —

true TIMER_SERVICE_DATA_STORE_REFRESH_INTERVAL



HTTPS_KEYSTORE_DIR

—









—


—



—



—







154

























155





















156















157















158












159









MYSQL_USER KIE server MySQLdatabase username.

${KIE_SERVER_MYSQL_USER}

MYSQL_PASSWORD KIE server MySQLdatabase password.

${KIE_SERVER_MYSQL_PWD}

MYSQL_DATABASE KIE server MySQLdatabase name.


4.4.2.3.3.7. Volumes





ssl certs True


${APPLICATION_NAME}-mysql-pvol

/var/lib/mysql/data

mysql false



A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an


160

administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWSElastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for moreinformation.

Name Access Mode

${APPLICATION_NAME}-mysql-claim ReadWriteOnce

4.4.2.4.2. Secrets



4.5. RHPAM73-KIESERVER-POSTGRESQL.YAML TEMPLATE

Application template for a managed KIE Server with a PostgreSQL database, for Red Hat ProcessAutomation Manager 7.3

4.5.1. Parameters




APPLICATION_NAME


myapp True

MAVEN_MIRROR_URL

MAVEN_MIRROR_URL


— False

MAVEN_MIRROR_OF

MAVEN_MIRROR_OF


external:* False


161



MAVEN_REPO_ID



repo-custom False

MAVEN_REPO_URL




True

MAVEN_REPO_USERNAME



— False

MAVEN_REPO_PASSWORD



— False



The service namefor the optionalbusiness central,where it can bereached, to allowservice lookups(for maven repousage), if required.

myapp-rhpamcentr

False




162





mavenUser False




maven1! False

KIE_ADMIN_USER

KIE_ADMIN_USER


adminUser False

KIE_ADMIN_PWD

KIE_ADMIN_PWD


— False

KIE_SERVER_USER

KIE_SERVER_USER


executionUser False

KIE_SERVER_PWD

KIE_SERVER_PWD


— False



openshift True




163




True

IMAGE_STREAM_TAG


1.1 True




— False




myapp-smartrouter

False



Port on which thesmart router serverlistens. (routerpropertyorg.kie.server.router.port)

9000 False




http False








164




— False




— False




— False





False




8080 False




165





False

KIE_SERVER_POSTGRESQL_USER

RHPAM_USERNAME

KIE serverPostgreSQLdatabaseusername.

rhpam False

KIE_SERVER_POSTGRESQL_PWD

RHPAM_PASSWORD

KIE serverPostgreSQLdatabasepassword.

— False

KIE_SERVER_POSTGRESQL_DB

RHPAM_DATABASE

KIE serverPostgreSQLdatabase name.

rhpam7 False

POSTGRESQL_IMAGE_STREAM_NAMESPACE

— Namespace inwhich theImageStream forthe PostgreSQLimage is installed.The ImageStreamis already installedin the openshiftnamespace. Youshould only needto modify this ifyou installed theImageStream in adifferentnamespace/project. Default is"openshift".

openshift False

POSTGRESQL_IMAGE_STREAM_TAG

— The PostgreSQLimage version,which is intendedto correspond tothe PostgreSQLversion. Default is"10".

10 False




166



Allows thePostgreSQL tohandle XAtransactions.

100 True

DB_VOLUME_CAPACITY


1Gi True

KIE_SERVER_POSTGRESQL_DIALECT


KIE serverPostgreSQLHibernate dialect.


True

KIE_SERVER_MODE

KIE_SERVER_MODE


PRODUCTION False


enabled False




true False




167


HOSTNAME_HTTP


— False


HOSTNAME_HTTPS


— False




false False




True


HTTPS_KEYSTORE


keystore.jks False




168



jboss False


HTTPS_PASSWORD






false False




30000 False



1Gi False





False




169




true False





False


False


— False




170




— False



252793ed-7118-4ca8-8dab-5622fa97d892

False

SSO_USERNAME

SSO_USERNAME


— False

SSO_PASSWORD

SSO_PASSWORD


— False




false False




preferred_username

False

AUTH_LDAP_URL

AUTH_LDAP_URL



False

AUTH_LDAP_BIND_DN

AUTH_LDAP_BIND_DN



False




Password False




— False




171





False




(uid={0}) False




SUBTREE_SCOPE

False




10000 False




distinguishedName

False




172




true False




— False




— False




memberOf False




173





False








174




1 False



A role included forall authenticatedusers

guest False




name False




false False




175




false False




— False




176




— False




— False



4.5.2. Objects


4.5.2.1. Services





8443 https






177



4.5.2.2. Routes









4.5.2.3.1. Triggers


Deployment Triggers


${APPLICATION_NAME}-postgresql ImageChange

4.5.2.3.2. Replicas


Deployment Replicas


${APPLICATION_NAME}-postgresql 1



Service accounts are API objects that exist within each project. They can be created or deleted like any


178








4.5.2.3.3.2. Image

Deployment Image


${APPLICATION_NAME}-postgresql postgresql





/usr/libexec/check-container





/usr/libexec/check-container --live




jolokia 8778 TCP

http 8080 TCP

https 8443 TCP


179


ping 8888 TCP


— 5432 TCP






${KIE_ADMIN_USER}


${KIE_ADMIN_PWD}


${KIE_SERVER_MODE}


${KIE_MBEANS}








180














— ws












181





${KIE_SERVER_USER}


${KIE_SERVER_PWD}



c2=g2:a2:v2


MAVEN_MIRROR_URL


${MAVEN_MIRROR_URL}

MAVEN_MIRROR_OF


${MAVEN_MIRROR_OF}

MAVEN_REPOS —

RHPAMCENTR,EXTERNAL


—



182


The service name for theoptional businesscentral, where it can bereached, to allow servicelookups (for maven repousage), if required.



—











${MAVEN_REPO_URL}





183












Port on which the smartrouter server listens.(router propertyorg.kie.server.router.port)









184








DATASOURCES —

RHPAM RHPAM_DATABASE KIE server PostgreSQLdatabase name.


RHPAM_DRIVER —

postgresql RHPAM_USERNAME KIE server PostgreSQLdatabase username.


RHPAM_PASSWORD KIE server PostgreSQLdatabase password.


RHPAM_SERVICE_HOST

—


RHPAM_SERVICE_PORT

—

5432 KIE_SERVER_PERSISTENCE_DIALECT

KIE server PostgreSQLHibernate dialect.



185

${KIE_SERVER_POSTGRESQL_DIALECT}

RHPAM_JTA —

true RHPAM_JNDI KIE server persistencedatasource. (Sets theorg.kie.server.persistence.ds system property)





HTTPS_KEYSTORE_DIR

—









—


—



—



—





186
























187





















188


















189









A role included for allauthenticated users






190












191









POSTGRESQL_USER

KIE server PostgreSQLdatabase username.


POSTGRESQL_PASSWORD

KIE server PostgreSQLdatabase password.


POSTGRESQL_DATABASE

KIE server PostgreSQLdatabase name.



Allows the PostgreSQLto handle XAtransactions.


4.5.2.3.3.7. Volumes





ssl certs True


${APPLICATION_NAME}-postgresql-pvol

/var/lib/pgsql/data

postgresql false



192



Name Access Mode

${APPLICATION_NAME}-postgresql-claim ReadWriteOnce

4.5.2.4.2. Secrets



4.6. OPENSHIFT USAGE QUICK REFERENCE

To deploy, monitor, manage, and undeploy Red Hat Process Automation Manager templates on RedHat OpenShift Container Platform, you can use the OpenShift Web console or the oc command.

For instructions about using the Web console, see Create and build an image using the Web console .

For detailed instructions about using the oc command, see CLI Reference. The following commands arelikely to be required:

To create a project, use the following command:

$ oc new-project <project-name>

For more information, see Creating a project using the CLI .

To deploy a template (create an application from a template), use the following command:

$ oc new-app -f <template-name> -p <parameter>=<value> -p <parameter>=<value> ...

For more information, see Creating an application using the CLI .

To view a list of the active pods in the project, use the following command:

$ oc get pods

To view the current status of a pod, including information whether or not the pod deploymenthas completed and it is now in a running state, use the following command:

$ oc describe pod <pod-name>

You can also use the oc describe command to view the current status of other objects. Formore information, see Application modification operations.

To view the logs for a pod, use the following command:


193


https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/getting_started/#getting-started-developers-console

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/cli_reference/

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#create-a-project-using-the-cli

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#using-the-cli

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/cli_reference/cli-reference-basic-cli-operations#application-modification-cli-operations

$ oc logs <pod-name>

To view deployment logs, look up a DeploymentConfig name in the template reference and runthe following command:

$ oc logs -f dc/<deployment-config-name>

For more information, see Viewing deployment logs.

To view build logs, look up a BuildConfig name in the template reference and run thecommand:

$ oc logs -f bc/<build-config-name>

For more information, see Accessing build logs.

To scale a pod in the application, look up a DeploymentConfig name in the template referenceand run the command:

$ oc scale dc/<deployment-config-name> --replicas=<number>

For more information, see Manual scaling .

To undeploy the application, you can delete the project by using the command:

$ oc delete project <project-name>

Alternatively, you can use the oc delete command to remove any part of the application, suchas a pod or replication controller. For details, see Application modification operations.


194

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#viewing-deployment-logs

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#accessing-build-logs

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/developer_guide/#scaling

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/cli_reference/cli-reference-basic-cli-operations#application-modification-cli-operations

APPENDIX A. VERSIONING INFORMATIONDocumentation last updated on Monday, March 01, 2021.

APPENDIX A. VERSIONING INFORMATION

195

Documents

access.redhat.com.... .R. . . .A. . .E