Upgrading

How to upgrade HCL Workload Automation to the current version.

Overview

When upgrading your HCL Workload Automation environment, it is a good practice to start with the upgrade of the Dynamic Workload Console first. If you upgrade the console to the new product version level, you can then use it to verify that your environment is working after upgrading the remaining components.

You can choose between two upgrade methods:
direct upgrade
which applies from version 9.5.0.x to version 10.2.0.x. For more information, see Performing a direct upgrade from v 9.5.0.x to v 10.2.0.x.

To upgrade agents and domain managers, see Upgrading agents and domain managers.

parallel upgrade
which applies:

In a direct upgrade procedure, you upgrade the Dynamic Workload Console, then upgrade the domain managers and their backups, the dynamic domain manager and its backups, then master domain manager and its backups and finally the agents.

In a parallel upgrade, you upgrade the Dynamic Workload Console (if your previous version was 9.5.0.x) or install the Dynamic Workload Console at v 10.2.0.x (if your previous version was 9.4.x). You then proceed to upgrading the backup domain managers and domain managers. You then upgrade the database tables for the dynamic domain manager and its backups and install a new backup dynamic domain manager, switch the manager to the new backup, install a new backup and switch back the manager capabilities, so that the newly installed backup dynamic domain manager becomes the current dynamic domain manager.

You then proceed to upgrading the master domain manager database tables and running the serverinst script to install a version 10.2.0.x master domain manager configured as a backup. The installation process is able to detect the presence of an existing master domain manager and automatically configures the second one as the backup master domain manager. The new backup master domain manager is configured to point to the existing database instance. You then perform a switch with the previous version master domain manager, so that the newly installed backup master domain manager becomes the current active master domain manager.

You then install a second master domain manager to act as the new backup master domain manager. Each Dynamic Workload Console, backup dynamic domain manager, dynamic domain manager, master domain manager and backup master domain manager installation requires its own installation of Open Liberty. The upgrade process concludes with upgrading agents. Agents can be upgraded with minimal disruption to scheduling activities.

When upgrading, you can upgrade directly to the latest fix pack level, if available, by downloading the latest fix pack image, and launching one single command that automatically installs the latest product level. For more information, see Upgrading from the CLI.

Using the new features introduced with the latest release creates new records in the database which are not compatible with previous versions and therefore you cannot roll back your environment to a previous version.

If you upgrade HCL Workload Automation to version 10.2.0.x, and the HCL Workload Automation database was created with DB2, change the DB2 configuration parameter EXTENDED_ROW_SZ to ENABLE, or create a new buffer pool and table space with a page size of 16 kilobytes and migrate the tables to the new table space. For more information, see Error in upgrading the HCL Workload Automation database when using a DB2 database.

Before upgrading, ensure that you have stopped workload processing on the master domain manager.

Upgrading Prometheus and Grafana to the current version

To upgrade Prometheus and Grafana to version10.2 or later modify the prometheus.xml file using the latest mpMetrics version as follows:
<server>  
  <featureManager>
      <feature>mpMetrics-4.0</feature>
      <feature>cdi-3.0</feature>
      </featureManager>
     <mpMetrics authentication="false" />
</server>

Choosing how to upgrade your network

After upgrading the Dynamic Workload Console, there are different approaches to upgrading the remaining components in your HCL Workload Automation environment. Because HCL Workload Automation supports compatibility with earlier versions, after upgrading the console, you can decide to proceed with upgrading in one of the following ways, depending on the type of your network:

Top-down
Upgrade components in the following order:
  1. backup domain managers and domain managers
  2. dynamic domain managers
  3. backup master domain manager
  4. master domain manager
  5. agents
This order ensures that events involving folders are correctly managed by the master domain manager and sent to agents at a supported version level.

When you have a backup master domain manager at the V9.5 Fix Pack 2, or later, but the master domain manager is still at a previous product version level, problems can occur when monitoring objects that support the definition in a folder such as, prompts, workstations, and resources, as well as objects that contain the workstation in their object identifier, for example, job streams. More specifically these objects are not displayed in the results of the monitoring query on the plan if you use filters in your query. To solve this problem, upgrade the master domain manager to the V9.5 Fix Pack 2 level, or later, and then run planman resynch.

Many of the new functions that are introduced in the current version become available for each agent as it is upgraded. The disadvantage is that the same functions are not available to all agents at the same time.
Bottom-up
Upgrade components in the following order:
  1. agents
  2. backup domain managers and domain managers
  3. dynamic domain managers
  4. backup master domain manager
  5. master domain manager
The new functions that are introduced in the current version are not available until the whole network is upgraded.
Note: Due to new support of the UPN Windows user, if you have Windows domain users that are defined in the logon fields as domain\username, after performing an upgrade to this version, update the Security file before starting the HCL Workload Automation instance. Insert the escape character '\' before the '\' character in the domain\username value. For example, if you use the MYDOMAIN\user1 value in the logon field, after the upgrade, in the Security file you must update the line in following way:
..............
logon=MYDOMAIN\\user1
...............

For details, see Configuring the Security File.

Note: Custom events (in event rules) must be added manually after an upgrade.

When you upgrade, the “custom events” are not migrated.

You should add them manually as follows:

  1. 1: On MDM: $ evtdef dumpdef <file_name>

    where <file_name> is the name of a new XML file to where your custom events are saved.

  2. switchmgr to BKM

  3. Copy the file created in step 1 to BKM.

  4. On BKM: $ evtdef loaddef <file_name>

  5. Stop DWC Liberty

  6. Start DWC Liberty with "-directclean" option.

    <DWC_HOME>/appservertools/startAppServer.sh -directclean