Planning an Upgrade

This topic explains how to plan an upgrade of VMware Tanzu GemFire.

Before you upgrade your system, back it up. Make backup copies of all existing disk-stores, server-side code, configuration files, and data across the entire cluster. To get a backup of the data that includes the most recent changes may require that traffic across the cluster is stopped before the backup is made.

For a description of the backup process, see Creating Backups for System Recovery and Operational Management.

For information about running the gfsh backup disk-store command, see the backup disk-store command reference page.

Note: When connected to a GemFire version 10.1 or later locator, if members running a GemFire version earlier than 10.1 exist in the cluster, issuing the backup disk-store command results in the following error message: "Backup only supports GemFire 10.1 and later. The following members are running on an earlier GemFire version."
When connected to a GemFire version 10.0 or earlier locator, the backup disk-store runs successfully even if other locators have been upgraded to 10.1 or later.

Guidelines for Upgrading

Schedule your upgrade during a period of low user activity for your system and network.
Verify that the machines hosting the cluster members meet the Host Machine Requirements of the upgraded cluster.
Important: After all locators have been upgraded, do not start or restart any processes that use the older version of the software. The older process will either not be allowed to join the distributed system or, if allowed to join, can potentially cause a deadlock.
Verify that all members that you wish to upgrade are members of the same distributed system cluster. A list of cluster members will be output with the gfsh command:
```
gfsh>list members
```
Locate a copy of your system’s startup script, if your site has one (most do). The startup script can be a handy reference for restarting upgraded locators and servers with the same gfsh command lines that were used in your current installation.
Identify how your current cluster configuration was specified. The way in which your cluster configuration was created determines which commands you use to save and restore that cluster configuration during the upgrade procedure. There are two possibilites:
- With gfsh commands, relying on the underlying cluster configuration service to record the configuration: see Exporting and Importing Cluster Configurations.
- With XML properties specified through the Java API or configuration files: see Deploying Configuration Files without the Cluster Configuration Service.
Do not modify region attributes or data, either via gfsh or cache.xml configuration, during the upgrade process.

Version Compatibilities

Before you upgrade GemFire to a newer version, confirm that your system meets the hardware and software requirements for the newer version described in Supported Configurations and System Requirements.

For best reliability and performance, all server components of a Tanzu GemFire system should run the same version of the software. For the purposes of a rolling upgrade, you can have peers or cache servers running different minor versions of VMware Tanzu GemFire at the same time, as long as the major version is the same. For example, some components can continue to run under version 9.10 while you are in the process of upgrading to version 9.15.

Upgrade to a Newer Version

VMware recommends that you upgrade to the newest version of VMware GemFire. Upgrade to a newer version in one of the following ways:

Rolling Upgrade: If possible, follow the Rolling Upgrade procedure. With a multi-site installation, you can perform a rolling upgrades within each site.
Off-Line Upgrade: If you cannot perform a rolling upgrade, follow the Off-Line Upgrade procedure.

Note
You cannot perform a rolling upgrade on a cluster that has partitioned regions without redundancy. Without the redundancy, region entries will be lost when individual servers are taken out of the cluster during a rolling upgrade.