Child pages
  • Appendix C - Upgrading a License or Cluster
Skip to end of metadata
Go to start of metadata

This appendix describes how to upgrade your Netmail Store license and cluster nodes.

On this page:


Upgrading a License

When you add additional storage capacity, a new feature, or updated customer information, you may be required to update the Netmail Store license file. A license file is required to use the erasure coding and content indexing features.

All new license files must be issued by your sales representative or generated from the Licensing page in the CSN Console to ensure they have an electronic signature that is recognized and approved by Netmail Store. When updating an actively-running cluster with a new license file, the updated file must retain the same file name and be placed in the same location currently used by the cluster. This location is defined by the licenseFileURL parameter in the node or cluster configuration file.

The default location is the caringo directory of the local node's USB drive or centralized configuration server. If you are installing Netmail Store from a CSN, an updated license file is automatically placed in the correct location when the license file is published from the CSN Console.

Netmail Store checks the license file every 15 minutes. If the file is updated, Netmail Store validates the license and updates the customer information and/or licensed capacity as necessary. After a license is updated successfully on a running cluster, an announcement message appears once in the syslog and the admin console on each node. If a license update fails to validate a new license file, the cluster nodes will report a critical error message on both the console and in the syslog. If an update fails with a validation error, Netmail Store will continue to use the previous license file until the validation error is corrected.

Note: If the license file is located on an HTTP server that is not available when Netmail Store starts, Netmail Store analyzes the file for updates when it becomes available. Netmail Store may publish a corresponding update announcement in the syslog and the admin console, even if the file itself has not changed.

Upgrading the Netmail Store Software

Note: If you use a CSN, see the CSN Installation and Configuration Guide for additional information about upgrading your Netmail Store software on the CSN.

To upgrade your Netmail Store software, shut down all nodes in the cluster, upgrade the software, and reboot the nodes. If you cannot shut down the cluster due to business processes, you can perform a rolling upgrade.

For both upgrade procedures, prepare for the upgrade by locating your configuration information. When completed, ensure that all nodes are healthy and then plan your maintenance window activities.

Preparing for the Upgrade

To prepare for the upgrade:

1. Contact Netmail to obtain the upgraded Netmail Store software.

2. Locate your node configuration data, backup configuration files, and license files.

3. Prepare your node configuration data on new USB flash drives or on a centralized configuration server.

5. Verify the health of all cluster nodes.

6. Schedule an off-line window for the cluster down time.

Review the release notes included with the new boot devices prior to starting the cluster upgrade. The release notes contain information about feature changes, operational differences, and any issues that could impact how your Netmail Store cluster will process and store data.

You can remove USB flash drives from the running nodes to view and back up the configuration and license files. USB flash drives or the configuration server can be updated using the instructions in the README.txt file.

After all upgrades and validations are completed, you can return each USB flash drive to the node from which it was removed. Be sure to match each USB device to its original node in the cluster and make sure the vols parameter which defines the storage devices matches the correct node.

Before you perform any node upgrade, verify the cluster health by checking for critical error messages on the status page of each node or the SNMP CastorErrTable OID. This process ensures that no hardware problems exist that could interrupt the upgrade process. Any problems should be corrected prior to upgrading your cluster.

When upgrading a single node in your cluster, be sure to include the clusterSettingsUUID parameter value in the node or cluster configuration file prior to rebooting the node so the settings file can be located after the nodes reboot.

Upgrading the Cluster Nodes

To upgrade your cluster nodes:

1. Shut down all cluster nodes (or one at a time for a rolling upgrade).

2. Install the updated USB flash drives or updated ISO on your PXE boot server.

3. Reboot all nodes.

4. Verify that your cluster is operating normally.

A simultaneous shutdown of all cluster nodes is the first step in the simple upgrade. If your cluster cannot be shut down during normal business operations, the nodes can be rebooted one at a time in a rolling upgrade so the cluster remains online.

If you perform a rolling upgrade and a cluster node is off-line, the cluster will detect the missing node and the remaining nodes will try to recover the missing content. When the missing node is brought back online, the cluster detects the node and the recovery process will stop. To minimize node downtime and prevent the remaining nodes from filling their disks with recovered content, prepare USB flash drives with the upgraded version of Netmail Store for each node before you begin the upgrade.

If all the nodes are shut down within several seconds of each other, initiating the disk recovery process is not a concern. You may also choose to suspend volume recovery from the Setting pop-up on the admin console to prevent recovery from kicking off while nodes reboot into the new software version. For more information, reference Suspend.

Example Shutdown Script

This UNIX shell script demonstrates a method of issuing the shutdown command to all cluster nodes. In this example, all the nodes of the cluster are defined in the NODES variable.


for n in $NODES; do

snmpset –v 2c –c pwd –m +CARINGO-CASTOR-MIB $n \

caringo.castor.CastorShutdownAction = ”shutdown”


Cluster Reboot Procedure

After the cluster is shut down, make sure the updated USB flash drives, configuration server, or CSN is prepared and then begin the reboot process.

The recommended power-on sequence is:

1. Start a single node.

2. Verify that the node boots properly. This process verifies that the software loads correctly and the node can communicate with the network.

3. Repeat step 1 and step 2 on each remaining node in the cluster.

When you initially boot a node, the hpStartDelay parameter provides a 15-minute delay window by default for all nodes to boot up and join the cluster before Netmail Store begins to check for missing cluster nodes. As long as all nodes in the cluster are running within this window, rapid recovery operations are avoided.

This window only exists immediately following a node reboot. After 15 minutes, the recovery operations begin immediately after Netmail Store detects a missing node.

  • No labels