Upgrading

Upgrading on Linux or Mac OS X

To use a newer version of the Engine API, you must install an additional instance, and copy your data across should you wish to preserve it.

  1. Download the latest version from here
  2. Stop the existing Engine API instance
> $PRELERT_HOME/bin/prelert_shutdown.sh
  1. If the new installer has lost its execute permission during the download process, reinstate it using:

    > chmod +x prelert_engine_linux_64bit.bin
    
  2. On the command line run the executable and follow the instructions. You will be required to install to a new directory.

./prelert_engine_linux_64bit.bin

When the installer offers the option to start the API, answer no if you want to preserve your results and job state.

  1. If you wish to retain your data, move it to the new instance. It can be found in the following folder (of the _old_ installation):

    $PRELERT_HOME/cots/elasticsearch/data
    

Move this directory to the corresponding location under the new $PRELERT_HOME directory. (If you want to be cautious and have enough disk space you can copy the directory instead of moving it.)

Important

Do not move or copy the data directory while either the old or new version of the Engine API is running. Doing this may lead to unrecoverable data corruption. This is why it is important to shut down the old version before installing the new one and to tell the installer for the new version not to start the processes.

  1. Source the profile (for bash/ksh/sh) or cshrc (for tcsh/csh) file in the _new_ installation directory to ensure that $PRELERT_HOME in your environment corresponds to the new location, for example in bash:

    . /wherever/new_prelert_home/profile
    
  2. Start the API processes

> prelert_startup.sh

Note

Providing you sourced the correct profile or cshrc, the version of this script corresponding to the new install will be on your $PATH, so there is no need to type the path in the command.

  1. You are now ready to use the upgraded version of the Engine API
The Prelert Engine REST API is available at http://localhost:8080/engine/v2
The Prelert Engine Dashboard is available at http://localhost:5601

Upgrading on Windows

The Prelert Engine installer does not currently support an in-place upgrade. In order to upgrade to a newer version, you must first uninstall the Engine API and then reinstall.

If you are upgrading to a version which supports the migration of data, please follow the steps below which describe how to retain your data.

  1. Download the latest version from here.
  2. Stop the existing Engine API instance. This can be done by running the Shutdown Prelert Engine Service shortcut available in the Program Start menu or by running the shutdown script. You must have administrator privileges to perform this task.

Note: “INSTALLDIR” should be substituted for the Prelert Engine installation folder; this is not an environment variable.

> INSTALLDIR\bin\prelert_shutdown.bat

3. Take a copy of the Prelert Engine data as this will be removed during the uninstall. This can be retained as a backup, or migrated to a newer version of the Engine API (if supported). The data can be found in the folder below. To backup, simply move the .dataPrelert folder to a different location Note: This must be done after the Engine Services have been stopped.

INSTALLDIR\cots\elasticsearch\data\Prelert
  1. Uninstall the Prelert Engine using Control Panel Programs and Features.

Follow the on-screen prompts.

  1. Install the new version of the Prelert Engine by running the Windows installer msi file.

Follow the on-screen prompts. Detailed installation help can be found here.

  1. If data migration is supported, you may now move your data across to this current installation.
  1. First stop the Engine API instance by following the instructions in step 2 above.
  2. Then copy or move the retained backup data folder back to INSTALLDIRcotselasticsearchdataPrelert

Important

Do not move or copy the data directory while the Engine API is running. Doing this may lead to unrecoverable data corruption.

  1. Restart the Engine API instance. This can be done by running the Start Prelert Engine Service shortcut available in the Program Start menu or by running the startup script. You must have administrator privileges to perform this task.
> INSTALLDIR\bin\prelert_startup.bat
  1. You are now ready to use the upgraded version of the Engine API
REST API is available at http://localhost:8080/engine/v2
Dashboard is available at http://localhost:5601