Upgrade

Edit online

Upgrading is performed from the Settings tab. The upgrade process supports n-2 upgrades, which means the starting point of a direct upgrade is a release version whose second digit differs by less than or equal to two. Contact IBM® Customer Support for further information.

Upgrading is based on the concept of a single upgrade queue, containing the devices to be upgraded. A device selected for upgrade is placed in a queue and upgraded, while ensuring the health of the vaults across the system are not compromised. Before a device upgrade, the Manager application tests to see whether the health of any of the vaults that are associated with the device are negatively impacted if the device goes down. Upgrade can be performed on a single device, a handful of devices, or an entire access/storage pool. Checks will be performed to ensure that a device comes back online correctly after upgrade.

Note: When upgrading to a new version of ClevOS, some incidents are automatically closed and reopened if they still exist after upgrade.

Note: Protection cannot be enabled on a vault or container until all devices that will host the protected vault or container have been upgraded to ClevOS 3.14.1 or newer.

In a typical device upgrade, the state transitions as follows:

Table 1. Typical device upgrade state transitions
State transitions	Detail
Requiring	The device software version differs from the Manager device.
Enqueuing	The command to upgrade this device is sent, but a status update has not been performed. Status updates occur every 10 seconds.
Precheck	The device is performing a pre-upgrade consistency check to ensure that the system is capable of being upgraded.
Precheck Failed	When a precheck fails, this status appears and remains until the device is upgraded again. Reloading the page removes this status.
Pending	The device is added to the upgrade queue.
Initiated	The device has begun the upgrade process.
Downloading	The upgrade package is copied to the device.
Stopping	The command to stop the device process has been issued.
Capturing Integrity	The device is capturing integrity state that will be used after upgrading the device to ensure the upgrade completed successfully.
Rebooting	The device is being rebooted with a new software version.
Verifying Integrity	The device is verifying that it upgraded successfully.
Success	All data integrity checks passed and the correct version of the software is confirmed.
Failure	The device did not pass the data integrity checks and the correct version of the software is not confirmed.
Current	The device has the most recent software version.

Prechecks are performed before adding devices into the upgrade queue. During an upgrade, several scenarios can occasionally occur that require operator intervention. As part of an upgrade, various options are presented to the user if unexpected conditions arise during a device upgrade. In particular, the following scenarios might arise:

Pre-checks can fail.
Device upgrade takes longer than expected.
Device processes take longer than expected to stop.
General issues arise during a device upgrade.

If problematic devices exist within a pool, a message appears. An exclamation point (icon) appears on the left side of the page. It indicates that user intervention is needed on that pool.

If the device does not upgrade successfully, an icon appears with an alert message on the same page; manual intervention is needed. The device can be removed from the upgrade queue and the upgrade retried. Remove applies to a single device in the Pending or Failure state. A Remove button exists to the right of the device (right portion of the upgrade page), which when selected removes the device from the upgrade queue. After a device is removed, the status will be Requiring. Upgrade is attempted only if vault health will not be compromised. Problems encountered when software updates fail are identified through messages.

Upgrade detects circumstances in which device processes cannot be stopped in a timely manner. When detected, an icon appears, and a Force Kill button is displayed. If selected, upgrade forces termination of the process.

Upgrade also detects scenarios where restart, download, or integrity verification take longer than expected. If this occurs, the device can be removed from the upgrade queue by using the Force Removal button.

Note: Integrity failures result in an incident appearing in the Open Incidents view.

Note:

If IE is being used to upgrade, set the following option:

Go to Internet Options. It is available from Tools (IE8) or a circular settings icon (IE9).
In the General tab, select Settings | Browsing history.
In the pop-up window for the Check for newer versions of stored pages section, select the Every time I visit the webpage option.

The high-level procedure consists of the following steps:

Transfer the upgrade compressed file to the machine running the browser. (See alternative procedure in the note below.)
Browse and upload one upgrade compressed file from the Upgrade page. (See alternative procedure in the note below.)
Note: In systems with multiple Manager devices, the upgrade file only needs to be uploaded to one of the Manager devices.
Initiate the Manager upgrade from the System Software Upgrade page. In systems with multiple Manager devices, upgrade can only be initiated from one Manager device at a time. You cannot proceed to upgrade other device types until all Manager devices are upgraded.
Note: Perform a backup of the Manager database before continuing. At the end of the upgrade, log back in to the Manager.
Initiate the upgrade of the remaining devices from the Upgrade page. In systems with multiple Manager devices, upgrade can only be initiated from one Manager device at a time.

In some circumstances, a desirable alternative to Steps 1 and 2 is to transfer the image file directly to the Manager device from an alternative source machine. It is beneficial when the operator is working over a low-bandwidth connection (for example, wifi or trans-continental) for which the upload time of the upgrade image is prohibitive. In such cases, the operator can log in to a jump host elsewhere on the network that already contains the upgrade image and send it directly to the Manager device. The following curl command accomplishes this:

$ curl --insecure -u <ADMIN_USERNAME> -F upgradeFile=@<UPGRADE_IMAGE> -F action=installUpgradeFile 
https://<MANAGER_IP>/manager/upgrade.adm

Table 2. Description of Options
Option	Description
`—insecure`	Manager device certificate does not need to verify as the Upgrade file is not secret information.
`-u <ADMIN_USERNAME>`	Administrative user name
`-F upgradeFile=@<UPGRADE_IMAGE>`	Upgrade image to send to the manager.
`-F action=installUpgradeFile`	Manager device extracts the provided file to disk.
`(https://<MANAGER_IP>/manager/upgrade.adm)`	URL of the upgrade page.

When run, the command prompts for the password that is associated with the specified user.

To determine the current version of the system, go to the Settings tab in the Manager Web Interface.

Before clicking Upgrade, the upgrade compressed file that is provided with the release needs to be copied to the machine running the browser.

From the Settings tab, navigate to Operations > System Software Upgrade.

The System Software Upgrade page shows three steps:

Upgrade File Upload
Browse for the upgrade file and click Upload on the Upgrade page.

Note: In systems with multiple Manager devices, the upgrade file only needs to be uploaded to one of the Manager devices.

Note: Only one upgrade file can be uploaded to the Manager at a time. If another file is uploaded during an upgrade, an error message appears until the page is reloaded.
Note: The behavior of the upload progress is different based on the browser:
- Firefox and Internet Explorer display an upload progress bar in the Manager Web Interface.
- Chrome and Safari do not show a progress bar. The browser window displays progress.
Manager Upgrade
Click Start Upgrade.
Note: In systems with multiple Manager devices, click Upgrade next to the Manager device on which you are logged in. While one Manager device is upgrading, the other Manager device cannot initiate upgrades. Once the first Manager device completes upgrading, click Upgrade next to the second Manager device.

Note: You will not be able to start the upgrade if Software Signature Verification is enabled and the upgrade file can not be verified. If this occurs, contact IBM Customer Support.

Attention: Do not restart the Manager while upgrade is in progress. Manager upgrade takes approximately 15 minutes. If the upgrade takes longer, contact IBM Customer Support.

After all Manager devices are upgraded, a dialog box appears. Click Log back into the manager to return to the log in page.
Note: When you upgrade the Manager to ClevOS 3.10.1 or later, it might not be possible to log in immediately since an extra 20 - 30 minutes might be needed for the Manager application to become available. On systems with large databases, the time might be longer. Contact Customer Support if it takes longer than 30 minutes to successfully log in to the Manager.
1. If a backup is configured for this Manager, go to Step G.
2. If the Upgrade has new End User License Agreements (EULA), then Accept License Agreement to Continue is made available for the user under Step 3 - Upgrade Devices, which on click, displays an IBM standard and non-IBM End User License Agreements (EULA) in a pop-up window similar to the End User License Agreement figure shown. The user needs to complete the Print Name (License Acceptor) field and check the appropriate box and click Accept IBM & non-IBM Licenses to accept the EULA, otherwise, device upgrades are not allowed.
3. If no backup configuration is created for this Manager, you are prompted to configure the backup, or upgrade without performing a backup.
  Attention: IBM strongly recommends that the Manager is backed up before upgrade to ensure preservation of Manager data.
  
  Click Configure backup.
4. On the Backup Configuration screen, specify encryption and FTP values as prompted and click Configure in the Backup Configuration action bar.
  It is also possible to perform a manual backup from the Settings tab, but when you return to the upgrade step you are prompted again to configure the backup or upgrade without performing a backup. Then, you can select to upgrade without performing backup.
5. Refer to https://www.ibm.com/docs/en/coss/3.18?topic=manager-set-backup-configuration-parameters for how to configure the backup parameters. On completion of the Backup Configuration, return to the Upgrade page by clicking the Settings tab and navigating to Operations > System Software Upgrade.
6. Click Start Upgrade.
7. A prompt offers the option to back up the Manager or cancel the operation. Click Backup Manager Now.
8. On completion of the backup, you are prompted to proceed with the upgrade or cancel the operation. Click Proceed with Upgrade.
9. The Manager will now be upgraded. Status updates are presented in the dialog box.
  Once the upgrade is verified, the button allowing you to log back in to the Manager Web Interface is enabled. Click Log back into the Manager Web Interface.
  
  Note: When you upgrade the Manager to ClevOS 3.10.1 or later, it might not be possible to log in immediately since an extra 20 - 30 minutes might be needed for the Manager application to become available. On systems with large databases, the time might be longer. Contact Customer Support if it takes longer than 30 minutes to successfully log in to the Manager.
10. The Manager home page displays a banner at the top of the page that indicates there are devices in the system running a different version of software and provides a link.
  Click this link to proceed to the Upgrade page.
11. The Manager upgrade portion of the UI shows the upgraded version of the Manager device or devices and reports that no upgrade is available.

Upgrade Pools

Accesser® devices are grouped by Access Pool. Slicestor® devices are grouped by Storage Pool, and devices that are not associated with any particular pool are placed in their own group "Devices not in a storage pool or access pool." At the left of the page, for a storage pool in which all devices are to be upgraded, the following options are available: "Upgrade Entire Storage Pool," "Upgrade Entire Set," or "Upgrade" a single device. Similarly, for an access pool, the following options are available: "Upgrade Entire Access Pool" or "Upgrade" a single device. For "Devices not in a storage pool or access pool," the following options are available: "Upgrade All Devices Not in a Pool" or "Upgrade" a single device. Upgrade is possible when the status is Requiring, Pre-check Failed, or Failure.

Note: Vault access (unavailable) events will be generated after an Accesser device upgrade completes if the core process is down, particularly in single Accesser device configurations.

Table 3. Supported Operations for Upgrade All Devices
Operation	Action
Upgrade All	The "Upgrade All" button is enabled if there are 1 or more devices that are not in the Pending or Failure state.
Remove All	The "Remove All" button applies to all devices in the Pending or Failure state.

Table 4. Supported Operations for Upgrade Storage Pools
Operation	Action
Upgrade Pool	The "Upgrade Pool" button is enabled if there are 1 or more devices in the storage pool that are not in the Pending or Failure state.
Remove Pool	The "Remove Pool" button is enabled if there are 1 or more devices in the storage pool that are in the Pending or Failure state.
Upgrade Set	The "Upgrade Set" button is enabled if there are 1 or more devices in the storage pool set that are not in the Pending or Failure state.
Remove Set	The "Remove Set" button is enabled if there are 1 or more devices in the storage pool set that are in the Pending or Failure state.
Upgrade Devices Step
Upgrade Entire Set	The "Upgrade Entire Set" button is enabled if there are 1 or more devices in the storage pool set that are not in the Pending or Failure state, and require an upgrade.
Remove Entire Set	The "Remove Entire Set" button is enabled if there are 1 or more devices in the storage pool set that are in the Pending or Failure state, and require removal.
Upgrade	The "Upgrade" button is enabled if the storage pool device is displaying a "requiring" status.
Remove	The "Remove" button is enabled if the storage pool device is displaying a "pending" status.

Table 5. Supported Operations for Upgrade Access Pools
Operation	Action
Upgrade Pool	The "Upgrade Pool" button is enabled if there are 1 or more devices in the access pools that are not in the Pending or Failure state.
Remove Pool	The "Remove Pool" button is enabled if there are 1 or more devices in the access pools that are in the Pending or Failure state.
Upgrade Devices Step
Upgrade Entire Access Pool	The "Upgrade Entire Access Pool" button is enabled if there are 1 or more devices in the access pool that are not in the Pending or Failure state, and require an upgrade.
Remove Entire Access Pool	The "Remove Entire Acces Pool" button is enabled if there are 1 or more devices in the access pool that are in the Pending or Failure state, and require removal.
Upgrade	The "Upgrade" button is enabled if the access pool device is displaying a "requiring" status.
Remove	The "Remove" button is enabled if the access pool device is displaying a "pending" status.

See the section on Upgrade settings configuration for supported operations when changing the upgrade settings.

Change in Manager Properties Upon Upgrade
During upgrades, the default value for "Object Access" is decided based on the following rules:
1. If the dsNet has no vaults, read and listing option are selected.
2. If the dsNet has only standard vaults, read and listing option are selected.
3. If the dsNet has only container vaults
  1. If at least one of the container vaults was migrated from a standard vault (vault → container mode migration), read and listing option will be selected. Containers that were not migrated from standard vaults will be migrated from "only list" to "read and list" which means additional S3 clients may have access to existing objects.
  2. Otherwise, "Only list" option is selected.