Converting to a Separated Configuration Database

Converting an existing Spectrum Technology Platform installation to a separated configuration database enables you to take advantage of the improved scalability of a separated configuration database. When you convert to a separated configuration database, your existing installation is converted from one where the configuration database is part of the server to one where the configuration database is in a separate cluster.

At a high level, this is the conversion process:

  • Stop your existing Spectrum Technology Platform server.
  • Set up the new configuration database cluster:
    • Install the separate configuration database software on a new server.
    • Copy your existing configuration database to the new server.
    • Configure clustering and start the configuration database cluster.
  • Install the server-only cluster and start it up.
Note: This procedure applies both to converting a single server to a separated configuration database, and converting a cluster to a separated configuration database.

To convert to a separated configuration database:

  1. 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.
  2. Stop the server. If you have a clustered installation, stop the cluster.
  3. Install the configuration database to a new server.
    1. Place the Spectrum Technology Platform installer on the machine where you want to install the configuration database. This must be a different machine from the one where you have your existing Spectrum Technology Platform server installed.
    2. Double-click installdb.exe.
    3. Follow the prompts to install the configuration database.
      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.
    4. Copy the databases folder from your existing server to the server where you installed the separate configuration database. Replace the existing folder.
    Important:
    • If you are upgrading from any previous version 12.0 or later, copy this folder: SpectrumDirectory\Database\repository\data\databases folder.
    .
    1. Configure the cluster properties for the database cluster by editing 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 configuration database. 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. Install the configuration database on additional servers as needed to complete the configuration database cluster.
  4. Install the server.
    1. (Optional) If you are upgrading to a new version and you want to use the same machine to host the upgraded server as hosted the existing server, uninstall the existing server of Spectrum Technology Platform.
    2. Install the server cluster. For more information, see Installing 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.