Configuring database setup

Edit online

Configure database setup parameters in the Helm values file to initialize or upgrade the PEM database schema.

About this task

Before deploying PEM on OCP, you must configure the database setup parameters to either create a new database schema or upgrade an existing one.

Procedure

  1. Configure for new database installation

    When installing PEM on a new database that does not have the IBM PEM Essential Software schema tables and metadata:

    • Set dbsetup.upgrade to false
    • Set dbsetup.enabled to true

    This will create the required database tables and metadata in the database before installing the chart.

  2. Configure for database upgrade

    When installing the chart on a database with a new image upgrade:

    • Set dbsetup.upgrade to true
  3. Configure database connection parameters

    Set the following database connection parameters in the values file:

    • dbsetup.setupfile.db_type - Database type (DB2, Oracle, or MSSQL)
    • dbsetup.setupfile.db_host - Database host
    • dbsetup.setupfile.db_port - Database port
    • dbsetup.setupfile.db_name - Database name
    • dbsetup.setupfile.db_schema - Database schema name
    • dbsetup.setupfile.db_user - Database username
    • dbsetup.setupfile.db_password - Database password secret name
    • dbsetup.setupfile.db_driver - Database driver class name
  4. Configure SSL connection for database

    If using SSL connection between the application servers and database:

    • Set dbsetup.setupfile.ssl_connection to true
    • Specify dbsetup.setupfile.db_sslTrustStoreName
    • Specify dbsetup.setupfile.db_sslTrustStoresecret
    • Specify dbsetup.setupfile.db_sslTrustStorePassword
  5. Configure database connection pool parameters

    Configure the following connection pool parameters:

    • dbsetup.setupfile.db_max_pool_size - Maximum pool size (default: 500)
    • dbsetup.setupfile.db_min_pool_size - Minimum pool size (default: 5)
    • dbsetup.setupfile.db_aged_timeout - Maximum time before connection is discarded (default: 1440m)
    • dbsetup.setupfile.db_max_idle_time - Maximum idle time for connection (default: 1440m)
  6. Configure test mode database parameters

    Optionally configure test mode database parameters to start the following Docker containers: PEM Portal, Migrator, Master Key Regenerator, and DBUtils.

    Set the following test mode database connection parameters in the values file:

    • dbsetup.setupfile.testmode_db_host - Test mode database host
    • dbsetup.setupfile.testmode_db_port - Test mode database port
    • dbsetup.setupfile.testmode_db_name - Test mode database name
    • dbsetup.setupfile.testmode_db_schema - Test mode database schema name
    • dbsetup.setupfile.testmode_db_user - Test mode database user name
    • dbsetup.setupfile.testmode_db_password - Test mode database password secret name
    • dbsetup.setupfile.testmode_db_driver - Test mode database driver class name

    Configure the following test mode database connection pool parameters:

    • dbsetup.setupfile.testmode_db_max_pool_size - Maximum pool size (default: 500)
    • dbsetup.setupfile.testmode_db_min_pool_size - Minimum pool size (default: 5)
    • dbsetup.setupfile.testmode_db_aged_timeout - Maximum time before connection is discarded (default: 1440m)
    • dbsetup.setupfile.testmode_db_max_idle_time - Maximum idle time for connection (default: 1440m)

    If using SSL connection between the application servers and test mode database:

    • Specify dbsetup.setupfile.testmode_db_sslTrustStoreName - Test mode database SSL truststore file name
    • Specify dbsetup.setupfile.testmode_db_sslTrustStoresecret - Test mode database SSL truststore secret name
    • Specify dbsetup.setupfile.testmode_db_sslTrustStorePassword - Test mode database SSL truststore password secret name