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 high-availability service. Use a high-availability authoring environment to provide maximum reliability and responsiveness, especially if several users are involved in authoring at the same time.

Important

In the current version, the high-availability functionality is a technology preview.

3.1. Deploying a single authoring environment

To deploy a single authoring environment, use the rhpam71-authoring.yaml template file.

You can extract this file from the rhpam-7.1.0-openshift-templates.zip product deliverable file. You can download the file from the Software Downloads page.

If you want to modify the environment defined by the template file, see Section 3.3, “Modifying the template for the single authoring environment”.

Procedure

Use one of the following methods to deploy the template:
- In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select or paste the rhpam71-authoring.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>/rhpam71-authoring.yaml -p BUSINESS_CENTRAL_HTTPS_SECRET=businesscentral-app-secret -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret
```
  In this command line:
  - Replace <template-path> with the path to the downloaded template file.
  - Use as many -p PARAMETER=value pairs as needed to set the required parameters. You can view the template file to see descriptions for all parameters.
Set the following parameters as necessary:
- Business Central Server Keystore Secret Name (BUSINESS_CENTRAL_HTTPS_SECRET): The name of the secret for Business Central, as created in Section 2.3, “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.2, “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 and Process Server. OpenShift uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. You can deploy several applications using the same template into the same project, as long as you use different application names. Also, the application name determines the name of the server configuration (server template) on the Business Central that the Process Server is to join.
- Business Central Server Certificate Name (BUSINESS_CENTRAL_HTTPS_NAME): The name of the certificate in the keystore that you created in Section 2.3, “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.3, “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.2, “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.2, “Creating the secrets for Process Server”.
- 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”), the namespace is openshift. If you have installed the image streams file, the namespace is the name of the OpenShift project.
  You can also set the following user names and passwords:
- KIE Admin User (KIE_ADMIN_USER) and KIE Admin Password (KIE_ADMIN_PWD): The user name and password for the administrative user in Business Central.
- KIE Server User (KIE_SERVER_USER) and KIE Server Password (KIE_SERVER_PWD): The user name and password that a client application must use to connect to the Process Server.
If you want to place the built KJAR files into an external Maven repository, set the following parameters:
- Maven repository URL (MAVEN_REPO_URL): The URL for the Maven repository.
- Maven repository username (MAVEN_REPO_USERNAME): The user name for the Maven repository.
- Maven repository password (MAVEN_REPO_PASSWORD): The password for the Maven repository.
- Maven repository ID (MAVEN_REPO_ID): The Maven ID, which must match the id setting for the Maven repository.
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration:
1. In the RH-SSO or 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 name adminUser, roles: kie-server,rest-all,admin,kiemgmt,Administrators
  - KIE_SERVER_CONTROLLER_USER: default user name controllerUser, roles: kie-server,rest-all,guest
  - BUSINESS_CENTRAL_MAVEN_USERNAME (not needed if you configure the use of an external Maven repository): default user name mavenUser. No roles are required.
  - KIE_SERVER_USER: default user name executionUser, roles kie-server,rest-all,guest
2. If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSO realm that applies to Red Hat Process Automation Manager must exist. Process Server. If the client does not yet exist, the template can create it during deployment. Clients within RH-SSO must also exist for Business Central and for Process Server. If the clients do not yet exist, the template can create them during deployment.
  For the user roles that you can configure in RH-SSO, see Roles and users.
  Use one of the following procedures:
  1. If the clients for Red Hat Process Automation Manager within RH-SSO already exist, set the following parameters in the template:
    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.
    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.
    RH-SSO Disable SSL Certificate Validation (SSO_DISABLE_SSL_CERTIFICATE_VALIDATION): Set to true if your RH-SSO installation does not use a valid HTTPS certificate.
  2. To create the clients for Red Hat Process Automation Manager within RH-SSO, set the following parameters in the template:
    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.
    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.
    Business Central Custom http Route Hostname (BUSINESS_CENTRAL_HOSTNAME_HTTP): The fully qualified host name to use for the HTTP endpoint for Business Central. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    Business Central Custom https Route Hostname (BUSINESS_CENTRAL_HOSTNAME_HTTPS): The fully qualified host name to use for the HTTPS endpoint for Business Central. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    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.
    KIE Server Custom http Route Hostname (KIE_SERVER_HOSTNAME_HTTP): The fully qualified host name to use for the HTTP endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    KIE Server Custom https Route Hostname (KIE_SERVER_HOSTNAME_HTTPS): The fully qualified host name to use for the HTTPS endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    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.
    RH-SSO Disable SSL Certificate Validation (SSO_DISABLE_SSL_CERTIFICATE_VALIDATION): Set to true if your RH-SSO installation does not use a valid HTTPS certificate.
3. To configure LDAP, set the AUTH_LDAP* parameters of the template. These parameters correspond to the settings of the LdatExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.
  Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
If you modified the template to use an external database server for the Process Server, as described in Section 3.3, “Modifying the template for the single authoring environment”, 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_HOST): 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.MySQL5Dialect (used for MySQL and MariaDB)
  - org.hibernate.dialect.PostgreSQLDialect
  - org.hibernate.dialect.SQLServer2012Dialect (used for MS SQL)
  - org.hibernate.dialect.DB2Dialect
  - org.hibernate.dialect.Oracle12cDialect
  - org.hibernate.dialect.SybaseASE15Dialect
- KIE Server External Database Host (KIE_SERVER_EXTERNALDB_HOST): The host name of the external database server.
- KIE Server External Database Port (KIE_SERVER_EXTERNALDB_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.
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in Section 3.5, “Building a custom Process Server image for an external database”, set the KIE Server Image Stream Name (KIE_SERVER_IMAGE_STREAM_NAME) parameter to the following value:
- For Microsoft SQL Server, rhpam71-kieserver-mssql-openshift
- For MariaDB, rhpam71-kieserver-mariadb-openshift
- For IBM DB2, rhpam71-kieserver-db2-openshift
- For Oracle Database, rhpam71-kieserver-oracle-openshift
- For Sybase, rhpam71-kieserver-sybase-openshift
Complete the creation of the environment, depending on the method that you are using:
- In the OpenShift Web UI, click Create.
- Complete and run the command line.

3.2. Deploying a high-availability authoring environment

To deploy a high-availability authoring environment, use the rhpam71-authoring-ha.yaml template file.

You can download the file from the Software Downloads page.

If you want to modify the environment defined by the template file, see Section 3.4, “Modifying the template for the High Availability authoring environment”.

Important

In the current version, the high-availability functionality is a technology preview.

Procedure

Use one of the following methods to deploy the template:
- In the OpenShift Web UI, select Add to Project → Import YAML / JSON and then select or paste the rhpam71-authoring-ha.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>/rhpam71-authoring-ha.yaml -p BUSINESS_CENTRAL_HTTPS_SECRET=businesscentral-app-secret -p KIE_SERVER_HTTPS_SECRET=kieserver-app-secret
```
  In this command line:
  - Replace <template-path> with the path to the downloaded template file.
  - Use as many -p PARAMETER=value pairs as needed to set the required parameters. You can view the template file to see descriptions for all parameters.
Set the following parameters as necessary:
- Business Central Server Keystore Secret Name (BUSINESS_CENTRAL_HTTPS_SECRET): The name of the secret for Business Central, as created in Section 2.3, “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.2, “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 and Process Server. OpenShift uses the application name to create a separate set of deployment configurations, services, routes, labels, and artifacts. You can deploy several applications using the same template into the same project, as long as you use different application names. Also, the application name determines the name of the server configuration (server template) on the Business Central that the Process Server is to join.
- Business Central Server Certificate Name (BUSINESS_CENTRAL_HTTPS_NAME): The name of the certificate in the keystore that you created in Section 2.3, “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.3, “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.2, “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.2, “Creating the secrets for Process Server”.
- 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”), the namespace is openshift. If you have installed the image streams file, the namespace is the name of the OpenShift project.
  You can also set the following user names and passwords:
- KIE Admin User (KIE_ADMIN_USER) and KIE Admin Password (KIE_ADMIN_PWD): The user name and password for the administrative user in Business Central.
- KIE Server User (KIE_SERVER_USER) and KIE Server Password (KIE_SERVER_PWD): The user name and password that a client application must use to connect to the Process Server.
If you want to place the built KJAR files into an external Maven repository, set the following parameters:
- Maven repository URL (MAVEN_REPO_URL): The URL for the Maven repository.
- Maven repository username (MAVEN_REPO_USERNAME): The user name for the Maven repository.
- Maven repository password (MAVEN_REPO_PASSWORD): The password for the Maven repository.
- Maven repository ID (MAVEN_REPO_ID): The Maven ID, which must match the id setting for the Maven repository.
If you want to use RH-SSO or LDAP authentication, complete the following additional configuration:
1. In the RH-SSO or 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 name adminUser, roles: kie-server,rest-all,admin,kiemgmt,Administrators
  - KIE_SERVER_CONTROLLER_USER: default user name controllerUser, roles: kie-server,rest-all,guest
  - BUSINESS_CENTRAL_MAVEN_USERNAME (not needed if you configure the use of an external Maven repository): default user name mavenUser. No roles are required.
  - KIE_SERVER_USER: default user name executionUser, roles kie-server,rest-all,guest
2. If you want to configure Red Hat Single Sign On (RH-SSO) authentication, an RH-SSO realm that applies to Red Hat Process Automation Manager must exist. Process Server. If the client does not yet exist, the template can create it during deployment. Clients within RH-SSO must also exist for Business Central and for Process Server. If the clients do not yet exist, the template can create them during deployment.
  For the user roles that you can configure in RH-SSO, see Roles and users.
  Use one of the following procedures:
  1. If the clients for Red Hat Process Automation Manager within RH-SSO already exist, set the following parameters in the template:
    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.
    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.
    RH-SSO Disable SSL Certificate Validation (SSO_DISABLE_SSL_CERTIFICATE_VALIDATION): Set to true if your RH-SSO installation does not use a valid HTTPS certificate.
  2. To create the clients for Red Hat Process Automation Manager within RH-SSO, set the following parameters in the template:
    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.
    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.
    Business Central Custom http Route Hostname (BUSINESS_CENTRAL_HOSTNAME_HTTP): The fully qualified host name to use for the HTTP endpoint for Business Central. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    Business Central Custom https Route Hostname (BUSINESS_CENTRAL_HOSTNAME_HTTPS): The fully qualified host name to use for the HTTPS endpoint for Business Central. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    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.
    KIE Server Custom http Route Hostname (KIE_SERVER_HOSTNAME_HTTP): The fully qualified host name to use for the HTTP endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    KIE Server Custom https Route Hostname (KIE_SERVER_HOSTNAME_HTTPS): The fully qualified host name to use for the HTTPS endpoint for Process Server. If you need to create a client in RH-SSO, you can not leave this parameter blank.
    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.
    RH-SSO Disable SSL Certificate Validation (SSO_DISABLE_SSL_CERTIFICATE_VALIDATION): Set to true if your RH-SSO installation does not use a valid HTTPS certificate.
3. To configure LDAP, set the AUTH_LDAP* parameters of the template. These parameters correspond to the settings of the LdatExtended Login module of Red Hat JBoss EAP. For instructions about using these settings, see LdapExtended Login Module.
  Do not configure LDAP authentication and RH-SSO authentication in the same deployment.
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 High Availability authoring environment”, 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_HOST): 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.MySQL5Dialect (used for MySQL and MariaDB)
  - org.hibernate.dialect.PostgreSQLDialect
  - org.hibernate.dialect.SQLServer2012Dialect (used for MS SQL)
  - org.hibernate.dialect.DB2Dialect
  - org.hibernate.dialect.Oracle12cDialect
  - org.hibernate.dialect.SybaseASE15Dialect
- KIE Server External Database Host (KIE_SERVER_EXTERNALDB_HOST): The host name of the external database server.
- KIE Server External Database Port (KIE_SERVER_EXTERNALDB_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.
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in Section 3.5, “Building a custom Process Server image for an external database”, set the KIE Server Image Stream Name (KIE_SERVER_IMAGE_STREAM_NAME) parameter to the following value:
- For Microsoft SQL Server, rhpam71-kieserver-mssql-openshift
- For MariaDB, rhpam71-kieserver-mariadb-openshift
- For IBM DB2, rhpam71-kieserver-db2-openshift
- For Oracle Database, rhpam71-kieserver-oracle-openshift
- For Sybase, rhpam71-kieserver-sybase-openshift
If an AMQ 7.1 image is not available in the openshift namespace with default settings, set the following parameters:
- AMQ ImageStream Namespace (AMQ_IMAGE_STREAM_NAMESPACE): Namespace in which the ImageStream for the AMQ image is installed. The default setting is openshift.
- AMQ ImageStream Name (AMQ_IMAGE_STREAM_NAME): The name of the image stream for the AMQ broker. The default setting is amq-broker71-openshift.
- AMQ ImageStream Tag (AMQ_IMAGE_STREAM_TAG): The AMQ image stream tag. The default setting is 1.0.
Complete the creation of the environment, depending on the method that you are using:
- In the OpenShift Web UI, click Create.
- Complete and run the command line.

3.3. 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 rhpam71-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 to END, with blocks from the rhpam71-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:
1. Replace the block named H2 database parameters with the block named MySQL database parameters. (Take this block and all subsequent replacement blocks from the rhpam71-kieserver-mysql.yaml file.)
2. Replace the block named H2 driver settings with the block named MySQL driver settings
3. Replace the block named H2 persistent volume claim with the block named MySQL persistent volume claim.
4. Remove the blocks named H2 volume mount and H2 volume settings
5. Under the comment Place to add database service, add the block named MySQL service
6. Under the comment Place to add database deployment config, add the block named MySQL deployment config
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 to END, with blocks from the rhpam71-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:
1. Replace the block named H2 database parameters with the block named PostgreSQL database parameters. (Take this block and all subsequent replacement blocks from the rhpam71-kieserver-postgresql.yaml file.)
2. Replace the block named H2 driver settings with the block named PostgreSQL driver settings
3. Replace the block named H2 persistent volume claim with the block named PostgreSQL persistent volume claim.
4. Remove the blocks named H2 volume mount and H2 volume settings
5. Under the comment Place to add database service, add the block named PostgreSQL service
6. Under the comment Place to add database deployment config, add the block named PostgreSQL deployment config
If you want to use an external database server, replace several blocks of the file, marked with comments from BEGIN to END, with blocks from the rhpam71-kieserver-externaldb.yaml file, and also remove some blocks:
1. Replace the block named H2 database parameters with the block named External database parameters. (Take this block and all subsequent replacement blocks from the rhpam71-kieserver-externaldb.yaml file.)
2. Replace the block named H2 driver settings with the block named External database driver settings.
3. Remove the following blocks of the file, marked with comments from BEGIN to END:
  - H2 persistent volume claim
  - H2 volume mount
  - H2 volume settings

Important

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 3.5, “Building a custom Process Server image for an external database”.

3.4. 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.

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

Procedure

Edit the rhpam71-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 to END, with blocks from the rhpam71-kieserver-postgresql.yaml file:
1. Replace the block named MySQL database parameters with the block named PosgreSQL database parameters. (Take this block and all subsequent replacement blocks from the rhpam71-kieserver-postgresql.yaml file.)
2. Replace the block named MySQL service with the block named PosgrreSQL service.
3. Replace the block named MySQL driver settings with the block named PosgreSQL driver settings.
4. Replace the block named MySQL deployment config with the block named PosgreSQL deployment config.
5. Replace the block named MySQL persistent volume claim with the block named PosgreSQL persistent volume claim.
If you want to use an external database server, replace several blocks of the file, marked with comments from BEGIN to END, with blocks from the rhpam71-kieserver-externaldb.yaml file, and also remove some blocks:
1. Replace the block named MySQL database parameters with the block named External database parameters. (Take this block and all subsequent replacement blocks from the rhpam71-kieserver-externaldb.yaml file.)
2. Replace the block named MySQL driver settings with the block named External database driver settings.
3. Remove the following blocks of the file, marked with comments from BEGIN to END:
  - MySQL service
  - MySQL deployment config
  - MySQL persistent volume claim

Important

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.

3.5. Building a custom Process Server image for an external database

If you want to use an external database server for a Process Server and this server is neither MySQL nor PostgreSQL, you must build a custom Process Server image with drivers for this server before deploying your environment.

You can use this build procedure to provide drivers for the following database servers:

Microsoft SQL Server
MariaDB
IBM DB2
Oracle Database
Sybase

For the tested versions of the database servers, see Red Hat Process Automation Manager 7 Supported Configurations.

The build procedure creates a custom image that extends the existing Process Server image. It pushes this custom image into a new ImageStream in the openshift namespace with the same version tag as the original image.

Prerequisites

You have logged on to your project in the OpenShift environment using the oc command as a user with the cluster-admin role.
For IBM DB2, Oracle Database, or Sybase, you have downloaded the JDBC driver from the database server vendor.

Procedure

For IBM DB2, Oracle Database, or Sybase, provide the JDBC driver JAR in a local directory or on an HTTP server. Within the local directory or HTTP server, the following paths are expected:
- For IBM DB2, <local_path_or_url>/com/ibm/db2/jcc/db2jcc4/10.5/db2jcc4-10.5.jar
- For Oracle Database, <local_path_or_url>/com/oracle/ojdbc7/12.1.0.1/ojdbc7-12.1.0.1.jar
- For Sybase, <local_path_or_url>/com/sysbase/jconn4/16.0_PL05/jconn4-16.0_PL05.jar
  Where <local_path_or_url> is the path to the local directory or the URL for the HTTP server where the driver is provided.
To install the source code for the custom build, download the rhpam-7.1.0-openshift-templates.zip product deliverable file from the Software Downloads page. Unzip the file and, using the command line, change to the templates/contrib/jdbc directory of the unzipped file.
Change to the following subdirectory:
- For Microsoft SQL Server, mssql-driver-image
- For MariaDB, mariadb-driver-image
- For IBM DB2, db2-driver-image
- For Oracle Database, oracle-driver-image
- For Sybase, sybase-driver-image
Run the following command:
- For Microsoft SQL Server or MariaDB:
```
../build.sh
```
- For IBM DB2, Oracle Database, or Sybase:
```
../build.sh --artifact-repo=<local_path_or_url>
```
Where <local_path_or_url> is the path to the local directory or the URL for the HTTP server where the driver is provided. For example:
```
../build.sh --artifact-repo=/home/builder/drivers
../build.sh --artifact-repo=http://nexus.example.com/nexus/content/groups/public
```
If you want to configure your OpenShift docker registry address in the process, add also the --registry=<registry_name.domain_name:port> parameter to your build command.
Examples:
```
../build.sh --registry=docker-registry.custom-domain:80

../build.sh --artifact-repo=/home/builder/drivers --registry=docker-registry.custom-domain:80
```

Where did the comment section go?

Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.

Log in to Your Red Hat Account

Red Hat Account

Customer Portal

Select Your Language

Infrastructure and Management

Cloud Computing

Storage

JBoss Development and Management

JBoss Integration and Automation

Mobile

Services

Tools

Red Hat Product Security Center

Security Updates

Resources

Customer Portal Community

Customer Events

Stories

Chapter 3. Authoring environment

3.1. Deploying a single authoring environment

3.2. Deploying a high-availability authoring environment

3.3. Modifying the template for the single authoring environment

3.4. Modifying the template for the High Availability authoring environment

3.5. Building a custom Process Server image for an external database

Where did the comment section go?