Upgrading clusters

Complete these steps to upgrade clusters in a network deployment environment.

About this task

After upgrading the deployment manager and the managed nodes containing cluster members, follow these steps to upgrade each of the clusters in your network deployment environment before starting the cluster members (servers).
Note: If minimum downtime is the objective during this upgrade, special precautions should be taken. These are documented separately in the topic "Upgrading clusters with minimum downtime."

Procedure

  1. Stop the deployment manager, if it is running.
  2. On the deployment manager, change directories to install_root.
  3. Run the following command for each cluster:
    • Windows
      • For English locales: bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName profile_name -Dupgrade=true -Dcluster=cluster_name
      • For non-English locales: bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName profile_name -Dupgrade=true "-Dcluster=cluster_name"
    • Linux Unix bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName profile_name -Dupgrade=true -Dcluster=cluster_name

    where profile_name is the name of the deployment manager profile and cluster_name is the name of the cluster.

  4. Check the following log file for errors: profile_root/logs/BPMProfileUpgrade.profile_name.cluster_name.timestamp.log where profile_root is the root directory of the deployment manager profile. If there is an error, fix the cause, then rerun Step 3.
  5. Optional: For DB2 on z/OS, set the parameter database.is.db2zos=true in the upgrade.properties file under installroot/BPM/Lombardi/tools/upgrade/upgrade_7x.
  6. Update the Process Server database for the cluster where the Business Process Definition engine (Application Cluster) is configured.
    • For distributed (non DB2® on z/OS®) database types, run the following command on the installation that hosts the deployment manager:
      • Windows BPM\Lombardi\tools\upgrade\UpgradeProcessData\upgradeProcessData.bat -profileName profile_name -nodeName node_name -serverName server_name
      • Linux Unix BPM/Lombardi/tools/upgrade/UpgradeProcessData/upgradeProcessData.sh -profileName profile_name -nodeName node_name -serverName server_name

      where profile_name is the name of the deployment manager profile, server_name is the name of the cluster member where Business Process Definition Engine is configured (this is generally referred as the Application Cluster member), and node_name is the name of the node where the cluster member is hosted. This command should be run only once per database, irrespective of the number of cluster members.

      If Performance Data Warehouse is configured on a different cluster, for example, when using one of the "Remote Support" topology patterns, you must also supply the -perfNodeName <pdw_node_name> and -perfServerName <pdw_server-name> parameters, where <pdw_node_name> is the name of any Performance Data Warehouse cluster node, and <pdw_server-name> is the name of any member of the Performance Data Warehouse cluster on that node. For example:
      upgradeProcessData.sh -profileName MyDMgr1  -nodeName TestNode1 -serverName  TestEnv.AppTarget.0 -perfNodeName TestNode1 -perfServerName TestEnv.Support.testNode14.0 

      For more information about the parameters that you can use with the upgradeProcessData command, see upgradeProcessData command-line utility.

    • If you are using DB2 on z/OS, you must manually alter a set of table spaces and upgrade the database schema before you upgrade the database data:
      1. To ensure that you can successfully run the SQL files for the DB2 for z/OS schema upgrade, alter the following table spaces to increase the buffer pool size to 8K:
        • WLPT36
        • WLPT44
        • WLPT64
        For information about altering table spaces, see
      2. From the install_root/profiles/profile_name/dbscripts/ProcessServer/DB2zOS/database_name directory, copy the script named upgradeSchema800_ProcessServer.sql to your working directory.

        Review the script, and, if necessary, edit the file to replace the following symbolic variables with the actual values for the schema name, database name, storage group, and buffer pool for large objects and tables: @SCHEMA@, @DB_NAME@, @STOGRP@, @BPLOB4K@, @BPTABLE4K@, and @BPTABLE8K@. Then connect to the DB2 for z/OS database, and run the script against the database by using your preferred tool.

      3. From the install_root/profiles/profile_name/dbscripts/PerformanceDW/DB2zOS/database_name directory, copy the script named upgradeSchema800_PerformanceDW.sql to your working directory.

        Review the script, and, if necessary, edit the file to replace the following symbolic variables with the actual values for the schema name, database name, storage group, and buffer pool for large objects and tables: @SCHEMA@, @DB_NAME@, @STOGRP@, @BPLOB4K@, @BPTABLE4K@, and @BPTABLE8K@. Then connect to the DB2 for z/OS database, and run the script against the database by using your preferred tool.

      4. Go to the [IBM_BPM_home]/BPM/Lombardi/tools/upgrade/UpgradeProcessData directory and set the database.is.db2zos property to true in the upgrade.properties file. For example:
        database.is.db2zos=true
      5. Run the following command on the installation that hosts the deployment manager:
        • Windows BPM\Lombardi\tools\upgrade\UpgradeProcessData\upgradeProcessData.bat -profileName profile_name -nodeName node_name -serverName server_name
        • Linux Unix BPM/Lombardi/tools/upgrade/UpgradeProcessData/upgradeProcessData.sh -profileName profile_name -nodeName node_name -serverName server_name

        where profile_name is the name of the deployment manager profile, node_name is the name of any cluster node, and server_name is the name of any member of the cluster on that node. For more information about the parameters that you can use with the upgradeProcessData command, see upgradeProcessData command-line utility.

        This topic applies only to the z/OS platformNote: If you are using IBM® Business Process Manager for z/OS and have set up symbolic links, additionally specify the -wasHome WAS_HOME parameter when you run the upgradeProcessData command.

    The upgradeProcessData command obtains the Process Server database information from the datasource configured for JNDI jdbc/TeamWorksDB and the Performance Data Warehouse database information from the datasource configured for JNDI jdbc/PDWDB.

    After completing this step, check for any errors in the logs saved under Profile/logs as upgradeProcessData_nodeName_serverName.0_timeStamp.log and bootstrapProcesServerData.AppClusteName.TimeStamp.log.

  7. This topic applies only to the IBM Business Process Manager Advanced configuration.If you have configured Business Process Choreographer, you must upgrade the BPEDB database manually to create the SCHEMA_STATUS table.
    1. Change to the directory where the Business Process Choreographer database scripts are generated. Run the following command on the installation that hosts the deployment manager:
      • Windows cd profile_root\dbscripts\ProcessChoreographer\db_type\db_name\schema_name
      • Linux Unix cd profile_root/dbscripts/ProcessChoreographer/db_type/db_name/schema_name

      where profile_root is the root directory of the deployment manager profile, db_type is the database type, db_name is the database name, and schema_name is the (possibly empty) schema name.

    2. If the database server is remote and you do not have a local database client, copy the upgradeSchema_SchemaStatus.sql script to the database server so that you can run it there.
    3. Run the upgradeSchema_SchemaStatus.sql script to create the SCHEMA_STATUS table in the Business Process Choreographer database. If the table already exists, there will be an error that you can ignore.
  8. When all clusters have been successfully upgraded, restart the deployment manager.
  9. If you have a four-cluster topology or a three-cluster topology, move the IBM_BPM_Process_Portal_Notification application from the Support cluster to the AppTarget cluster. If you do not do this, the collaboration function that is implemented within the application does not initialize properly when a coach is loaded. Complete the following steps:
    1. Open the administrative console on the deployment manager and go to Applications > Application Types > WebSphere enterprise applications.
    2. Click IBM_BPM_Process_Portal_Notification_supportClusterName, where supportClusterName is the name of the support cluster in the deployment environment.
    3. On the Configuration tab, click Manage Modules in the Modules section.
    4. In the Clusters and servers list box, select the name of the application cluster in the deployment environment.
    5. In the modules list, click Select All > Apply > OK.
    6. Save the configuration changes.
  10. This topic applies only to the z/OS platformFor each node in the cluster, manually update the profile as follows:
    1. From the install_root directory, run the following command:

      bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName profile_name -Dupgrade=true -Duser=userID -Dpassword=password

      where profile_name is the name of the profile (which on z/OS is default), userID is a user ID that has administration authority, and password is the password for that user ID.

    2. Check for any errors as explained in the "Identifying profile update errors" section of Recovering from profile update errors before continuing.
  11. For each node, restart the node agent, and wait for the node synchronization to complete.
  12. If you have disabled automatic synchronization, ensure that all of your nodes are correctly synchronized before starting the cluster members.
  13. Start all the servers and cluster members, as needed.