Reindex 2022.1 Search Indexes before upgrading to 2023.1 - spectrum_platform - 23 - 23.1

Spectrum Installation Guide for Linux

Product type
Software
Portfolio
Integrate
Locate
Verify
Product family
Spectrum
Product
Spectrum > Spectrum Platform
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Installation Guide for Linux
Topic type
Configuration
Installation
Overview
How Do I
First publish date
2007
ft:lastEdition
2023-11-17
ft:lastPublication
2023-11-17T17:30:19.950257
If you upgraded from a previous version of the Spectrum Technology Platform (such as, 19.1. or 20.1) to Spectrum 2022.1, you must first reindex the search indexes before upgrading to 2023.1. You do not need to perform this procedure if you did not upgrade to 2022.1 from a previous version of Spectrum.

Reindex 2022.1 Search indexes on a standalone server

For a standalone server configuration, perform this procedure before you upgrade Spectrum Technology Platform 2022.1 to 2023.1.

Note: In this procedure, SpectrumDirectory is the directory where the Spectrum Technology Platform server is installed (for example, /home/user/myuser/Precisely/Spectrum).
  1. Source the SpectrumDirectory/server/bin/setup script.
  2. Run the SpectrumDirectory/server/bin/server.stop script to stop the Spectrum Technology Platform server.
  3. Check that all Spectrum Java processes are stopped.
  4. Back up the SpectrumDirectory/index/data directory.
  5. Use the link provided here to download the ZIP file containing the reindex files.
  6. FTP the Reindex_20221.tar file in binary mode to a temporary directory on the host machine for the Spectrum Technology Platform server.
  7. Change to the directory where the Spectrum Technology Platform server is installed (SpectrumDirectory).
  8. Untar the file using this command.
    tar -xvf TemporaryDirectory/Reindex_20221.tar
  9. From the command line in the SpectrumDirectory/index/bin directory, run the command ./elasticsearch to start Elasticsearch.
  10. From a new command line window, source the SpectrumDirectory/server/bin/setup script to set the Java environment variables to run the ./reindex.sh command in the SpectrumDirectory/index/bin directory.
  11. Once the reindex has completed, close the reindex command line window.
  12. Verify that the reindex was successful.
    1. Open the SpectrumDirectory/index/logs/reindex.log in a text editor, such as Notepad++.
      The log file will show you a count of indexes before and after the reindex.
    2. Search the reindex.log file for Not reindexing index.
    3. If you find Not reindexing index in the log for one or more indexes, open the SpectrumDirectory/index/config/jvm.options file.
    4. Increase the minimum and maximum heap space, then run the reindex again (steps 10 and 11).
      # Xms represents the initial size of total heap space
      -Xms1g
      # Xmx represents the maximum size of total heap space
      -Xmx1g
  13. Press Ctrl-C to stop Elasticsearch, then close the command line window.
  14. Verify all Java processes are stopped.
After you finish this procedure, complete the Spectrum Server Upgrade.

Reindex 2022.1 Search Indexes on a cluster server

For a clustered configuration, perform this procedure before you upgrade 2022.1 to 2023.1 on each node in the cluster. For a distributed cluster configuration, perform this procedure on each node in the Spectrum Technology Platform server configuration.

  1. Source the SpectrumDirectory/server/bin/setup script.
  2. Run the SpectrumDirectory/server/bin/server.stop script to stop the Spectrum Technology Platform server.
  3. Check that all Spectrum Java processes are stopped.
  4. Back up the SpectrumDirectory/index/data directory.
  5. Use the link provided here to download the ZIP file containing the product update.
  6. FTP the Reindex_20221.tar file in binary mode to a temporary directory on the host machine for the Spectrum Technology Platform server.
  7. Change to the directory where the Spectrum Technology Platform server is installed (SpectrumDirectory).
  8. Untar the file using this command.
    tar -xvf TemporaryDirectory/Reindex_20221.tar
  9. After steps 1 through 8 have been completed on each node in the cluster, run the ./elasticsearch command simultaneously on each node in the cluster to start Elasticsearch in cluster mode.
    The file is located in the SpectrumDirectory/index/bin directory.
  10. From a new command line window, run the reindex.sh file on one of the nodes in the cluster.
    The file is located in the SpectrumDirectory/index/bin directory.
  11. Once the reindex has completed, close the reindex command line window.
  12. Verify that the reindex was successful.
    1. Open the SpectrumDirectory/index/logs/reindex.log in a text editor, such as Notepad++.
      The log file will show you a count of indexes before and after the reindex.
    2. Search the reindex.log file for Not reindexing index.
    3. If you find Not reindexing index in the log for one or more indexes, open the SpectrumDirectory/index/config/jvm.options file.
    4. Increase the minimum and maximum heap space, then run the reindex again (steps 10 and 11).
      # Xms represents the initial size of total heap space
      -Xms1g
      # Xmx represents the maximum size of total heap space
      -Xmx1g
  13. Press Ctrl-C to stop Elasticsearch, then close the command line window.
  14. Verify all Java processes are stopped.
  15. Repeat steps 10 through 12 on each node in the cluster. Make sure the reindex has completed on each node before running it on the next node.
    Even though the other cluster nodes should already be reindexed, it is best practice to run the reindex on each node. You will see the following message if cluster node has already been reindexed:
    INFO: no need to reindex cluster
  16. Use Ctrl-C to stop Elasticsearch, then close the command line window.
  17. Verify all java processes have stopped.
After you finish this procedure, complete the Spectrum Server Upgrade.