Configuring Application Engine

Before you perform the installation, configure the custom resource YAML file for your IBM Business Automation Application Engine (Application Engine) deployment

Procedure

  1. Open the custom resource (CR) file that you created in Generating the custom resource.
  2. Update the application_engine_configuration sections of the custom resource YAML file. For more information, see Custom resource pattern templates. For database configuration, set the configuration parameters according to the database type:
    • For Db2®, Application Engine:
      1. Set application_engine_configuration.database.type to DB2.
      2. Enter your DB2® server hostname or IP into application_engine_configuration.database.host.
      3. Enter your DB2 server port into application_engine_configuration.database.port.
      4. Enter your Application Engine database into application_engine_configuration.database.name.
      5. If you want to connect your database by SSL, set application_engine_configuration.database.enable_ssl to true and put your database secret into application_engine_configuration.database.db_cert_secret_name.
      6. If you want to user your own JDBC driver, set application_engine_configuration.user_custom_jdbc_drivers to true and put your PVC for JDBC driver into application_engine_configuration.database.custom_jdbc_pvc. For more information, see Implementing storage.
    • For Oracle, Application Engine:
      1. Set application_engine_configuration.user_custom_jdbc_drivers to true.
      2. Set application_engine_configuration.database.type to Oracle.
      3. Enter the Oracle connection URL (URL format: (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))) into application_engine_configuration.database.oracle_url_without_wallet_directory.
      4. Enter your PVC for Oracle JDBC driver into application_engine_configuration.database.custom_jdbc_pvc. For more information, see Implementing storage.
      5. If you want to connect your database by SSL, set application_engine_configuration.database.enable_ssl to true.
        • Update application_engine_configuration.database.oracle_url_without_wallet_directory (set in step c) to use Oracle SSL URL (URL 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 (URL format: (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)))) into 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 into application_engine_configuration.database.oracle_sso_wallet_secret_name. For more information, see Creating secrets to protect sensitive configuration data.
    • For PostgreSQL:
      1. Set application_engine_configuration.use_custom_jdbc_drivers to true.
      2. Set application_engine_configuration.database.type to PostgreSQL.
      3. Enter your PostgreSQL server hostname or IP into application_engine_configuration.database.host.
      4. Enter your PostgreSQL server port into application_engine_configuration.database.port.
      5. Enter your Application Engine database into application_engine_configuration.database.name.
      6. Enter your PVC for PostgreSQL JDBC driver into application_engine_configuration.database.custom_jdbc_pvc. For more information, see Implementing storage.
      7. If you want to connect your database by SSL, set application_engine_configuration.database.enable_ssl to true and put your database secret into application_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.
    For a full list of parameters, see IBM Business Automation Application Engine parameters.
  3. If you select Application Designer for optional components to deploy, see Configuring Business Automation Studio.
  4. If IBM Business Automation Application data persistence is enabled, you must complete the following steps:
    1. IBM Business Automation Application needs one object store from IBM FileNet® Content Manager. 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 FileNet Content Manager.
    2. Prepare your ibm-fncm-secret. For more information, see Creating secrets to protect sensitive IBM FileNet Content Manager configuration data.
      Important: Data persistence uses the appLoginUsername as the data persistence object store (AEOS) user. Ensure this user belongs to that object store administrator group.
  5. 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.