Red Hat Training
A Red Hat training course is available for Red Hat Decision Manager
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.2.0-openshift-templates.zip product deliverable file from the Software Downloads page of the Red Hat customer portal.
-
rhdm72-prod-immutable-kieserver.yamlprovides 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, “rhdm72-prod-immutable-kieserver.yaml template”.
4.1. rhdm72-prod-immutable-kieserver.yaml template
Application template for an immutable KIE server in a production environment, for Red Hat Decision Manager 7.2
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 installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhdm72-kieserver-openshift". | rhdm72-kieserver-openshift | True |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | 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. The application uses this service name to register with the controller. (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 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. 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, will use secure-APPLICATION_NAME-kieserver vs. APPLICATION_NAME-kieserver as the route name. | 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 |
|
|
| 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 | rhdm-kieserver-hellorules=org.openshift.quickstarts:rhdm-kieserver-hellorules:1.4.0-SNAPSHOT | True |
|
| — | Git source URI for application | https://github.com/jboss-container-images/rhdm-7-openshift-image.git | True |
|
| — | Git branch/tag reference | master | False |
|
| — | Path within Git project to build; empty for root project directory. | quickstarts/hello-rules/hellorules | 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. | my-repo-id | 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 | myapp-rhdmcentr | False |
|
|
| Username to access the Maven service hosted by Decision Central inside EAP. | mavenUser | False |
|
|
| Password to access the Maven service hosted by Decision 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 |
|
| — | 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 | 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.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 |
|---|---|---|---|
| rhdm72-kieserver-openshift:1.1 |
| 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. The application uses this service name to register with the controller. (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, will use secure-APPLICATION_NAME-kieserver vs. APPLICATION_NAME-kieserver as the route name. |
| |
|
| 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 |
| The service name for the optional decision central, where it can be reached, to allow service lookups (for maven repo usage), if required | |
|
|
| — | |
|
|
| Username to access the Maven service hosted by Decision Central inside EAP. | |
|
|
| Password to access the Maven service hosted by Decision Central inside EAP. | |
|
|
| 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. 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.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 describecommand 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
DeploymentConfigname 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
BuildConfigname 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
DeploymentConfigname 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 deletecommand to remove any part of the application, such as a pod or replication controller. For details, see Application modification operations.
