Installing a new backup master domain manager

Installing the new backup master domain manager

Before you begin

Before beginning the installation, ensure you have converted the certificates, as described in Converting default certificates.

About this task

You can perform a typical installation, as described in the following scenario, or you can customize the installation parameters, as described in FAQ - master domain manager and backup master domain manager customizations.

For more information about all serverinst parameters and default values, see Server components installation - serverinst script.

The procedure to install the backup master domain manager is exactly the same as installing a master domain manager. The backup master domain manager is installed on a workstation different from the master domain manager and points to its local WebSphere Application Server Liberty Base installation. HCL Workload Automation detects the presence of an existing master domain manager in the environment and proceeds to install a backup master domain manager.

The HCL Workload Automation administrator installs the master domain manager. The following information is required:

Table 1. Required information

Required information for performing the upgrade

Command parameter Information type Provided in..
HCL Workload Automation information
--wauser HCL Workload Automation administrative user name Creating the HCL Workload Automation administrative user
--wapassord HCL Workload Automation administrative user password
WebSphere Application Server Liberty Base information
--wlpdir WebSphere Application Server Liberty Base installation directory Installing WebSphere Application Server Liberty
Security information
--sslkeysfolder location of converted certificates Converting default certificates
--sslpassword password of converted certificates Converting default certificates

You can run the serverinst command specifying a typical set of parameters. In this case, default values are used for all remaining parameters.

Default values are stored in the serverinst.properties file, located in image_location/TWS/interp_name.

If you need to modify any of the default values, edit the serverinst.properties file, but do not modify the serverinst.template file located in the same path.

To install the backup master domain manager, perform the following steps:

Procedure

  1. Log in to the workstation where you plan to install.
  2. Browse to the folder where the serverinst command is located in image_location/TWS/interp_name.
  3. Start the installation specifying a typical set of parameters. In this case, default values are used for all remaining parameters:
    On Windows operating systems
    cscript serverinst.vbs --acceptlicense yes --rdbmstype <db_type>
        --dbhostname <db_hostname> --dbport <db_port> --dbname <db_name>
        --dbuser <db_user> --dbpassword <db_password> --wauser <wa_user>
        --wapassword <wa_password> --wlpdir <Liberty_installation_dir>\wlp
        --sslkeysfolder <certificate_files_path> --sslpassword <keystore_truststore_password>
    On UNIX operating systems
    serverinst.sh --acceptlicense yes --rdbmstype <db_type>
            --dbhostname <db_hostname> --dbport <db_port> --dbname <db_name>
            --dbuser <db_user> --dbpassword <db_password> --wauser <wa_user>
            --wapassword <wa_password> --wlpdir <Liberty_installation_dir>/wlp
            --sslkeysfolder <certificate_files_path> --sslpassword <keystore_truststore_password>
    where
    acceptlicense
    Specify yes to accept the product license.
    rdbmstype|-r rdbms_type
    The database type. Supported databases are:
    • DB2
    • ORALE
    • IDS (Informix), only for UNIX operating systems
    • MSSQL
    This parameter is optional. The default value is db2.
    dbhostname db_hostname
    The host name or IP address of database server.
    dbport db_port
    The port of the database server.
    dbname db_name
    The name of the HCL Workload Automation database.
    dbuser db_user
    The user that has been granted access to the HCL Workload Automation tables on the database server.
    dbpassword db_password
    The password for the user that has been granted access to the HCL Workload Automation tables on the database server. Special characters are not supported.
    wauser user_name
    The user for which you are installing HCL Workload Automation.
    wapassword wauser_password
    The password of the user for which you are installing HCL Workload Automation.
    On Windows operating systems
    Supported characters for the password are alphanumeric, dash (-), underscore (_) characters, and ()|?*~+.@!^
    On UNIX operating systems
    Supported characters for the password are any alphanumeric, dash (-), underscore (_) characters, and ()|?=*~+..
    wlpdir
    The path where WebSphere Application Server Liberty Base is installed.
    --sslkeysfolder keystore_truststore_folder
    The name and path of the folder containing certificates in .PEM format. The installation program automatically processes the keystore and truststore files using the password you specify with the --sslpassword parameter. The folder must contain the following files:
    • ca.crt
      The Certificate Authority (CA) public certificate. Note that if certificates being installed are part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then this file must contain the Root CA certificate only. Any Intermediate CA certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.
    • tls.key
      The private key of the end user certificate for the instance to be installed.
    • tls.crt
      The public part of the previous key, that is the end user certificate.

    You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA, whose name must be additionalCAs. This can be used for example to add to the list of trusted CAs the certificate of the LDAP server or DB2 server. Additionally, you can store here any intermediate CA certificate to be added to the truststore. The subfolder must be named additionalCAs. Note that if the end user certificate being installed in the instance is part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then the Intermediate CAs certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.

    --sslpassword ssl_password
    You can use this parameter to define the password for either default or custom certificates, as follows:
    • If you want HCL Workload Automation to generate default certificates, provide the password to be used for the default certificates. HCL Workload Automation generates the certificates and stores them on the master domain manager in the installation_directory/defaultCerts and TWA_DATA_DIR/ssl/depot directories. You can then use the TWA_DATA_DIR/ssl/depot to retrieve the default certificates for the other product components.
    • If you want HCL Workload Automation to process custom certificates, provide the password for the custom certificates and the path to the folder containing certificates in .PEM format with the sslkeysfolder parameter. To process custom certificates, the sslkeysfolder parameter is required.

    For more information, see sslkeysfolder.

    You can optionally encrypt the password using the secure script. For more information, see Optional password encryption - secure script.
  4. To verify that the installation completed successfully, browse to the directory where you installed the backup master domain manager and type the following commands:
     . ./tws_env.sh
    optman ls

    This command lists the HCL Workload Automation configurations settings and confirms that HCL Workload Automation installed correctly.

Results

You have now successfully installed the backup master domain manager and it is inserted in the next production plan. To have the backup domain manager added immediately to the production plan, run
JnextPlan -for 0000

What to do next

You can now proceed to Configuring security or to Uninstalling the back-level backup master domain manager.