Upgrading a Cluster - spectrum_platform - 23 - 23.1

Spectrum Installation Guide for Windows

Product type
Product family
Spectrum > Spectrum Platform
Product name
Spectrum Technology Platform
Spectrum Installation Guide for Windows
Topic type
How Do I
First publish date
  • 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.
  • Important: If you upgraded to Spectrum Technology Platform 2022.1 from an earlier version of Spectrum, you must reindex the Spectrum 2022.1 search indexes before you upgrade to Spectrum Technology Platform 2023.1. For instructions how to do this, see Reindex 2022.1 Search Indexes before upgrading to 2023.1 under Upgrading you Installation.
  • Make sure that you follow the appropriate upgrade path for the currently installed version of Spectrum that you want to upgrade.
  • 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 if an error occurs during the upgrade you can recover your flows, security settings, and other settings and customizations.

    To retain customized settings in the wrapper.conf file located in the SpectrumDirectory\server\bin\wrapper directory, you will need to compare the contents of wrapper.conf installed during the upgrade with the contents of the backed up copy of the file. Before upgrading make sure you have backed up all models and property files. You can then manually copy customizations that you want to retain after the upgrade into the updated version of the file. This is particularly important for changes to the initial and maximum Java heap sizes. This release requires Java 11, so corresponding updates to JVM properties should be used.

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.

The following scenarios have special procedures for upgrading a cluster.

For this scenario Use this information
Separate clusters for server nodes and configuration database nodes Upgrading a Cluster with a Separated Database.
Upgrading a cluster for Spatial only Upgrading a Cluster with Spatial
Upgrading both Spectrum and Spatial clusters Upgrading a Cluster with Spatial
Upgrading a cluster running Context Graph Before shutting down all nodes in the cluster, see Upgrading a Cluster with Context Graph.

If none of the scenarios apply to your installation of Spectrum, complete the following steps to upgrade your cluster.

  1. Back up the server.
    For instructions on creating a backup, see the Administration Guide.
  2. Back up module-specific data for any of these modules if you have them installed. The following module sections may also contain other information that you should read before upgrading.
  3. Stop all the nodes in the cluster.
    For more information, see Stopping a Cluster.
  4. Check that all Spectrum Java processes on each machine are stopped before you start the upgrade.
    Note: If you have Global Sentry installed, stop the Global Sentry database server by opening the Windows Services Manager and stopping the Global Sentry Database Server service.
  5. Upgrade each node in the cluster.
  6. On each node, perform the following steps.
    1. Open the file SpectrumDirectory\server\conf\spectrum-container.properties in a text editor and configure the cluster properties.
      For more information, see Cluster Properties.
      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.
    2. Open the file SpectrumDirectory\index\opensearch.template and scroll down to the Node Address section.
      • Remove the hash character # to uncomment the following line
        cluster.initial_master_nodes: ${seeds}

        Then edit it to specify the node names in the cluster:

        cluster.initial_master_nodes: node-1,node-2,node-3,...
        Important: This setting must be uncommented when you start the upgraded cluster for the first time.
      • Insert the hash character # to comment out the following line:
        #discovery.type: single-node
    3. Confirm the following settings on each node in the cluster.
      • SpectrumDirectory\repository\neo4j.template
        dbms.default_listen_address= causal_clustering.discovery_advertised_address=${spectrum.agent.address}
        dbms.routing.listen_address= dbms.routing.advertised_address=${spectrum.agent.address}
  7. Check again that all Spectrum Java processes on each machine are stopped before you start the cluster.
  8. Start each node in the cluster consecutively.
    To start a server, right-click the Spectrum Technology Platform icon on the Windows task bar, and click Start Spectrum. Do not wait for one node to start before starting another node. All nodes must be started at the same time.
    For more information, see Starting a Cluster.