Upgrade Fusion

When you have a Fusion-based search application running, at some point it might be necessary to upgrade to a later version of Fusion.

Tip
See the release history to find out what’s new, including which versions of Solr, Spark, and ZooKeeper are bundled with each Fusion release.

Beginning with Fusion 3.1, we provide a migrator tool to simplify the upgrade process. The migrator transfers over most of the objects that make up your search application, all configurations and customizations for your application, and all data in collections in the application.

Note
In some cases, manual steps are required for objects that the migrator can’t handle automatically. We give you instructions and guidance about what might be required. You should also review the log of the upgrade in /opt/fusion/x.y.z/var/upgrade/tmp/migrator.log (on Unix) or C:\lucidworks\var\fusion\x.y.z\upgrade\tmp\migrator.log (on Windows). The x.y.z directory is for the Fusion version that you are migrating from.

Key points when using the migrator

Following are some key points about using the migrator to upgrade Fusion:

  • Migration involves down time – The upgrade process involves multiple starts and stops of Fusion services. Please plan accordingly, especially in terms of disabling external load balancers or monitors that might react adversely to the starts and stops.

  • Current deployment is preserved – Upgrades preserve the current Fusion deployment, copying information over from the current deployment to the new one. This provides a rapid roll-back option if you encounter problems during the upgrade process.

  • If the upgrade fails – If an upgrade fails, there’s a procedure for dealing with that.

Supported upgrade sequences

Important
Only specific version-to-version upgrade sequences are supported. Some upgrades require multiple steps.

These upgrade sequences are supported:

Manual:

  • 2.4.5 to 3.0.0 (one step)

  • 3.0.0 to 3.0.1 (one step)

Using the migrator:

  • 3.0.x to 3.1.0 – From 3.0.0 or 3.0.1 directly to 3.1.0 (one step)

  • 3.1.x to 3.1.y – From 3.1.0, 3.1.1, 3.1.2, 3.1.3, or 3.1.4 directly to 3.1.5 (one step)

For example, to upgrade from Fusion 3.0.1 to Fusion 3.1.5, you would perform the following upgrades (both of them using the migrator):

  1. Upgrade from Fusion 3.0.1 to Fusion 3.1.0

  2. Upgrade from Fusion 3.1.0 to Fusion 3.1.5

Per-version instruction sets

To upgrade to a later version of Fusion from an existing installation requires transferring over all configurations and data from your existing Fusion installation to the new version.

Important
Some upgrades require multiple steps. For example, to upgrade from Fusion 2.4.5 to Fusion 3.1.3, you must first upgrade from Fusion 2.4.5 to 3.0.0, and then from Fusion 3.0.0 to Fusion 3.1.3.

Perform the steps in the appropriate section:

Log file

The log file for the migrator is in /opt/fusion/x.y.z/var/upgrade/tmp/migrator.log (on Unix) or C:\lucidworks\var\fusion\x.y.z\upgrade\tmp\migrator.log (on Windows). The x.y.z directory is for the Fusion version that you are migrating from.

Repeat an upgrade

If the migrator script produces an error while running (including during any of the separate stages for a multinode upgrade), you will need to correct the problem that the script encountered, and then repeat the upgrade.

To repeat an upgrade:
  1. Examine the log file and determine what went wrong.

  2. Remove the directory for the new version of Fusion.

  3. Reinstall the new version of Fusion, but don’t start it.

  4. Fix what went wrong.

  5. Repeat the upgrade procedure.