Upgrading a Cluster with a Separated Database

  • 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.
  • Install all patches and updates in an earlier version of Spectrum Technology Platform before you upgrade to Spectrum Technology Platform 2020.1.0
  • 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, if an error occurs during the upgrade process.

    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. 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 procedure describes how to upgrade Spectrum Technology Platform when you have separated the configuration database from the server. To upgrade an environment that has a separated configuration database, you first upgrade the configuration database cluster, then the server cluster.

  1. Back up the server. For instructions on creating a backup, see the Administration Guide.
    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.
  2. Back up module-specific data for any of these modules if you have them installed.
    Note: For Screener, see the section Upgrading Screener in the Screener guide.
    Module Items to Back Up
    Advanced Matching, Data Normalization, and Universal Name Back up the contents of these subfolders located in SpectrumDirectory/server/modules:
    • cdqdb
    • lucene
    • matcher
    • parser
    • searchindex
    • tables
    Context Graph Open the Relationship Analysis Client and click Manage. Select the model you want to back up then click Backup. You can also perform Context Graph backups with CLI commands.
    In addition to backing up your models, back up these two property files:
    • server\modules\hub\hub.properties
    • server\modules\hub\db\neo4j.properties
    Spatial Back up your named resources, data, and configuration files.
  3. Stop all the nodes in the server cluster then stop all the nodes in the configuration database cluster. Make a note of the last node that you stop in the configuration database cluster. You must start this node first after upgrading. For instructions on stopping a cluster, see Stopping a Cluster.
  4. On the last node that you shut down in the configuration database cluster, run installdb.exe. The installer upgrades the configuration database.
    Warning: The first node that you upgrade must be the last node that was stopped. This is because on some operating systems the configuration database will start automatically at the end of the upgrade process. If the first node that starts is not the last node that was stopped, data such as job history and configuration settings may be lost. If you do not know which node was stopped last, look in each node's log for the time stamp of the shutdown message. You can find the log in: SpectrumDirectory\Database\logs\spectrum-server.log.
    Important: When prompted with the option to start Spectrum Technology Platform after the installation, you must disable this option so that the database does not start automatically when the installation completes.
  5. After the upgrade is complete, the configuration database starts up automatically. Verify that the configuration database is fully started before continuing by opening the log file SpectrumInstallationLocation\Database\logs\spectrum-server.log and looking for the message Started.
  6. Stop the configuration repository.
    Right-click the Spectrum Technology Platform icon in the Windows system tray and select Stop Spectrum. Alternatively, you can use the Windows Services control panel to stop the configuration database by stopping the Spectrum Database service.
    Important: Do not attempt to stop the server until after it has fully started for the first time. Stopping the server before it performs an initial startup can cause your installation to become unusable.
  7. Configure the database cluster.
    1. Edit the file Database/repository/spectrum-container.properties as described in Cluster Properties for a Configuration Database Cluster.
    2. Save and close the spectrum-container.properties file.
    3. Start the last node that was stopped in the configuration database cluster. To start the configuration database, right-click the Spectrum Technology Platform icon in the Windows system tray and select Start Spectrum. Alternatively, you can use the Windows Services control panel to start the configuration database by starting the Spectrum Database service.
    4. To start the configuration database, right-click the Spectrum Technology Platform icon in the Windows system tray and select Start Spectrum. Alternatively, you can use the Windows Services control panel to start the configuration database by starting the Spectrum Database service.
    5. After the upgraded configuration database is fully started, repeat the previous steps to upgrade each of the remaining servers in the configuration database cluster and start each of them.
  8. Upgrade each node in the server cluster. For more information, see Upgrading a Cluster.
    Important: When installing each server select the Server only option in the installer and provide the host and port of one or more of the configuration database servers. You can find the port in the file SpectrumDirectory\Database\repository\spectrum-container.properties. The port is specified in the spectrum.repository.server.connector.bolt.port property.
Note: Any job or subflow stored in the system during a server upgrade is marked as exposed to provide the same behavior for those jobs and subflows as before the upgrade. Any job or subflow that is exported prior to the upgrade will not be exposed. Therefore, when importing these jobs or subflows back into the system, you must manually expose the imported job or subflow.

Some modules have post-upgrade steps you need to perform.

Context Graph Open this file in a text editor: server/modules/hub/db/neo4j.properties and set this property to true: dbms.allow_upgrade=true. This property protects against unintentional and irreversible store upgrades. Setting this property to "true" indicates that you understand the ramifications of proceeding with an upgrade and have taken the necessary precautions before proceeding.

Restart the Spectrum Technology Platform server. The server will upgrade each model. Examine the file server/logs/spectrum-server.log for errors or warning messages. Once all models have been upgraded, edit the neo4j.properties file again and comment out the dbms.allow_upgrade property.
Spatial During an upgrade, the pool size is reset to 4 if set to a lower value. A pool size setting of 4 or more is unaffected. To change the Remote Component Pool Size value after upgrading, open the Management Console and select Resources > Spatial. Change the pool size value and click Save. For details, see Modifying the Pool Size in the Spectrum Spatial Guide.
Spectrum Screener See the Upgrading Screener section of the Screener guide for details.