Upgrading BMC Digital Workplace Catalog in a server group

If you are running BMC Digital Workplace Catalog on multiple servers in a cluster to enable high availability, you can upgrade all servers in the cluster to BMC Digital Workplace Catalog 20.02 without disrupting your business. The BMC Digital Workplace Catalog non-disruptive upgrade process ensures that you do not lose the data from user requests and running processes.

The following sections describe changes to the functions of a load balancer in a cluster and how to perform the upgrade.

Related topics

System requirements

Downloading the BMC Digital Workplace Catalog upgrade files

Cluster environment before the BMC Digital Workplace Catalog upgrade

A typical cluster installation comprises a primary server that is used for all administrative operations, and a group of secondary servers that process all the end user requests through the BMC Digital Workplace application. All servers in the cluster share the database associated with the primary server, as shown in the following illustration.

digitalworkplace_catalog_high_availability_3.3.00.001

Label	Description
	The primary server runs BMC Digital Workplace Catalog and is connected to the database. Catalog administrators can only perform administrative operations for managing the catalog on the primary server.
	Each secondary server runs BMC Digital Workplace Catalog and shares the same database as the primary server. BMC Digital Workplace Catalog administrators cannot perform administrative operations to manage the catalog on the secondary servers.
	The load balancer distributes the network traffic across each secondary server to fulfill end user requests submitted through the BMC Digital Workplace application.

Cluster environment after the upgrade to BMC Digital Workplace Catalog 18.02.00 or later

After you upgrade BMC Digital Workplace Catalog to 18.02.00 or later on all the servers, the primary server and all secondary servers still share the same database. However, the upgraded primary server and all secondary servers can process administrative operations as well as end user requests through the BMC Digital Workplace application, as shown in the following illustration.

Label	Description
	The primary server runs BMC Digital Workplace Catalog 18.02 or later, and is connected to the database. The primary server is part of the cluster.
	Each secondary server runs BMC Digital Workplace Catalog 18.02 or later, and shares the same database as the primary server.
	The load balancer shares the network traffic across each of the servers in the cluster to fulfill end user requests submitted through the BMC Digital Workplace application.
	The BMC Digital Workplace Catalog upgrade to 18.02 or later, enables BMC Digital Workplace Catalog administrators to perform administrative operations to manage the catalog by logging in to the BMC Digital Workplace Catalog application by opening the URL of the load balancer. The load balancer can share administration tasks across each of the servers in the cluster.

Before you begin

Perform the following tasks to prepare your environment for upgrading BMC Digital Workplace Catalog in a cluster.

Note

When you upgrade BMC Digital Workplace Catalog in a cluster, you must upgrade each server individually until all the servers have been upgraded.

Task	Action	Reference
1	Back up the database, system files and folders, and additional configuration files for each server.	Preparing a system for a BMC Digital Workplace Catalog upgrade
2	Create a configuration options text file for each server based on the values that you collected in the upgrade worksheet.	Creating a BMC Digital Workplace Catalog upgrade options file
3	Notify BMC Digital Workplace Catalog administrators to log out of the system. Catalog administrators cannot perform administrative operations (such as creating services, importing services, or developing workflows) until after the upgrade is finished.	(Not applicable)

When you upgrade BMC Digital Workplace Catalog on the primary server, you must modify the server configuration before and after the upgrade, as described in the following sections.

To prepare the BMC Digital Workplace Catalog primary server for the upgrade

Perform the following tasks to remove the primary server from the cluster temporarily so that you can upgrade BMC Digital Workplace Catalog.

Log in to the primary server with the credentials of the user account that will perform the upgrade.
Open the ar.conf file in a text editor. If you installed BMC Digital Workplace Catalog in the default location, run the following command:
Example of opening the vi text editor to edit the ar.conf file
```
vi /opt/bmc/digitalworkplace/conf/ar.conf
```
Search for the Server-Group-Member parameter, and set the value to F. Only the primary server must be removed from the cluster before the upgrade.
Restart the primary server for the setting to take effect. For example, if you installed BMC Digital Workplace Catalog in the default location, run the following commands to stop and restart the server. Replace the user name Demo and the password Passw0rd! with your system credentials.
```
$ /opt/bmc/digitalworkplace/dwpcontroller stop

(... wait for the console to stop displaying messages ...)

$ /opt/bmc/digitalworkplace/dwpcontroller start -u Demo -p Passw0rd!
```

To upgrade BMC Digital Workplace Catalog on the primary server

Perform the following steps to upgrade the BMC Digital Workplace Catalog primary server with the upgrade options file that you created for the primary server.

Extract the files from the upgrade archive package. For instructions, see Extracting the downloaded archive.
On the Linux server, find the directory where you extracted the installation files.
Run the upgrade script and specify the upgrade options file. For more information, see Creating a BMC Digital Workplace Catalog upgrade options file.
Command to run the upgrade script and load an upgrade options file
```
./upgrade-digitalworkplace.sh -o myoptions.txt
```
Tip

If you want to use the configuration wizard to create a new options file, run the above command without specifying the upgrade options file. Follow the prompts to proceed with the upgrade.
If you specified the options file, the following message will be displayed. Enter y to validate your options file, and enter n to skip the validation and proceed with the next step.
Would you like you validate your options file using the DWPCatalog Configuration Wizard
After you read and accept the End User License Agreement (EULA), the upgrade process begins.
The system will report if the upgrade succeeds or fails. If the upgrade fails, review the error message and the log files to troubleshoot the problem.

To reset the BMC Digital Workplace Catalog primary server to be part of the cluster

Log in to the primary server with the credentials of the user account that performed the upgrade.
Open the ar.conf file in a text editor. If you installed BMC Digital Workplace Catalog in the default location, run the following command:
Example of opening the vi text editor to edit the ar.conf file
```
vi /opt/bmc/digitalworkplace/conf/ar.conf
```
Search for the Server-Group-Member parameter, and set the value back to T.
Restart the primary server for the settings to take effect. For example, if you installed BMC Digital Workplace Catalog in the default location, run the following commands to stop and restart the server. Replace the user name Demo and the password Passw0rd! with your system credentials.
Example of stopping and restarting the BMC Digital Workplace Catalog 3.3.02 server
```
$ /opt/bmc/digitalworkplace/dwpcontroller stop

(... wait for the console to stop displaying messages ...)

$ /opt/bmc/digitalworkplace/dwpcontroller start -u Demo -p Passw0rd!
```

To upgrade each of the BMC Digital Workplace Catalog secondary servers in the cluster

You do not need to modify the configuration of the secondary servers. Proceed to upgrade BMC Digital Workplace Catalog on each secondary server one after another. The BMC Digital Workplace Catalog cluster will still process end user requests through the BMC Digital Workplace application by reading the cached data on the secondary servers that have not yet been upgraded.

Extract the files from the upgrade archive package. For instructions, see Extracting the downloaded archive.
On the Linux server, find the directory where you extracted the installation files.
Run the upgrade script and specify the upgrade options file. For more information, see Creating a BMC Digital Workplace Catalog upgrade options file.
Command to run the upgrade script and load an upgrade options file
```
./upgrade-digitalworkplace.sh -o myoptions.txt
```
Tip

If you want to use the configuration wizard to create a new options file, run the above command without specifying the upgrade options file. Follow the prompts to proceed with the upgrade.
If you specified the options file, the following message will be displayed. Enter y to validate your options file, and enter n to skip the validation and proceed with the next step.
Would you like you validate your options file using the DWPCatalog Configuration Wizard
After you read and accept the End User License Agreement (EULA), the upgrade process begins.
The system will report if the upgrade succeeds or fails. If the upgrade fails, review the error message and the log files to troubleshoot the problem.