-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat Decision Manager
Deploying a Red Hat Decision 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 Decision Manager immutable server environment on Red Hat OpenShift Container Platform to provide an infrastructure to execute services and other business assets. You can use standard integration tools to manage the immutable Decision Server image. You can create new server images to add and update the business assets.
Prerequisites
- At least two gigabytes of memory must be available in the OpenShift cluster/namespace.
- 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.
Chapter 1. Overview of Red Hat Decision Manager on Red Hat OpenShift Container Platform
You can deploy Red Hat Decision Manager into a Red Hat OpenShift Container Platform environment.
In this solution, components of Red Hat Decision 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 Decision Manager are available on OpenShift:
Decision Server, also known as Execution Server or KIE Server, is the infrastructure element that runs decision services and other deployable assets (collectively referred to as services) . All logic of the services runs on execution servers.
You can freely scale up a Decision 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 run the same services. OpenShift provides load balancing and a request can be handled by any of the pods.
You can deploy a separate Decision 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 Decision Server pods as necessary.
Decision Central is a web-based interactive environment for authoring services. It also provides a management console. You can use Decision Central to develop services and deploy them to Decision Servers.
Decision Central is a centralized application. However, you can configure it for high availability, where multiple pods run and share the same data.
Decision 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, Decision Central can place the compiled services (KJAR files) into the built-in Maven repository or (if configured) into an external Maven repository.
In the current version, high-availability Decision Central functionality is a technology preview.
You can arrange these and other components into various environment configurations within OpenShift.
The following environment types are typical:
- Authoring or managed environment: An environment architecture that can be used for creating and modifying services using Decision Central and also for running services on Decision Servers. It consists of pods that provide Decision Central for the authoring work and one or more Decision Servers for execution of the services. Each Decision Server is a pod that you can replicate by scaling it up or down as necessary. You can deploy and undeploy services on each Decision Server using Decision Central. For instructions about deploying this environment, see Deploying a Red Hat Decision Manager authoring or 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 Decision 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 Decision 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. For instructions about deploying this environment, see Deploying a Red Hat Decision Manager immutable server environment on Red Hat OpenShift Container Platform.
You can also deploy a trial or evaluation environment. This environment includes Decision Central and a Decision 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 Decision Manager trial environment on Red Hat OpenShift Container Platform.
To deploy a Red Hat Decision Manager environment on OpenShift, you can use the templates that are provided with Red Hat Decision Manager.
Chapter 2. Preparing to deploy Red Hat Decision Manager in your OpenShift environment
Before deploying Red Hat Decision 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 decision services or for other decision services
2.1. Ensuring the availability of image streams
You must ensure that the image streams that are required for the deployment are available in your OpenShift environment. Some versions of the OpenShift environment include the necessary image streams. You must check if they are available. If they are not available, you must install the rhdm71-image-streams.yaml
file.
Procedure
Run the following commands:
$ oc get imagestreamtag -n openshift | grep rhdm71-decisioncentral-openshift $ oc get imagestreamtag -n openshift | grep rhdm71-kieserver-openshift
If the outputs of both commands are not empty, the required image streams are available and no further action is required.
If the output of one or both of the commands is empty, download the
rhdm-7.1.0-openshift-templates.zip
product deliverable file from the Software Downloads page. Extract therhdm71-image-streams.yaml
file from it. Complete one of the following actions:Run the following command:
$ oc create -f rhdm71-image-streams.yaml
- Using the OpenShift Web UI, select Add to Project → Import YAML / JSON, then choose the file or paste its contents.
2.2. Creating the secrets for Decision Server
OpenShift uses objects called Secrets
to hold sensitive information, such as passwords or keystores. See the Secrets chapter in the OpenShift documentation for more information.
You must create an SSL certificate for Decision Server and provide it to your OpenShift environment as a secret.
You do not need to create the secrets object if you are planning to deploy only Decision Servers without support for HTTPS.
Procedure
Generate an SSL keystore with a private and public key for SSL encryption for Decision Server. In a production environment, generate a valid signed certificate that matches the expected URL of the Decision Server. Save the keystore in a file named
keystore.jks
. Record the name of the certificate and the password of the keystore file.See Generate a SSL Encryption Key and Certificate for more information on how to create a keystore with self-signed or purchased SSL certificates.
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
Chapter 3. Environment with immutable servers
You can deploy an environment that includes one or more pods running Decision Server with preloaded services. Each Decision Server pod can be separately scaled as necessary.
In this case, any services (KJAR files) must be loaded onto a Decision Server at the time the image is created. You cannot load or unload services on a running Decision Server. The advantage of this approach is that the Decision Server with the services in it runs like any other containerized service and does not require specialized management. The Decision Server runs like any other pod on the OpenShift environment; you can use any container-based integration workflows as necessary.
When you create a Decision Server image, you must 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 Decision Central, copy the source into a separate repository for the S2I build. OpenShift automatically builds the source, installs the process into the Decision Server image, and starts the process. No further management of the image is required. If you want to use a new version of the process, you can build a new image.
If you are using Decision 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.
3.1. Extracting the source code from Decision Central for use in an S2I build
If you are using Decision 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@decision-central-host:8001/MySpace/MyProject
Replace:
-
adminUser
with the administrative user for Decision Central -
decision-central-host
with the host on which Decision Central is running -
MySpace
with the name of the Decision 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.
3.2. Deploying an immutable Decision Server
To deploy an immutable Decision Server, use the rhdm71-prod-immutable-kieserver.yaml
template file. You can extract this file from the rhdm-7.1.0-openshift-templates.zip
product deliverable file. You can download the file from the Software Downloads page.
When you deploy an immutable Decision 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.
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
rhdm71-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>/rhdm71-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.
-
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 Decision Server, as created in Section 2.2, “Creating the secrets for Decision Server”. -
Application Name (
APPLICATION_NAME
): The name of the OpenShift application. It is used in the default URL for Decision 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 Decision Central that the Decision Server is to join. -
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 Decision 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 Decision 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”), 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 username for the Maven repository.
-
Maven repository URL (
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration:
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,kiemgmt,Administrators
-
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 Decision 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 Decision 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 Decision Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The RH-SSO client name for Decision Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Decision 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 Decision 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 Decision Manager. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The name of the client to create in RH-SSO for Decision Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string to set in RH-SSO for the client for Decision Server. -
KIE Server Custom http Route Hostname (
KIE_SERVER_HOSTNAME_HTTP
): The fully qualified host name to use for the HTTP endpoint for Decision 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 Decision 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 Decision 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 LdatExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
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.
Chapter 4. OpenShift template reference information
Red Hat Decision Manager provides the following OpenShift templates. To access the templates, download and extract the rhdm-7.1.0-openshift-templates.zip
product deliverable file from the Software Downloads page of the Red Hat customer portal.
-
rhdm71-prod-immutable-kieserver.yaml
provides an immutable Decision Server. Deployment of this template includes a source-to-image (S2I) build for one or several services that are to run on the Decision Server. For details about this template, see Section 4.1, “rhdm71-prod-immutable-kieserver.yaml
template”.
4.1. rhdm71-prod-immutable-kieserver.yaml
template
Application template for an immultable KIE server in a production environment, for Red Hat Decision Manager 7.1
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 |
|
| 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 |
| — | 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’ve installed the ImageStreams in a different namespace/project. | openshift | True |
| — | The name of the image stream to use for KIE server. Default is "rhdm71-kieserver-openshift". | rhdm71-kieserver-openshift | True |
| — | A named pointer to an image in an image stream. Default is "1.0". | 1.0 | True |
|
| 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 standalone controller, where it can be reached to allow service lookup, and registered with (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) |
| False |
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| False |
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) | true | False |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. 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 |
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. | false | False |
| — | The name of the secret containing the keystore file | — | 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 bypass auth user (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 |
| True |
| — | Git source URI for application | — | True |
| — | Git branch/tag reference | — | False |
| — | Path within Git project to build; empty for root project directory. | — | False |
| — | GitHub trigger secret | — | True |
| — | Generic build trigger secret | — | True |
| — | Maven mirror to use for S2I builds | — | False |
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| 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 decision central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
| — | Username to access the Maven service hosted by Decision Central inside EAP. | — | False |
| — | Password to access the Maven service hosted by Decision Central inside EAP. | — | False |
| — | List of directories from which archives will be copied into the deployment folder. If unspecified, all archives in /target will be copied. | — | 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 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 |
| 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 |
| False |
|
| Bind DN used for authentication |
| False |
|
| LDAP Credentials used for authentication |
| 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. |
| 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}). |
| False |
|
| The search scope to use. |
| False |
|
| The timeout in milliseconds for user or role searches. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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}). |
| False |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| False |
|
| A role included for all authenticated users |
| 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. |
| 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 |
|
| 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 |
|
| If you are not using referrals, this option can be ignored. 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 |
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 KIE server web server’s ports. |
8443 | https | ||
| 8888 | ping | The JGroups ping port for clustering. |
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 |
|
4.1.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 |
---|---|---|---|
rhdm71-kieserver-openshift:1.0 |
| GitHub, Generic, ImageChange, ConfigChange |
4.1.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.1.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 |
4.1.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 |
4.1.2.4.3. Pod Template
4.1.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.1.2.4.3.2. Image
Deployment | Image |
---|---|
|
|
4.1.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
4.1.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/readycheck
4.1.2.4.3.5. Exposed Ports
Deployments | Name | Port | Protocol |
---|---|---|---|
| jolokia | 8778 |
|
http | 8080 |
| |
https | 8443 |
| |
ping | 8888 |
|
4.1.2.4.3.6. Image Environment Variables
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
| KIE administrator username |
| |
| KIE administrator password |
| |
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
| KIE server bypass auth user (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 standalone controller, where it can be reached to allow service lookup, and registered with (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) |
| |
| — |
| |
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
| — |
| |
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. |
| |
| KIE server username (Sets the org.kie.server.user system property) |
| |
| 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 Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| |
| — | RHDMCENTR,EXTERNAL | |
| — |
| |
| — |
| |
| Username to access the Maven repository, if required. |
| |
| Password to access the Maven repository, if required. |
| |
| The id to use for the maven repository, if set. Default is generated randomly. |
| |
| Fully qualified URL to a Maven repository. |
| |
| Username to access the Maven repository, if required. |
| |
| Password to access the Maven repository, if required. |
| |
| — |
| |
| 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 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, if set will also configure the KIE_SERVER_HOST. 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, this option can be ignored. 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. |
|
4.1.2.4.3.7. Volumes
Deployment | Name | mountPath | Purpose | readOnly |
---|---|---|---|---|
| kieserver-keystore-volume |
| ssl certs | True |
4.1.2.5. External Dependencies
4.1.2.5.1. Secrets
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.2. OpenShift usage quick reference
To deploy, monitor, manage, and undeploy Red Hat Decision 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 CLI operation.
Appendix A. Versioning information
Documentation last updated on Wednesday, March 27, 2019.