Red Hat SummitDeploying a Red Hat Decision Manager trial environment on Red Hat OpenShift Container Platform
Abstract
Preface
As a system engineer, you can deploy a Red Hat Decision Manager trial environment on Red Hat OpenShift Container Platform to evaluate or demonstrate development and use of rules and other business assets.
Prerequisites
- At least three 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
occommand. For more information about theoccommand-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. 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
$ oc get imagestreamtag -n openshift | grep rhdm71-decisioncentral-openshift $ oc get imagestreamtag -n openshift | grep rhdm71-kieserver-openshiftCopy to Clipboard Copied! 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.zipproduct deliverable file from the Software Downloads page. Extract therhdm71-image-streams.yamlfile from it. Complete one of the following actions:Run the following command:
oc create -f rhdm71-image-streams.yaml
$ oc create -f rhdm71-image-streams.yamlCopy to Clipboard Copied! - Using the OpenShift Web UI, select Add to Project → Import YAML / JSON, then choose the file or paste its contents.
Chapter 3. Deploying a trial environment
You can deploy a trial (evaluation) Red Hat Decision Manager environment. It consists of Decision Central for authoring or managing services and Decision Server for test execution of services.
This environment does not include permanent storage. Assets that you create or modify in a trial environment are not saved.
The procedure is minimal. There are no required settings and all passwords are set to a single value (the default password is RedHat).
To deploy a trial environment, use the rhdm71-trial-ephemeral.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 of the Red Hat Customer Portal.
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-trial-ephemeral.yamlfile. 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-trial-ephemeral.yaml
oc new-app -f <template-path>/rhdm71-trial-ephemeral.yamlCopy to Clipboard Copied! In this command line, replace
<template-path>with the path to the downloaded template file.
-
In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select or paste the
- Optionally, set any parameters as described in the template. However, a typical trial deployment does not require any parameters.
Complete the creation of the environment, depending on the method that you are using:
In the OpenShift Web UI, click Create.
-
A
This will create resources that may have security or project behavior implicationspop-up message might be displayed. If it is displayed, click Create Anyway.
-
A
- 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-trial-ephemeral.yamlprovides a Decision Central and a Decision Server connected to the Decision Central. This environment uses an ephemeral configuration without any persistent storage. For details about this template, see Section 4.1, “rhdm71-trial-ephemeral.yamltemplate”.
4.1. rhdm71-trial-ephemeral.yaml template
Application template for an ephemeral authoring and testing 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 |
|
| — | Default password used for multiple components for user convenience in this trial environment | RedHat | True |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) | controllerUser | 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, 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 http service route. Leave blank for default hostname, e.g.: <application-name>-rhdmcentr-<project>.<default-domain-suffix> |
| 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 Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| False |
|
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| False |
|
|
| Fully qualified URL to a Maven repository or service. |
| False |
|
|
| Username to access the Maven repository, if required. |
| False |
|
|
| Password to access the Maven repository, if required. |
| False |
|
| — | Username to access the Maven service hosted by Decision Central inside EAP. | mavenUser | True |
|
|
| The directory to use for git hooks, if required. |
| False |
|
| — | Decision Central Container memory limit | 2Gi | False |
|
| — | KIE server Container memory limit | 1Gi | False |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| Decision Central RH-SSO Client name |
| False |
|
|
| Decision Central RH-SSO Client Secret |
| 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 Decision Central web server’s ports. |
| 8001 | git-ssh | ||
|
| 8080 | — | All the KIE server web server’s ports. |
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 |
|
|
| none |
|
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 |
|
| 1 |
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 |
|---|---|
|
| rhdm71-decisioncentral-openshift |
|
|
|
4.1.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-rhdmcentr
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${DEFAULT_PASSWORD}' http://localhost:8080/kie-drools-wb.jsp
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${DEFAULT_PASSWORD}' http://localhost:8080/kie-drools-wb.jsp${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u ${KIE_ADMIN_USER}:${DEFAULT_PASSWORD} http://localhost:8080/services/rest/server/readycheck
/bin/bash -c curl --fail --silent -u ${KIE_ADMIN_USER}:${DEFAULT_PASSWORD} http://localhost:8080/services/rest/server/readycheck4.1.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-rhdmcentr
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${DEFAULT_PASSWORD}' http://localhost:8080/kie-drools-wb.jsp
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${DEFAULT_PASSWORD}' http://localhost:8080/kie-drools-wb.jsp${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u ${KIE_ADMIN_USER}:${DEFAULT_PASSWORD} http://localhost:8080/services/rest/server/readycheck
/bin/bash -c curl --fail --silent -u ${KIE_ADMIN_USER}:${DEFAULT_PASSWORD} http://localhost:8080/services/rest/server/readycheck4.1.2.3.3.5. Exposed Ports
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| git-ssh | 8001 |
| |
|
| jolokia | 8778 |
|
| http | 8080 |
|
4.1.2.3.3.6. Image Environment Variables
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE administrator username |
|
|
| — |
| |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) |
| |
|
| — |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| — |
| |
|
| — |
| |
|
| 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. |
| |
|
| — |
| |
|
| — |
| |
|
| The directory to use for git hooks, if required. |
| |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| Decision Central RH-SSO Client Secret |
| |
|
| Decision Central 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> |
| |
|
| 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. |
| |
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
|
| KIE administrator username |
| |
|
| — |
| |
|
| 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) |
| |
|
| — |
| |
|
| — |
| |
|
| — | ws | |
|
| — |
| |
|
| 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> |
| |
|
| — |
| |
|
| KIE server username (Sets the org.kie.server.user 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 or service. |
| |
|
| Username to access the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| Decision Central RH-SSO Client Secret |
| |
|
| Decision Central 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> |
| |
|
| 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. External Dependencies
4.1.2.4.1. Secrets
This template requires the following secrets to be installed for the application to run.
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>
$ oc new-project <project-name>Copy to Clipboard Copied! 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> ...
$ oc new-app -f <template-name> -p <parameter>=<value> -p <parameter>=<value> ...Copy to Clipboard Copied! 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
$ oc get podsCopy to Clipboard Copied! 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>
$ oc describe pod <pod-name>Copy to Clipboard Copied! 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>
$ oc logs <pod-name>Copy to Clipboard Copied! To view deployment logs, look up a
DeploymentConfigname in the template reference and run the following command:oc logs -f dc/<deployment-config-name>
$ oc logs -f dc/<deployment-config-name>Copy to Clipboard Copied! 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>
$ oc logs -f bc/<build-config-name>Copy to Clipboard Copied! 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>
$ oc scale dc/<deployment-config-name> --replicas=<number>Copy to Clipboard Copied! For more information, see Manual scaling.
To undeploy the application, you can delete the project by using the command:
oc delete project <project-name>
$ oc delete project <project-name>Copy to Clipboard Copied! 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 CLI operation.
Appendix A. Versioning information
Documentation last updated on Monday, December 21, 2020.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}