rhdm713-authoring-ha.adoc

rhdm713-authoring-ha

Application template for a HA persistent authoring environment, for Red Hat Decision Manager 7.13 - Deprecated

Table of Contents

• Parameters
• Objects
  • Services
  • Routes
  • Deployment Configurations
    • Triggers
    • Replicas
    • Pod Template
      • Service Accounts
      • Image
      • Readiness Probe
      • Liveness Probe
      • Exposed Ports
      • Image Environment Variables
      • Volumes
  • External Dependencies
    • Volume Claims
    • Secrets
    • Clustering

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
APPLICATION_NAME	—	The name for the application.	myapp	True
CREDENTIALS_SECRET	—	Secret containing the KIE_ADMIN_USER and KIE_ADMIN_PWD values.	rhpam-credentials	True
KIE_SERVER_CONTROLLER_TOKEN	KIE_SERVER_CONTROLLER_TOKEN	KIE Server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property)	—	False
KIE_SERVER_BYPASS_AUTH_USER	KIE_SERVER_BYPASS_AUTH_USER	Allows the KIE Server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property)	false	False
KIE_SERVER_MODE	KIE_SERVER_MODE	The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE Server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property).	DEVELOPMENT	False
KIE_MBEANS	KIE_MBEANS	KIE Server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties)	enabled	False
DROOLS_SERVER_FILTER_CLASSES	DROOLS_SERVER_FILTER_CLASSES	KIE Server class filtering. (Sets the org.drools.server.filter.classes system property)	true	False
PROMETHEUS_SERVER_EXT_DISABLED	PROMETHEUS_SERVER_EXT_DISABLED	If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property)	false	False
DECISION_CENTRAL_HOSTNAME_HTTP	HOSTNAME_HTTP	Custom hostname for http service route for Decision Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhdmcentr-<project>.<default-domain-suffix>	—	False
DECISION_CENTRAL_HOSTNAME_HTTPS	HOSTNAME_HTTPS	Custom hostname for https service route for Decision Central. Leave blank for default hostname, e.g.: <application-name>-rhdmcentr-<project>.<default-domain-suffix>	—	False
KIE_SERVER_HOSTNAME_HTTP	HOSTNAME_HTTP	Custom hostname for http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix>	—	False
KIE_SERVER_HOSTNAME_HTTPS	HOSTNAME_HTTPS	Custom hostname for https service route for KIE Server. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix>	—	False
DECISION_CENTRAL_HTTPS_SECRET	—	The name of the secret containing the keystore file for Decision Central.	decisioncentral-app-secret	True
DECISION_CENTRAL_HTTPS_KEYSTORE	HTTPS_KEYSTORE	The name of the keystore file within the secret for Decision Central.	keystore.jks	False
DECISION_CENTRAL_HTTPS_NAME	HTTPS_NAME	The name associated with the server certificate for Decision Central.	jboss	False
DECISION_CENTRAL_HTTPS_PASSWORD	HTTPS_PASSWORD	The password for the keystore and certificate for Decision Central.	mykeystorepass	False
KIE_SERVER_HTTPS_SECRET	—	The name of the secret containing the keystore file for KIE Server.	kieserver-app-secret	True
KIE_SERVER_HTTPS_KEYSTORE	HTTPS_KEYSTORE	The name of the keystore file within the secret for KIE Server.	keystore.jks	False
KIE_SERVER_HTTPS_NAME	HTTPS_NAME	The name associated with the server certificate for KIE Server.	jboss	False
KIE_SERVER_HTTPS_PASSWORD	HTTPS_PASSWORD	The password for the keystore and certificate for KIE Server.	mykeystorepass	False
APPFORMER_JMS_BROKER_USER	APPFORMER_JMS_BROKER_USER	The user name to connect to the JMS broker.	jmsBrokerUser	True
APPFORMER_JMS_BROKER_PASSWORD	APPFORMER_JMS_BROKER_PASSWORD	The password to connect to the JMS broker.	—	True
DATAGRID_IMAGE	—	DataGrid image.	registry.redhat.io/datagrid/datagrid-8-rhel8:1.2	True
DATAGRID_CPU_LIMIT	—	DataGrid Container CPU limit.	1000m	True
DATAGRID_MEMORY_LIMIT	—	DataGrid Container memory limit.	2Gi	True
DATAGRID_VOLUME_CAPACITY	—	Size of the persistent storage for DataGrid’s runtime data.	1Gi	True
AMQ_BROKER_IMAGE	—	AMQ Broker Image	registry.redhat.io/amq7/amq-broker:7.8	True
AMQ_ROLE	—	User role for standard broker user.	admin	True
AMQ_NAME	—	The name of the broker.	broker	True
AMQ_GLOBAL_MAX_SIZE	—	Specifies the maximum amount of memory that message data can consume. If no value is specified, half of the system’s memory is allocated.	10 gb	False
AMQ_VOLUME_CAPACITY	—	Size of persistent storage for AMQ broker volume.	1Gi	True
AMQ_REPLICAS	—	Number of broker replicas for a cluster	2	True
DECISION_CENTRAL_CONTAINER_REPLICAS	—	Decision Central Container Replicas, defines how many Decision Central containers will be started.	2	True
KIE_SERVER_CONTAINER_REPLICAS	—	KIE Server Container Replicas, defines how many KIE Server containers will be started.	2	True
KIE_SERVER_CONTROLLER_OPENSHIFT_GLOBAL_DISCOVERY_ENABLED	KIE_SERVER_CONTROLLER_OPENSHIFT_GLOBAL_DISCOVERY_ENABLED	If set to true, turns on KIE Server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property)	false	False
KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE	KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE	If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property)	true	False
KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL	KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL	KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property)	60000	False
IMAGE_STREAM_NAMESPACE	—	Namespace in which the ImageStreams for Red Hat Decision Manager images are installed. These ImageStreams are normally installed in the openshift namespace. You need to modify this parameter only if you installed the ImageStreams in a different namespace/project.	openshift	True
DECISION_CENTRAL_IMAGE_STREAM_NAME	—	The name of the image stream to use for Decision Central. Default is "rhdm-decisioncentral-rhel8".	rhdm-decisioncentral-rhel8	True
KIE_SERVER_IMAGE_STREAM_NAME	—	The name of the image stream to use for KIE Server. Default is "rhdm-kieserver-rhel8".	rhdm-kieserver-rhel8	True
IMAGE_STREAM_TAG	—	A named pointer to an image in an image stream. Default is "7.13.0".	7.13.0	True
MAVEN_MIRROR_URL	MAVEN_MIRROR_URL	Maven mirror that Decision Central and KIE Server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services.	—	False
MAVEN_MIRROR_OF	MAVEN_MIRROR_OF	Maven mirror configuration for KIE Server.	external:*,!repo-rhdmcentr	False
MAVEN_REPO_ID	MAVEN_REPO_ID	The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhdmcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF.	repo-custom	False
MAVEN_REPO_URL	MAVEN_REPO_URL	Fully qualified URL to a Maven repository or service.	http://nexus.nexus-project.svc.cluster.local:8081/nexus/content/groups/public/	False
MAVEN_REPO_USERNAME	MAVEN_REPO_USERNAME	User name for accessing the Maven repository, if required.	—	False
MAVEN_REPO_PASSWORD	MAVEN_REPO_PASSWORD	Password to access the Maven repository, if required.	—	False
GIT_HOOKS_DIR	GIT_HOOKS_DIR	The directory to use for git hooks, if required.	/opt/kie/data/git/hooks	False
DECISION_CENTRAL_VOLUME_CAPACITY	—	Size of the persistent storage for Decision Central’s runtime data.	1Gi	True
DECISION_CENTRAL_JAVA_MAX_MEM_RATIO	JAVA_MAX_MEM_RATIO	Decision Central Container JVM max memory ratio. -Xmx is set to a ratio of the memory available on the container. The default is 80, which means the upper boundary is 80% of the available memory. To skip adding the -Xmx option, set this value to 0.	80	True
DECISION_CENTRAL_MEMORY_LIMIT	—	Decision Central Container memory limit.	4Gi	True
DECISION_CENTRAL_CPU_LIMIT	—	Decision Central Container CPU limit.	2	True
DECISION_CENTRAL_MEMORY_REQUEST	—	Decision Central Container memory request.	3Gi	True
DECISION_CENTRAL_CPU_REQUEST	—	Decision Central Container CPU request.	1500m	True
KIE_SERVER_MEMORY_LIMIT	—	KIE Server Container memory limit.	2Gi	True
KIE_SERVER_MEMORY_REQUEST	—	KIE Server Container memory Request.	1536Mi	True
KIE_SERVER_CPU_LIMIT	—	KIE Server Container CPU limit.	1	True
KIE_SERVER_CPU_REQUEST	—	KIE Server Container CPU Request.	750m	True
SSO_URL	SSO_URL	RH-SSO URL.	https://rh-sso.example.com/auth	False
SSO_REALM	SSO_REALM	RH-SSO Realm name.	—	False
DECISION_CENTRAL_SSO_CLIENT	SSO_CLIENT	Decision Central RH-SSO Client name.	—	False
DECISION_CENTRAL_SSO_SECRET	SSO_SECRET	Decision Central RH-SSO Client Secret.	252793ed-7118-4ca8-8dab-5622fa97d892	False
KIE_SERVER_SSO_CLIENT	SSO_CLIENT	KIE Server RH-SSO Client name.	—	False
KIE_SERVER_SSO_SECRET	SSO_SECRET	KIE Server RH-SSO Client Secret.	252793ed-7118-4ca8-8dab-5622fa97d892	False
SSO_USERNAME	SSO_USERNAME	RH-SSO Realm admin user name used to create the Client if it doesn’t exist.	—	False
SSO_PASSWORD	SSO_PASSWORD	RH-SSO Realm Admin Password used to create the Client.	—	False
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION	SSO_DISABLE_SSL_CERTIFICATE_VALIDATION	RH-SSO Disable SSL Certificate Validation.	false	False
SSO_PRINCIPAL_ATTRIBUTE	SSO_PRINCIPAL_ATTRIBUTE	RH-SSO Principal Attribute to use as user name.	preferred_username	False
AUTH_LDAP_URL	AUTH_LDAP_URL	LDAP endpoint to connect for authentication. For failover, set two or more LDAP endpoints separated by space.	ldap://myldap.example.com:389	False
AUTH_LDAP_LOGIN_MODULE	AUTH_LDAP_LOGIN_MODULE	LDAP login module flag, adds backward compatibility with the legacy security subsystem on Elytron. 'optional' is the only supported value, if set, it will create a distributed realm on Elytron configuration with LDAP and FileSystem realms with the user added using the KIE_ADMIN_USER.	optional	False
AUTH_LDAP_LOGIN_FAILOVER	AUTH_LDAP_LOGIN_FAILOVER	Enable failover, if LDAP Url is unreachable, it will fail over to the KieFsRealm.	true	False
AUTH_LDAP_BIND_DN	AUTH_LDAP_BIND_DN	Bind DN used for authentication.	uid=admin,ou=users,ou=example,ou=com	False
AUTH_LDAP_BIND_CREDENTIAL	AUTH_LDAP_BIND_CREDENTIAL	LDAP Credentials used for authentication.	Password	False
AUTH_LDAP_BASE_CTX_DN	AUTH_LDAP_BASE_CTX_DN	LDAP Base DN of the top-level context to begin the user search.	ou=users,ou=example,ou=com	False
AUTH_LDAP_BASE_FILTER	AUTH_LDAP_BASE_FILTER	LDAP search filter used to locate the context of the user to authenticate. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. A common example for the search filter is (uid={0}).	(uid={0})	False
AUTH_LDAP_RECURSIVE_SEARCH	AUTH_LDAP_RECURSIVE_SEARCH	Indicates if the user queries are recursive.	true	False
AUTH_LDAP_SEARCH_TIME_LIMIT	AUTH_LDAP_SEARCH_TIME_LIMIT	The timeout in milliseconds for user or role searches.	10000	False
AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE	AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE	The name of the attribute in the user entry that contains the DN of the user. This may be necessary if the DN of the user itself contains special characters, backslash for example, that prevent correct user mapping. If the attribute does not exist, the entry’s DN is used.	distinguishedName	False
AUTH_LDAP_ROLE_ATTRIBUTE_ID	AUTH_LDAP_ROLE_ATTRIBUTE_ID	Name of the attribute containing the user roles.	memberOf	False
AUTH_LDAP_ROLES_CTX_DN	AUTH_LDAP_ROLES_CTX_DN	The fixed DN of the context to search for user roles. This is not the DN where the actual roles are, but the DN where the objects containing the user roles are. For example, in a Microsoft Active Directory server, this is the DN where the user account is.	ou=groups,ou=example,ou=com	False
AUTH_LDAP_ROLE_FILTER	AUTH_LDAP_ROLE_FILTER	A search filter used to locate the roles associated with the authenticated user. The input username or userDN obtained from the login module callback is substituted into the filter anywhere a {0} expression is used. The authenticated userDN is substituted into the filter anywhere a {1} is used. An example search filter that matches on the input username is (member={0}). An alternative that matches on the authenticated userDN is (member={1}).	(memberOf={1})	False
AUTH_LDAP_ROLE_RECURSION	AUTH_LDAP_ROLE_RECURSION	The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0.	1	False
AUTH_LDAP_DEFAULT_ROLE	AUTH_LDAP_DEFAULT_ROLE	A role included for all authenticated users	user	False
AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES	AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES	Provide new identities for LDAP identity mapping, the pattern to be used with this env is 'attribute_name=attribute_value;another_attribute_name=value'	sn=BlankSurname;cn=BlankCommonName	False
AUTH_LDAP_REFERRAL_MODE	AUTH_LDAP_REFERRAL_MODE	If LDAP referrals should be followed. Corresponds to REFERRAL ('java.naming.referral') environment property. Allowed values: 'ignore', 'follow', 'throw'	—	False
AUTH_ROLE_MAPPER_ROLES_PROPERTIES	AUTH_ROLE_MAPPER_ROLES_PROPERTIES	When present, the RoleMapping will be configured to use the provided properties file or roles. This parameter defines the fully-qualified file path and name of a properties file or a set of roles with the following pattern 'role=role1;another-role=role2'. The format of every entry in the file is original_role=role1,role2,role3	role=role1,role3,role4;role7=role,admin	False
AUTH_LDAP_MAPPER_KEEP_MAPPED	AUTH_LDAP_MAPPER_KEEP_MAPPED	When set to 'true' the mapped roles will retain all roles, that have defined mappings. Defaults to false.	—	False
AUTH_LDAP_MAPPER_KEEP_NON_MAPPED	AUTH_LDAP_MAPPER_KEEP_NON_MAPPED	When set to 'true' the mapped roles will retain all roles, that have no defined mappings. Defaults to false.	—	False
APPFORMER_INFINISPAN_USERNAME	APPFORMER_INFINISPAN_USERNAME	Username used for the Datagrid.	user	True
APPFORMER_INFINISPAN_PASSWORD	APPFORMER_INFINISPAN_PASSWORD	Password used for the Datagrid.	pass	True

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.

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
${APPLICATION_NAME}-rhdmcentr	8080	http	All the Decision Central web server’s ports.
	8443	https
${APPLICATION_NAME}-datagrid-ping	8888	ping	Provides a ping service for clustered applications.
${APPLICATION_NAME}-datagrid	11222	hotrod	Provides a service for accessing the application over Hot Rod protocol.
${APPLICATION_NAME}-kieserver	8080	http	All the KIE Server web server’s ports.
	8443	https
${APPLICATION_NAME}-amq-tcp	61616	—	The broker’s OpenWire port.
ping	8888	—	The JGroups ping port for amq clustering.

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
insecure-${APPLICATION_NAME}-rhdmcentr-http	none	${DECISION_CENTRAL_HOSTNAME_HTTP}
${APPLICATION_NAME}-rhdmcentr-https	TLS passthrough	${DECISION_CENTRAL_HOSTNAME_HTTPS}
insecure-${APPLICATION_NAME}-kieserver-http	none	${KIE_SERVER_HOSTNAME_HTTP}
${APPLICATION_NAME}-kieserver-https	TLS passthrough	${KIE_SERVER_HOSTNAME_HTTPS}

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.

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
${APPLICATION_NAME}-rhdmcentr	ImageChange
${APPLICATION_NAME}-kieserver	ImageChange

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
${APPLICATION_NAME}-rhdmcentr	2
${APPLICATION_NAME}-kieserver	2

Pod Template

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
${APPLICATION_NAME}-rhdmcentr	${APPLICATION_NAME}-rhdmsvc
${APPLICATION_NAME}-kieserver	${APPLICATION_NAME}-rhdmsvc

Image

Deployment	Image
${APPLICATION_NAME}-rhdmcentr	${DECISION_CENTRAL_IMAGE_STREAM_NAME}
${APPLICATION_NAME}-kieserver	${KIE_SERVER_IMAGE_STREAM_NAME}

Readiness Probe

${APPLICATION_NAME}-rhdmcentr

Http Get on http://localhost:8080/rest/ready

${APPLICATION_NAME}-kieserver

Http Get on http://localhost:8080/services/rest/server/readycheck

Liveness Probe

${APPLICATION_NAME}-rhdmcentr

Http Get on http://localhost:8080/rest/healthy

${APPLICATION_NAME}-kieserver

Http Get on http://localhost:8080/services/rest/server/healthcheck

Exposed Ports

Deployments	Name	Port	Protocol
${APPLICATION_NAME}-rhdmcentr	jolokia	8778	TCP
	http	8080	TCP
	https	8443	TCP
${APPLICATION_NAME}-kieserver	jolokia	8778	TCP
	http	8080	TCP
	https	8443	TCP

Image Environment Variables

Deployment	Variable name	Description	Example value
${APPLICATION_NAME}-rhdmcentr	APPLICATION_USERS_PROPERTIES	—	/opt/kie/data/configuration/application-users.properties
	APPLICATION_ROLES_PROPERTIES	—	/opt/kie/data/configuration/application-roles.properties
	KIE_ADMIN_USER	—	—
	KIE_ADMIN_PWD	—	—
	KIE_MBEANS	KIE Server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties)	${KIE_MBEANS}
	KIE_SERVER_CONTROLLER_OPENSHIFT_ENABLED	—	true
	KIE_SERVER_CONTROLLER_OPENSHIFT_GLOBAL_DISCOVERY_ENABLED	If set to true, turns on KIE Server global discovery feature (Sets the org.kie.server.controller.openshift.global.discovery.enabled system property)	${KIE_SERVER_CONTROLLER_OPENSHIFT_GLOBAL_DISCOVERY_ENABLED}
	KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE	If OpenShift integration of Business Central is turned on, setting this parameter to true enables connection to KIE Server via an OpenShift internal Service endpoint. (Sets the org.kie.server.controller.openshift.prefer.kieserver.service system property)	${KIE_SERVER_CONTROLLER_OPENSHIFT_PREFER_KIESERVER_SERVICE}
	KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL	KIE ServerTemplate Cache TTL in milliseconds. (Sets the org.kie.server.controller.template.cache.ttl system property)	${KIE_SERVER_CONTROLLER_TEMPLATE_CACHE_TTL}
	KIE_SERVER_CONTROLLER_TOKEN	KIE Server controller token for bearer authentication. (Sets the org.kie.server.controller.token system property)	${KIE_SERVER_CONTROLLER_TOKEN}
	WORKBENCH_ROUTE_NAME	—	${APPLICATION_NAME}-rhdmcentr
	MAVEN_MIRROR_URL	Maven mirror that Decision Central and KIE Server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services.	${MAVEN_MIRROR_URL}
	MAVEN_REPO_ID	The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhdmcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF.	${MAVEN_REPO_ID}
	MAVEN_REPO_URL	Fully qualified URL to a Maven repository or service.	${MAVEN_REPO_URL}
	MAVEN_REPO_USERNAME	User name for accessing the Maven repository, if required.	${MAVEN_REPO_USERNAME}
	MAVEN_REPO_PASSWORD	Password to access the Maven repository, if required.	${MAVEN_REPO_PASSWORD}
	GIT_HOOKS_DIR	The directory to use for git hooks, if required.	${GIT_HOOKS_DIR}
	HTTPS_KEYSTORE_DIR	—	/etc/decisioncentral-secret-volume
	HTTPS_KEYSTORE	The name of the keystore file within the secret for Decision Central.	${DECISION_CENTRAL_HTTPS_KEYSTORE}
	HTTPS_NAME	The name associated with the server certificate for Decision Central.	${DECISION_CENTRAL_HTTPS_NAME}
	HTTPS_PASSWORD	The password for the keystore and certificate for Decision Central.	${DECISION_CENTRAL_HTTPS_PASSWORD}
	JGROUPS_PING_PROTOCOL	—	kubernetes.KUBE_PING
	KUBERNETES_NAMESPACE	—	—
	KUBERNETES_LABELS	—	cluster=jgrp.k8s.${APPLICATION_NAME}.rhdmcentr
	APPFORMER_INFINISPAN_SERVICE_NAME	—	${APPLICATION_NAME}-datagrid
	APPFORMER_INFINISPAN_PORT	—	11222
	APPFORMER_INFINISPAN_USERNAME	Username used for the Datagrid.	${APPFORMER_INFINISPAN_USERNAME}
	APPFORMER_INFINISPAN_PASSWORD	Password used for the Datagrid.	${APPFORMER_INFINISPAN_PASSWORD}
	APPFORMER_INFINISPAN_SASL_QOP	—	auth
	APPFORMER_INFINISPAN_SERVER_NAME	—	infinispan
	APPFORMER_INFINISPAN_REALM	—	default
	APPFORMER_JMS_BROKER_ADDRESS	—	${APPLICATION_NAME}-amq-tcp
	APPFORMER_JMS_BROKER_PORT	—	61616
	APPFORMER_JMS_BROKER_USER	The user name to connect to the JMS broker.	${APPFORMER_JMS_BROKER_USER}
	APPFORMER_JMS_BROKER_PASSWORD	The password to connect to the JMS broker.	${APPFORMER_JMS_BROKER_PASSWORD}
	JAVA_MAX_MEM_RATIO	Decision Central Container JVM max memory ratio. -Xmx is set to a ratio of the memory available on the container. The default is 80, which means the upper boundary is 80% of the available memory. To skip adding the -Xmx option, set this value to 0.	${DECISION_CENTRAL_JAVA_MAX_MEM_RATIO}
	SSO_URL	RH-SSO URL.	${SSO_URL}
	SSO_OPENIDCONNECT_DEPLOYMENTS	—	ROOT.war
	SSO_REALM	RH-SSO Realm name.	${SSO_REALM}
	SSO_SECRET	Decision Central RH-SSO Client Secret.	${DECISION_CENTRAL_SSO_SECRET}
	SSO_CLIENT	Decision Central RH-SSO Client name.	${DECISION_CENTRAL_SSO_CLIENT}
	SSO_USERNAME	RH-SSO Realm admin user name used to create the Client if it doesn’t exist.	${SSO_USERNAME}
	SSO_PASSWORD	RH-SSO Realm Admin Password used to create the Client.	${SSO_PASSWORD}
	SSO_DISABLE_SSL_CERTIFICATE_VALIDATION	RH-SSO Disable SSL Certificate Validation.	${SSO_DISABLE_SSL_CERTIFICATE_VALIDATION}
	SSO_PRINCIPAL_ATTRIBUTE	RH-SSO Principal Attribute to use as user name.	${SSO_PRINCIPAL_ATTRIBUTE}
	HOSTNAME_HTTP	Custom hostname for http service route for Decision Central. Leave blank for default hostname, e.g.: insecure-<application-name>-rhdmcentr-<project>.<default-domain-suffix>	${DECISION_CENTRAL_HOSTNAME_HTTP}
	HOSTNAME_HTTPS	Custom hostname for https service route for Decision Central. Leave blank for default hostname, e.g.: <application-name>-rhdmcentr-<project>.<default-domain-suffix>	${DECISION_CENTRAL_HOSTNAME_HTTPS}
	AUTH_LDAP_URL	LDAP endpoint to connect for authentication. For failover, set two or more LDAP endpoints separated by space.	${AUTH_LDAP_URL}
	AUTH_LDAP_LOGIN_MODULE	LDAP login module flag, adds backward compatibility with the legacy security subsystem on Elytron. 'optional' is the only supported value, if set, it will create a distributed realm on Elytron configuration with LDAP and FileSystem realms with the user added using the KIE_ADMIN_USER.	${AUTH_LDAP_LOGIN_MODULE}
	AUTH_LDAP_LOGIN_FAILOVER	Enable failover, if LDAP Url is unreachable, it will fail over to the KieFsRealm.	${AUTH_LDAP_LOGIN_FAILOVER}
	AUTH_LDAP_BIND_DN	Bind DN used for authentication.	${AUTH_LDAP_BIND_DN}
	AUTH_LDAP_BIND_CREDENTIAL	LDAP Credentials used for authentication.	${AUTH_LDAP_BIND_CREDENTIAL}
	AUTH_LDAP_BASE_CTX_DN	LDAP Base DN of the top-level context to begin the user search.	${AUTH_LDAP_BASE_CTX_DN}
	AUTH_LDAP_BASE_FILTER	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}).	${AUTH_LDAP_BASE_FILTER}
	AUTH_LDAP_RECURSIVE_SEARCH	Indicates if the user queries are recursive.	${AUTH_LDAP_RECURSIVE_SEARCH}
	AUTH_LDAP_SEARCH_TIME_LIMIT	The timeout in milliseconds for user or role searches.	${AUTH_LDAP_SEARCH_TIME_LIMIT}
	AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE	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.	${AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE}
	AUTH_LDAP_ROLE_ATTRIBUTE_ID	Name of the attribute containing the user roles.	${AUTH_LDAP_ROLE_ATTRIBUTE_ID}
	AUTH_LDAP_ROLES_CTX_DN	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.	${AUTH_LDAP_ROLES_CTX_DN}
	AUTH_LDAP_ROLE_FILTER	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}).	${AUTH_LDAP_ROLE_FILTER}
	AUTH_LDAP_ROLE_RECURSION	The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0.	${AUTH_LDAP_ROLE_RECURSION}
	AUTH_LDAP_DEFAULT_ROLE	A role included for all authenticated users	${AUTH_LDAP_DEFAULT_ROLE}
	AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES	Provide new identities for LDAP identity mapping, the pattern to be used with this env is 'attribute_name=attribute_value;another_attribute_name=value'	${AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES}
	AUTH_LDAP_REFERRAL_MODE	If LDAP referrals should be followed. Corresponds to REFERRAL ('java.naming.referral') environment property. Allowed values: 'ignore', 'follow', 'throw'	${AUTH_LDAP_REFERRAL_MODE}
AUTH_ROLE_MAPPER_ROLES_PROPERTIES	When present, the RoleMapping will be configured to use the provided properties file or roles. This parameter defines the fully-qualified file path and name of a properties file or a set of roles with the following pattern 'role=role1;another-role=role2'. The format of every entry in the file is original_role=role1,role2,role3	${AUTH_ROLE_MAPPER_ROLES_PROPERTIES}
AUTH_LDAP_MAPPER_KEEP_MAPPED	When set to 'true' the mapped roles will retain all roles, that have defined mappings. Defaults to false.	${AUTH_LDAP_MAPPER_KEEP_MAPPED}
AUTH_LDAP_MAPPER_KEEP_NON_MAPPED	When set to 'true' the mapped roles will retain all roles, that have no defined mappings. Defaults to false.	${AUTH_LDAP_MAPPER_KEEP_NON_MAPPED}
${APPLICATION_NAME}-kieserver	WORKBENCH_SERVICE_NAME	—	${APPLICATION_NAME}-rhdmcentr
	KIE_ADMIN_USER	—	—
	KIE_ADMIN_PWD	—	—
	KIE_SERVER_MODE	The KIE Server mode. Valid values are 'DEVELOPMENT' or 'PRODUCTION'. In production mode, you can not deploy SNAPSHOT versions of artifacts on the KIE Server and can not change the version of an artifact in an existing container. (Sets the org.kie.server.mode system property).	${KIE_SERVER_MODE}
	KIE_MBEANS	KIE Server mbeans enabled/disabled. (Sets the kie.mbeans and kie.scanner.mbeans system properties)	${KIE_MBEANS}
	DROOLS_SERVER_FILTER_CLASSES	KIE Server class filtering. (Sets the org.drools.server.filter.classes system property)	${DROOLS_SERVER_FILTER_CLASSES}
	PROMETHEUS_SERVER_EXT_DISABLED	If set to false, the prometheus server extension will be enabled. (Sets the org.kie.prometheus.server.ext.disabled system property)	${PROMETHEUS_SERVER_EXT_DISABLED}
	KIE_SERVER_BYPASS_AUTH_USER	Allows the KIE Server to bypass the authenticated user for task-related operations, for example, queries. (Sets the org.kie.server.bypass.auth.user system property)	${KIE_SERVER_BYPASS_AUTH_USER}
	KIE_SERVER_CONTROLLER_SERVICE	—	${APPLICATION_NAME}-rhdmcentr
	KIE_SERVER_CONTROLLER_PROTOCOL	—	ws
	KIE_SERVER_ID	—	—
	KIE_SERVER_ROUTE_NAME	—	insecure-${APPLICATION_NAME}-kieserver
	KIE_SERVER_STARTUP_STRATEGY	—	OpenShiftStartupStrategy
	MAVEN_MIRROR_URL	Maven mirror that Decision Central and KIE Server must use. If you configure a mirror, this mirror must contain all artifacts that are required for building and deploying your services.	${MAVEN_MIRROR_URL}
	MAVEN_MIRROR_OF	Maven mirror configuration for KIE Server.	${MAVEN_MIRROR_OF}
	MAVEN_REPOS	—	RHDMCENTR,EXTERNAL
	RHDMCENTR_MAVEN_REPO_ID	—	repo-rhdmcentr
	RHDMCENTR_MAVEN_REPO_SERVICE	—	${APPLICATION_NAME}-rhdmcentr
	RHDMCENTR_MAVEN_REPO_PATH	—	/maven2/
	RHDMCENTR_MAVEN_REPO_USERNAME	—	—
	RHDMCENTR_MAVEN_REPO_PASSWORD	—	—
	EXTERNAL_MAVEN_REPO_ID	The id to use for the maven repository. If set, it can be excluded from the optionally configured mirror by adding it to MAVEN_MIRROR_OF. For example: external:*,!repo-rhdmcentr,!repo-custom. If MAVEN_MIRROR_URL is set but MAVEN_MIRROR_ID is not set, an id will be generated randomly, but won’t be usable in MAVEN_MIRROR_OF.	${MAVEN_REPO_ID}
	EXTERNAL_MAVEN_REPO_URL	Fully qualified URL to a Maven repository or service.	${MAVEN_REPO_URL}
	EXTERNAL_MAVEN_REPO_USERNAME	User name for accessing the Maven repository, if required.	${MAVEN_REPO_USERNAME}
	EXTERNAL_MAVEN_REPO_PASSWORD	Password to access the Maven repository, if required.	${MAVEN_REPO_PASSWORD}
	HTTPS_KEYSTORE_DIR	—	/etc/kieserver-secret-volume
	HTTPS_KEYSTORE	The name of the keystore file within the secret for KIE Server.	${KIE_SERVER_HTTPS_KEYSTORE}
	HTTPS_NAME	The name associated with the server certificate for KIE Server.	${KIE_SERVER_HTTPS_NAME}
	HTTPS_PASSWORD	The password for the keystore and certificate for KIE Server.	${KIE_SERVER_HTTPS_PASSWORD}
	KUBERNETES_NAMESPACE	—	—
	KUBERNETES_LABELS	—	cluster=jgrp.k8s.${APPLICATION_NAME}.kieserver
	SSO_URL	RH-SSO URL.	${SSO_URL}
	SSO_OPENIDCONNECT_DEPLOYMENTS	—	ROOT.war
	SSO_REALM	RH-SSO Realm name.	${SSO_REALM}
	SSO_SECRET	KIE Server RH-SSO Client Secret.	${KIE_SERVER_SSO_SECRET}
	SSO_CLIENT	KIE Server RH-SSO Client name.	${KIE_SERVER_SSO_CLIENT}
	SSO_USERNAME	RH-SSO Realm admin user name used to create the Client if it doesn’t exist.	${SSO_USERNAME}
	SSO_PASSWORD	RH-SSO Realm Admin Password used to create the Client.	${SSO_PASSWORD}
	SSO_DISABLE_SSL_CERTIFICATE_VALIDATION	RH-SSO Disable SSL Certificate Validation.	${SSO_DISABLE_SSL_CERTIFICATE_VALIDATION}
	SSO_PRINCIPAL_ATTRIBUTE	RH-SSO Principal Attribute to use as user name.	${SSO_PRINCIPAL_ATTRIBUTE}
	HOSTNAME_HTTP	Custom hostname for http service route for KIE Server. Leave blank for default hostname, e.g.: insecure-<application-name>-kieserver-<project>.<default-domain-suffix>	${KIE_SERVER_HOSTNAME_HTTP}
	HOSTNAME_HTTPS	Custom hostname for https service route for KIE Server. Leave blank for default hostname, e.g.: <application-name>-kieserver-<project>.<default-domain-suffix>	${KIE_SERVER_HOSTNAME_HTTPS}
	AUTH_LDAP_URL	LDAP endpoint to connect for authentication. For failover, set two or more LDAP endpoints separated by space.	${AUTH_LDAP_URL}
	AUTH_LDAP_LOGIN_MODULE	LDAP login module flag, adds backward compatibility with the legacy security subsystem on Elytron. 'optional' is the only supported value, if set, it will create a distributed realm on Elytron configuration with LDAP and FileSystem realms with the user added using the KIE_ADMIN_USER.	${AUTH_LDAP_LOGIN_MODULE}
	AUTH_LDAP_LOGIN_FAILOVER	Enable failover, if LDAP Url is unreachable, it will fail over to the KieFsRealm.	${AUTH_LDAP_LOGIN_FAILOVER}
	AUTH_LDAP_BIND_DN	Bind DN used for authentication.	${AUTH_LDAP_BIND_DN}
	AUTH_LDAP_BIND_CREDENTIAL	LDAP Credentials used for authentication.	${AUTH_LDAP_BIND_CREDENTIAL}
	AUTH_LDAP_BASE_CTX_DN	LDAP Base DN of the top-level context to begin the user search.	${AUTH_LDAP_BASE_CTX_DN}
	AUTH_LDAP_BASE_FILTER	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}).	${AUTH_LDAP_BASE_FILTER}
	AUTH_LDAP_RECURSIVE_SEARCH	Indicates if the user queries are recursive.	${AUTH_LDAP_RECURSIVE_SEARCH}
	AUTH_LDAP_SEARCH_TIME_LIMIT	The timeout in milliseconds for user or role searches.	${AUTH_LDAP_SEARCH_TIME_LIMIT}
	AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE	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.	${AUTH_LDAP_DISTINGUISHED_NAME_ATTRIBUTE}
	AUTH_LDAP_ROLE_ATTRIBUTE_ID	Name of the attribute containing the user roles.	${AUTH_LDAP_ROLE_ATTRIBUTE_ID}
	AUTH_LDAP_ROLES_CTX_DN	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.	${AUTH_LDAP_ROLES_CTX_DN}
	AUTH_LDAP_ROLE_FILTER	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}).	${AUTH_LDAP_ROLE_FILTER}
	AUTH_LDAP_ROLE_RECURSION	The number of levels of recursion the role search will go below a matching context. Disable recursion by setting this to 0.	${AUTH_LDAP_ROLE_RECURSION}
	AUTH_LDAP_DEFAULT_ROLE	A role included for all authenticated users	${AUTH_LDAP_DEFAULT_ROLE}
	AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES	Provide new identities for LDAP identity mapping, the pattern to be used with this env is 'attribute_name=attribute_value;another_attribute_name=value'	${AUTH_LDAP_NEW_IDENTITY_ATTRIBUTES}
	AUTH_LDAP_REFERRAL_MODE	If LDAP referrals should be followed. Corresponds to REFERRAL ('java.naming.referral') environment property. Allowed values: 'ignore', 'follow', 'throw'	${AUTH_LDAP_REFERRAL_MODE}
	AUTH_ROLE_MAPPER_ROLES_PROPERTIES	When present, the RoleMapping will be configured to use the provided properties file or roles. This parameter defines the fully-qualified file path and name of a properties file or a set of roles with the following pattern 'role=role1;another-role=role2'. The format of every entry in the file is original_role=role1,role2,role3	${AUTH_ROLE_MAPPER_ROLES_PROPERTIES}
	AUTH_LDAP_MAPPER_KEEP_MAPPED	When set to 'true' the mapped roles will retain all roles, that have defined mappings. Defaults to false.	${AUTH_LDAP_MAPPER_KEEP_MAPPED}
	AUTH_LDAP_MAPPER_KEEP_NON_MAPPED	When set to 'true' the mapped roles will retain all roles, that have no defined mappings. Defaults to false.	${AUTH_LDAP_MAPPER_KEEP_NON_MAPPED}

Volumes

Deployment	Name	mountPath	Purpose	readOnly
${APPLICATION_NAME}-rhdmcentr	decisioncentral-keystore-volume	/etc/decisioncentral-secret-volume	ssl certs	True
${APPLICATION_NAME}-kieserver	kieserver-keystore-volume	/etc/kieserver-secret-volume	ssl certs	True

External Dependencies

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
${APPLICATION_NAME}-rhdmcentr-claim	ReadWriteMany

Secrets

This template requires the following secrets to be installed for the application to run.

• decisioncentral-app-secret

• kieserver-app-secret

Clustering

Clustering in OpenShift EAP is achieved through Kubernetes discovery mechanism. This is done by configuring the JGroups protocol stack in standalone-openshift.xml with the <kubernetes.KUBE_PING/> element. The templates are configured to use kubernetes.KUBE_PING.

The discovery mechanism used is specified by the JGROUPS_PING_PROTOCOL environment variable which can be set to kubernetes.KUBE_PING. kubernetes.KUBE_PING is the default used by the image if no value is specified for JGROUPS_PING_PROTOCOL.

For kubernetes.KUBE_PING to work, the following steps must be taken:

1. The KUBERNETES_NAMESPACE environment variable must be set using the kubernetes metadata.namespace assigned to the pod. If not set, the server will act as if it is a single-node cluster (a "cluster of one").

2. The KUBERNETES_LABELS environment variables should be set (see table above). If not set, pods outside of your application (albeit in your namespace) will try to join.

3. The value used as a KUBERNETES_LABELS must be added as a label in the respective deployment config. By convention the value is cluster=kubernetes.ping.<name>-cluster ,name used are console-cluster, consolemon-cluster, kieserver-cluster.

4. Authorization must be granted to the service account the pod is running under to be allowed to access Kubernetes' REST api. This is done on the command line.

Example 1. Policy commands

Using the default service account in the myproject namespace:

oc policy add-role-to-user view system:serviceaccount:myproject:default -n myproject

Using the eap-service-account in the myproject namespace:

oc policy add-role-to-user view system:serviceaccount:myproject:eap-service-account -n myproject