Installing the master domain manager and backup master domain manager

A fresh installation for the master domain manager and the backup master domain manager

About this task

This picture describes the steps required for installing the full HCL Workload Automation software stack. You are now at step 5: installing the master domain manager and backup master domain manager
Note: Automatic failover triggers a switch to a backup master domain manager without manual intervention under certain conditions. To take advantage of this feature, you must install the master domain manager and backup master domain managers with the same user. With a fresh installation of a master domain manager on Linux and UNIX, a new extended agent is installed on the master domain manager workstation which is used to communicate where to run the FINAL job stream. For information about configuring automatic failover, see Automatic failover.

Procedure to install a master domain manager and backup master domain manager

Before you begin

Before starting the installation, ensure the following steps have been completed:
  1. Installing WebSphere Application Server Liberty Base on the workstation where you plan to install the master domain manager and on the workstation where you plan to install the backup master domain manager.
  2. Creating and populating the database
  3. Creating the HCL Workload Automation administrative user
  4. Ensure you have created a license server and made a note of the server ID, which you will need when installing. For more information about enabling your product license, see Enabling product license management. For more information about creating and setting up the license server, see What is the HCL License & Delivery Portal (FlexNet Portal)?.
Note: When installing a backup master domain manager, the backup points to the existing HCL Workload Automation database. In this case, creating and populating the database is not required.

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 Master components installation - serverinst script.

You can optionally configure your environment in SSL mode, by using the --sslkeysfolder and --sslpassword parameters and generating automatically the certificates for each workstation in your environment.

The procedure to install the master domain manager and backup master domain manager is exactly the same, with the difference that it is performed on two different workstations and that each installation points to its local WebSphere Application Server Liberty Base installation. HCL Workload Automation determines whether or not a master domain manager is already present in the environment and proceeds to install a master domain manager or backup master domain manager accordingly.

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

Table 1. Required information

Required information for performing the installation
Command parameter Information type Provided in..
Database information
--rdbmstype database type Creating and populating the database
--dbhostname database hostname
--dbport database port
--dbname database name
--dbuser database user name
--dbpassword database password
HCL Workload Automation information
--wauser HCL Workload Automation administrative user name Creating the HCL Workload Automation administrative user
--wapassword 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 Base
Licensing information
--licenseserverid The ID of the license server which processes license usage information For more information about enabling your product license, see Enabling product license management. For more information about creating and setting up the license server, see What is the HCL License & Delivery Portal (FlexNet Portal)?

You can run the serverinst command specifying a typical set of parameters. In this case, default values are used for all remaining parameters. For more information about all serverinst parameters and default values, see Master components installation - serverinst script.

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 master domain manager and backup master domain manager, perform the following steps:

Procedure

  1. Log in as root or Administrator 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
--licenseserverid <license_server_ID>
--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
--licenseserverid <license_server_ID>
--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
    • oracle
    • ids (informix, only on 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 database 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.
    --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 alphanumeric, dash (-), underscore (_) characters, and ()|?=*~+.
    --wlpdir
    The path where WebSphere Application Server Liberty Base is installed.
    --licenseserverid
    The ID of the license server which processes license usage information. This parameter is required. For more information about enabling your product license, see Enabling product license management. For more information about creating and setting up the license server, see What is the HCL License & Delivery Portal (FlexNet Portal)?
    --sslkeysfolder
    The name and path of the folder, containing either the keystore (TWSServerKeyFile.jks) , the key database (TWSClientKeyStore.kdb), and the truststore (TWSServerTrustFile.jks, TWSClientKeyStoreJKS.jks) files, you need to provide when supplying custom certificates (only on UNIX operating systems), or certificates in .PEM format:
    • Only on UNIX operating systems, if you provide the keystore and truststore files, these files are used to configure SSL communication using the passwords you provide with the --keystorepassword and --truststorepassword respectively.
      Note: When installing using the keystore, key database, and truststore files, you are required to manually configure these files prior the installation setup. If providing custom .jks files, it is your responsibility to provide such .jks files equipped with all the CA certificates they need in the truststore. For these reasons, this procedure is not recommended.
    • If you provide .PEM certificates, the installation program automatically generates 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.
      • tls.key
        The private key for the instance to be installed.
      • tls.crt
        The public part of the previous key.

    You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA. 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.

    This parameter is required if you set the --dbsslconnection parameter to true.
    --sslpassword
    If you provide .PEM certificates with the --sslkeysfolder parameter, this is the password for the certificates automatically generated by the installation program. This parameter is mutually exclusive with the keystorepassword and truststorepassword parameters, which apply when you provide the keystore and truststore files using the sslkeysfolder parameter.
    Note: The values for the following parameters must match the values you provided when creating and populating the database:
    • --rdbmstype
    • --dbhostname
    • --dbport
    • --dbname
    • --dbuser
    • --dbpassword
    See Creating and populating the database, then follow the link to the database vendor you are using for more information about command parameters.
    Note: Before starting the deployment of a new master domain manager or backup master domain manager on an already used database, be sure that no failed plan creation/extension has been performed. If a failed plan creation/extension has been performed, resolve the failure before attempting the new deployment or unlock the database by running the planman unlock db command.
  4. To verify that the installation completed successfully, browse to the directory where you installed the 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 master domain manager and backup master domain manager.

If you want to customize more installation parameters, see FAQ - master domain manager and backup master domain manager customizations.

What to do next

You can proceed to Installing the Dynamic Workload Console servers.