Chapter 3. Authoring environment
You can deploy an environment for creating and modifying processes using Business Central. It consists of Business Central for the authoring work and Process Server for test execution of the processes.
Depending on your needs, you can deploy either a single authoring environment or a high-availability (HA) authoring environment.
A single authoring environment contains two pods. One of the pods runs Business Central, the other runs Process Server. The Process Server includes an embedded in-memory H2 database engine. This type of environment uses the least possible amount of resources. However, because of the in-memory database, restarting the Process Server pod leads to loss of all process information.
An HA authoring environment contains several pods. Both Business Central and Process Server are provided in scalable pods that can run in parallel and share persistent storage. The database is provided by a separate pod. Use a high-availability authoring environment to provide maximum reliability and responsiveness, especially if several users are involved in authoring at the same time.
You can also deploy additional managed or immutable Process Servers, if desired. Business Central automatically discovers any Process Servers in the same namespace, including immutable Process Servers and managed Process Servers. This feature requires the OpenShiftStartupStrategy
setting, which is enabled for all Process Servers except those deployed in a fixed managed infrastructure. For instructions about deploying managed Process Servers with the OpenShiftStartupStrategy
setting enabled, see Deploying a Red Hat Process Automation Manager freeform managed server environment on Red Hat OpenShift Container Platform. For instructions about deploying immutable Process Servers, see Deploying a Red Hat Process Automation Manager immutable server environment on Red Hat OpenShift Container Platform.
In Red Hat Process Automation Manager 7.4, high-availability Business Central functionality is for Technology Preview only. For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.
3.1. Deploying an authoring environment
You can use OpenShift templates to deploy a single or high-availability authoring environment. This environment consists of Business Central and a single Process Server.
3.1.1. Starting configuration of the template for an authoring environment
If you want to deploy a single authoring environment, use the rhpam74-authoring.yaml
template file. By default, the single authoring template uses the H2 database with permanent storage. If you prefer to create a MySQL or PostgreSQL pod or to use an external database server (outside the OpenShift project), modify the template before deploying the environment. For instructions about modifying the template, see Section 3.4, “Modifying the template for the single authoring environment”.
If you want to deploy a high-availability authoring environment, use the rhpam74-authoring-ha.yaml
template file. By default, the high-availability authoring template creates a MySQL pod to provide the database server for the Process Server. If you prefer to use PostgreSQL or to use an external server (outside the OpenShift project) you need to modify the template before deploying the environment. You can also modify the template to change the number of replicas initially created for Business Central. For instructions about modifying the template, see Section 3.5, “Modifying the template for the High Availability authoring environment”.
Procedure
-
Download the
rhpam-7.4.0-openshift-templates.zip
product deliverable file from the Software Downloads page of the Red Hat Customer Portal. - Extract the required template file.
Use one of the following methods to start deploying the template:
-
To use the OpenShift Web UI, in the OpenShift application console select Add to Project → Import YAML / JSON and then select or paste the
<template-file-name>.yaml
file. In the Add Template window, ensure Process the template is selected and click Continue. To use the OpenShift command line console, prepare the following command line:
oc new-app -f <template-path>/<template-file-name>.yaml -p BUSINESS_CENTRAL_HTTPS_SECRET=businesscentral-app-secret -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret -p PARAMETER=value
In this command line, make the following changes:
-
Replace
<template-path>
with the path to the downloaded template file. -
Replace
<template-file-name>
with the name of the template file. -
Use as many
-p PARAMETER=value
pairs as needed to set the required parameters.
-
Replace
-
To use the OpenShift Web UI, in the OpenShift application console select Add to Project → Import YAML / JSON and then select or paste the
Next steps
Set the parameters for the template. Follow the steps in Section 3.1.2, “Setting required parameters for an authoring environment” to set common parameters. You can view the template file to see descriptions for all parameters.
3.1.2. Setting required parameters for an authoring environment
When configuring the template to deploy an authoring environment, you must set the following parameters in all cases.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
Set the following parameters:
-
Business Central Server Keystore Secret Name (
BUSINESS_CENTRAL_HTTPS_SECRET
): The name of the secret for Business Central, as created in Section 2.4, “Creating the secrets for Business Central”. -
KIE Server Keystore Secret Name (
KIE_SERVER_HTTPS_SECRET
): The name of the secret for Process Server, as created in Section 2.3, “Creating the secrets for Process Server”. -
Business Central Server Certificate Name (
BUSINESS_CENTRAL_HTTPS_NAME
): The name of the certificate in the keystore that you created in Section 2.4, “Creating the secrets for Business Central”. -
Business Central Server Keystore Password (
BUSINESS_CENTRAL_HTTPS_PASSWORD
): The password for the keystore that you created in Section 2.4, “Creating the secrets for Business Central”. -
KIE Server Certificate Name (
KIE_SERVER_HTTPS_NAME
): The name of the certificate in the keystore that you created in Section 2.3, “Creating the secrets for Process Server”. -
KIE Server Keystore Password (
KIE_SERVER_HTTPS_PASSWORD
): The password for the keystore that you created in Section 2.3, “Creating the secrets for Process Server”. -
Application Name (
APPLICATION_NAME
): The name of the OpenShift application. It is used in the default URLs for Business Central Monitoring and Process Server. OpenShift uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. -
ImageStream Namespace (
IMAGE_STREAM_NAMESPACE
): The namespace where the image streams are available. If the image streams were already available in your OpenShift environment (see Section 2.1, “Ensuring the availability of image streams and the image registry”), the namespace isopenshift
. If you have installed the image streams file, the namespace is the name of the OpenShift project.
-
Business Central Server Keystore Secret Name (
You can set the following user names and passwords. By default, the deployment automatically generates the passwords.
-
KIE Admin User (
KIE_ADMIN_USER
) and KIE Admin Password (KIE_ADMIN_PWD
): The user name and password for the administrative user. If you want to use the Business Central to control or monitor any Process Servers other than the Process Server deployed by the same template , you must set and record the user name and password. -
KIE Server User (
KIE_SERVER_USER
) and KIE Server Password (KIE_SERVER_PWD
): The user name and password that a client application can use to connect to any of the Process Servers.
-
KIE Admin User (
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.3. Configuring the image stream namespace for an authoring environment
If you created image streams in a namespace that is not openshift
, you must configure the namespace in the template.
If all image streams were already available in your Red Hat OpenShift Container Platform environment, you can skip this procedure.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
-
If you installed an image streams file according to instructions in Section 2.1, “Ensuring the availability of image streams and the image registry”, set the ImageStream Namespace (
IMAGE_STREAM_NAMESPACE
) parameter to the name of your OpenShift project. -
If you are deploying a high-availability authoring environment and installed an image streams file for AMQ scaledown controller image streams according to instructions in Section 2.2, “Ensuring the availability of AMQ scaledown controller image streams for a high-availability deployment”, set the AMQ Scaledown Controller ImageStream Namespace (
AMQ_SCALEDOWN_CONTROLLER_IMAGE_STREAM_NAMESPACE
) parameter to the name of your OpenShift project.
3.1.4. Setting an optional Maven repository for an authoring environment
When configuring the template to deploy an authoring environment, if you want to place the built KJAR files into an external Maven repository, you must set parameters to access the repository.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
To configure access to a custom Maven repository, set the following parameters:
-
Maven repository URL (
MAVEN_REPO_URL
): The URL for the Maven repository. -
Maven repository ID (
MAVEN_REPO_ID
): An identifier for the Maven repository. The default value isrepo-custom
. -
Maven repository username (
MAVEN_REPO_USERNAME
): The username for the Maven repository. -
Maven repository password (
MAVEN_REPO_PASSWORD
): The password for the Maven repository.
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
To export or push Business Central projects as KJAR artifacts to the external Maven repository, you must also add the repository information in the pom.xml
file for every project. For information about exporting Business Central projects to an external repository, see Packaging and deploying a Red Hat Process Automation Manager project.
3.1.5. Specifying credentials to access the built-in Maven repository for an authoring environment
When configuring the template to deploy an authoring environment, if you want to use the Maven repository that is built into Business Central and to connect additional Process Servers to the Business Central, you must configure credentials for accessing this Maven repository. You can then use these credentials to configure the Process Servers.
Also, if you are configuring RH-SSO or LDAP authentication, you must set the credentials for the built-in Maven repository to a username and password configured in RH-SSO or LDAP. This setting is required so that the Process Server can access the Maven repository.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
To configure credentials for the built-in Maven repository, set the following parameters:
-
Username for the Maven service hosted by Business Central (
BUSINESS_CENTRAL_MAVEN_USERNAME
): The user name for the built-in Maven repository. -
Password for the Maven service hosted by Business Central (
BUSINESS_CENTRAL_MAVEN_PASSWORD
): The password for the built-in Maven repository.
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.6. Configuring access to a Maven mirror in an environment without a connection to the public Internet for an authoring environment
When configuring the template to deploy an authoring environment, if your OpenShift environment does not have a connection to the public Internet, you must configure access to a Maven mirror that you set up according to Section 2.6, “Preparing a Maven mirror repository for offline use”.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
To configure access to the Maven mirror, set the following parameters:
-
Maven mirror URL (
MAVEN_MIRROR_URL
): The URL for the Maven mirror repository that you set up in Section 2.6, “Preparing a Maven mirror repository for offline use”. This URL must be accessible from a pod in your OpenShift environment. -
Maven mirror of (
MAVEN_MIRROR_OF
): The value that determines which artifacts are to be retrieved from the mirror. For instructions about setting themirrorOf
value, see Mirror Settings in the Apache Maven documentation. The default value isexternal:*,!repo-rhpamcentr
; with this value, Maven retrieves artifacts from the built-in Maven repository of Business Central directly and retrieves any other required artifacts from the mirror. If you configure an external Maven repository (MAVEN_REPO_URL
), changeMAVEN_MIRROR_OF
to exclude the artifacts in this repository, for example,external:*,!repo-custom
. Replacerepo-custom
with the ID that you configured inMAVEN_REPO_ID
.
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.7. Specifying the Git hooks directory for an authoring environment
You can use Git hooks to facilitate interaction between the internal Git repository of Business Central and an external Git repository.
If you want to use Git hooks, you must configure a Git hooks directory.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
To configure a Git hooks directory, set the following parameter:
-
Git hooks directory (
GIT_HOOKS_DIR
): The fully qualified path to a Git hooks directory, for example,/opt/kie/data/git/hooks
. You must provide the content of this directory and mount it at the specified path. For instructions about providing and mounting the Git hooks directory using a configuration map or a persistent volume, see Section 3.3, “(Optional) Providing the Git hooks directory”.
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.8. Setting parameters for RH-SSO authentication for an authoring environment
If you want to use RH-SSO authentication, complete the following additional configuration when configuring the template to deploy an authoring environment.
Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
Prerequisites
- A realm for Red Hat Process Automation Manager is created in the RH-SSO authentication system.
User names and passwords for Red Hat Process Automation Manager are created in the RH-SSO authentication system. For a list of the available roles, see Chapter 4, Red Hat Process Automation Manager roles and users. The following users are required in order to set the parameters for the environment:
-
An administrative user with the
kie-server,rest-all,admin
roles. This user can administer and use the environment. Process Servers use this user to authenticate with Business Central. -
A server user with the
kie-server,rest-all,user
roles. This user can make REST API calls to the Process Server. Business Central uses this user to authenticate with Process Servers.
-
An administrative user with the
- Clients are created in the RH-SSO authentication system for all components of the Red Hat Process Automation Manager environment that you are deploying. The client setup contains the URLs for the components. You can review and edit the URLs after deploying the environment. Alternatively, the Red Hat Process Automation Manager deployment can create the clients. However, this option provides less detailed control over the environment.
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
-
Set the
KIE_ADMIN_USER
andKIE_ADMIN_PASSWORD
parameters of the template to the user name and password of the administrative user that you created in the RH-SSO authentication system. -
Set the
KIE_SERVER_USER
andKIE_SERVER_PASSWORD
parameters of the template to the user name and password of the server user that you created in the RH-SSO authentication system. Set the following parameters:
-
RH-SSO URL (
SSO_URL
): The URL for RH-SSO. -
RH-SSO Realm name (
SSO_REALM
): The RH-SSO realm for Red Hat Process Automation Manager. -
RH-SSO Disable SSL Certificate Validation (
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION
): Set totrue
if your RH-SSO installation does not use a valid HTTPS certificate.
-
RH-SSO URL (
Complete one of the following procedures:
If you created the clients for Red Hat Process Automation Manager within RH-SSO, set the following parameters in the template:
-
Business Central RH-SSO Client name (
BUSINESS_CENTRAL_SSO_CLIENT
): The RH-SSO client name for Business Central. -
Business Central RH-SSO Client Secret (
BUSINESS_CENTRAL_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Business Central. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The RH-SSO client name for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string that is set in RH-SSO for the client for Process Server.
-
Business Central RH-SSO Client name (
To create the clients for Red Hat Process Automation Manager within RH-SSO, set the following parameters in the template:
-
Business Central RH-SSO Client name (
BUSINESS_CENTRAL_SSO_CLIENT
): The name of the client to create in RH-SSO for Business Central. -
Business Central RH-SSO Client Secret (
BUSINESS_CENTRAL_SSO_SECRET
): The secret string to set in RH-SSO for the client for Business Central. -
KIE Server RH-SSO Client name (
KIE_SERVER_SSO_CLIENT
): The name of the client to create in RH-SSO for Process Server. -
KIE Server RH-SSO Client Secret (
KIE_SERVER_SSO_SECRET
): The secret string to set in RH-SSO for the client for Process Server. -
RH-SSO Realm Admin Username (
SSO_USERNAME
) and RH-SSO Realm Admin Password (SSO_PASSWORD
): The user name and password for the realm administrator user for the RH-SSO realm for Red Hat Process Automation Manager. You must provide this user name and password in order to create the required clients.
-
Business Central RH-SSO Client name (
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
After completing the deployment, review the URLs for components of Red Hat Process Automation Manager in the RH-SSO authentication system to ensure they are correct.
3.1.9. Setting parameters for LDAP authentication for an authoring environment
If you want to use LDAP authentication, complete the following additional configuration when configuring the template to deploy an authoring environment.
Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
Prerequisites
You created user names and passwords for Red Hat Process Automation Manager in the LDAP system. For a list of the available roles, see Chapter 4, Red Hat Process Automation Manager roles and users. As a minimum, in order to set the parameters for the environment, you created the following users:
-
An administrative user with the
kie-server,rest-all,admin
roles. This user can administer and use the environment. -
A server user with the
kie-server,rest-all,user
roles. This user can make REST API calls to the Process Server.
-
An administrative user with the
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
In the LDAP service, create all user names in the deployment parameters. If you do not set any of the parameters, create users with the default user names. The created users must also be assigned to roles:
-
KIE_ADMIN_USER
: default user nameadminUser
, roles:kie-server,rest-all,admin
KIE_SERVER_USER
: default user nameexecutionUser
, roleskie-server,rest-all,guest
For the user roles that you can configure in LDAP, see Roles and users.
-
Set the
AUTH_LDAP*
parameters of the template. These parameters correspond to the settings of theLdapExtended
Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended login module.If the LDAP server does not define all the roles required for your deployment, you can map LDAP groups to Red Hat Process Automation Manager roles. To enable LDAP role mapping, set the following parameters:
-
RoleMapping rolesProperties file path (
AUTH_ROLE_MAPPER_ROLES_PROPERTIES
): The fully qualified path name of a file that defines role mapping, for example,/opt/eap/standalone/configuration/rolemapping/rolemapping.properties
. You must provide this file and mount it at this path in all applicable deployment configurations; for instructions, see Section 3.2, “(Optional) Providing the LDAP role mapping file”. -
RoleMapping replaceRole property (
AUTH_ROLE_MAPPER_REPLACE_ROLE
): If set totrue
, mapped roles replace the roles defined on the LDAP server; if set tofalse
, both mapped roles and roles defined on the LDAP server are set as user application roles. The default setting isfalse
.
-
RoleMapping rolesProperties file path (
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.10. Setting parameters for using an external database server for an authoring environment
If you modified the template to use an external database server for the Process Server, as described in Section 3.4, “Modifying the template for the single authoring environment” or Section 3.5, “Modifying the template for the High Availability authoring environment”, complete the following additional configuration when configuring the template to deploy an authoring environment.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
Set the following parameters:
KIE Server External Database Driver (
KIE_SERVER_EXTERNALDB_DRIVER
): The driver for the server, depending on the server type:-
mysql
-
postgresql
-
mariadb
-
mssql
-
db2
-
oracle
-
sybase
-
-
KIE Server External Database User (
KIE_SERVER_EXTERNALDB_USER
) and KIE Server External Database Password (KIE_SERVER_EXTERNALDB_PWD
): The user name and password for the external database server -
KIE Server External Database URL (
KIE_SERVER_EXTERNALDB_URL
): The JDBC URL for the external database server KIE Server External Database Dialect (
KIE_SERVER_EXTERNALDB_DIALECT
): The Hibernate dialect for the server, depending on the server type:-
org.hibernate.dialect.MySQL5InnoDBDialect
(used for MySQL and MariaDB) -
org.hibernate.dialect.PostgreSQL82Dialect
-
org.hibernate.dialect.SQLServer2012Dialect
(used for MS SQL) -
org.hibernate.dialect.DB2Dialect
-
org.hibernate.dialect.Oracle10gDialect
-
org.hibernate.dialect.SybaseASE157Dialect
-
-
KIE Server External Database Host (
KIE_SERVER_EXTERNALDB_SERVICE_HOST
): The host name of the external database server -
KIE Server External Database Port (
KIE_SERVER_EXTERNALDB_SERVICE_PORT
): The port number of the external database server -
KIE Server External Database name (
KIE_SERVER_EXTERNALDB_DB
): The database name to use on the external database server -
JDBC Connection Checker class (
KIE_SERVER_EXTERNALDB_CONNECTION_CHECKER
): The name of the JDBC connection checker class for the database server. Without this information, a database server connection cannot be restored after it is lost, for example, if the database server is rebooted. -
JDBC Exception Sorter class (
KIE_SERVER_EXTERNALDB_EXCEPTION_SORTER
): The name of the JDBC exception sorter class for the database server. Without this information, a database server connection cannot be restored after it is lost, for example, if the database server is rebooted.
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in Section 2.7, “Building a custom Process Server extension image for an external database”, set the following parameters:
-
Drivers Extension Image (
EXTENSIONS_IMAGE
): The ImageStreamTag definition of the extension image, for example,jboss-kie-db2-extension-openshift-image:11.1.4.4
-
Drivers ImageStream Namespace (
EXTENSIONS_IMAGE_NAMESPACE
): The namespace to which you uploaded the extension image, for example,openshift
or your project namespace.
-
Drivers Extension Image (
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
3.1.11. Enabling Prometheus metric collection for an authoring environment
If you want to configure your Process Server deployment to use Prometheus to collect and store metrics, enable support for this feature in Process Server at deployment time.
Prerequisites
- You started the configuration of the template, as described in Section 3.1.1, “Starting configuration of the template for an authoring environment”.
Procedure
To enable support for Prometheus metric collection, set the Prometheus Server Extension Disabled (PROMETHEUS_SERVER_EXT_DISABLED
) parameter to false
.
Next steps
If necessary, set additional parameters.
To complete the deployment, follow the procedure in Section 3.1.12, “Completing deployment of the template for an authoring environment”.
For instructions about configuring Prometheus metrics collection, see Managing and monitoring Process Server.
3.1.12. Completing deployment of the template for an authoring environment
After setting all the required parameters in the OpenShift Web UI or in the command line, complete deployment of the template.
Procedure
Depending on the method that you are using, complete the following steps:
In the OpenShift Web UI, click Create.
-
If the
This will create resources that may have security or project behavior implications
message appears, click Create Anyway.
-
If the
- Complete the command line and press Enter.
3.2. (Optional) Providing the LDAP role mapping file
If you configure the AUTH_ROLE_MAPPER_ROLES_PROPERTIES
parameter, you must provide a file that defines the role mapping. Mount this file on all affected deployment configurations.
Procedure
Create the role mapping properties file, for example,
my-role-map
. The file must contain entries in the following format:ldap_role = product_role1, product_role2...
For example:
admins = kie-server,rest-all,admin
Create an OpenShift configuration map from the file by entering the following command:
oc create configmap ldap-role-mapping --from-file=<new_name>=<existing_name>
Replace
<new_name>
with the name that the file is to have on the pods (it must be the same as the name specified in theAUTH_ROLE_MAPPER_ROLES_PROPERTIES
file) and<existing_name>
with the name of the file that you created. Example:oc create configmap ldap-role-mapping --from-file=rolemapping.properties=my-role-map
Mount the configuration map on every deployment configuration that is configured for role mapping.
The following deployment configurations can be affected in this environment:
-
myapp-rhpamcentr
: Business Central -
myapp-kieserver
: Process Server
Replace
myapp
with the application name. Sometimes, several Process Server deployments can be present under different application names.For every deployment configuration, run the command:
oc set volume dc/<deployment_config_name> --add --type configmap --configmap-name ldap-role-mapping --mount-path=<mapping_dir> --name=ldap-role-mapping
Replace
<mapping_dir>
with the directory name (without file name) set in theAUTH_ROLE_MAPPER_ROLES_PROPERTIES
parameter, for example,/opt/eap/standalone/configuration/rolemapping
.-
3.3. (Optional) Providing the Git hooks directory
If you configure the GIT_HOOKS_DIR
parameter, you must provide a directory of Git hooks and must mount this directory on the Business Central deployment.
The typical use of Git hooks is interaction with an upstream repository. To enable Git hooks to push commits into an upstream repository, you must also provide a secret key that corresponds to a public key configured on the upstream repository.
Procedure
If interaction with an upstream repository using SSH authentication is required, complete the following steps to prepare and mount a secret with the necessary files:
-
Prepare the
id_rsa
file with a private key that matches a public key stored in the repository. -
Prepare the
known_hosts
file with the correct name, address, and public key for the repository. Create a secret with the two files using the
oc
command, for example:oc create secret git-hooks-secret --from-file=id_rsa=id_rsa --from-file=known_hosts=known_hosts
Mount the secret in the SSH key path of the Business Central deployment, for example:
oc set volume dc/<myapp>-rhpamcentr --add --type secret --secret-name git-hooks-secret --mount-path=/home/jboss/.ssh --name=ssh-key
Replace
<myapp>
with the application name that you set when configuring the template.
-
Prepare the
Create the Git hooks directory. For instructions, see the Git hooks reference documentation.
For example, a simple Git hooks directory can provide a post-commit hook that pushes the changes upstream. If the project was imported into Business Central from a repository, this repository remains configured as the upstream repository. Create a file named
post-commit
with permission values755
and the following content:git push
Supply the Git hooks directory to the Business Central deployment. You can use a configuration map or a persistent volume.
If the Git hooks consist of one or several fixed script files, use a configuration map. Complete the following steps:
- Change into the Git hooks directory that you have created.
Create an OpenShift configuration map from the files in the directory. Run the following command:
oc create configmap git-hooks --from-file=<file_1>=<file_1> --from-file=<file_2>=<file_2> ...
Replace
file_1
,file_2
, and so on with Git hook script file names. Example:oc create configmap git-hooks --from-file=post-commit=post-commit
Mount the configuration map on the Business Central deployment in the path that you have configured:
oc set volume dc/<myapp>-rhpamcentr --add --type configmap --configmap-name git-hooks --mount-path=<git_hooks_dir> --name=git-hooks
Replace
<myapp>
with the application name that was set when configuring the template and<git_hooks_dir>
is the value ofGIT_HOOKS_DIR
that was set when configuring the template.
-
If the Git hooks consist of long files or depend on binaries, such as executable or KJAR files, use a persistence volume. You must create a persistent volume, create a persistent volume claim and associate the volume with the claim, transfer files to the volume, and mount the volume in the
myapp-rhpamcentr
deployment configuration (replace myapp with the application name). For instructions about creating and mounting persistence volumes, see Using persistent volumes. For instructions about copying files onto a persistent volume, see Transferring files in and out of containers.
Wait a few minutes, then review the list and status of pods in your project. Because Business Central does not start until you provide the Git hooks directory, the Process Server might not start at all. To see if it has started, check the output of the following command:
oc get pods
If a working Process Server pod is not present, start it:
oc rollout latest dc/<myapp>-kieserver
Replace
<myapp>
with the application name that was set when configuring the template.
3.4. Modifying the template for the single authoring environment
By default, the single authoring template uses the H2 database with permanent storage. If you prefer to create a MySQL or PostgreSQL pod or to use an external database server (outside the OpenShift project), you need to modify the template before deploying the environment.
An OpenShift template defines a set of objects that can be created by OpenShift. To change an environment configuration, you need to modify, add, or delete these objects. To simplify this task, comments are provided in the Red Hat Process Automation Manager templates.
Some comments mark blocks within the template, staring with BEGIN
and ending with END
. For example, the following block is named Sample block
:
## Sample block BEGIN sample line 1 sample line 2 sample line 3 ## Sample block END
For some changes, you might need to replace a block in one template file with a block from another template file provided with Red Hat Process Automation Manager. In this case, delete the block, then paste the new block in its exact location.
Procedure
Edit the rhpam74-authoring.yaml
template file to make any of the following changes as necessary.
If you want to use MySQL instead of the H2 database, you need to replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam74-kieserver-mysql.yaml
file that are also marked with comments. You also need to remove several other blocks and to add blocks in designated locations:-
Replace the block named
H2 database parameters
with the block namedMySQL database parameters
. (Take this block and all subsequent replacement blocks from therhpam74-kieserver-mysql.yaml
file.) -
Replace the block named
H2 driver settings
with the block namedMySQL driver settings
. -
Replace the block named
H2 persistent volume claim
with the block namedMySQL persistent volume claim
. -
Remove the blocks named
H2 volume mount
andH2 volume settings
. -
Under the comment
Place to add database service
, add the block namedMySQL service
. -
Under the comment
Place to add database deployment config
, add the block namedMySQL deployment config
.
-
Replace the block named
If you want to use PostgreSQL instead of the H2 database, you need to replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam74-kieserver-postgresql.yaml
file that are also marked with comments. You also need to remove several other blocks and to add blocks in designated locations:-
Replace the block named
H2 database parameters
with the block namedPostgreSQL database parameters
. (Take this block and all subsequent replacement blocks from therhpam74-kieserver-postgresql.yaml
file.) -
Replace the block named
H2 driver settings
with the block namedPostgreSQL driver settings
. -
Replace the block named
H2 persistent volume claim
with the block namedPostgreSQL persistent volume claim
. -
Remove the blocks named
H2 volume mount
andH2 volume settings
. -
Under the comment
Place to add database service
, add the block namedPostgreSQL service
. -
Under the comment
Place to add database deployment config
, add the block namedPostgreSQL deployment config
.
-
Replace the block named
If you want to use an external database server, replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam74-kieserver-externaldb.yaml
file, and also remove some blocks:-
Replace the block named
H2 database parameters
with the block namedExternal database parameters
. (Take this block and all subsequent replacement blocks from therhpam74-kieserver-externaldb.yaml
file.) -
Replace the block named
H2 driver settings
with the block namedExternal database driver settings
. Remove the following blocks of the file, marked with comments from
BEGIN
toEND
:-
H2 persistent volume claim
-
H2 volume mount
-
H2 volume settings
-
-
Replace the block named
The standard Process Server image includes drivers for MySQL and PostgreSQL external database servers. If you want to use another database server, you must build a custom Process Server image. For instructions, see Section 2.7, “Building a custom Process Server extension image for an external database”.
3.5. Modifying the template for the High Availability authoring environment
By default, the high-availability authoring template creates a MySQL pod to provide the database server for the Process Server. If you prefer to use PostgreSQL or to use an external server (outside the OpenShift project), you need to modify the template before deploying the environment.
You can also modify the High Availability authoring template to change the number of replicas initially created for Business Central.
An OpenShift template defines a set of objects that can be created by OpenShift. To change an environment configuration, you need to modify, add, or delete these objects. To simplify this task, comments are provided in the Red Hat Process Automation Manager templates.
Some comments mark blocks within the template, staring with BEGIN
and ending with END
. For example, the following block is named Sample block
:
## Sample block BEGIN sample line 1 sample line 2 sample line 3 ## Sample block END
For some changes, you might need to replace a block in one template file with a block from another template file provided with Red Hat Process Automation Manager. In this case, delete the block, then paste the new block in its exact location.
Procedure
Edit the rhpam74-authoring-ha.yaml
template file to make any of the following changes as necessary.
If you want to use PostgreSQL instead of MySQL, replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam74-kieserver-postgresql.yaml
file:-
Replace the block named
MySQL database parameters
with the block namedPosgreSQL database parameters
. (Take this block and all subsequent replacement blocks from therhpam74-kieserver-postgresql.yaml
file.) -
Replace the block named
MySQL service
with the block namedPosgrreSQL service
. -
Replace the block named
MySQL driver settings
with the block namedPosgreSQL driver settings
. -
Replace the block named
MySQL deployment config
with the block namedPosgreSQL deployment config
. -
Replace the block named
MySQL persistent volume claim
with the block namedPosgreSQL persistent volume claim
.
-
Replace the block named
If you want to use an external database server, replace several blocks of the file, marked with comments from
BEGIN
toEND
, with blocks from therhpam74-kieserver-externaldb.yaml
file, and also remove some blocks:-
Replace the block named
MySQL database parameters
with the block namedExternal database parameters
. (Take this block and all subsequent replacement blocks from therhpam74-kieserver-externaldb.yaml
file.) -
Replace the block named
MySQL driver settings
with the block namedExternal database driver settings
. Remove the following blocks of the file, marked with comments from
BEGIN
toEND
:-
MySQL service
-
MySQL deployment config
-
MySQL persistent volume claim
-
-
Replace the block named
The standard Process Server image includes drivers for MySQL and PostgreSQL external database servers. If you want to use another database server, you must build a custom Process Server image. For instructions, see Section 2.7, “Building a custom Process Server extension image for an external database”.
-
If you want to change the number of replicas initially created for Business Central, on the line below the comment
## Replicas for Business Central
, change the number of replicas to the desired value.