Deploying a Red Hat Process Automation Manager immutable server environment on Red Hat OpenShift Container Platform
Red Hat Customer Content Services
brms-docs@redhat.com
Abstract
Preface
As a system engineer, you can deploy a Red Hat Process Automation Manager immutable server environment 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 the immutable Process Server image. You can create new server images to add and update the business assets.
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 theoc
command-line tool, see the OpenShift CLI Reference. If you want to use the OpenShift Web console to deploy templates, you must also be logged on using the Web console. Dynamic persistent volume (PV) provisioning must be enabled. Alternatively, if dynamic PV provisioning is not enabled, enough persistent volumes must be available. By default, the following 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 in the template parameters. You can deploy multiple immutable servers; each requires a separate database PV. This requirement does not apply if you use an external database server.
- If you deploy the immutable monitoring template, two 64Mi PVs are also required (one for Business Central Monitoring and one for Smart Router).
- If you intend to deploy the immutable monitoring template, your OpenShift environment supports persistent volumes with ReadWriteMany mode. For information about access mode support in OpenShift Online volume plug-ins, see Access Modes.
Chapter 1. Overview of Red Hat Process Automation Manager on Red Hat OpenShift Container Platform
You can deploy Red Hat Process Automation Manager into a Red Hat OpenShift Container Platform environment.
In this solution, components of Red Hat Process Automation Manager are deployed as separate OpenShift pods. You can scale each of the pods up and down individually, providing as few or as many containers as necessary for a particular component. You can use standard OpenShift methods to manage 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 that runs decision services, process applications, and other deployable assets (collectively referred to 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 in another OpenShift pod or configure an execution server on OpenShift to use any other database server. Alternatively, Process Server can use an H2 database; in this case, the pod cannot be scaled.
You can freely scale up a Process Server pod, providing as many copies as necessary, running on the same host or different hosts. As you scale a pod up or down, all its copies use the same database server and run the same services. OpenShift provides load balancing and a request can be handled by any of the pods.
You can deploy a separate Process Server pod to run a different group of services. That pod can also be scaled up or down. You can have as many separate replicated Process Server pods as necessary.
Business Central is a web-based interactive environment for authoring services. It also provides a management and monitoring console. You can use Business Central to develop services and deploy them to Process Servers. You can also use Business Central to monitor the execution of processes.
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 you develop on it. It also includes a built-in Maven repository. Depending on configuration, Business Central can place the compiled services (KJAR files) into the built-in Maven repository or (if configured) into an external Maven repository.
ImportantIn the current version, high-availability Business Central functionality is for Technology Preview only. For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.
- Business Central Monitoring is a web-based management and monitoring console. It can manage deployment of services to Process Servers and provide monitoring information, but does not include authoring capabilities. You can use this component to manage staging and production environments.
- Smart Router is an optional layer between Process Servers and other components that interact with them. It is required if you want Business Central or Business Central Monitoring to interact with several different Process Servers. Also, when your environment includes many services running on different Process Servers, Smart Router provides a single endpoint to all client applications. A client application can make a REST API call requiring any service. Smart Router automatically 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. It consists of pods that provide Business Central for the authoring work and a Process Server for test execution of the services. For instructions about deploying this environment, see Deploying a Red Hat Process Automation Manager authoring environment on Red Hat OpenShift Container Platform.
- Managed deployment: An environment for running existing services for staging and production purposes. This environment includes several groups of Process Server pods; you can deploy and undeploy services on every such group and also scale the group up or down as necessary. Use Business 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 Automation Manager managed server environment on Red Hat OpenShift Container Platform.
- Deployment with immutable servers: An alternate environment for running existing services for staging and production purposes. In this environment, when you deploy a Process Server pod, it builds an image that loads and starts a service or group of services. You cannot stop any service on the pod or add any new service to the pod. If you want to use another version of a service or modify the configuration in any other way, you deploy a new server image and displace the old one. 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 tools to manage the pods. Optionally, you can use Business Central Monitoring to monitor the performance of the environment and to stop and restart some of the service instances, but not to deploy additional services to any Process Server or undeploy any existing ones (you can not add or remove containers). For instructions about deploying this environment, see Deploying a Red Hat Process Automation Manager immutable server environment on Red Hat OpenShift Container Platform.
You can also deploy a trial or evaluation environment. This environment includes Business Central and a Process Server. You can set it up quickly and use it to evaluate or demonstrate developing and running assets. However, the environment does not use any persistent storage, and any work you do in the environment is not saved. For instructions about deploying this environment, see Deploying a Red Hat Process Automation Manager trial environment on Red Hat OpenShift Container Platform.
To deploy a Red Hat Process Automation Manager environment on OpenShift, you can use the templates that are provided with Red Hat Process Automation Manager. You can modify the templates to ensure that the configuration suits your environment.
Chapter 2. Preparing to deploy Red Hat Process Automation Manager in your OpenShift environment
Before deploying Red Hat Process Automation Manager in your OpenShift environment, you need to complete several preparatory tasks. You do not need to repeat these tasks if you want to deploy additional images, for example, for new versions of processes or for other processes.
2.1. Ensuring the availability of image streams and the image registry
To deploy Red Hat Process Automation Manager components on Red Hat OpenShift Container Platform, 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 image streams). OpenShift also must be configured to authenticate with the Red Hat registry using your service account user name and password.
Some versions of the OpenShift environment include the required image streams. You must check if they are available. If image streams are available in OpenShift by default, you can use them if the OpenShift infrastructure is configured for registry authentication server. The administrator must complete the registry authentication configuration when installing the OpenShift environment.
Otherwise, you can configure registry authentication in your own project and install the image streams in the same project.
Procedure
- Determine whether Red Hat OpenShift Container Platform is configured with the user name and password for Red Hat registry access. For details about the required configuration, see Configuring a Registry Location. If you are using an OpenShift Online subscription, it is configured for Red Hat registry access.
If Red Hat OpenShift Container Platform is configured with the user name and password for Red 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.If the output of one or both of the commands is empty or if OpenShift is not configured with the user name and password for Red Hat registry access, complete the following steps:
-
Ensure you are logged in to OpenShift with the
oc
command and that your project is active. - 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 the steps to create a registry service account.
- Select the OpenShift Secret tab and click the link under Download secret to download the YAML secret file.
-
View the downloaded file and note the name that is listed in the
name:
entry. Run the following commands:
oc create -f <file_name>.yaml oc secrets link default <secret_name> --for=pull oc secrets link builder <secret_name> --for=pull
Where
<file_name>
is the name of the downloaded file and <secret_name> is the name that is listed in thename:
entry of the file.-
Download the
rhpam-7.3.0-openshift-templates.zip
product deliverable file from the Software Downloads page and extract therhpam73-image-streams.yaml
file. 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 then choose the file or paste its contents.
NoteIf you complete these steps, you install the image streams into the namespace of your project. If you install the image streams using these steps, you must set the
IMAGE_STREAM_NAMESPACE
parameter to the name of this project when deploying templates.
-
Ensure you are logged in to OpenShift with the
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 OpenShift documentation.
You must create an SSL certificate for Process Server and provide it to your OpenShift environment as a secret.
Procedure
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 URL of the Process Server. Save the keystore in a file named
keystore.jks
. Record the name of the certificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSL certificates, see Generate a SSL Encryption Key and Certificate.
Use the
oc
command to generate a secret namedkieserver-app-secret
from the new keystore file:$ 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 environment, you must create an SSL certificate for Business Central and provide it to your OpenShift environment as a secret. Do not use the same certificate and keystore for Business Central and for Process Server.
Procedure
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 URL of the Business Central. Save the keystore in a file named
keystore.jks
. Record the name of the certificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSL certificates, see Generate a SSL Encryption Key and Certificate.
Use the
oc
command to generate a secret namedbusinesscentral-app-secret
from the new keystore 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 SSL certificate for Smart Router and provide it to your OpenShift environment as a secret. Do not use the same certificate and keystore for Smart Router as the ones used for Process Server or Business Central.
Procedure
Generate an SSL keystore with a private and public key for SSL encryption for Smart Router. In a production environment, generate a valid signed certificate that matches the expected URL of the Smart Router. Save the keystore in a file named
keystore.jks
. Record the name of the certificate and the password of the keystore file.For more information on how to create a keystore with self-signed or purchased SSL certificates, see Generate a SSL Encryption Key and Certificate.
Use the
oc
command to generate a secret namedsmartrouter-app-secret
from the new keystore 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 it uses GlusterFS, to ensure optimal performance, tune your GlusterFS storage by changing the storage class configuration.
Procedure
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 listsglusterfs
. For example, in the following output the default storage class isgluster-container
, which does listglusterfs
:NAME PROVISIONER AGE gluster-block gluster.org/glusterblock 8d gluster-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, you do not need to make any changes. In this case, skip the rest of this procedure.To save the configuration of the default storage class into a YAML file, run the following command:
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
Edit the
storage_config.yaml
file:Remove the lines with the following keys:
-
creationTimestamp
-
resourceVersion
-
selfLink
-
uid
-
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
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
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 Central for use in an S2I build
If you are using Business Central for authoring services, you can extract the source code for your service and place it into a separate Git repository (such as GitHub or an on-premise installation of GitLab) for use in the S2I build.
Procedure
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
-
- 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 public Internet, you must prepare a Maven repository with a mirror of all the necessary artifacts and make this repository available to your environment.
Skip this procedure if your Red Hat OpenShift Container Platform environment is connected to the Internet.
Procedure
- Prepare a Maven release repository to which you can write. The repository must allow read access without authentication. Your OpenShift environment must have access to this repository. You can deploy a Nexus repository manager in the OpenShift environment. For instructions about setting up Nexus on OpenShift, see Setting up Nexus.
Complete the following actions on a computer that has an outgoing connection to the public Internet:
-
Clear the local Maven cache directory (
~/.m2/repository
). -
Build the source of your services using the
mvn clean install
command. -
Upload all artifacts from the local Maven cache directory (
~/.m2/repository
) to the Maven repository that you prepared. You can use the Maven Repository Provisioner utility to upload the artifacts.
-
Clear the local Maven cache directory (
Chapter 3. Environment with immutable servers
You can deploy an environment that includes one or more pods running Process Server with preloaded services. The database servers are, by default, also run in pods. Each Process Server pod can be separately scaled as necessary.
In this case, any services (KJAR files) must be loaded onto a Process Server at the time the image is created. You cannot load or unload services on a running Process Server. The advantage of this approach is that the Process Server with the services in it runs like any other containerized service and does not require specialized management. The Process Server runs like any other pod on the OpenShift environment; 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 Process Servers and to view monitoring data.
Smart Router is a single endpoint that can receive calls from client applications to any of your services and 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 the services 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 starts the containers with the services.
If you are using Business Central for authoring services, you can extract the source for your process and place it into a separate Git repository (such as GitHub or an on-premise installation of GitLab) for use in the S2I build.
Alternatively, you can create a similar Process Server deployment using services that are already built as KJAR files. In this case, you must provide the services in a Maven repository; you can use the built-in repository of the Business Central or your own repository (for example, a Nexus deployment). The KJAR files are retrieved from the Maven repository during the startup of the pod and not updated or changed after that. The files are retrieved at every restart or scaling of the pod, so you must ensure they do not change on the Maven repository to keep the deployment immutable.
With both methods of creating immutable images, no further management of the image is required. If you 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 Router template before creating any Process Server images. You must also provide a Maven repository. Your integration process must ensure that all the versions of KJAR files built into any Process Server image are also available in the Maven repository.
3.1. Deploying monitoring and Smart Router for an environment with immutable servers
If you want to use Business Central Monitoring and Smart Router for an environment with immutable servers, you must deploy them before deploying any Process Servers. If you do not want to use these components, 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 the Software Downloads page.
Procedure
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 or paste 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.
-
Replace
-
In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select or paste the
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
): The name of the secret for Smart Router, as created in Section 2.4, “Creating the secrets for Smart Router”. -
Application Name (
APPLICATION_NAME
): The name of the OpenShift application. It is used in the default URLs for Business Central Monitoring and Smart Router. OpenShift also uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. You can deploy several applications using the same template into the same project, as long as you use different application names. -
Maven repository URL (
MAVEN_REPO_URL
): A URL for a Maven repository. You must upload all the processes (KJAR files) that are to be deployed in your environment into this repository. -
Maven repository username (
MAVEN_REPO_USERNAME
): The username for the Maven repository. -
Maven repository password (
MAVEN_REPO_PASSWORD
): The username for the Maven repository. -
Business Central Server Certificate Name (
BUSINESS_CENTRAL_HTTPS_NAME
): The name of the certificate in the keystore that you created in Section 2.3, “Creating the secrets for Business Central”. -
Business Central Server Keystore Password (
BUSINESS_CENTRAL_HTTPS_PASSWORD
): The password for the keystore that you created in Section 2.3, “Creating the secrets for Business Central”. -
Smart Router Certificate Name (
KIE_SERVER_ROUTER_HTTPS_NAME
): The name of the certificate in the keystore that you created in Section 2.4, “Creating the secrets for Smart Router”. -
Smart Router Keystore Password (
KIE_SERVER_ROUTER_HTTPS_PASSWORD
): The password for the keystore that you created in Section 2.4, “Creating the secrets for Smart Router”. ImageStream Namespace (
IMAGE_STREAM_NAMESPACE
): The namespace where the image streams are available. If the image streams were already available in your OpenShift environment (see Section 2.1, “Ensuring the availability of image streams and the image registry”), the namespace isopenshift
. If you have installed the image streams file, the namespace is the name of the OpenShift project.You can also set other parameters as necessary.
-
Business Central Server Keystore Secret Name (
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration. Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
In the RH-SSO or LDAP service, create all user names in the deployment parameters. If you do not set any of the parameters, create users with the default user names. The created users must also be assigned to roles:
-
KIE_ADMIN_USER
: default user nameadminUser
, roles:kie-server,rest-all,admin
-
KIE_SERVER_MONITOR_USER
: user namemonitorUser
. You must not change this user name. You also must configure theKIE_SERVER_MONITOR_PASSWORD
parameter 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 be incorrect. Roles:kie-server,rest-all,guest
-
If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSO realm 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, the template 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:
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 Process Automation Manager. -
Business Central Monitoring RH-SSO Client name (
BUSINESS_CENTRAL_SSO_CLIENT
): The RH-SSO client name for Business Central Monitoring. -
Business Central Monitoring RH-SSO Client Secret (
BUSINESS_CENTRAL_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Business Central Monitoring. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To create the client for Red Hat Process Automation Manager within RH-SSO, 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 Process Automation Manager. -
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 for the client for Business Central Monitoring. -
Business Central Monitoring Custom http Route Hostname (
BUSINESS_CENTRAL_HOSTNAME_HTTP
): The fully qualified host name to use for the HTTP endpoint for Business Central Monitoring. If you need to create a client 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 to use for the HTTPS endpoint for Business Central Monitoring. If you need to create a client in RH-SSO, you can not leave this parameter blank. -
RH-SSO Realm Admin Username (
SSO_USERNAME
) and RH-SSO Realm Admin Password (SSO_PASSWORD
): The user name and password for the realm administrator user for the RH-SSO realm for Red Hat Process Automation Manager. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To configure LDAP, set the
AUTH_LDAP*
parameters of the template. These parameters correspond to the settings of the LdapExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.If the LDAP server does not define all the roles required for your deployment, you can map LDAP groups to Red Hat Process Automation Manager roles. To enable LDAP role mapping, set the following parameters:
-
RoleMapping rolesProperties file path (
AUTH_ROLE_MAPPER_ROLES_PROPERTIES
): The fully qualified pathname of a file that defines role mapping, for example,/opt/eap/standalone/configuration/rolemapping/rolemapping.properties
. You must provide this file and mount it at this path in all applicable deployment configurations; for instructions, see Section 3.4, “Providing the LDAP role mapping file”. -
RoleMapping replaceRole property (
AUTH_ROLE_MAPPER_REPLACE_ROLE
): If set totrue
, mapped roles replace the roles defined on the LDAP server; if set tofalse
, both mapped roles and roles defined on the LDAP server are set as user application roles. The default setting isfalse
.
-
RoleMapping rolesProperties file path (
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.
-
If the
- Complete and run the command line.
- Record the suggested command line that is displayed. This command line includes the parameters that you must set when deploying the immutable servers.
3.2. Deploying an immutable Process Server from service source 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.zip
product 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 the server configuration built from source code for an immutable server environment”.
When you deploy an immutable Process Server, the deployment procedure retrieves the source code for 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 KJAR files are uploaded to the Maven repository that the Business Central Monitoring instance uses.
Procedure
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 or paste the
rhpam73-prod-immutable-kieserver.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-kieserver.yaml -p KIE_SERVER_HTTPS_SECRET=kieserver-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.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 add the
-p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret
parameter.
-
Replace
-
In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select or paste the
Set the following parameters as necessary:
-
KIE Server Keystore Secret Name (
KIE_SERVER_HTTPS_SECRET
): The name of the secret for Process Server, as created in Section 2.2, “Creating the secrets for Process Server”. -
Application Name (
APPLICATION_NAME
): The name of the OpenShift application. It is used in the default URL for Process Server. OpenShift uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. You can deploy several applications using the same template into the same project, as long as you use different application names. Also, the application name determines the name of the server configuration (server template) on the Business Central that the Process Server is to join. If you are deploying several Process Servers, you must ensure each of the servers has a different application name. -
KIE Server Certificate Name (
KIE_SERVER_HTTPS_NAME
): The name of the certificate in 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 for the keystore that you created in Section 2.2, “Creating the secrets for Process Server”. -
KIE Server Container Deployment (
KIE_SERVER_CONTAINER_DEPLOYMENT
): The identifying information of the decision service (KJAR file) that is built from your source. 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
. The Maven build process must produce all these files from the source in the Git repository. -
Git Repository URL (
SOURCE_REPOSITORY_URL
): The URL for the Git repository that contains 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 project downloaded from the Git repository -
Artifact Directory (
ARTIFACT_DIR
): The path within the project that contains the required binary files (KJAR files and any other necessary files) after a successful Maven build. Normally this directory is the target directory of the build. However, you can provide prebuilt binaries in this directory in the Git repository -
ImageStream Namespace (
IMAGE_STREAM_NAMESPACE
): The namespace where the image streams are available. If the image streams were already available in your OpenShift environment (see Section 2.1, “Ensuring the availability of image streams and the image registry”), the namespace isopenshift
. If you have installed the image streams file, the namespace is the name of the OpenShift project.
-
KIE Server Keystore Secret Name (
If your build includes dependencies that are not available on the public Maven tree and require a separate repository, set the parameters to provide this repository:
-
Maven repository URL (
MAVEN_REPO_URL
): The URL for the Maven repository. -
Maven repository username (
MAVEN_REPO_USERNAME
): The username for the Maven repository. -
Maven repository password (
MAVEN_REPO_PASSWORD
): The password for the Maven repository.
-
Maven repository URL (
If your OpenShift environment does not have outgoing access to the public Internet, set the following parameters:
-
Maven mirror URL (
MAVEN_MIRROR_URL
): The URL for the Maven mirror repository that you set up in Section 2.7, “Preparing a Maven mirror repository for offline use”. This URL must be accessible from a pod in your OpenShift environment. Maven mirror of (
MAVEN_MIRROR_OF
): The MavenmirrorOf
value that determines which artifacts are to be retrieved from the mirror. For instructions about setting themirrorOf
value, see Mirror Settings in the Apache Maven documentation. The default value isexternal:*
. With this value, Maven retrieves every required artifact from the mirror and does not query any other repositories.-
If you configure an external Maven repository (
MAVEN_REPO_URL
), changeMAVEN_MIRROR_OF
to exclude the artifacts in this repository from the mirror, for example,external:*,!repo-custom
. Replacerepo-custom
with the ID that you configured inMAVEN_REPO_ID
. -
If you configure a built-in Business Central Maven repository (
BUSINESS_CENTRAL_MAVEN_SERVICE
), changeMAVEN_MIRROR_OF
to exclude the artifacts in this repository from the mirror:external:*,!repo-rhpamcentr
. -
If you configure both repositories, change
MAVEN_MIRROR_OF
to exclude the artifacts in both repositories from the mirror:external:*,!repo-rhpamcentr,!repo-custom
. Replacerepo-custom
with the ID that you configured inMAVEN_REPO_ID
.
-
If you configure an external Maven repository (
-
Maven mirror URL (
- If you want to use Business Central Monitoring or Smart Router, set the parameters that were displayed in the sample command line after you deployed the monitoring infrastructure (see Section 3.1, “Deploying monitoring and Smart Router for an environment with immutable servers”).
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration. Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
In the RH-SSO or LDAP service, create all user names in the deployment parameters. If you do not set any of the parameters, create users with the default user names. The created users must also be assigned to roles:
-
KIE_ADMIN_USER
: default user nameadminUser
, roles:kie-server,rest-all,admin
-
KIE_SERVER_USER
: default user nameexecutionUser
, roleskie-server,rest-all,guest
-
If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSO realm that applies to Red Hat Process Automation Manager must exist. A client within RH-SSO must also exist for
For the user roles that you can configure in RH-SSO, see Roles and users.
Use one of the following procedures:
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 Process Automation Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The RH-SSO client name for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Process Server. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To create the client for Red Hat Process Automation Manager within RH-SSO, 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 Process Automation Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The name of the client to create in RH-SSO for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string 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. If you 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 the HTTPS endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank. -
RH-SSO Realm Admin Username (
SSO_USERNAME
) and RH-SSO Realm Admin Password (SSO_PASSWORD
): The user name and password for the realm administrator user for the RH-SSO realm for Red Hat Process Automation Manager. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To configure LDAP, set the
AUTH_LDAP*
parameters of the template. These parameters correspond to the settings of the LdapExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.If the LDAP server does not define all the roles required for your deployment, you can map LDAP groups to Red Hat Process Automation Manager roles. To enable LDAP role mapping, set the following parameters:
-
RoleMapping rolesProperties file path (
AUTH_ROLE_MAPPER_ROLES_PROPERTIES
): The fully qualified pathname of a file that defines role mapping, for example,/opt/eap/standalone/configuration/rolemapping/rolemapping.properties
. You must provide this file and mount it at this path in all applicable deployment configurations; for instructions, see Section 3.4, “Providing the LDAP role mapping file”. -
RoleMapping replaceRole property (
AUTH_ROLE_MAPPER_REPLACE_ROLE
): If set totrue
, mapped roles replace the roles defined on the LDAP server; if set tofalse
, both mapped roles and roles defined on the LDAP server are set as user application roles. The default setting isfalse
.
-
RoleMapping rolesProperties file path (
If you modified the template to use an external database server for the Process Server, as described in Section 3.5, “Modifying the server configuration built from source code for an immutable server environment”, set the following parameters:
KIE Server External Database Driver (
KIE_SERVER_EXTERNALDB_DRIVER
): The driver 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 KIE Server External Database Password (KIE_SERVER_EXTERNALDB_PWD
): The user name and password for the external database server. -
KIE Server External Database URL (
KIE_SERVER_EXTERNALDB_HOST
): The JDBC URL for the external database server. KIE Server External Database Dialect (
KIE_SERVER_EXTERNALDB_DIALECT
): The Hibernate 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 host name of the external database server. -
KIE Server External Database Port (
KIE_SERVER_EXTERNALDB_PORT
): The port number of the external database server. -
KIE Server External Database name (
KIE_SERVER_EXTERNALDB_DB
): The database name to use on the external database server.
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in Section 3.6, “Building a custom Process Server image for an external 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
-
For Microsoft SQL Server,
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.
-
If the
- Complete and run the command line.
3.3. Deploying an immutable Process Server from KJAR services
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 this template 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.ImportantThe standard Process Server image for an external database server includes drivers for MySQL and PostgreSQL external database servers. If you want to use another database server, you must build a custom Process Server image. For instructions, see Section 3.6, “Building a custom Process Server image for an external database”.
You can extract these template files from the rhpam-7.3.0-openshift-templates.zip
product deliverable 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 startup of 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 KJAR files are uploaded to the Maven repository that the Business Central Monitoring instance uses.
Procedure
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 or paste the template 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>/<template-file-name>.yaml -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret
In this command line:
-
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.
-
Replace
Set the following parameters as necessary:
-
KIE Server Keystore Secret Name (
KIE_SERVER_HTTPS_SECRET
): The name of the secret for Process Server, as created in Section 2.2, “Creating the secrets for Process Server”. -
Application Name (
APPLICATION_NAME
): The name of the OpenShift application. It is used in the default URL for Process Server. OpenShift uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. You can deploy several applications using the same template into the same project, as long as you use different application names. Also, the application name determines the name of the server configuration (server template) on the Business Central that the Process Server is to join. If you are deploying several Process Servers, you must ensure each of the servers has a different application name. -
KIE Server Certificate Name (
KIE_SERVER_HTTPS_NAME
): The name of the certificate in 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 for the keystore that you created in Section 2.2, “Creating the secrets for Process Server”. -
KIE Server Mode (
KIE_SERVER_MODE
): Set toDEVELOPMENT
if you need to deploy aSNAPSHOT
version of a KJAR artifact. In therhpam73-kieserver-*.yaml
templates the default value isPRODUCTION
, which does not allow deployment ofSNAPSHOT
versions. -
KIE Server Container Deployment (
KIE_SERVER_CONTAINER_DEPLOYMENT
): The identifying information of the decision services (KJAR files) that the deployment must pull from 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 username (
MAVEN_REPO_USERNAME
): The username for the Maven repository. -
Maven repository password (
MAVEN_REPO_PASSWORD
): The password for the Maven repository. -
Disable KIE server management (
KIE_SERVER_MGMT_DISABLED
): You must set this parameter totrue
for an immutable deployment. -
KIE Server Startup Strategy (
KIE_SERVER_STARTUP_STRATEGY
): You must set this parameter toLocalContainersStartupStrategy
for an immutable deployment. -
ImageStream Namespace (
IMAGE_STREAM_NAMESPACE
): The namespace where the image streams are available. If the image streams were already available in your OpenShift environment (see Section 2.1, “Ensuring the availability of image streams and the image registry”), the namespace isopenshift
. If you have installed the image streams file, the namespace is the name of the OpenShift project.
-
KIE Server Keystore Secret Name (
If your OpenShift environment does not have outgoing access to the public Internet, set the following parameters:
-
Maven mirror URL (
MAVEN_MIRROR_URL
): The URL for the Maven mirror repository that you set up in Section 2.7, “Preparing a Maven mirror repository for offline use”. This URL must be accessible from a pod in your OpenShift environment. Maven mirror of (
MAVEN_MIRROR_OF
): The MavenmirrorOf
value that determines which artifacts are to be retrieved from the mirror. For instructions about setting themirrorOf
value, see Mirror Settings in the Apache Maven documentation. The default value isexternal:*
. With this value, Maven retrieves every required artifact from the mirror and does not query any other repositories.-
If you configure an external Maven repository (
MAVEN_REPO_URL
), changeMAVEN_MIRROR_OF
to exclude the artifacts in this repository from the mirror, for example,external:*,!repo-custom
. Replacerepo-custom
with the ID that you configured inMAVEN_REPO_ID
. -
If you configure a built-in Business Central Maven repository (
BUSINESS_CENTRAL_MAVEN_SERVICE
), changeMAVEN_MIRROR_OF
to exclude the artifacts in this repository from the mirror:external:*,!repo-rhpamcentr
. -
If you configure both repositories, change
MAVEN_MIRROR_OF
to exclude the artifacts in both repositories from the mirror:external:*,!repo-rhpamcentr,!repo-custom
. Replacerepo-custom
with the ID that you configured inMAVEN_REPO_ID
.
-
If you configure an external Maven repository (
-
Maven mirror URL (
If you want to use Business Central Monitoring or Smart Router, set some of the parameters that were displayed in the sample command line after you deployed the monitoring infrastructure (see Section 3.1, “Deploying monitoring and Smart Router for an environment with immutable servers”), namely:
-
Set
KIE_ADMIN_USER
,KIE_ADMIN_PWD
,KIE_SERVER_USER
,KIE_SERVER_PWD
, andKIE_SERVER_ROUTER_SERVICE
to the values that were displayed for these parameters. -
Set
KIE_SERVER_CONTROLLER_USER
to the value that was displayed forKIE_SERVER_MONITOR_USER
. -
Set
KIE_SERVER_CONTROLLER_PWD
to the value that was displayed forKIE_SERVER_MONITOR_PWD
. -
Set
KIE_SERVER_CONTROLLER_SERVICE
to the value that was displayed forKIE_SERVER_MONITOR_SERVICE
.
-
Set
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration. Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
In the RH-SSO or LDAP service, create all user names in the deployment parameters. If you do not set any of the parameters, create users with the default user names. The created users must also be assigned to roles:
-
KIE_ADMIN_USER
: default user nameadminUser
, roles:kie-server,rest-all,admin
-
KIE_SERVER_USER
: default user nameexecutionUser
, roleskie-server,rest-all,guest
-
If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSO realm that applies to Red Hat Process Automation Manager must exist. A client within RH-SSO must also exist for
For the user roles that you can configure in RH-SSO, see Roles and users.
Use one of the following procedures:
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 Process Automation Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The RH-SSO client name for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Process Server. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To create the client for Red Hat Process Automation Manager within RH-SSO, 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 Process Automation Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The name of the client to create in RH-SSO for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string 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. If you 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 the HTTPS endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank. -
RH-SSO Realm Admin Username (
SSO_USERNAME
) and RH-SSO Realm Admin Password (SSO_PASSWORD
): The user name and password for the realm administrator user for the RH-SSO realm for Red Hat Process Automation Manager. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
To configure LDAP, set the
AUTH_LDAP*
parameters of the template. These parameters correspond to the settings of the LdapExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.If the LDAP server does not define all the roles required for your deployment, you can map LDAP groups to Red Hat Process Automation Manager roles. To enable LDAP role mapping, set the following parameters:
-
RoleMapping rolesProperties file path (
AUTH_ROLE_MAPPER_ROLES_PROPERTIES
): The fully qualified pathname of a file that defines role mapping, for example,/opt/eap/standalone/configuration/rolemapping/rolemapping.properties
. You must provide this file and mount it at this path in all applicable deployment configurations; for instructions, see Section 3.4, “Providing the LDAP role mapping file”. -
RoleMapping replaceRole property (
AUTH_ROLE_MAPPER_REPLACE_ROLE
): If set totrue
, mapped roles replace the roles defined on the LDAP server; if set tofalse
, both mapped roles and roles defined on the LDAP server are set as user application roles. The default setting isfalse
.
-
RoleMapping rolesProperties file path (
If you are using the
rhpam73-kieserver-externaldb.yaml
template to use an external database server for the Process Server, set the following parameters:KIE Server External Database Driver (
KIE_SERVER_EXTERNALDB_DRIVER
): The driver 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 KIE Server External Database Password (KIE_SERVER_EXTERNALDB_PWD
): The user name and password for the external database server. -
KIE Server External Database URL (
KIE_SERVER_EXTERNALDB_HOST
): The JDBC URL for the external database server. KIE Server External Database Dialect (
KIE_SERVER_EXTERNALDB_DIALECT
): The Hibernate 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 host name of the external database server. -
KIE Server External Database Port (
KIE_SERVER_EXTERNALDB_PORT
): The port number of the external database server. -
KIE Server External Database name (
KIE_SERVER_EXTERNALDB_DB
): The database name to use on the external database server.
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in Section 3.6, “Building a custom Process Server image for an external 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
-
For Microsoft SQL Server,
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.
-
If the
- Complete and run the command line.
3.4. Providing the LDAP role mapping file
If you configure the AUTH_ROLE_MAPPER_ROLES_PROPERTIES
parameter, you must provide a file that defines the role mapping. Mount this file on all affected deployment configurations.
Procedure
Create the role mapping properties file, for example,
my-role-map
. The file must contain entries in the following format:ldap_role = product_role1, product_role2...
For example:
admins = kie-server,rest-all,admin
Create an OpenShift configuration map from the file by entering the following command:
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 same as the name specified in theAUTH_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
Mount the configuration map on every deployment configuration that is configured for role mapping.
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 can be 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 theAUTH_ROLE_MAPPER_ROLES_PROPERTIES
parameter, for example,/opt/eap/standalone/configuration/rolemapping
.-
3.5. Modifying the server configuration built from source code for an immutable server environment
By default, the immutable server configuration built from source code creates a separate PostgreSQL pod to provide the database server for each replicable Process Server. If you prefer to use MySQL or to use 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 an environment 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
. For example, the following block is named Sample block
:
## Sample block BEGIN sample line 1 sample line 2 sample line 3 ## Sample block END
For some changes, you might need to replace a block in one template file with a block from another template file provided with Red Hat Process Automation Manager. In this case, delete the block, then paste the new block in its exact location.
Procedure
If you want to use MySQL instead of PostgreSQL, replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam73-kieserver-mysql.yaml
file:-
Replace the block named
PostgreSQL database parameters
with the block namedMySQL database parameters
. (Take this block and all subsequent replacement blocks from therhpam73-kieserver-postgresql.yaml
file.) -
Replace the block named
PostgreSQL service
with the block namedMySQL service
. -
Replace the block named
PostgreSQL driver settings
with the block namedMySQL driver settings
. -
Replace the block named
PostgreSQL deployment config
with the block namedMySQL deployment config
. -
Replace the block named
PostgreSQL persistent volume claim
with the block namedMySQL persistent volume claim
.
-
Replace the block named
If you want to use an external database server, replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam73-kieserver-externaldb.yaml
file, and also remove some blocks:-
Replace the block named
PostgreSQL database parameters
with the block namedExternal database parameters
. (Take this block and all subsequent replacement blocks from therhpam73-kieserver-externaldb.yaml
file.) -
Replace the block named
PostgreSQL driver settings
with the block namedExternal database driver settings
. Remove the following blocks of the file, marked with comments from
BEGIN
toEND
:-
PostgreSQL service
-
PostgreSQL deployment config
-
PostgreSQL persistent volume claim
-
-
Replace the block named
The standard Process Server image includes drivers for MySQL and PostgreSQL external database servers. If you want to use another database server, you must build a custom Process Server image. For instructions, see Section 3.6, “Building a custom Process Server image for an external database”.
3.6. Building a custom Process Server image for an external database
If you want to use an external database server for a Process Server and this server is neither MySQL nor PostgreSQL, you must build a custom Process Server image with drivers for this server before deploying your environment.
You can use this build procedure to provide drivers for the following database servers:
- Microsoft SQL Server
- MariaDB
- IBM DB2
- Oracle Database
- Sybase
For the tested versions of the database servers, see Red Hat Process Automation Manager 7 Supported Configurations.
The build procedure creates a custom image that extends the existing Process Server image. It pushes this custom image into a new ImageStream
in the openshift
namespace with the same version tag as the original image.
Prerequisites
-
You have logged on to your project in the OpenShift environment using the
oc
command as a user with thecluster-admin
role. - For IBM DB2, Oracle Database, or Sybase, you have downloaded the JDBC driver from the database server vendor.
Procedure
For IBM DB2, Oracle Database, or Sybase, provide the JDBC driver JAR in a local directory or on 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.jar
Where
<local_path_or_url>
is the path to the local directory or the URL for the HTTP server where the driver is provided.
-
For IBM DB2,
-
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 thetemplates/contrib/jdbc
directory of the unzipped file. 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
-
For Microsoft SQL Server,
Run the following command:
- For Microsoft SQL Server or MariaDB:
../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 server where 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
Chapter 4. OpenShift template reference information
Red Hat Process Automation Manager provides the following OpenShift templates. To access the templates, download and extract the rhpam-7.3.0-openshift-templates.zip
product deliverable file from the Software Downloads page of the Red Hat customer portal.
-
rhpam73-prod-immutable-monitor.yaml
provides a Business Central Monitoring instance and a Smart Router that you can use with immutable Process Servers. When you deploy this template, OpenShift displays the settings that you must then use for deploying therhpam73-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 you deploy this template, a source-to-image (S2I) build is triggered for one or several services that are to run on the Process Server. The Process Server can optionally be configured to connect to the Business Central Monitoring and Smart Router provided byrhpam73-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 copy sections from this template into another template to configure a Process Server in the other template 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 the Process 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 Process Server in the other template to use MySQL and to provide the MySQL instance. For details about this template, see Section 4.4, “rhpam73-kieserver-mysql.yaml template”. -
rhpam73-kieserver-postgresql.yaml
provides a Process Server and a PostgreSQL instance that the Process 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 Process Server in the other template to use PostgreSQL and to provide the PostgreSQL instance. For details about this template, see Section 4.4, “rhpam73-kieserver-mysql.yaml template”.
4.1. rhpam73-prod-immutable-monitor.yaml template
Application template for a router and monitoring console in a production environment, for Red Hat Process Automation Manager 7.3
4.1.1. Parameters
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
Variable name | Image Environment Variable | Description | Example value | Required |
---|---|---|---|---|
| — | The name for the application. | myapp | True |
|
| The id to use for the maven repository, if set. Default is generated randomly. | repo-custom | False |
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | False |
|
| Username to access the Maven repository, if required. | — | False |
|
| Password to access the Maven repository, if required. | — | False |
|
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | myapp-rhpamcentr | False |
|
| Username to access the Maven service hosted by Business Central inside EAP. | mavenUser | False |
|
| Password to access the Maven service hosted by Business Central inside EAP. | maven1! | False |
|
| KIE administrator username | adminUser | False |
|
| KIE administrator password | — | False |
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) | — | False |
|
| If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) | false | False |
|
| KIE ServerTemplate Cache TTL in milliseconds (Sets the org.kie.server.controller.template.cache.ttl system property) | 60000 | False |
|
| If set to true, turns on OpenShift integration feature in Business Central. With OpenShift integration, Business Central automatically discovers and connects to any KIE server in the same namespace, provided that OpenShift integration (OpenShiftStartupStrategy) is enabled on the KIE server. (Sets the org.kie.workbench.controller.openshift.enabled system property) | false | False |
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you installed the ImageStreams in a different namespace/project. | openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | False |
| — | Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-smartrouter-<project>.<default-domain-suffix> | — | False |
| — | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-smartrouter-<project>.<default-domain-suffix> | — | False |
|
| Router ID used when connecting to the controller. (Router property org.kie.server.router.id) | kie-server-router | True |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | http | False |
|
| Public URL where the router can be found. Format http://<host>:<port> (Router property org.kie.server.router.url.external) | — | False |
|
| Router name used when connecting to the controller. (Router property org.kie.server.router.name) | KIE Server Router | True |
| — | The name of the secret containing the keystore file. | smartrouter-app-secret | True |
| — | The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| KIE server monitor username. (Sets the org.kie.server.controller.user system property) | monitorUser | False |
|
| KIE server monitor password. (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| KIE server monitor token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-rhpamcentrmon-<project>.<default-domain-suffix> | — | False |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix> | — | False |
| — | The name of the secret containing the keystore file. | businesscentral-app-secret | True |
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
| — | Business Central Container memory limit. | 2Gi | False |
| — | Smart Router Container memory limit. | 512Mi | False |
|
| RH-SSO URL. | False | |
|
| RH-SSO Realm name. | — | False |
|
| Business Central Monitoring RH-SSO Client name. | — | False |
|
| Business Central Monitoring RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | — | False |
|
| RH-SSO Realm Admin Password used to create the Client. | — | False |
|
| RH-SSO Disable SSL Certificate Validation. | false | False |
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=exmample,ou=com | False |
|
| LDAP Credentials used for authentication. | Password | False |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | — | False |
|
| LDAP Base DN of the top-level context to begin the user search. | ou=users,ou=example,ou=com | False |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | (uid={0}) | False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. | 10000 | False |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | distinguishedName | False |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | true | False |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Name of the attribute containing the user roles. | memberOf | False |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | ou=groups,ou=example,ou=com | False |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | (memberOf={1}) | False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | 1 | False |
|
| A role included for all authenticated users. | guest | False |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
4.1.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found 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. Refer to the container-engine documentation for more information.
Service | Port | Name | Description |
---|---|---|---|
| 8080 | http | All the Business Central Monitoring web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
| 9000 | http | The smart router server http 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 a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
Service | Security | Hostname |
---|---|---|
| none |
|
| TLS passthrough |
|
| none |
|
| TLS passthrough |
|
4.1.2.3. Deployment Configurations
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to 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 outside OpenShift. Refer to the Openshift documentation for more information.
Deployment | Triggers |
---|---|
| ImageChange |
| ImageChange |
4.1.2.3.2. Replicas
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
Deployment | Replicas |
---|---|
| 1 |
| 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 any other API object. Refer to the Openshift documentation for more information.
Deployment | Service Account |
---|---|
|
|
4.1.2.3.3.2. Image
Deployment | Image |
---|---|
| rhpam73-businesscentral-monitoring-openshift |
| rhpam73-smartrouter-openshift |
4.1.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-rhpamcentrmon
/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
${APPLICATION_NAME}-rhpamcentrmon
/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 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
| |
| http | 9000 |
|
4.1.2.3.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE administrator password |
|
| KIE administrator username |
| |
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) |
| |
| KIE server username (Sets the org.kie.server.user system property) |
| |
| — | RHPAMCENTR,EXTERNAL | |
| — | repo-rhpamcentr | |
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required |
| |
| — |
| |
| Username to access the Maven service hosted by Business Central inside EAP. |
| |
| Password to access the Maven service hosted by Business Central inside EAP. |
| |
| The id to use for the maven repository, if set. Default is generated randomly. |
| |
| Fully qualified URL to a Maven repository or service. |
| |
| Username to access the Maven repository, if required. |
| |
| Password to access the Maven repository, if required. |
| |
| If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) |
| |
| KIE ServerTemplate Cache TTL in milliseconds (Sets the org.kie.server.controller.template.cache.ttl system property) |
| |
| If set to true, turns on OpenShift integration feature in Business Central. With OpenShift integration, Business Central automatically discovers and connects to any KIE server in the same namespace, provided that OpenShift integration (OpenShiftStartupStrategy) is enabled on the KIE server. (Sets the org.kie.workbench.controller.openshift.enabled system property) |
| |
| KIE server monitor username. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server monitor password. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server monitor token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| — |
| |
| The name of the keystore file within the secret. |
| |
| The name associated with the server certificate. |
| |
| The password for the keystore and certificate. |
| |
| — | openshift.DNS_PING | |
| — |
| |
| — | 8888 | |
| RH-SSO URL. |
| |
| — | ROOT.war | |
| RH-SSO Realm name. |
| |
| Business Central Monitoring RH-SSO Client Secret. |
| |
| Business Central Monitoring RH-SSO Client name. |
| |
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. |
| |
| RH-SSO Realm Admin Password used to create the Client. |
| |
| RH-SSO Disable SSL Certificate Validation. |
| |
| RH-SSO Principal Attribute to use as username. |
| |
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| |
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| |
| LDAP Endpoint to connect for authentication. |
| |
| Bind DN used for authentication. |
| |
| LDAP Credentials used for authentication. |
| |
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
| LDAP Base DN of the top-level context to begin the user search. |
| |
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
| The search scope to use. |
| |
| The timeout in milliseconds for user or role searches. |
| |
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
| Name of the attribute containing the user roles. |
| |
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
| A role included for all authenticated users. |
| |
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 |
| |
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. |
| |
|
| — | — |
| — | 9000 | |
| — | 9443 | |
| Public URL where the router can be found. Format http://<host>:<port> (Router property org.kie.server.router.url.external) |
| |
| Router ID used when connecting to the controller. (Router property org.kie.server.router.id) |
| |
| Router name used when connecting to the controller. (Router property org.kie.server.router.name) |
| |
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) |
| |
| The name associated with the server certificate. |
| |
| The password for the keystore and certificate. |
| |
| — |
| |
| KIE server monitor username. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server monitor password. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server monitor token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| — |
| |
| — | http | |
| — |
| |
| — | true |
4.1.2.3.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| businesscentral-keystore-volume |
| ssl certs | True |
|
|
| — | 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 an administrator by creating PersistentVolume
objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
Name | Access Mode |
---|---|
| ReadWriteMany |
| 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 Process Automation Manager 7.3
4.2.1. Parameters
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
Variable name | Image Environment Variable | Description | Example value | Required |
---|---|---|---|---|
| — | The name for the application. | myapp | True |
|
| KIE administrator username. | adminUser | False |
|
| KIE administrator password. | — | False |
|
| KIE server username. (Sets the org.kie.server.user system property) | executionUser | False |
|
| KIE server password, used to connect to KIE servers. Value is automatically generated by default. (Sets the org.kie.server.pwd system property) | — | False |
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you installed the ImageStreams in a different namespace/project. | openshift | True |
| — | The name of the image stream to use for KIE server. Default is "rhpam73-kieserver-openshift". | rhpam73-kieserver-openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
| KIE server monitor username, for optional use of Business Central Monitoring. (Sets the org.kie.server.controller.user system property) | monitorUser | False |
|
| KIE server monitor password, for optional use of Business Central Monitoring. (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| KIE server monitor token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) | — | False |
|
| The service name for the optional smart router. | — | False |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | myapp-smartrouter | False |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | 9000 | False |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | http | False |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
| — | Namespace in which the ImageStream for the PostgreSQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
| — | The PostgreSQL image version, which is intended to correspond to the PostgreSQL version. Default is "10". | 10 | False |
|
| KIE server PostgreSQL database username. | rhpam | False |
|
| KIE server PostgreSQL database password. | — | False |
|
| KIE server PostgreSQL database name. | rhpam7 | False |
|
| Allows the PostgreSQL to handle XA transactions. | 100 | True |
| — | Size of persistent storage for the database volume. | 1Gi | True |
|
| KIE server PostgreSQL Hibernate dialect. | org.hibernate.dialect.PostgreSQLDialect | True |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) | true | False |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. | false | False |
| — | The name of the secret containing the keystore file. | kieserver-app-secret | True |
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 | rhpam-kieserver-library=org.openshift.quickstarts:rhpam-kieserver-library:1.4.0-SNAPSHOT | True |
| — | Git source URI for application. | https://github.com/jboss-container-images/rhpam-7-openshift-image.git | True |
| — | Git branch/tag reference. | master | False |
| — | Path within Git project to build; empty for root project directory. | quickstarts/library-process/library | False |
| — | GitHub trigger secret. | — | True |
| — | Generic build trigger secret. | — | True |
|
| Maven mirror to use for S2I builds. If enabled, the mirror must contain all the artifacts necessary for building and running the required services. | — | False |
|
| Maven mirror configuration for KIE server. | external:* | False |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
| Fully qualified URL to a Maven repository. | — | False |
|
| Username to access the Maven repository, if required. | — | False |
|
| Password to access the Maven repository, if required. | — | False |
|
| The service name for the optional Business Central, where it can be reached, to allow service lookups (for maven repo usage), if required. | myapp-rhpamcentr | False |
|
| Username to access the Maven service hosted by Business Central inside EAP. | mavenUser | False |
|
| Password to access the Maven service hosted by Business Central inside EAP. | maven1! | False |
| — | List of directories from which archives will be copied into the deployment folder. If unspecified, all archives in /target will be copied. | — | False |
|
| Sets refresh-interval for the EJB timer service database-data-store. | 30000 | False |
| — | KIE server Container memory limit. | 1Gi | False |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | true | True |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | LocalContainersStartupStrategy | True |
|
| RH-SSO URL. | False | |
|
| RH-SSO Realm name. | — | False |
|
| KIE Server RH-SSO Client name. | — | False |
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | — | False |
|
| RH-SSO Realm Admin Password used to create the Client. | — | False |
|
| RH-SSO Disable SSL Certificate Validation. | false | False |
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=exmample,ou=com | False |
|
| LDAP Credentials used for authentication. | Password | False |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | — | False |
|
| LDAP Base DN of the top-level context to begin the user search. | ou=users,ou=example,ou=com | False |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | (uid={0}) | False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. | 10000 | False |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | distinguishedName | False |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | true | False |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Name of the attribute containing the user roles. | memberOf | False |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | ou=groups,ou=example,ou=com | False |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | (memberOf={1}) | False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | 1 | False |
|
| A role included for all authenticated users | guest | False |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
4.2.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.2.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
Service | Port | Name | Description |
---|---|---|---|
| 8080 | http | All the KIE server web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
| 5432 | — | The database server’s port. |
4.2.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 a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
Service | Security | Hostname |
---|---|---|
| none |
|
| TLS passthrough |
|
4.2.2.3. Build Configurations
A buildConfig
describes a single build definition and a set of triggers for when a new build should be created. A buildConfig
is a REST object, which can be used in a POST to the API server to create a new instance. Refer to the Openshift documentation for more information.
S2I image | link | Build output | BuildTriggers and Settings |
---|---|---|---|
rhpam73-kieserver-openshift:1.1 |
| GitHub, Generic, ImageChange, ConfigChange |
4.2.2.4. Deployment Configurations
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.2.2.4.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
Deployment | Triggers |
---|---|
| ImageChange |
| ImageChange |
4.2.2.4.2. Replicas
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
Deployment | Replicas |
---|---|
| 2 |
| 1 |
4.2.2.4.3. Pod Template
4.2.2.4.3.1. Service Accounts
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
Deployment | Service Account |
---|---|
|
|
4.2.2.4.3.2. Image
Deployment | Image |
---|---|
|
|
| postgresql |
4.2.2.4.3.3. Readiness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.2.2.4.3.4. Liveness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/healthcheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container --live
4.2.2.4.3.5. Exposed Ports
Deployments | Name | Port | Protocol |
---|---|---|---|
| jolokia | 8778 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
| |
| — | 5432 |
|
4.2.2.4.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE administrator username. |
|
| KIE administrator password. |
| |
| — |
| |
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) |
| |
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
| KIE server monitor username, for optional use of Business Central Monitoring. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server monitor password, for optional use of Business Central Monitoring. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server monitor token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) |
| |
| — | ws | |
| — |
| |
| — |
| |
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. |
| |
| KIE server username. (Sets the org.kie.server.user system property) |
| |
| KIE server password, used to connect to KIE servers. Value is automatically generated by default. (Sets the org.kie.server.pwd system property) |
| |
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version | c2=g2:a2:v2 | |
|
| Maven mirror to use for S2I builds. If enabled, the mirror must contain all the artifacts necessary for building and running the required services. | |
|
| Maven mirror configuration for KIE server. | |
|
| — | |
RHPAMCENTR,EXTERNAL |
| — | |
repo-rhpamcentr |
| The service name for the optional Business Central, where it can be reached, to allow service lookups (for maven repo usage), if required. | |
|
| — | |
|
| Username to access the Maven service hosted by Business Central inside EAP. | |
|
| Password to access the Maven service hosted by Business Central inside EAP. | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | |
|
| Fully qualified URL to a Maven repository. | |
|
| Username to access the Maven repository, if required. | |
|
| Password to access the Maven repository, if required. | |
|
| The service name for the optional smart router. | |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| — | |
|
| KIE server PostgreSQL database name. | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| — | |
true |
| — | |
postgresql |
| KIE server PostgreSQL Hibernate dialect. | |
|
| KIE server PostgreSQL database username. | |
|
| KIE server PostgreSQL database password. | |
|
| — | |
|
| — | |
5432 |
| Sets refresh-interval for the EJB timer service database-data-store. | |
|
| — | |
|
| The name of the keystore file within the secret. | |
|
| The name associated with the server certificate. | |
|
| The password for the keystore and certificate. | |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | |
|
| — | |
openshift.DNS_PING |
| — | |
|
| — | |
8888 |
| RH-SSO URL. | |
|
| — | |
ROOT.war |
| RH-SSO Realm name. | |
|
| KIE Server RH-SSO Client Secret. | |
|
| KIE Server RH-SSO Client name. | |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | |
|
| RH-SSO Realm Admin Password used to create the Client. | |
|
| RH-SSO Disable SSL Certificate Validation. | |
|
| RH-SSO Principal Attribute to use as username. | |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| LDAP Endpoint to connect for authentication. | |
|
| Bind DN used for authentication. | |
|
| LDAP Credentials used for authentication. | |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | |
|
| LDAP Base DN of the top-level context to begin the user search. | |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | |
|
| The search scope to use. | |
|
| The timeout in milliseconds for user or role searches. | |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Name of the attribute containing the user roles. | |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | |
|
| A role included for all authenticated users | |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | |
|
|
| KIE server PostgreSQL database username. |
|
| KIE server PostgreSQL database password. | |
|
| KIE server PostgreSQL database name. | |
|
| Allows the PostgreSQL to handle XA transactions. |
4.2.2.4.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
| postgresql | false |
4.2.2.5. External Dependencies
4.2.2.5.1. Volume Claims
A PersistentVolume
object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume
objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
Name | Access Mode |
---|---|
| ReadWriteOnce |
4.2.2.5.2. Secrets
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.3. rhpam73-kieserver-externaldb.yaml template
Application template for a managed KIE Server with an external database, for Red Hat Process Automation Manager 7.3
4.3.1. Parameters
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
Variable name | Image Environment Variable | Description | Example value | Required |
---|---|---|---|---|
| — | The name for the application. | myapp | True |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | — | False |
|
| Maven mirror configuration for KIE server. | external:* | False |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | True |
|
| Username to access the Maven repository, if required. | — | False |
|
| Password to access the Maven repository, if required. | — | False |
|
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required. | myapp-rhpamcentr | False |
|
| Username to access the Maven service hosted by Business Central inside EAP. | mavenUser | False |
|
| Password to access the Maven service hosted by Business Central inside EAP. | maven1! | False |
|
| KIE administrator username. | adminUser | False |
|
| KIE administrator password. | — | False |
|
| KIE server username. (Sets the org.kie.server.user system property) | executionUser | False |
|
| KIE server password. (Sets the org.kie.server.pwd system property) | — | False |
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you installed the ImageStreams in a different namespace/project. | openshift | True |
| — | The name of the image stream to use for KIE server. Default is "rhpam73-kieserver-openshift". | rhpam73-kieserver-openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
| The service name for the optional smart router. | — | False |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | myapp-smartrouter | False |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | 9000 | False |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | http | False |
|
| KIE server controller username. (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) | — | False |
|
| KIE server controller host. (Used to set the org.kie.server.controller system property) | my-app-controller-ocpuser.os.example.com | False |
|
| KIE server controller port. (Used to set the org.kie.server.controller system property) | 8080 | False |
|
| Hibernate persistence schema. | bd.schema | False |
|
| KIE server external database Hibernate dialect. | org.hibernate.dialect.MySQL57Dialect | True |
|
| Sets the datasource service host. Use this if you want to use the predefined mysql or postgresql datasource properties. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | 10.10.10.1 | False |
|
| Sets the datasource service port. Use this if you want to use the predefined mysql or postgresql datasource properties. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | 4321 | False |
|
| Sets the datasources type. It can be XA or NONXA. For non XA set it to true. Default value is false. | True | False |
|
| Sets the datasource jdbc connection url. Note that, if you are using PostgreSQL do not use this field, use the SERVICE_HOST and PORT. If using SERVICE_PORT and HOST there is no need to fill this parameter. | jdbc:mysql://127.0.0.1:3306/rhpam | False |
|
| The predefined driver name, available values are mysql, postgresql or the preferred name for the external driver. | mysql | True |
|
| Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/ExampleDS. | java:jboss/datasources/jbpmDS | True |
|
| KIE server external database name. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | rhpam | False |
|
| KIE server external database username. | rhpam | True |
|
| KIE server external database password. | — | True |
|
| Sets xa-pool/min-pool-size for the configured datasource. | — | False |
|
| Sets xa-pool/max-pool-size for the configured datasource. | — | False |
|
| An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate if a connection is valid. | org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker | False |
|
| An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate if an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred. | org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter | False |
|
| Sets the sql validation method to background-validation, if set to false the validate-on-match method will be used. | true | False |
|
| Defines the interval for the background-validation check for the jdbc connections. | 10000 | False |
|
| KIE server external database driver type, applicable only for DB2, possible values are 4 (default) or 2. | 4 | False |
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| False |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties). | enabled | False |
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property). | true | False |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. | false | False |
| — | The name of the secret containing the keystore file. | kieserver-app-secret | True |
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
| — | KIE server Container memory limit. | 1Gi | False |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 | rhpam-kieserver-library=org.openshift.quickstarts:rhpam-kieserver-library:1.4.0-SNAPSHOT | False |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped. Sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | true | False |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | LocalContainersStartupStrategy | False |
|
| RH-SSO URL. | False | |
|
| RH-SSO Realm name. | — | False |
|
| KIE Server RH-SSO Client name. | — | False |
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | — | False |
|
| RH-SSO Realm Admin Password used to create the Client. | — | False |
|
| RH-SSO Disable SSL Certificate Validation. | false | False |
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=exmample,ou=com | False |
|
| LDAP Credentials used for authentication. | Password | False |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | — | False |
|
| LDAP Base DN of the top-level context to begin the user search. | ou=users,ou=example,ou=com | False |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | (uid={0}) | False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. | 10000 | False |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | distinguishedName | False |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | true | False |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Name of the attribute containing the user roles. | memberOf | False |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | ou=groups,ou=example,ou=com | False |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | (memberOf={1}) | False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | 1 | False |
|
| A role included for all authenticated users. | guest | False |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This property defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
4.3.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.3.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
Service | Port | Name | Description |
---|---|---|---|
| 8080 | http | All the KIE server web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
4.3.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 a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
Service | Security | Hostname |
---|---|---|
| none |
|
| TLS passthrough |
|
4.3.2.3. Deployment Configurations
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.3.2.3.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
Deployment | Triggers |
---|---|
| ImageChange |
4.3.2.3.2. Replicas
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
Deployment | Replicas |
---|---|
| 1 |
4.3.2.3.3. Pod Template
4.3.2.3.3.1. Service Accounts
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
Deployment | Service Account |
---|---|
|
|
4.3.2.3.3.2. Image
Deployment | Image |
---|---|
|
|
4.3.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
4.3.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/healthcheck
4.3.2.3.3.5. Exposed Ports
Deployments | Name | Port | Protocol |
---|---|---|---|
| jolokia | 8778 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
|
4.3.2.3.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE administrator username. |
|
| KIE administrator password. |
| |
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| |
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties). |
| |
| KIE server class filtering (Sets the org.drools.server.filter.classes system property). |
| |
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
| KIE server controller username. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) |
| |
| — | ws | |
| KIE server controller host. (Used to set the org.kie.server.controller system property) |
| |
| KIE server controller port. (Used to set the org.kie.server.controller system property) |
| |
| — |
| |
| — |
| |
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. |
| |
| KIE server username. (Sets the org.kie.server.user system property) |
| |
| KIE server password. (Sets the org.kie.server.pwd system property) |
| |
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version | c2=g2:a2:v2 | |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | |
|
| Maven mirror configuration for KIE server. | |
|
| — | |
RHPAMCENTR,EXTERNAL |
| — | |
repo-rhpamcentr |
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required. | |
|
| — | |
|
| Username to access the Maven service hosted by Business Central inside EAP. | |
|
| Password to access the Maven service hosted by Business Central inside EAP. | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | |
|
| Fully qualified URL to a Maven repository or service. | |
|
| Username to access the Maven repository, if required. | |
|
| Password to access the Maven repository, if required. | |
|
| The service name for the optional smart router. | |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped. Sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | |
|
| Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/ExampleDS. | |
|
| Hibernate persistence schema. | |
|
| KIE server external database Hibernate dialect. | |
|
| — | |
|
| KIE server external database name. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | |
|
| Sets the datasource service host. Use this if you want to use the predefined mysql or postgresql datasource properties. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | |
|
| Sets the datasource service port. Use this if you want to use the predefined mysql or postgresql datasource properties. Leave blank if the KIE_SERVER_EXTERNALDB_URL is set. | |
|
| Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/ExampleDS. | |
|
| The predefined driver name, available values are mysql, postgresql or the preferred name for the external driver. | |
|
| KIE server external database username. | |
|
| KIE server external database password. | |
|
| Sets the datasources type. It can be XA or NONXA. For non XA set it to true. Default value is false. | |
|
| Sets the datasource jdbc connection url. Note that, if you are using PostgreSQL do not use this field, use the SERVICE_HOST and PORT. If using SERVICE_PORT and HOST there is no need to fill this parameter. | |
|
| Sets the datasource jdbc connection url. Note that, if you are using PostgreSQL do not use this field, use the SERVICE_HOST and PORT. If using SERVICE_PORT and HOST there is no need to fill this parameter. | |
|
| Sets xa-pool/min-pool-size for the configured datasource. | |
|
| Sets xa-pool/max-pool-size for the configured datasource. | |
|
| An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate if a connection is valid. | |
|
| An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate if an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred. | |
|
| Sets the sql validation method to background-validation, if set to false the validate-on-match method will be used. | |
|
| Defines the interval for the background-validation check for the jdbc connections. | |
|
| KIE server external database driver type, applicable only for DB2, possible values are 4 (default) or 2. | |
|
| — | |
true |
| Sets refresh-interval for the EJB timer database data-store service. | |
|
| — | |
|
| The name of the keystore file within the secret. | |
|
| The name associated with the server certificate. | |
|
| The password for the keystore and certificate. | |
|
| — | |
openshift.DNS_PING |
| — | |
|
| — | |
8888 |
| RH-SSO URL. | |
|
| — | |
ROOT.war |
| RH-SSO Realm name. | |
|
| KIE Server RH-SSO Client Secret. | |
|
| KIE Server RH-SSO Client name. | |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | |
|
| RH-SSO Realm Admin Password used to create the Client. | |
|
| RH-SSO Disable SSL Certificate Validation. | |
|
| RH-SSO Principal Attribute to use as username. | |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| LDAP Endpoint to connect for authentication. | |
|
| Bind DN used for authentication. | |
|
| LDAP Credentials used for authentication. | |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | |
|
| LDAP Base DN of the top-level context to begin the user search. | |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | |
|
| The search scope to use. | |
|
| The timeout in milliseconds for user or role searches. | |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Name of the attribute containing the user roles. | |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | |
|
| A role included for all authenticated users. | |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This property defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. |
4.3.2.3.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| kieserver-keystore-volume |
| ssl certs | True |
4.3.2.4. External Dependencies
4.3.2.4.1. Secrets
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.4. rhpam73-kieserver-mysql.yaml template
Application template for a managed KIE Server with a MySQL database, for Red Hat Process Automation Manager 7.3
4.4.1. Parameters
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
Variable name | Image Environment Variable | Description | Example value | Required |
---|---|---|---|---|
| — | The name for the application. | myapp | True |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | — | False |
|
| Maven mirror configuration for KIE server. | external:* | False |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | True |
|
| Username to access the Maven repository, if required. | — | False |
|
| Password to access the Maven repository, if required. | — | False |
|
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | myapp-rhpamcentr | False |
|
| Username to access the Maven service hosted by Business Central inside EAP. | mavenUser | False |
|
| Password to access the Maven service hosted by Business Central inside EAP. | maven1! | False |
|
| KIE administrator username. | adminUser | False |
|
| KIE administrator password. | — | False |
|
| KIE server username. (Sets the org.kie.server.user system property) | executionUser | False |
|
| KIE server password. (Sets the org.kie.server.pwd system property) | — | False |
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you installed the ImageStreams in a different namespace/project. | openshift | True |
| — | The name of the image stream to use for KIE server. Default is "rhpam73-kieserver-openshift". | rhpam73-kieserver-openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
| The service name for the optional smart router. | — | False |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | myapp-smartrouter | False |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | 9000 | False |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | http | False |
|
| KIE server controller username. (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) | — | False |
|
| KIE server controller host. (Used to set the org.kie.server.controller system property) | my-app-controller-ocpuser.os.example.com | False |
|
| KIE server controller port. (Used to set the org.kie.server.controller system property) | 8080 | False |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
| — | Namespace in which the ImageStream for the MySQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
| — | The MySQL image version, which is intended to correspond to the MySQL version. Default is "5.7". | 5.7 | False |
|
| KIE server MySQL database username. | rhpam | False |
|
| KIE server MySQL database password. | — | False |
|
| KIE server MySQL database name. | rhpam7 | False |
| — | Size of persistent storage for the database volume. | 1Gi | True |
|
| KIE server MySQL Hibernate dialect. | org.hibernate.dialect.MySQL57Dialect | True |
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| False |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) | true | False |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. | false | False |
| — | The name of the secret containing the keystore file. | kieserver-app-secret | True |
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
| — | KIE server Container memory limit. | 1Gi | False |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 | rhpam-kieserver-library=org.openshift.quickstarts:rhpam-kieserver-library:1.4.0-SNAPSHOT | False |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | true | False |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | LocalContainersStartupStrategy | False |
|
| RH-SSO URL. | False | |
|
| RH-SSO Realm name. | — | False |
|
| KIE Server RH-SSO Client name. | — | False |
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | — | False |
|
| RH-SSO Realm Admin Password used to create the Client. | — | False |
|
| RH-SSO Disable SSL Certificate Validation. | false | False |
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=exmample,ou=com | False |
|
| LDAP Credentials used for authentication. | Password | False |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | — | False |
|
| LDAP Base DN of the top-level context to begin the user search. | ou=users,ou=example,ou=com | False |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | (uid={0}) | False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. | 10000 | False |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | distinguishedName | False |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | true | False |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Name of the attribute containing the user roles. | memberOf | False |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | ou=groups,ou=example,ou=com | False |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | (memberOf={1}) | False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | 1 | False |
|
| A role included for all authenticated users. | guest | False |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
4.4.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.4.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
Service | Port | Name | Description |
---|---|---|---|
| 8080 | http | All the KIE server web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
| 3306 | — | The database server’s port. |
4.4.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 a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
Service | Security | Hostname |
---|---|---|
| none |
|
| TLS passthrough |
|
4.4.2.3. Deployment Configurations
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.4.2.3.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
Deployment | Triggers |
---|---|
| ImageChange |
| ImageChange |
4.4.2.3.2. Replicas
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
Deployment | Replicas |
---|---|
| 1 |
| 1 |
4.4.2.3.3. Pod Template
4.4.2.3.3.1. Service Accounts
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
Deployment | Service Account |
---|---|
|
|
4.4.2.3.3.2. Image
Deployment | Image |
---|---|
|
|
| mysql |
4.4.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-mysql
/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1'
4.4.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/healthcheck
${APPLICATION_NAME}-mysql
tcpSocket on port 3306
4.4.2.3.3.5. Exposed Ports
Deployments | Name | Port | Protocol |
---|---|---|---|
| jolokia | 8778 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
| |
| — | 3306 |
|
4.4.2.3.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE administrator username. |
|
| KIE administrator password. |
| |
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| |
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) |
| |
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
| KIE server controller username. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) |
| |
| — | ws | |
| KIE server controller host. (Used to set the org.kie.server.controller system property) |
| |
| KIE server controller port. (Used to set the org.kie.server.controller system property) |
| |
| — |
| |
| — |
| |
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. |
| |
| KIE server username. (Sets the org.kie.server.user system property) |
| |
| KIE server password. (Sets the org.kie.server.pwd system property) |
| |
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version | c2=g2:a2:v2 | |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | |
|
| Maven mirror configuration for KIE server. | |
|
| — | |
RHPAMCENTR,EXTERNAL |
| — | |
repo-rhpamcentr |
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | |
|
| — | |
|
| Username to access the Maven service hosted by Business Central inside EAP. | |
|
| Password to access the Maven service hosted by Business Central inside EAP. | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | |
|
| Fully qualified URL to a Maven repository or service. | |
|
| Username to access the Maven repository, if required. | |
|
| Password to access the Maven repository, if required. | |
|
| The service name for the optional smart router. | |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | |
|
| Port on which the smart router server listens. (Router property org.kie.server.router.port) | |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| — | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| KIE server MySQL database name. | |
|
| — | |
mysql |
| KIE server MySQL Hibernate dialect. | |
|
| KIE server MySQL database username. | |
|
| KIE server MySQL database password. | |
|
| — | |
|
| — | |
3306 |
| — | |
true |
| Sets refresh-interval for the EJB timer database data-store service. | |
|
| — | |
|
| The name of the keystore file within the secret. | |
|
| The name associated with the server certificate. | |
|
| The password for the keystore and certificate. | |
|
| — | |
openshift.DNS_PING |
| — | |
|
| — | |
8888 |
| RH-SSO URL. | |
|
| — | |
ROOT.war |
| RH-SSO Realm name. | |
|
| KIE Server RH-SSO Client Secret. | |
|
| KIE Server RH-SSO Client name. | |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | |
|
| RH-SSO Realm Admin Password used to create the Client. | |
|
| RH-SSO Disable SSL Certificate Validation. | |
|
| RH-SSO Principal Attribute to use as username. | |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| LDAP Endpoint to connect for authentication. | |
|
| Bind DN used for authentication. | |
|
| LDAP Credentials used for authentication. | |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | |
|
| LDAP Base DN of the top-level context to begin the user search. | |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | |
|
| The search scope to use. | |
|
| The timeout in milliseconds for user or role searches. | |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Name of the attribute containing the user roles. | |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | |
|
| A role included for all authenticated users. | |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | |
|
|
| KIE server MySQL database username. |
|
| KIE server MySQL database password. | |
|
| KIE server MySQL database name. |
4.4.2.3.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
| mysql | false |
4.4.2.4. External Dependencies
4.4.2.4.1. Volume Claims
A PersistentVolume
object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume
objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
Name | Access Mode |
---|---|
| ReadWriteOnce |
4.4.2.4.2. Secrets
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.5. rhpam73-kieserver-postgresql.yaml template
Application template for a managed KIE Server with a PostgreSQL database, for Red Hat Process Automation Manager 7.3
4.5.1. Parameters
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
Variable name | Image Environment Variable | Description | Example value | Required |
---|---|---|---|---|
| — | The name for the application. | myapp | True |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | — | False |
|
| Maven mirror configuration for KIE server. | external:* | False |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | True |
|
| Username to access the Maven repository, if required. | — | False |
|
| Password to access the Maven repository, if required. | — | False |
|
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required. | myapp-rhpamcentr | False |
|
| Username to access the Maven service hosted by Business Central inside EAP. | mavenUser | False |
|
| Password to access the Maven service hosted by Business Central inside EAP. | maven1! | False |
|
| KIE administrator username. | adminUser | False |
|
| KIE administrator password. | — | False |
|
| KIE server username. (Sets the org.kie.server.user system property) | executionUser | False |
|
| KIE server password. (Sets the org.kie.server.pwd system property) | — | False |
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you installed the ImageStreams in a different namespace/project. | openshift | True |
| — | The name of the image stream to use for KIE server. Default is "rhpam73-kieserver-openshift". | rhpam73-kieserver-openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
| The service name for the optional smart router. | — | False |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | myapp-smartrouter | False |
|
| Port on which the smart router server listens. (router property org.kie.server.router.port) | 9000 | False |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | http | False |
|
| KIE server controller username. (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) | — | False |
|
| KIE server controller host. (Used to set the org.kie.server.controller system property) | my-app-controller-ocpuser.os.example.com | False |
|
| KIE server controller port. (Used to set the org.kie.server.controller system property) | 8080 | False |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
| KIE server PostgreSQL database username. | rhpam | False |
|
| KIE server PostgreSQL database password. | — | False |
|
| KIE server PostgreSQL database name. | rhpam7 | False |
| — | Namespace in which the ImageStream for the PostgreSQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
| — | The PostgreSQL image version, which is intended to correspond to the PostgreSQL version. Default is "10". | 10 | False |
|
| Allows the PostgreSQL to handle XA transactions. | 100 | True |
| — | Size of persistent storage for the database volume. | 1Gi | True |
|
| KIE server PostgreSQL Hibernate dialect. | org.hibernate.dialect.PostgreSQLDialect | True |
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| False |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) | true | False |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. | false | False |
| — | The name of the secret containing the keystore file. | kieserver-app-secret | True |
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
| The name associated with the server certificate. | jboss | False |
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
| — | KIE server Container memory limit. | 1Gi | False |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 | rhpam-kieserver-library=org.openshift.quickstarts:rhpam-kieserver-library:1.4.0-SNAPSHOT | False |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | true | False |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | LocalContainersStartupStrategy | False |
|
| RH-SSO URL. | False | |
|
| RH-SSO Realm name. | — | False |
|
| KIE Server RH-SSO Client name. | — | False |
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | — | False |
|
| RH-SSO Realm Admin Password used to create the Client. | — | False |
|
| RH-SSO Disable SSL Certificate Validation. | false | False |
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=exmample,ou=com | False |
|
| LDAP Credentials used for authentication. | Password | False |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | — | False |
|
| LDAP Base DN of the top-level context to begin the user search. | ou=users,ou=example,ou=com | False |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | (uid={0}) | False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. | 10000 | False |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | distinguishedName | False |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | true | False |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | — | False |
|
| Name of the attribute containing the user roles. | memberOf | False |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | ou=groups,ou=example,ou=com | False |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | (memberOf={1}) | False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | 1 | False |
|
| A role included for all authenticated users | guest | False |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
4.5.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.5.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
Service | Port | Name | Description |
---|---|---|---|
| 8080 | http | All the KIE server web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
| 5432 | — | The database server’s port. |
4.5.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 a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
Service | Security | Hostname |
---|---|---|
| none |
|
| TLS passthrough |
|
4.5.2.3. Deployment Configurations
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.5.2.3.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
Deployment | Triggers |
---|---|
| ImageChange |
| ImageChange |
4.5.2.3.2. Replicas
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
Deployment | Replicas |
---|---|
| 1 |
| 1 |
4.5.2.3.3. Pod Template
4.5.2.3.3.1. Service Accounts
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
Deployment | Service Account |
---|---|
|
|
4.5.2.3.3.2. Image
Deployment | Image |
---|---|
|
|
| postgresql |
4.5.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.5.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/healthcheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container --live
4.5.2.3.3.5. Exposed Ports
Deployments | Name | Port | Protocol |
---|---|---|---|
| jolokia | 8778 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
| |
| — | 5432 |
|
4.5.2.3.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE administrator username. |
|
| KIE administrator password. |
| |
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| |
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) |
| |
| Allows the KIE server to bypass the authenticated user for task related operations e.g. queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
| KIE server controller username. (Sets the org.kie.server.controller.user system property) |
| |
| KIE server controller password. (Sets the org.kie.server.controller.pwd system property) |
| |
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
| The service name for the optional Business Central Monitoring. The application uses this service name to register with the monitoring console. (If set, will be used to discover host and port) |
| |
| — | ws | |
| KIE server controller host. (Used to set the org.kie.server.controller system property) |
| |
| KIE server controller port. (Used to set the org.kie.server.controller system property) |
| |
| — |
| |
| — |
| |
| If true, the KIE server will use secure-<application-name>-kieserver vs. <application-name>-kieserver as the KIE server route endpoint for Business Central to report. Therefore, Business Central displays the secure link to the user. |
| |
| KIE server username. (Sets the org.kie.server.user system property) |
| |
| KIE server password. (Sets the org.kie.server.pwd system property) |
| |
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version | c2=g2:a2:v2 | |
|
| Maven mirror that the KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | |
|
| Maven mirror configuration for KIE server. | |
|
| — | |
RHPAMCENTR,EXTERNAL |
| — | |
repo-rhpamcentr |
| The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required. | |
|
| — | |
|
| Username to access the Maven service hosted by Business Central inside EAP. | |
|
| Password to access the Maven service hosted by Business Central inside EAP. | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | |
|
| Fully qualified URL to a Maven repository or service. | |
|
| Username to access the Maven repository, if required. | |
|
| Password to access the Maven repository, if required. | |
|
| The service name for the optional smart router. | |
|
| The host name of the smart router, which can be the service name resolved by OpenShift or a globally resolvable domain name. | |
|
| Port on which the smart router server listens. (router property org.kie.server.router.port) | |
|
| KIE server router protocol. (Used to build the org.kie.server.router.url.external property) | |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | |
|
| When set to OpenShiftStartupStrategy, allows KIE server to start up independently using shared state from OpenShift API service and to connect to a Business Central that uses OpenShift integration. When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| — | |
|
| KIE server PostgreSQL database name. | |
|
| — | |
postgresql |
| KIE server PostgreSQL database username. | |
|
| KIE server PostgreSQL database password. | |
|
| — | |
|
| — | |
5432 |
| KIE server PostgreSQL Hibernate dialect. | |
|
| — | |
true |
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | |
|
| Sets refresh-interval for the EJB timer database data-store service. | |
|
| — | |
|
| The name of the keystore file within the secret. | |
|
| The name associated with the server certificate. | |
|
| The password for the keystore and certificate. | |
|
| — | |
openshift.DNS_PING |
| — | |
|
| — | |
8888 |
| RH-SSO URL. | |
|
| — | |
ROOT.war |
| RH-SSO Realm name. | |
|
| KIE Server RH-SSO Client Secret. | |
|
| KIE Server RH-SSO Client name. | |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist. | |
|
| RH-SSO Realm Admin Password used to create the Client. | |
|
| RH-SSO Disable SSL Certificate Validation. | |
|
| RH-SSO Principal Attribute to use as username. | |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> | |
|
| LDAP Endpoint to connect for authentication. | |
|
| Bind DN used for authentication. | |
|
| LDAP Credentials used for authentication. | |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. | |
|
| LDAP Base DN of the top-level context to begin the user search. | |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). | |
|
| The search scope to use. | |
|
| The timeout in milliseconds for user or role searches. | |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. | |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. | |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. | |
|
| Name of the attribute containing the user roles. | |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. | |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). | |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. | |
|
| A role included for all authenticated users | |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | |
|
|
| KIE server PostgreSQL database username. |
|
| KIE server PostgreSQL database password. | |
|
| KIE server PostgreSQL database name. | |
|
| Allows the PostgreSQL to handle XA transactions. |
4.5.2.3.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
| postgresql | false |
4.5.2.4. External Dependencies
4.5.2.4.1. Volume Claims
A PersistentVolume
object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume
objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
Name | Access Mode |
---|---|
| ReadWriteOnce |
4.5.2.4.2. Secrets
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.6. OpenShift usage quick reference
To deploy, monitor, manage, and undeploy Red Hat Process Automation Manager templates on Red Hat 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 are likely 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 deployment has 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. For more information, see Application modification operations.To view the logs for a pod, use the following command:
$ oc logs <pod-name>
To view deployment logs, look up a
DeploymentConfig
name in the template reference and run the 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 the command:$ 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 reference and 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, such as a pod or replication controller. For details, see Application modification operations.
Appendix A. Versioning information
Documentation last updated on Monday, March 01, 2021.