Configuring Application Engine
Before you install IBM Cloud Pak® for Business Automation, configure the custom resource YAML file for your Application Engine deployment.
Procedure
- Open the custom resource (CR) file that you created in Generating the custom resource.
-
If you did not run the script to prepare databases and secrets, configure your database by
setting the configuration parameters according to the database type. Update the
application_engine_configurationsections of the custom resource YAML file. For more information, see Custom resource pattern templates.You can use your own JDBC driver, but it is used only to initialize the database. Application Engine does not use the JDBC driver at runtime. Instead, Application Engine uses a Node.js library to connect to the database, and this library is not customizable. This behavior applies to all supported database types.For database configuration, set the configuration parameters according to the database type:- For Db2®:
- Set
application_engine_configuration.database.typetoDB2. - Enter your DB2® server hostname or IP into
application_engine_configuration.database.host. - Enter your DB2 server port into
application_engine_configuration.database.port. - Enter your Application Engine database into
application_engine_configuration.database.name. - If you want to connect your database by SSL, set
application_engine_configuration.database.enable_ssltotrueand put your database secret intoapplication_engine_configuration.database.db_cert_secret_name. - If you want to use your own JDBC driver, set
application_engine_configuration.use_custom_jdbc_driverstotrueand enter your PVC for JDBC driver intoapplication_engine_configuration.database.custom_jdbc_pvc. For more information, see Updating JDBC drivers.
- Set
- For Oracle:Note: If you want to deploy Application Engine using an Oracle database, then you need ODPI-C® applications with Oracle Instant Client to connect to the database at runtime. If you want a customized version of this client, download the Oracle Instant Client compressed file from Oracle Instant Client Download Page
.- Set
application_engine_configuration.use_custom_jdbc_driverstotrue. - Set
application_engine_configuration.database.typetoOracle. - Enter the Oracle connection URL in this format:
into(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))application_engine_configuration.database.oracle_url_without_wallet_directory. - Enter your PVC for Oracle JDBC driver into
application_engine_configuration.database.custom_jdbc_pvc. For more information, see Updating JDBC drivers. - If you want to connect your database by SSL, set
application_engine_configuration.database.enable_ssltotrue.- Update
application_engine_configuration.database.oracle_url_without_wallet_directory(set in step c) to use the Oracle SSL URL in this format:(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<your-oracle-database-hostname>)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>))) - Enter the Oracle SSL URL with the wallet path in this format:
into(DESCRIPTION=(ADDRESS=(PROTOCOL=tcps)(HOST=<your-oracle-database-hostname>)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>))(SECURITY=(SSL_SERVER_DN_MATCH=FALSE)(MY_WALLET_DIRECTORY=/shared/resources/oracle/wallet)))application_engine_configuration.database.oracle_url_with_wallet_directory.Note: Do not change the path MY_WALLET_DIRECTORY=/shared/resources/oracle/wallet. - Enter your Database Server Wallet Secret into
application_engine_configuration.database.db_cert_secret_name, and your Database Server Wallet SSO Secret intoapplication_engine_configuration.database.oracle_sso_wallet_secret_name. For more information, see Creating secrets to protect sensitive configuration data.
- Update
- Set
- For PostgreSQL:
- Set
application_engine_configuration.use_custom_jdbc_driverstotrue. - Set
application_engine_configuration.database.typetoPostgreSQL. - Enter your PostgreSQL
server hostname or IP into
application_engine_configuration.database.host. - Enter your PostgreSQL
server port into
application_engine_configuration.database.port. - Enter your Application
Engine
database into
application_engine_configuration.database.name. - Enter your PVC for PostgreSQL JDBC driver into
application_engine_configuration.database.custom_jdbc_pvc. For more information, see Updating JDBC drivers. - If you want to connect your database by SSL, set
application_engine_configuration.database.enable_ssltotrueand put your database secret intoapplication_engine_configuration.database.db_cert_secret_name.Note: CN verification of Application Engine is enabled by default when PostgreSQL SSL is enabled. Therefore, you must prepare the database SSL certificate with the proper CN or SAN, and make sure that the database server host name or IP address input matches the CN or the list of the SAN in the certificate.
- Set
For a full list of parameters, see Application Engine parameters. - For Db2®:
- If you selected Application Designer as an optional component to deploy, do the tasks in Configuring Business Automation Studio.
-
If Business Automation Application data
persistence is enabled, you must complete the following steps:
- Business Automation Application needs one object store from IBM Content Cortex. You can either reuse the existing one or create a new one and add the name to the application_engine_configuration[*].data_persistence.object_store_name parameter, which has the default value of AEOS. For more information, see Configuring Content Cortex.
- Prepare your ibm-fncm-secret. For more information, see Creating secrets to protect sensitive IBM®
Content Cortex configuration data.Important: Data persistence uses the appLoginUsername as the data persistence object store (AEOS) user. Ensure that this user belongs to that object store administrator group.
- If you need to install other components, go to their configuration sections and do the configuration for those components, using the same YAML file.
What to do next
Continue to configure the other capabilities that are in your CR file, and make sure that you complete the last step Validating the YAML in your custom resource file before you apply the CR to the operator.