红帽全球峰会此内容没有您所选择的语言版本。
Chapter 6. OpenShift template reference information
Red Hat Process Automation Manager provides the following OpenShift templates. To access the templates, download and extract the rhpam-7.8.0-openshift-templates.zip product deliverable file from the Software Downloads page of the Red Hat customer portal.
-
rhpam78-authoring.yamlprovides a Business Central and a KIE Server connected to the Business Central. The KIE Server uses an H2 database with persistent storage. You can use this environment to author processes, services, and other business assets. For details about this template, see Section 6.1, “rhpam78-authoring.yaml template”. -
rhpam78-authoring-ha.yamlprovides a high-availability Business Central, a KIE Server connected to the Business Central, and a MySQL instance that the KIE Server uses. You can use this environment to author processes, services, and other business assets. For details about this template, see Section 6.2, “rhpam78-authoring-ha.yaml template”.
6.1. rhpam78-authoring.yaml template
Application template for a non-HA persistent authoring environment, for Red Hat Process Automation Manager 7.8 - Deprecated
6.1.1. Parameters
Templates allow you to define parameters that 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. See the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
| — | Secret containing the KIE_ADMIN_USER and KIE_ADMIN_PWD values. | rhpam-credentials | True |
|
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
|
| Allows the KIE server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
| KIE_SERVER_H2_USER |
| KIE server H2 database user name. | sa | False |
| KIE_SERVER_H2_PWD |
| KIE server H2 database password. | — | False |
|
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property) |
| False |
|
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property) | false | False |
|
|
| Custom hostname for the http service route for Business Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhpamcentr-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for the https service route for Business Central. Leave blank for default hostname, e.g.: <application-name>-rhpamcentr-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for the http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for the https service route for KIE Server. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| — | The name of the secret containing the keystore file for Business Central. | businesscentral-app-secret | True |
|
|
| The name of the keystore file within the secret. | keystore.jks | False |
|
|
| The name associated with the server certificate. | jboss | False |
|
|
| The password for the keystore and certificate. | mykeystorepass | False |
|
| — | The name of the secret containing the keystore file for KIE server. | 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 |
|
| — | Size of persistent storage for the database volume. | 1Gi | True |
|
|
| If set to true, turns on KIE server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property) | false | False |
|
|
| If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) | true | False |
|
|
| KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property) | 5000 | False |
|
| — | Namespace in which the ImageStreams for Red Hat Process Automation Manager images are installed. These ImageStreams are normally installed in the openshift namespace. You need to modify this parameter only if you installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam-kieserver-rhel8". | rhpam-kieserver-rhel8 | True |
|
| — | A named pointer to an image in an image stream. Default is "7.8.0". | 7.8.0 | True |
|
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | — | False |
|
|
| Maven mirror configuration for KIE server. | external:*,!repo-rhpamcentr | False |
|
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | False |
|
|
| User name for accessing the Maven repository, if required. | — | False |
|
|
| Password to access the Maven repository, if required. | — | False |
|
|
| The directory to use for git hooks, if required. |
| False |
|
| — | Size of the persistent storage for Business Central runtime data. | 1Gi | True |
|
| — | Business Central Container memory limit. | 2Gi | False |
|
| — | KIE server Container memory limit. | 1Gi | False |
|
|
| RH-SSO URL. | https://rh-sso.example.com/auth | False |
|
|
| RH-SSO Realm name. | — | False |
|
|
| Business Central RH-SSO Client name. | — | False |
|
|
| Business Central RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
|
| KIE Server RH-SSO Client name. | — | False |
|
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
|
| RH-SSO Realm admin user name for creating 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 user name. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication | ldap://myldap.example.com | False |
|
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=example,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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. 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 | user | False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 | — | False |
|
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. | — | False |
6.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.
6.1.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. See the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the Business Central web server’s ports. |
| 8443 | https | ||
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https |
6.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. See the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
| insecure-${APPLICATION_NAME}-rhpamcentr-http | none |
|
|
| TLS passthrough |
|
| insecure-${APPLICATION_NAME}-kieserver-http | none |
|
|
| TLS passthrough |
|
6.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. See the Openshift documentation for more information.
6.1.2.3.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. See the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
6.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. See the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 1 |
|
| 1 |
6.1.2.3.3. Pod Template
6.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. See the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
|
|
|
6.1.2.3.3.2. Image
| Deployment | Image |
|---|---|
|
| rhpam-businesscentral-rhel8 |
|
|
|
6.1.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-rhpamcentr
Http Get on http://localhost:8080/rest/ready${APPLICATION_NAME}-kieserver
Http Get on http://localhost:8080/services/rest/server/readycheck6.1.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-rhpamcentr
Http Get on http://localhost:8080/rest/healthy${APPLICATION_NAME}-kieserver
Http Get on http://localhost:8080/services/rest/server/healthcheck6.1.2.3.3.5. Exposed Ports
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
|
6.1.2.3.3.6. Image Environment Variables
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| — |
|
|
| — |
| |
|
| Admin user name | Set according to the credentials secret | |
|
| Admin user password | Set according to the credentials secret | |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| — | false | |
|
| If set to true, turns on KIE server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property) |
| |
|
| If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) |
| |
|
| KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property) |
| |
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. |
| |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. |
| |
|
| Fully qualified URL to a Maven repository or service. |
| |
|
| User name for accessing the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| The directory to use for git hooks, 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. |
| |
|
| — |
| |
|
| RH-SSO URL. |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name. |
| |
|
| Business Central RH-SSO Client Secret. |
| |
|
| Business Central RH-SSO Client name. |
| |
|
| RH-SSO Realm admin user name for creating 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 user name. |
| |
|
| Custom hostname for the http service route for Business Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhpamcentr-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for the https service route for Business Central. Leave blank for default hostname, e.g.: <application-name>-rhpamcentr-<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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 |
| |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. |
| |
|
|
| — |
|
|
| — |
| |
|
| — | rhpam7 | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — | true | |
|
| — | h2 | |
|
| KIE server H2 database user name. |
| |
|
| KIE server H2 database password. |
| |
|
| — | false | |
|
| — | jdbc:h2:/opt/kie/data/h2/rhpam;AUTO_SERVER=TRUE | |
|
| — | org.hibernate.dialect.H2Dialect | |
|
| Admin user name | Set according to the credentials secret | |
|
| Admin user password | Set according to the credentials secret | |
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property) |
| |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) |
| |
|
| If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property) |
| |
|
| Allows the KIE server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| — |
| |
|
| — | ws | |
|
| — | — | |
|
| — | insecure-${APPLICATION_NAME}-kieserver | |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — | ControllerBasedStartupStrategy | |
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. |
| |
|
| Maven mirror configuration for KIE server. |
| |
|
| — | RHPAMCENTR,EXTERNAL | |
|
| — | repo-rhpamcentr | |
|
| — |
| |
|
| — |
| |
|
| — | Set according to the credentials secret | |
|
| — | Set according to the credentials secret | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. |
| |
|
| Fully qualified URL to a Maven repository or service. |
| |
|
| User name for accessing 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. |
| |
|
| 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 user name for creating 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 user name. |
| |
|
| Custom hostname for the http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for the https service route for KIE Server. 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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format is original_role=role1,role2,role3 |
| |
|
| Whether to add to the current roles, or replace the current roles with the mapped ones. Replaces if set to true. |
|
6.1.2.3.3.7. Volumes
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| businesscentral-keystore-volume |
| ssl certs | True |
|
| kieserver-keystore-volume |
| ssl certs | True |
6.1.2.4. External Dependencies
6.1.2.4.1. Volume Claims
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. See the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteOnce |
|
| ReadWriteOnce |
6.1.2.4.2. Secrets
This template requires the following secrets to be installed for the application to run.
businesscentral-app-secret kieserver-app-secret
6.2. rhpam78-authoring-ha.yaml template
Application template for a HA persistent authoring environment, for Red Hat Process Automation Manager 7.8 - Deprecated
6.2.1. Parameters
Templates allow you to define parameters that 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. See the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
| — | Secret containing the KIE_ADMIN_USER and KIE_ADMIN_PWD values. | rhpam-credentials | True |
|
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) | — | False |
|
|
| Allows the KIE server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
|
| MySQL database user name. | rhpam | False |
|
|
| MySQL database password. | — | False |
|
|
| MySQL database name. | rhpam7 | False |
|
| — | Size of persistent storage for the KIE server database volume. | 1Gi | True |
|
| — | Namespace in which the ImageStream for the MySQL image is installed. The ImageStream is already installed in the openshift namespace. You need to modify this parameter only if you installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
|
| — | The MySQL image version, which is intended to correspond to the MySQL version. Default is "8.0". | 8.0 | False |
|
|
| KIE server MySQL Hibernate dialect. | org.hibernate.dialect.MySQL8Dialect | True |
|
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| False |
|
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property) | false | False |
|
|
| Custom hostname for http service route for Business Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhpamcentr-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for https service route for Business Central. Leave blank for default hostname, e.g.: <application-name>-rhpamcentr-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
|
| Custom hostname for https service route for KIE Server. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> | — | False |
|
| — | The name of the secret containing the keystore file for Business Central. | businesscentral-app-secret | True |
|
|
| The name of the keystore file within the secret for Business Central. | keystore.jks | False |
|
|
| The name associated with the server certificate for Business Central. | jboss | False |
|
|
| The password for the keystore and certificate for Business Central. | mykeystorepass | False |
|
| — | The name of the secret containing the keystore file for KIE Server. | kieserver-app-secret | True |
|
|
| The name of the keystore file within the secret for KIE Server. | keystore.jks | False |
|
|
| The name associated with the server certificate for KIE Server. | jboss | False |
|
|
| The password for the keystore and certificate for KIE Server. | mykeystorepass | False |
|
|
| The user name for connecting to the JMS broker. | jmsBrokerUser | True |
|
|
| The password to connect to the JMS broker. | — | True |
|
| — | DataGrid image. | registry.redhat.io/jboss-datagrid-7/datagrid73-openshift:1.5 | True |
|
| — | DataGrid Container CPU limit. | 1000m | True |
|
| — | DataGrid Container memory limit. | 2Gi | True |
|
| — | Size of the persistent storage for DataGrid’s runtime data. | 1Gi | True |
|
| — | AMQ Broker Image. | registry.redhat.io/amq7/amq-broker:7.6 | True |
|
| — | User role for standard broker user. | admin | True |
|
| — | The name of the broker. | broker | True |
|
| — | Specifies the maximum amount of memory that message data can consume. If no value is specified, half of the system’s memory is allocated. | 10 gb | False |
|
| — | Size of persistent storage for AMQ broker volume. | 1Gi | True |
|
| — | Number of broker replicas for a cluster. | 2 | True |
|
|
| If set to true, turns on KIE server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property) | false | False |
|
|
| Enables connection to KIE Server via OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) | true | False |
|
|
| KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property) | 5000 | False |
|
| — | Namespace in which the ImageStreams for Red Hat Process Automation Manager images are installed. These ImageStreams are normally installed in the openshift namespace. You need to modify this parameter only if you installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for Business Central. Default is "rhpam-businesscentral-rhel8". | rhpam-businesscentral-rhel8 | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam-kieserver-rhel8". | rhpam-kieserver-rhel8 | True |
|
| — | A named pointer to an image in an image stream. Default is "7.8.0". | 7.8.0 | True |
|
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. | — | False |
|
|
| Maven mirror configuration for KIE server. | external:*,!repo-rhpamcentr | False |
|
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. | repo-custom | False |
|
|
| Fully qualified URL to a Maven repository or service. | http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/ | False |
|
|
| User name for accessing the Maven repository, if required. | — | False |
|
|
| Password to access the Maven repository, if required. | — | False |
|
|
| The directory to use for git hooks, if required. |
| False |
|
|
| Sets refresh-interval for the EJB timer database data-store service. | 60000 | True |
|
| — | Size of the persistent storage for Business Central runtime data. | 1Gi | True |
|
| — | Business Central Container memory limit. | 8Gi | True |
|
|
|
Business Central Container JVM max memory ratio. | 80 | True |
|
| — | Business Central Container CPU limit. | 2000m | True |
|
| — | KIE server Container memory limit. | 1Gi | True |
|
| — | KIE server Container CPU limit. | 1000m | True |
|
| — | Business Central Container Replicas, defines how many Business Central containers will be started. | 2 | True |
|
| — | KIE Server Container Replicas, defines how many KIE Server containers will be started. | 2 | True |
|
|
| RH-SSO URL. | https://rh-sso.example.com/auth | False |
|
|
| RH-SSO Realm name. | — | False |
|
|
| Business Central RH-SSO Client name. | — | False |
|
|
| Business Central RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
|
| KIE Server RH-SSO Client name. | — | False |
|
|
| KIE Server RH-SSO Client Secret. | 252793ed-7118-4ca8-8dab-5622fa97d892 | False |
|
|
| RH-SSO Realm admin user name for creating 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 user name. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication. | ldap://myldap.example.com | False |
|
|
| Bind DN used for authentication. | uid=admin,ou=users,ou=example,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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. 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 | user | False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. | name | False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. | false | False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. | false | False |
|
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. | — | False |
|
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format of every entry in the file 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 |
6.2.2. Objects
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
6.2.2.1. Services
A service is an abstraction which defines a logical set of pods and a policy by which to access them. See the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the Business Central web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for rhpamcentr clustering. |
|
| 8888 | ping | The JGroups ping port for clustering. |
|
| 11222 | hotrod | Provides a service for accessing the application over Hot Rod protocol. |
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https | ||
|
| 61616 | — | The broker’s OpenWire port. |
|
| 8888 | — | The JGroups ping port for amq clustering. |
|
| 3306 | — | The MySQL server’s port. |
6.2.2.2. Routes
A route is a way to expose a service by giving it an externally reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. See the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
| insecure-${APPLICATION_NAME}-rhpamcentr-http | none |
|
|
| TLS passthrough |
|
| insecure-${APPLICATION_NAME}-kieserver-http | none |
|
|
| TLS passthrough |
|
6.2.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. See the Openshift documentation for more information.
6.2.2.3.1. Triggers
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. See the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
|
| ImageChange |
6.2.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. See the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 2 |
|
| 2 |
|
| 1 |
6.2.2.3.3. Pod Template
6.2.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. See the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
|
|
|
6.2.2.3.3.2. Image
| Deployment | Image |
|---|---|
|
|
|
|
|
|
|
| mysql |
6.2.2.3.3.3. Readiness Probe
${APPLICATION_NAME}-rhpamcentr
Http Get on http://localhost:8080/rest/ready${APPLICATION_NAME}-kieserver
Http Get on http://localhost:8080/services/rest/server/readycheck${APPLICATION_NAME}-mysql
/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1'6.2.2.3.3.4. Liveness Probe
${APPLICATION_NAME}-rhpamcentr
Http Get on http://localhost:8080/rest/healthy${APPLICATION_NAME}-kieserver
Http Get on http://localhost:8080/services/rest/server/healthcheck${APPLICATION_NAME}-mysql
tcpSocket on port 33066.2.2.3.3.5. Exposed Ports
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
| |
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
|
| — | 3306 |
|
6.2.2.3.3.6. Image Environment Variables
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| — |
|
|
| — |
| |
|
| Admin user name | Set according to the credentials secret | |
|
| Admin user password | Set according to the credentials secret | |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| — | true | |
|
| If set to true, turns on KIE server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property) |
| |
|
| Enables connection to KIE Server via OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property) |
| |
|
| KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property) |
| |
|
| KIE server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property) |
| |
|
| — |
| |
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. |
| |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. |
| |
|
| Fully qualified URL to a Maven repository or service. |
| |
|
| User name for accessing the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| The directory to use for git hooks, if required. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret for Business Central. |
| |
|
| The name associated with the server certificate for Business Central. |
| |
|
| The password for the keystore and certificate for Business Central. |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| — |
| |
|
| — | 11222 | |
|
| — |
| |
|
| — | 61616 | |
|
| The user name for connecting to the JMS broker. |
| |
|
| The password to connect to the JMS broker. |
| |
|
|
Business Central Container JVM max memory ratio. |
| |
|
| RH-SSO URL. |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name. |
| |
|
| Business Central RH-SSO Client Secret. |
| |
|
| Business Central RH-SSO Client name. |
| |
|
| RH-SSO Realm admin user name for creating 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 user name. |
| |
|
| Custom hostname for http service route for Business Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhpamcentr-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route for Business Central. Leave blank for default hostname, e.g.: <application-name>-rhpamcentr-<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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format of every entry in the file 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. |
| |
|
|
| — |
|
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — |
| |
|
| MySQL database name. |
| |
|
| — | mariadb | |
|
| MySQL database user name. |
| |
|
| MySQL database password. |
| |
|
| — |
| |
|
| — | 3306 | |
|
| KIE server MySQL Hibernate dialect. |
| |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) |
| |
|
| KIE server persistence datasource. (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — | true | |
|
| Admin user name | Set according to the credentials secret | |
|
| Admin user password | Set according to the credentials secret | |
|
| KIE server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property). |
| |
|
| KIE server class filtering. (Sets the org.drools.server.filter.classes system property) |
| |
|
| If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property) |
| |
|
| Allows the KIE server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| — |
| |
|
| — | ws | |
|
| — | — | |
|
| — | insecure-${APPLICATION_NAME}-kieserver | |
|
| — | OpenShiftStartupStrategy | |
|
| Maven mirror that Business Central and KIE server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services. |
| |
|
| Maven mirror configuration for KIE server. |
| |
|
| — | RHPAMCENTR,EXTERNAL | |
|
| — | repo-rhpamcentr | |
|
| — |
| |
|
| — |
| |
|
| — | Set according to the credentials secret | |
|
| — | Set according to the credentials secret | |
|
| The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhpamcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF. |
| |
|
| Fully qualified URL to a Maven repository or service. |
| |
|
| User name for accessing the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret for KIE Server. |
| |
|
| The name associated with the server certificate for KIE Server. |
| |
|
| The password for the keystore and certificate for KIE Server. |
| |
|
| 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 user name for creating 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 user name. |
| |
|
| Custom hostname for http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route for KIE Server. 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 user name. If set to true, the DN is parsed for the user name. If set to false the DN is not parsed for the user name. 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 user name. 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 user name. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, you can ignore this option. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
| When present, the RoleMapping Login Module will be configured to use the provided file. This parameter defines the fully-qualified file path and name of a properties file or resource which maps roles to replacement roles. The format of every entry in the file 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. |
| |
|
|
| MySQL database user name. |
|
|
| MySQL database password. |
| |
|
| MySQL database name. |
| |
|
| — | mysql_native_password |
6.2.2.3.3.7. Volumes
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| businesscentral-keystore-volume |
| ssl certs | True |
|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
|
| mysql | false |
6.2.2.4. External Dependencies
6.2.2.4.1. Volume Claims
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. See the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteMany |
|
| ReadWriteOnce |
6.2.2.4.2. Secrets
This template requires the following secrets to be installed for the application to run.
businesscentral-app-secret kieserver-app-secret
6.2.2.4.3. Clustering
Clustering in OpenShift EAP is achieved through one of two discovery mechanisms: Kubernetes or DNS. This is done by configuring the JGroups protocol stack in standalone-openshift.xml with either the <openshift.KUBE_PING/> or <openshift.DNS_PING/> elements. The templates are configured to use DNS_PING, however `KUBE_PING`is the default used by the image.
The discovery mechanism used is specified by the JGROUPS_PING_PROTOCOL environment variable which can be set to either openshift.DNS_PING or openshift.KUBE_PING. openshift.KUBE_PING is the default used by the image if no value is specified for JGROUPS_PING_PROTOCOL.
For DNS_PING to work, the following steps must be taken:
-
The
OPENSHIFT_DNS_PING_SERVICE_NAMEenvironment variable must be set to the name of the ping service for the cluster (see table above). If not set, the server will act as if it is a single-node cluster (a "cluster of one"). -
The
OPENSHIFT_DNS_PING_SERVICE_PORTenvironment variables should be set to the port number on which the ping service is exposed (see table above). TheDNS_PINGprotocol will attempt to discern the port from the SRV records, if it can, otherwise it will default to 8888. A ping service which exposes the ping port must be defined. This service should be "headless" (ClusterIP=None) and must have the following:
- The port must be named for port discovery to work.
-
It must be annotated with
service.alpha.kubernetes.io/tolerate-unready-endpointsset to"true". Omitting this annotation will result in each node forming their own "cluster of one" during startup, then merging their cluster into the other nodes' clusters after startup (as the other nodes are not detected until after they have started).
Example ping service for use with DNS_PING
kind: Service
apiVersion: v1
spec:
clusterIP: None
ports:
- name: ping
port: 8888
selector:
deploymentConfig: eap-app
metadata:
name: eap-app-ping
annotations:
service.alpha.kubernetes.io/tolerate-unready-endpoints: "true"
description: "The JGroups ping port for clustering."
For KUBE_PING to work, the following steps must be taken:
-
The
OPENSHIFT_KUBE_PING_NAMESPACEenvironment variable must be set (see table above). If not set, the server will act as if it is a single-node cluster (a "cluster of one"). -
The
OPENSHIFT_KUBE_PING_LABELSenvironment variables should be set (see table above). If not set, pods outside of your application (albeit in your namespace) will try to join. - Authorization must be granted to the service account the pod is running under to be allowed to access Kubernetes' REST api. This is done on the command line.
Example 6.1. Policy commands
Using the default service account in the myproject namespace:
oc policy add-role-to-user view system:serviceaccount:myproject:default -n myprojectUsing the eap-service-account in the myproject namespace:
oc policy add-role-to-user view system:serviceaccount:myproject:eap-service-account -n myproject6.3. OpenShift usage quick reference
To deploy, monitor, manage, and undeploy Red Hat Process Automation Manager templates on Red Hat OpenShift Container Platform, you can use the OpenShift Web console or the oc command.
For instructions about using the Web console, see Create and build an image using the Web console.
For detailed instructions about using the oc command, see CLI Reference. The following commands are likely to be required:
To create a project, use the following command:
$ oc new-project <project-name>For more information, see Creating a project using the CLI.
To deploy a template (create an application from a template), use the following command:
$ oc new-app -f <template-name> -p <parameter>=<value> -p <parameter>=<value> ...For more information, see Creating an application using the CLI.
To view a list of the active pods in the project, use the following command:
$ oc get podsTo 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 enter 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 enter 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 enter 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.
'%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}