Upgrading a Cluster with a Separated Database

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 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.
    Module Items to Back Up
    Advanced Matching Module, Data Normalization Module, and Universal Name Module Back up the contents of these subfolders located in SpectrumLocation/server/modules:
    • cdqdb
    • lucene
    • matcher
    • parser
    • searchindex
    • tables
    Data Hub Module Open the Relationship Analysis Client and click Manage. Select the model you want to back up then click Backup.
    In addition to backing up your models, back up these two property files:
    • server\modules\hub\hub.properties
    • server\modules\db\neo4j.properties
    Location Intelligence Module 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. 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 wrapper log for the time stamp of the shutdown message. You can find the wrapper log in: Spectrum Location\Database\repository\logs\wrapper.log.
  5. Stop the configuration repository.
    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.
  6. Configure clustering for 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.

    4. 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.
  7. 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 InstallationLocation\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.

Data Hub Module Open this file in a text editor: server/modules/hub/neo4j.properties and set the property dbms.allow_format_migration property to true. The purpose of this property is to protect 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/app/repository/logs/wrapper.log for errors or warning messages. Once all models have been upgraded, go back to the hub.properties file and comment out the allow_store_upgrade property.