此内容没有您所选择的语言版本。
Chapter 4. OpenShift template reference information
Red Hat Process Automation Manager provides the following OpenShift templates. To access the templates, download and extract the rhpam-7.1.0-openshift-templates.zip product deliverable file from the Software Downloads page of the Red Hat customer portal.
-
rhpam71-prod-immutable-monitor.yamlprovides a Business Central Monitoring instance and a Smart Router that you can use with immutable Process Servers. When you deploy this template, OpenShift displays the settings that you must then use for deploying therhpam71-prod-immutable-kieserver.yamltemplate. For details about this template, see Section 4.1, “rhpam71-prod-immutable-monitor”. -
rhpam71-prod-immutable-kieserver.yamlprovides an immutable Process Server. When you deploy this template, a source-to-image (S2I) build is triggered for one or several services that are to run on the Process Server. The Process Server can optionally be configured to connect to the Business Central Monitoring and Smart Router provided byrhpam71-prod-immutable-monitor.yaml. For details about this template, see Section 4.2, “rhpam71-prod-immutable-kieserver”. -
rhpam71-kieserver-externaldb.yamlprovides a Process Server that uses an external database. You can configure the Process Server to connect to a Business Central. Also, you can copy sections from this template into another template to configure a Process Server in the other template to use an external database. For details about this template, see Section 4.3, “rhpam71-kieserver-externaldb”. -
rhpam71-kieserver-mysql.yamlprovides a Process Server and a MySQL instance that the Process Server uses. You can configure the Process Server to connect to a Business Central. Also, you can copy sections from this template into another template to configure a Process Server in the other template to use MySQL and to provide the MySQL instance. For details about this template, see Section 4.4, “rhpam71-kieserver-mysql”. -
rhpam71-kieserver-postgresql.yamlprovides a Process Server and a PostgreSQL instance that the Process Server uses. You can configure the Process Server to connect to a Business Central. Also, you can copy sections from this template into another template to configure a Process Server in the other template to use PostgreSQL and to provide the PostgreSQL instance. For details about this template, see Section 4.4, “rhpam71-kieserver-mysql”.
4.1. rhpam71-prod-immutable-monitor 复制链接链接已复制到粘贴板!
Application template for a router and monitoring console in a production environment, for Red Hat Process Automation 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 |
|
|
| 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 |
|
| — | The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
|
| — | Username to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | Password to access the Maven service hosted by Business Central inside EAP. | — | False |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE administrator password |
| False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) |
| False |
|
| — | 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 |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | False |
|
|
| Custom hostname for http service route. Leave blank for default hostname, e.g. <application-name>-smartrouter-<project>.<default-domain-suffix>' |
| False |
|
|
| Router ID used when connecting to the controller (router property org.kie.server.router.id) | kie-server-router | True |
|
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| False |
|
|
| Public URL where the router can be found. Format http://<host>:<port> (router property org.kie.server.router.url.external) |
| False |
|
|
| Router name used when connecting to the controller (router property org.kie.server.router.name) | KIE Server Router | True |
|
| — | KIE server monitor username (Sets the org.kie.server.controller.user system property) | monitorUser | False |
|
| — | KIE server monitor password (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| — | KIE server monitor token for bearer authentication (Sets the org.kie.server.controller.token system property) | — | False |
|
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| False |
|
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| False |
|
| — | The name of the secret containing the keystore file | — | 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 |
|
|
| Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| False |
|
| — | Business Central Container memory limit | 2Gi | False |
|
| — | Smart Router Container memory limit | 512Mi | False |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| Business Central Monitoring RH-SSO Client name |
| False |
|
|
| Business Central Monitoring RH-SSO Client Secret |
| 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 Business Central Monitoring web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for clustering. |
|
| 9000 | — | The smart router server http port. |
4.1.2.2. Routes 复制链接链接已复制到粘贴板!
A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
|
| none |
|
|
| TLS passthrough |
|
|
| none |
|
4.1.2.3. Deployment Configurations 复制链接链接已复制到粘贴板!
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.1.2.3.1. Triggers 复制链接链接已复制到粘贴板!
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
4.1.2.3.2. Replicas 复制链接链接已复制到粘贴板!
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 1 |
|
| 2 |
4.1.2.3.3. Pod Template 复制链接链接已复制到粘贴板!
4.1.2.3.3.1. Image 复制链接链接已复制到粘贴板!
| Deployment | Image |
|---|---|
|
| rhpam71-businesscentral-monitoring-openshift |
|
| rhpam71-smartrouter-openshift |
4.1.2.3.3.2. Readiness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-rhpamcentrmon
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/kie-wb.jsp
4.1.2.3.3.3. Liveness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-rhpamcentrmon
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/kie-wb.jsp
4.1.2.3.3.4. Exposed Ports 复制链接链接已复制到粘贴板!
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
| |
|
| http | 9000 |
|
4.1.2.3.3.5. Image Environment Variables 复制链接链接已复制到粘贴板!
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE administrator password |
|
|
| KIE administrator username |
| |
|
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| — | RHPAMCENTR,EXTERNAL | |
|
| — |
| |
|
| — |
| |
|
| 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. |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| The name of the keystore file within the secret |
| |
|
| The name associated with the server certificate |
| |
|
| The password for the keystore and certificate |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| Business Central Monitoring RH-SSO Client Secret |
| |
|
| Business Central Monitoring RH-SSO Client name |
| |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| |
|
| RH-SSO Realm Admin Password used to create the Client |
| |
|
| RH-SSO Disable SSL Certificate Validation |
| |
|
| RH-SSO Principal Attribute to use as username. |
| |
|
| Custom hostname for http service route. Leave blank for default hostname, e.g. <application-name>-smartrouter-<project>.<default-domain-suffix>' |
| |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-rhpamcentrmon-<project>.<default-domain-suffix> |
| |
|
| LDAP Endpoint to connect for authentication |
| |
|
| Bind DN used for authentication |
| |
|
| LDAP Credentials used for authentication |
| |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
|
| LDAP Base DN of the top-level context to begin the user search. |
| |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
|
| The search scope to use. |
| |
|
| The timeout in milliseconds for user or role searches. |
| |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, 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. |
| |
|
|
| — | — |
|
| — | 9000 | |
|
| Public URL where the router can be found. Format http://<host>:<port> (router property org.kie.server.router.url.external) |
| |
|
| Router ID used when connecting to the controller (router property org.kie.server.router.id) |
| |
|
| Router name used when connecting to the controller (router property org.kie.server.router.name) |
| |
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | ws | |
|
| — |
| |
|
| — | true |
4.1.2.3.3.6. Volumes 复制链接链接已复制到粘贴板!
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| businesscentral-keystore-volume |
| ssl certs | True |
|
|
|
| — | false |
4.1.2.4. External Dependencies 复制链接链接已复制到粘贴板!
4.1.2.4.1. Volume Claims 复制链接链接已复制到粘贴板!
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteMany |
|
| ReadWriteMany |
4.2. rhpam71-prod-immutable-kieserver 复制链接链接已复制到粘贴板!
Application template for an immultable KIE server in a production environment, for Red Hat Process Automation Manager 7.1
4.2.1. Parameters 复制链接链接已复制到粘贴板!
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE administrator password |
| False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) |
| False |
|
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam71-kieserver-openshift". | rhpam71-kieserver-openshift | True |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
| — | KIE server monitor username, for optional use of the business-central-monitor (Sets the org.kie.server.controller.user system property) | monitorUser | False |
|
| — | KIE server monitor password, for optional use of the business-central-monitor (Sets the org.kie.server.controller.pwd system property) | — | False |
|
| — | KIE server monitor token for bearer authentication (Sets the org.kie.server.controller.token system property) | — | False |
|
| — | The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) | — | False |
|
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| False |
|
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| False |
|
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| False |
|
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| False |
|
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
| — | Namespace in which the ImageStream for the PostgreSQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
|
| — | The PostgreSQL image version, which is intended to correspond to the PostgreSQL version. Default is "9.6". | 9.6 | False |
|
|
| KIE server PostgreSQL database username | rhpam | False |
|
| — | KIE server PostgreSQL database password | — | False |
|
| — | KIE server PostgreSQL database name | rhpam7 | False |
|
|
| Allows the PostgreSQL to handle XA transactions. | 100 | True |
|
| — | Size of persistent storage for database volume. | 1Gi | True |
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. | false | False |
|
| — | The name of the secret containing the keystore file | — | True |
|
|
| The name of the keystore file within the secret | keystore.jks | False |
|
|
| The name associated with the server certificate | jboss | False |
|
|
| The password for the keystore and certificate | mykeystorepass | False |
|
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| True |
|
| — | Git source URI for application | — | True |
|
| — | Git branch/tag reference | — | False |
|
| — | Path within Git project to build; empty for root project directory. | — | False |
|
| — | GitHub trigger secret | — | True |
|
| — | Generic build trigger secret | — | True |
|
| — | Maven mirror to use for S2I builds | — | False |
|
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| False |
|
|
| Fully qualified URL to a Maven repository. |
| False |
|
|
| Username to access the Maven repository, if required. |
| False |
|
|
| Password to access the Maven repository, if required. |
| False |
|
| — | The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
|
| — | Username to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | Password to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | List of directories from which archives will be copied into the deployment folder. If unspecified, all archives in /target will be copied. | — | False |
|
|
| Sets refresh-interval for the EJB timer service database-data-store. | 30000 | False |
|
| — | KIE server Container memory limit | 1Gi | False |
|
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. | true | True |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. | LocalContainersStartupStrategy | True |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| KIE Server RH-SSO Client name |
| False |
|
|
| KIE Server RH-SSO Client Secret |
| False |
|
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| False |
|
|
| RH-SSO Realm Admin Password used to create the Client |
| False |
|
|
| RH-SSO Disable SSL Certificate Validation | false | False |
|
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication |
| False |
|
|
| Bind DN used for authentication |
| False |
|
|
| LDAP Credentials used for authentication |
| False |
|
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| False |
|
|
| LDAP Base DN of the top-level context to begin the user search. |
| False |
|
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| False |
|
|
| The search scope to use. |
| False |
|
|
| The timeout in milliseconds for user or role searches. |
| False |
|
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| False |
|
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| False |
|
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Name of the attribute containing the user roles. |
| False |
|
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| False |
|
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| False |
|
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| False |
|
|
| A role included for all authenticated users |
| False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| False |
|
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| False |
4.2.2. Objects 复制链接链接已复制到粘贴板!
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.2.2.1. Services 复制链接链接已复制到粘贴板!
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for clustering. |
|
| 5432 | — | The database server’s port. |
4.2.2.2. Routes 复制链接链接已复制到粘贴板!
A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
|
| none |
|
|
| TLS passthrough |
|
4.2.2.3. Build Configurations 复制链接链接已复制到粘贴板!
A buildConfig describes a single build definition and a set of triggers for when a new build should be created. A buildConfig is a REST object, which can be used in a POST to the API server to create a new instance. Refer to the Openshift documentation for more information.
| S2I image | link | Build output | BuildTriggers and Settings |
|---|---|---|---|
| rhpam71-kieserver-openshift:1.1 |
| GitHub, Generic, ImageChange, ConfigChange |
4.2.2.4. Deployment Configurations 复制链接链接已复制到粘贴板!
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.2.2.4.1. Triggers 复制链接链接已复制到粘贴板!
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
4.2.2.4.2. Replicas 复制链接链接已复制到粘贴板!
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 2 |
|
| 1 |
4.2.2.4.3. Pod Template 复制链接链接已复制到粘贴板!
4.2.2.4.3.1. Service Accounts 复制链接链接已复制到粘贴板!
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
4.2.2.4.3.2. Image 复制链接链接已复制到粘贴板!
| Deployment | Image |
|---|---|
|
|
|
|
| postgresql |
4.2.2.4.3.3. Readiness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.2.2.4.3.4. Liveness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.2.2.4.3.5. Exposed Ports 复制链接链接已复制到粘贴板!
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
| |
|
| — | 5432 |
|
4.2.2.4.3.6. Image Environment Variables 复制链接链接已复制到粘贴板!
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
|
| KIE administrator username |
| |
|
| KIE administrator password |
| |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | 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> |
| |
|
| — |
| |
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| KIE server password, used to connect to KIE servers. Generated value can be a suggestion to use for thew s2i various (Sets the org.kie.server.pwd system property) |
| |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| |
|
| — | RHPAMCENTR,EXTERNAL | |
|
| — |
| |
|
| — |
| |
|
| Username to access the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| |
|
| Fully qualified URL to a Maven repository. |
| |
|
| Username to access the Maven repository, if required. |
| |
|
| Password to access the Maven repository, if required. |
| |
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| |
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| |
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| |
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| |
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | true | |
|
| — | postgresql | |
|
| — | org.hibernate.dialect.PostgreSQLDialect | |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | 5432 | |
|
| Sets refresh-interval for the EJB timer service database-data-store. |
| |
|
| Sets refresh-interval for the EJB timer service database-data-store. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret |
| |
|
| The name associated with the server certificate |
| |
|
| The password for the keystore and certificate |
| |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| KIE Server RH-SSO Client Secret |
| |
|
| KIE Server RH-SSO Client name |
| |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| |
|
| RH-SSO Realm Admin Password used to create the Client |
| |
|
| RH-SSO Disable SSL Certificate Validation |
| |
|
| RH-SSO Principal Attribute to use as username. |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| LDAP Endpoint to connect for authentication |
| |
|
| Bind DN used for authentication |
| |
|
| LDAP Credentials used for authentication |
| |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
|
| LDAP Base DN of the top-level context to begin the user search. |
| |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
|
| The search scope to use. |
| |
|
| The timeout in milliseconds for user or role searches. |
| |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
|
| KIE server PostgreSQL database username |
|
|
| — |
| |
|
| — |
| |
|
| Allows the PostgreSQL to handle XA transactions. |
|
4.2.2.4.3.7. Volumes 复制链接链接已复制到粘贴板!
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
|
| postgresql | false |
4.2.2.5. External Dependencies 复制链接链接已复制到粘贴板!
4.2.2.5.1. Volume Claims 复制链接链接已复制到粘贴板!
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteOnce |
4.2.2.5.2. Secrets 复制链接链接已复制到粘贴板!
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.3. rhpam71-kieserver-externaldb 复制链接链接已复制到粘贴板!
Application template for a managed KIE Server with an external database, for Red Hat Process Automation Manager 7.1
4.3.1. Parameters 复制链接链接已复制到粘贴板!
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| False |
|
|
| Fully qualified URL to a Maven repository or service. |
| True |
|
|
| Username to access the Maven repository, if required. |
| False |
|
|
| Password to access the Maven repository, if required. |
| False |
|
| — | The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
|
| — | Username to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | Password to access the Maven service hosted by Business Central inside EAP. | — | False |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE administrator password |
| False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| False |
|
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam71-kieserver-openshift". | rhpam71-kieserver-openshift | True |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| False |
|
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| False |
|
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| False |
|
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| False |
|
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| False |
|
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| False |
|
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| False |
|
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
| — | KIE server external database driver | — | True |
|
| — | KIE server external database driver type, applicable only for DB2, possible values are 4 (default) or 2 | — | False |
|
| — | KIE server external database username | — | True |
|
| — | KIE server external database password | — | True |
|
| — | KIE server external database JDBC URL | — | False |
|
| — | KIE server external database Hibernate dialect | — | True |
|
| — | KIE server external database host, for ejb_timer datasource configuration | — | True |
|
| — | KIE server external database port, for ejb_timer datasource configuration | — | True |
|
| — | KIE server external database name, for ejb_timer datasource configuration | rhpam | False |
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. | false | False |
|
| — | The name of the secret containing the keystore file | — | True |
|
|
| The name of the keystore file within the secret | keystore.jks | False |
|
|
| The name associated with the server certificate | jboss | False |
|
|
| The password for the keystore and certificate | mykeystorepass | False |
|
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
|
| — | KIE server Container memory limit | 1Gi | False |
|
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| False |
|
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. |
| False |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| False |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| KIE Server RH-SSO Client name |
| False |
|
|
| KIE Server RH-SSO Client Secret |
| False |
|
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| False |
|
|
| RH-SSO Realm Admin Password used to create the Client |
| False |
|
|
| RH-SSO Disable SSL Certificate Validation | false | False |
|
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication |
| False |
|
|
| Bind DN used for authentication |
| False |
|
|
| LDAP Credentials used for authentication |
| False |
|
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| False |
|
|
| LDAP Base DN of the top-level context to begin the user search. |
| False |
|
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| False |
|
|
| The search scope to use. |
| False |
|
|
| The timeout in milliseconds for user or role searches. |
| False |
|
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| False |
|
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| False |
|
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Name of the attribute containing the user roles. |
| False |
|
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| False |
|
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| False |
|
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| False |
|
|
| A role included for all authenticated users |
| False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| False |
|
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| False |
4.3.2. Objects 复制链接链接已复制到粘贴板!
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.3.2.1. Services 复制链接链接已复制到粘贴板!
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for clustering. |
4.3.2.2. Routes 复制链接链接已复制到粘贴板!
A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
|
| none |
|
|
| TLS passthrough |
|
4.3.2.3. Deployment Configurations 复制链接链接已复制到粘贴板!
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.3.2.3.1. Triggers 复制链接链接已复制到粘贴板!
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
4.3.2.3.2. Replicas 复制链接链接已复制到粘贴板!
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 1 |
4.3.2.3.3. Pod Template 复制链接链接已复制到粘贴板!
4.3.2.3.3.1. Service Accounts 复制链接链接已复制到粘贴板!
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
4.3.2.3.3.2. Image 复制链接链接已复制到粘贴板!
| Deployment | Image |
|---|---|
|
|
|
4.3.2.3.3.3. Readiness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
4.3.2.3.3.4. Liveness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
4.3.2.3.3.5. Exposed Ports 复制链接链接已复制到粘贴板!
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
|
4.3.2.3.3.6. Image Environment Variables 复制链接链接已复制到粘贴板!
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
|
| KIE administrator username |
| |
|
| KIE administrator password |
| |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) |
| |
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| |
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| |
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| |
|
| — | ws | |
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| |
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| |
|
| — |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| — |
| |
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| |
|
| — | RHPAMCENTR,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. |
| |
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| |
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| |
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| |
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| |
|
| Disable management api and don’t allow KIE containers to be deployed/undeployed or started/stopped sets the property org.kie.server.mgmt.api.disabled to true and org.kie.server.startup.strategy to LocalContainersStartupStrategy. |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| |
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | true | |
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret |
| |
|
| The name associated with the server certificate |
| |
|
| The password for the keystore and certificate |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| KIE Server RH-SSO Client Secret |
| |
|
| KIE Server RH-SSO Client name |
| |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| |
|
| RH-SSO Realm Admin Password used to create the Client |
| |
|
| RH-SSO Disable SSL Certificate Validation |
| |
|
| RH-SSO Principal Attribute to use as username. |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| LDAP Endpoint to connect for authentication |
| |
|
| Bind DN used for authentication |
| |
|
| LDAP Credentials used for authentication |
| |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
|
| LDAP Base DN of the top-level context to begin the user search. |
| |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
|
| The search scope to use. |
| |
|
| The timeout in milliseconds for user or role searches. |
| |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
|
4.3.2.3.3.7. Volumes 复制链接链接已复制到粘贴板!
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| kieserver-keystore-volume |
| ssl certs | True |
4.3.2.4. External Dependencies 复制链接链接已复制到粘贴板!
4.3.2.4.1. Secrets 复制链接链接已复制到粘贴板!
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.4. rhpam71-kieserver-mysql 复制链接链接已复制到粘贴板!
Application template for a managed KIE Server with a MySQL database, for Red Hat Process Automation Manager 7.1
4.4.1. Parameters 复制链接链接已复制到粘贴板!
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| False |
|
|
| Fully qualified URL to a Maven repository or service. |
| True |
|
|
| Username to access the Maven repository, if required. |
| False |
|
|
| Password to access the Maven repository, if required. |
| False |
|
| — | The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
|
| — | Username to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | Password to access the Maven service hosted by Business Central inside EAP. | — | False |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE administrator password |
| False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| False |
|
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam71-kieserver-openshift". | rhpam71-kieserver-openshift | True |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| False |
|
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| False |
|
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| False |
|
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| False |
|
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| False |
|
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| False |
|
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| False |
|
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
| — | Namespace in which the ImageStream for the MySQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
|
| — | The MySQL image version, which is intended to correspond to the MySQL version. Default is "5.7". | 5.7 | False |
|
|
| KIE server MySQL database username | rhpam | False |
|
| — | KIE server MySQL database password | — | False |
|
| — | KIE server MySQL database name | rhpam7 | False |
|
| — | Size of persistent storage for database volume. | 1Gi | True |
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. | false | False |
|
| — | The name of the secret containing the keystore file | — | True |
|
|
| The name of the keystore file within the secret | keystore.jks | False |
|
|
| The name associated with the server certificate | jboss | False |
|
|
| The password for the keystore and certificate | mykeystorepass | False |
|
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
|
| — | KIE server Container memory limit | 1Gi | False |
|
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| False |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| False |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| False |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| KIE Server RH-SSO Client name |
| False |
|
|
| KIE Server RH-SSO Client Secret |
| False |
|
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| False |
|
|
| RH-SSO Realm Admin Password used to create the Client |
| False |
|
|
| RH-SSO Disable SSL Certificate Validation | false | False |
|
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication |
| False |
|
|
| Bind DN used for authentication |
| False |
|
|
| LDAP Credentials used for authentication |
| False |
|
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| False |
|
|
| LDAP Base DN of the top-level context to begin the user search. |
| False |
|
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| False |
|
|
| The search scope to use. |
| False |
|
|
| The timeout in milliseconds for user or role searches. |
| False |
|
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| False |
|
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| False |
|
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Name of the attribute containing the user roles. |
| False |
|
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| False |
|
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| False |
|
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| False |
|
|
| A role included for all authenticated users |
| False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| False |
|
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| False |
4.4.2. Objects 复制链接链接已复制到粘贴板!
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.4.2.1. Services 复制链接链接已复制到粘贴板!
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for clustering. |
|
| 3306 | — | The database server’s port. |
4.4.2.2. Routes 复制链接链接已复制到粘贴板!
A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
|
| none |
|
|
| TLS passthrough |
|
4.4.2.3. Deployment Configurations 复制链接链接已复制到粘贴板!
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.4.2.3.1. Triggers 复制链接链接已复制到粘贴板!
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
4.4.2.3.2. Replicas 复制链接链接已复制到粘贴板!
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 1 |
|
| 1 |
4.4.2.3.3. Pod Template 复制链接链接已复制到粘贴板!
4.4.2.3.3.1. Service Accounts 复制链接链接已复制到粘贴板!
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
4.4.2.3.3.2. Image 复制链接链接已复制到粘贴板!
| Deployment | Image |
|---|---|
|
|
|
|
| mysql |
4.4.2.3.3.3. Readiness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-mysql
/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1'
4.4.2.3.3.4. Liveness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
4.4.2.3.3.5. Exposed Ports 复制链接链接已复制到粘贴板!
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
| |
|
| — | 3306 |
|
4.4.2.3.3.6. Image Environment Variables 复制链接链接已复制到粘贴板!
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
|
| KIE administrator username |
| |
|
| KIE administrator password |
| |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) |
| |
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| |
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| |
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| |
|
| — | ws | |
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| |
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| |
|
| — |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| — |
| |
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| |
|
| — | RHPAMCENTR,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. |
| |
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| |
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| |
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| |
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| |
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | mysql | |
|
| — | org.hibernate.dialect.MySQL5Dialect | |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | 3306 | |
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — | true | |
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret |
| |
|
| The name associated with the server certificate |
| |
|
| The password for the keystore and certificate |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| KIE Server RH-SSO Client Secret |
| |
|
| KIE Server RH-SSO Client name |
| |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| |
|
| RH-SSO Realm Admin Password used to create the Client |
| |
|
| RH-SSO Disable SSL Certificate Validation |
| |
|
| RH-SSO Principal Attribute to use as username. |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| LDAP Endpoint to connect for authentication |
| |
|
| Bind DN used for authentication |
| |
|
| LDAP Credentials used for authentication |
| |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
|
| LDAP Base DN of the top-level context to begin the user search. |
| |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
|
| The search scope to use. |
| |
|
| The timeout in milliseconds for user or role searches. |
| |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
|
| KIE server MySQL database username |
|
|
| — |
| |
|
| — |
|
4.4.2.3.3.7. Volumes 复制链接链接已复制到粘贴板!
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
|
| mysql | false |
4.4.2.4. External Dependencies 复制链接链接已复制到粘贴板!
4.4.2.4.1. Volume Claims 复制链接链接已复制到粘贴板!
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteOnce |
4.4.2.4.2. Secrets 复制链接链接已复制到粘贴板!
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.5. rhpam71-kieserver-postgresql 复制链接链接已复制到粘贴板!
Application template for a managed KIE Server with a PostgreSQL database, for Red Hat Process Automation Manager 7.1
4.5.1. Parameters 复制链接链接已复制到粘贴板!
Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. References can be defined in any text field in the objects list field. Refer to the Openshift documentation for more information.
| Variable name | Image Environment Variable | Description | Example value | Required |
|---|---|---|---|---|
|
| — | The name for the application. | myapp | True |
|
|
| The id to use for the maven repository, if set. Default is generated randomly. |
| False |
|
|
| Fully qualified URL to a Maven repository or service. |
| True |
|
|
| Username to access the Maven repository, if required. |
| False |
|
|
| Password to access the Maven repository, if required. |
| False |
|
| — | The service name for the optional business central, where it can be reached, to allow service lookups (for maven repo usage), if required | — | False |
|
| — | Username to access the Maven service hosted by Business Central inside EAP. | — | False |
|
| — | Password to access the Maven service hosted by Business Central inside EAP. | — | False |
|
|
| KIE administrator username | adminUser | False |
|
|
| KIE administrator password |
| False |
|
|
| KIE server username (Sets the org.kie.server.user system property) | executionUser | False |
|
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| False |
|
| — | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStreams in a different namespace/project. | openshift | True |
|
| — | The name of the image stream to use for KIE server. Default is "rhpam71-kieserver-openshift". | rhpam71-kieserver-openshift | True |
|
| — | A named pointer to an image in an image stream. Default is "1.1". | 1.1 | True |
|
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| False |
|
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| False |
|
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| False |
|
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| False |
|
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) | controllerUser | False |
|
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| False |
|
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| False |
|
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| False |
|
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| False |
|
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) | java:/jboss/datasources/rhpam | False |
|
|
| KIE server PostgreSQL database username | rhpam | False |
|
| — | KIE server PostgreSQL database password | — | False |
|
| — | KIE server PostgreSQL database name | rhpam7 | False |
|
| — | Namespace in which the ImageStream for the PostgreSQL image is installed. The ImageStream is already installed in the openshift namespace. You should only need to modify this if you’ve installed the ImageStream in a different namespace/project. Default is "openshift". | openshift | False |
|
| — | The PostgreSQL image version, which is intended to correspond to the PostgreSQL version. Default is "9.6". | 9.6 | False |
|
|
| Allows the PostgreSQL to handle XA transactions. | 100 | True |
|
| — | Size of persistent storage for database volume. | 1Gi | True |
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) | true | False |
|
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) | enabled | False |
|
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| False |
|
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. | false | False |
|
| — | The name of the secret containing the keystore file | — | True |
|
|
| The name of the keystore file within the secret | keystore.jks | False |
|
|
| The name associated with the server certificate | jboss | False |
|
|
| The password for the keystore and certificate | mykeystorepass | False |
|
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) | false | False |
|
|
| Sets refresh-interval for the EJB timer database data-store service. | 30000 | False |
|
| — | KIE server Container memory limit | 1Gi | False |
|
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| False |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable |
| False |
|
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| False |
|
|
| RH-SSO URL |
| False |
|
|
| RH-SSO Realm name |
| False |
|
|
| KIE Server RH-SSO Client name |
| False |
|
|
| KIE Server RH-SSO Client Secret |
| False |
|
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| False |
|
|
| RH-SSO Realm Admin Password used to create the Client |
| False |
|
|
| RH-SSO Disable SSL Certificate Validation | false | False |
|
|
| RH-SSO Principal Attribute to use as username. | preferred_username | False |
|
|
| LDAP Endpoint to connect for authentication |
| False |
|
|
| Bind DN used for authentication |
| False |
|
|
| LDAP Credentials used for authentication |
| False |
|
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| False |
|
|
| LDAP Base DN of the top-level context to begin the user search. |
| False |
|
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| False |
|
|
| The search scope to use. |
| False |
|
|
| The timeout in milliseconds for user or role searches. |
| False |
|
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| False |
|
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| False |
|
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| False |
|
|
| Name of the attribute containing the user roles. |
| False |
|
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| False |
|
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| False |
|
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| False |
|
|
| A role included for all authenticated users |
| False |
|
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| False |
|
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| False |
|
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| False |
|
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| False |
4.5.2. Objects 复制链接链接已复制到粘贴板!
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the Openshift documentation.
4.5.2.1. Services 复制链接链接已复制到粘贴板!
A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the container-engine documentation for more information.
| Service | Port | Name | Description |
|---|---|---|---|
|
| 8080 | http | All the KIE server web server’s ports. |
| 8443 | https | ||
|
| 8888 | ping | The JGroups ping port for clustering. |
|
| 5432 | — | The database server’s port. |
4.5.2.2. Routes 复制链接链接已复制到粘贴板!
A route is a way to expose a service by giving it an externally-reachable hostname such as www.example.com. A defined route and the endpoints identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists of a route name, service selector, and (optionally) security configuration. Refer to the Openshift documentation for more information.
| Service | Security | Hostname |
|---|---|---|
|
| none |
|
|
| TLS passthrough |
|
4.5.2.3. Deployment Configurations 复制链接链接已复制到粘贴板!
A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. Refer to the Openshift documentation for more information.
4.5.2.3.1. Triggers 复制链接链接已复制到粘贴板!
A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the Openshift documentation for more information.
| Deployment | Triggers |
|---|---|
|
| ImageChange |
|
| ImageChange |
4.5.2.3.2. Replicas 复制链接链接已复制到粘贴板!
A replication controller ensures that a specified number of pod "replicas" are running at any one time. If there are too many, the replication controller kills some pods. If there are too few, it starts more. Refer to the container-engine documentation for more information.
| Deployment | Replicas |
|---|---|
|
| 1 |
|
| 1 |
4.5.2.3.3. Pod Template 复制链接链接已复制到粘贴板!
4.5.2.3.3.1. Service Accounts 复制链接链接已复制到粘贴板!
Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the Openshift documentation for more information.
| Deployment | Service Account |
|---|---|
|
|
|
4.5.2.3.3.2. Image 复制链接链接已复制到粘贴板!
| Deployment | Image |
|---|---|
|
|
|
|
| postgresql |
4.5.2.3.3.3. Readiness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.5.2.3.3.4. Liveness Probe 复制链接链接已复制到粘贴板!
${APPLICATION_NAME}-kieserver
/bin/bash -c curl --fail --silent -u '${KIE_ADMIN_USER}:${KIE_ADMIN_PWD}' http://localhost:8080/services/rest/server/readycheck
${APPLICATION_NAME}-postgresql
/usr/libexec/check-container
4.5.2.3.3.5. Exposed Ports 复制链接链接已复制到粘贴板!
| Deployments | Name | Port | Protocol |
|---|---|---|---|
|
| jolokia | 8778 |
|
| http | 8080 |
| |
| https | 8443 |
| |
| ping | 8888 |
| |
|
| — | 5432 |
|
4.5.2.3.3.6. Image Environment Variables 复制链接链接已复制到粘贴板!
| Deployment | Variable name | Description | Example value |
|---|---|---|---|
|
|
| KIE server class filtering (Sets the org.drools.server.filter.classes system property) |
|
|
| KIE administrator username |
| |
|
| KIE administrator password |
| |
|
| KIE server mbeans enabled/disabled (Sets the kie.mbeans and kie.scanner.mbeans system properties) |
| |
|
| KIE server bypass auth user (Sets the org.kie.server.bypass.auth.user system property) |
| |
|
| KIE server controller username (Sets the org.kie.server.controller.user system property) |
| |
|
| KIE server controller password (Sets the org.kie.server.controller.pwd system property) |
| |
|
| KIE server controller token for bearer authentication (Sets the org.kie.server.controller.token system property) |
| |
|
| The service name for the optional business central monitor, where it can be reached to allow service lookup, and registered with to allow monitoring console functionality (If set, will be used to discover host and port) |
| |
|
| — | ws | |
|
| KIE server controller host (Used to set the org.kie.server.controller system property) |
| |
|
| KIE server controller port (Used to set the org.kie.server.controller system property) |
| |
|
| — |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| — |
| |
|
| Use https for the KIE_SERVER_HOST when it is not explicit configured to a custom value. |
| |
|
| KIE server username (Sets the org.kie.server.user system property) |
| |
|
| KIE server password (Sets the org.kie.server.pwd system property) |
| |
|
| KIE Server Container deployment configuration in format: containerId=groupId:artifactId:version|c2=g2:a2:v2 |
| |
|
| — | RHPAMCENTR,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. |
| |
|
| The service name for the optional smart router, where it can be reached, to allow smart routing |
| |
|
| The host name of the smart router, which could be the service name resolved by OpenShift or a globally resolvable domain name |
| |
|
| Port in which the smart router server listens (router property org.kie.server.router.port) |
| |
|
| KIE server router protocol (Used to build the org.kie.server.router.url.external property) |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable |
| |
|
| When set to LocalContainersStartupStrategy, allows KIE server to start up and function with local config, even when a controller is configured and unavailable. |
| |
|
| KIE server persistence datasource (Sets the org.kie.server.persistence.ds system property) |
| |
|
| — |
| |
|
| — |
| |
|
| — | postgresql | |
|
| — |
| |
|
| — |
| |
|
| — |
| |
|
| — | 5432 | |
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — | org.hibernate.dialect.PostgreSQLDialect | |
|
| — | true | |
|
| — |
| |
|
| Sets refresh-interval for the EJB timer database data-store service. |
| |
|
| — |
| |
|
| The name of the keystore file within the secret |
| |
|
| The name associated with the server certificate |
| |
|
| The password for the keystore and certificate |
| |
|
| — | openshift.DNS_PING | |
|
| — |
| |
|
| — | 8888 | |
|
| RH-SSO URL |
| |
|
| — | ROOT.war | |
|
| RH-SSO Realm name |
| |
|
| KIE Server RH-SSO Client Secret |
| |
|
| KIE Server RH-SSO Client name |
| |
|
| RH-SSO Realm Admin Username used to create the Client if it doesn’t exist |
| |
|
| RH-SSO Realm Admin Password used to create the Client |
| |
|
| RH-SSO Disable SSL Certificate Validation |
| |
|
| RH-SSO Principal Attribute to use as username. |
| |
|
| Custom hostname for http service route, if set will also configure the KIE_SERVER_HOST. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-kieserver-<project>.<default-domain-suffix> |
| |
|
| LDAP Endpoint to connect for authentication |
| |
|
| Bind DN used for authentication |
| |
|
| LDAP Credentials used for authentication |
| |
|
| The JMX ObjectName of the JaasSecurityDomain used to decrypt the password. |
| |
|
| LDAP Base DN of the top-level context to begin the user search. |
| |
|
| LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}). |
| |
|
| The search scope to use. |
| |
|
| The timeout in milliseconds for user or role searches. |
| |
|
| The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used. |
| |
|
| A flag indicating if the DN is to be parsed for the username. If set to true, the DN is parsed for the username. If set to false the DN is not parsed for the username. This option is used together with usernameBeginString and usernameEndString. |
| |
|
| Defines the String which is to be removed from the start of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Defines the String which is to be removed from the end of the DN to reveal the username. This option is used together with usernameEndString and only taken into account if parseUsername is set to true. |
| |
|
| Name of the attribute containing the user roles. |
| |
|
| The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is. |
| |
|
| A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}). |
| |
|
| The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0. |
| |
|
| A role included for all authenticated users |
| |
|
| Name of the attribute within the roleCtxDN context which contains the role name. If the roleAttributeIsDN property is set to true, this property is used to find the role object’s name attribute. |
| |
|
| A flag indicating if the DN returned by a query contains the roleNameAttributeID. If set to true, the DN is checked for the roleNameAttributeID. If set to false, the DN is not checked for the roleNameAttributeID. This flag can improve the performance of LDAP queries. |
| |
|
| Whether or not the roleAttributeID contains the fully-qualified DN of a role object. If false, the role name is taken from the value of the roleNameAttributeId attribute of the context name. Certain directory schemas, such as Microsoft Active Directory, require this attribute to be set to true. |
| |
|
| If you are not using referrals, this option can be ignored. When using referrals, this option denotes the attribute name which contains users defined for a certain role, for example member, if the role object is inside the referral. Users are checked against the content of this attribute name. If this option is not set, the check will always fail, so role objects cannot be stored in a referral tree. |
| |
|
|
| KIE server PostgreSQL database username |
|
|
| — |
| |
|
| — |
| |
|
| Allows the PostgreSQL to handle XA transactions. |
|
4.5.2.3.3.7. Volumes 复制链接链接已复制到粘贴板!
| Deployment | Name | mountPath | Purpose | readOnly |
|---|---|---|---|---|
|
| kieserver-keystore-volume |
| ssl certs | True |
|
|
|
| postgresql | false |
4.5.2.4. External Dependencies 复制链接链接已复制到粘贴板!
4.5.2.4.1. Volume Claims 复制链接链接已复制到粘贴板!
A PersistentVolume object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator by creating PersistentVolume objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. Refer to the Openshift documentation for more information.
| Name | Access Mode |
|---|---|
|
| ReadWriteOnce |
4.5.2.4.2. Secrets 复制链接链接已复制到粘贴板!
This template requires the following secrets to be installed for the application to run.
kieserver-app-secret
4.6. OpenShift usage quick reference 复制链接链接已复制到粘贴板!
To deploy, monitor, manage, and undeploy Red Hat Process Automation Manager templates on Red Hat OpenShift Container Platform, you can use the OpenShift Web console or the oc command.
For instructions about using the Web console, see Create and build an image using the Web console.
For detailed instructions about using the oc command, see CLI Reference. The following commands are likely to be required:
To create a project, use the following command:
$ oc new-project <project-name>For more information, see Creating a project using the CLI.
To deploy a template (create an application from a template), use the following command:
$ oc new-app -f <template-name> -p <parameter>=<value> -p <parameter>=<value> ...For more information, see Creating an application using the CLI.
To view a list of the active pods in the project, use the following command:
$ oc get 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 run the following command:$ oc logs -f dc/<deployment-config-name>For more information, see Viewing deployment logs.
To view build logs, look up a
BuildConfigname in the template reference and run the command:$ oc logs -f bc/<build-config-name>For more information, see Accessing build logs.
To scale a pod in the application, look up a
DeploymentConfigname in the template reference and run the command:$ oc scale dc/<deployment-config-name> --replicas=<number>For more information, see Manual scaling.
To undeploy the application, you can delete the project by using the command:
$ oc delete project <project-name>Alternatively, you can use the
oc deletecommand to remove any part of the application, such as a pod or replication controller. For details, see Application modification CLI operation.