Upgrading a Cluster

Prerequisites:

  • Before upgrading, be sure to read the release notes for the new version. The release notes contain a list of known issues, important compatibility information, supported upgrade paths, and module-specific data backup recommendations.
  • Apply all the latest updates available for your operating system, especially those that resolve issues with Java.
  • IMPORTANT: We recommend that you create a backup before upgrading so that you can recover your flows, security settings, and other settings, if an error occurs during the upgrade process.

This procedure is for upgrading a cluster where the Spectrum™ Technology Platform server and configuration database are installed on each node of the cluster. To upgrade a cluster, you upgrade one node at a time. The first node you upgrade is handled slightly differently than the other nodes because you must point the node to itself as a seed node since no other nodes will be running in the cluster when it starts up.

Note that these scenarios have special procedures for upgrading a cluster:
For this scenario... Use this information...
...have separate clusters for server nodes and configuration database nodes Upgrading a Cluster with a Separated Database.
…are upgrading a cluster for the Location Intelligence Module only Upgrading a Cluster with the Location Intelligence Module
...are upgrading both Spectrum and Location Intelligence Module clusters Upgrading a Cluster with the Location Intelligence Module
...are upgrading a cluster running the Data Hub Module Before shutting down all nodes, see Upgrading a Cluster with the Data Hub Module for some required pre-upgrade steps.
If the above scenarios do not apply to you, follow this procedure to upgrade your cluster:
  1. Back up the server. For instructions on creating a backup, see the Administration Guide.
  2. Stop all the nodes in the cluster. For more information, see Stopping a Cluster. When you stop all nodes of the cluster, manually, or if all nodes are down, you must start as a new cluster/session. To refresh, start node 1 of the cluster with spectrum.cluster.seeds IP address as node 1’s IP alone. Do not include other nodes' IP addresses when re-starting.
  3. On the last node that you stopped:
    1. Open the file server/app/conf/spectrum-container.properties in a text editor.
    2. In the spectrum.cluster.seeds property, remove all nodes except for the current node.
    3. Make a note of the nodes you remove so you can add them back later.
    4. Save and close spectrum-container.properties
    5. Upgrade the node. For more information, see Upgrading a Server.
    6. Open the file spectrum-container.properties in a text editor and configure the cluster properties. For more information, see Cluster Properties. Be sure to leave spectrum.cluster.seeds set to only the current node's IP address or host name.
      Note: Be aware that the container property definitions are dependent upon your server configuration and whether you are running clusters on Neo4j instances. Review the spectrum.repository.server.cluster.nodeCount property to determine the definitions for your setup.
  4. Upgrade each of the other nodes, one at a time. Follow this procedure only when upgrading nodes other than the first node.
    Note: Be sure to back up your server before proceeding. This step is only applicable when upgrading from Spectrum™ Technology Platform versions 11.1 or older.
    1. Add or ensure that you have set these properties:
      • spectrum.cluster.address – Specify the node’s IP address.
      • spectrum.cluster.nodeID – Set this to "1" on the first node, and this value will increase for subsequent nodes.
    2. Delete this folder, if present: SpectrumLocation\server\app\repository\store\databases
    3. Upgrade the node. For more information, see Upgrading a Server.
    4. Open the file spectrum-container.properties in a text editor and configure the cluster properties. For more information, see Cluster Properties. Save and close the file when you are done.
    5. Start the Server.
  5. After you have upgraded and started all the nodes, go back to the first node you upgraded, open spectrum-container.properties, and add the seed nodes you removed from spectrum.cluster.seeds.

You may find it necessary to stop nodes manually, as in the case of applying software updates. When you stop all nodes of the cluster manually, or if all nodes are down, you must start up as a new cluster/session. To refresh, start node 1 of the cluster with the spectrum.cluster.seeds IP address as node 1’s IP address only. Do not include other node's IP address at startup.