Upgrade Fusion Server 4.1.x to 4.1.y

This topic describes how to perform the following upgrade:

  • From version: Fusion 4.1.x

  • To version: Fusion 4.1.y

Important
Only specific version-to-version upgrade sequences are supported. Some upgrades require multiple steps. For more information, see the supported upgrade sequences.

For Fusion 3.1 and later releases, a migrator is available for upgrading Fusion. During the upgrade process, choose the correct properties file. After downloading and installing the migrator, you can find the properties files in the /opt/fusion/4.1.x/var/upgrade directory (on Unix or MacOS) or the C:\lucidworks\fusion\4.1.x\var\upgrade\ directory (on Windows).

The file names reference the versions you are upgrading from and to. For example:

  • To upgrade 4.1.0 to 4.1.1, use the 4.1.x-4.1.x.properties file.

Migration entails down time and multiple starts and stops of Fusion services. Plan accordingly, especially in terms of disabling external load balancers or monitors that might react adversely to the starts and stops.

Download the latest migrator immediately before upgrading. This helps ensure that the upgrade goes smoothly.

Important
The newer Fusion instance must be newly untarred and never started.

Connectors

In Fusion 3.1.0 and above, only a subset of connectors are included by default. The migrator detects which connectors were used in the older version of Fusion, and installs them automatically in Fusion 4.1.y. This step requires an Internet connection. If no connection is available, then you must download connectors at http://lucidworks.com/connectors/ and install them separately. If this is necessary, then a message in /opt/fusion/4.1.x/var/upgrade/tmp/migrator.log (on Unix) or C:\lucidworks\fusion\4.1.x\var\upgrade\tmp\migrator.log (on Windows) will indicate so.

Only datasources for connectors that are supported in the new Fusion version are upgraded. Datasources for custom connectors aren’t upgraded.

Object migrations and transformations

The migrator automatically migrates these Fusion 4.1 object types, transforming them as needed:

  • Collections

  • Index pipelines

  • Query pipelines

  • Search cluster configurations

  • Datasources

  • Parsing configurations

  • Object groups

  • Links

  • Tasks

  • Jobs

  • Spark objects

  • Apps

  • Appkit apps

  • Index profiles

  • Query profiles

  • Blobs

Only datasources for connectors that are supported in the new Fusion version are upgraded. Datasources for custom connectors aren’t upgraded.

To add connectors in the new Fusion version, you can do so during migration (by adding zip files at the specified time) or after migration (using the Fusion UI or API).

Important
In Fusion Server 4.0 and later, most objects exist in the context of apps. When you migrate from Fusion Server 4.1.x to 4.1.y, the migrator migrates app objects, all objects in or linked to objects in apps, and objects that are not linked to apps. You can explore the objects in Object Explorer.

Access control migration

The migrator migrates all access control configurations:

  • Security realms

  • Roles

  • Users

None of these should require adjustments after migration.

Association of blobs with apps

The association of blobs with apps becomes stronger in Fusion Server 4.1.1. Newly created blobs are only linked to the app to which they are uploaded, and are only shared with other apps when the blobs are directly linked to those apps (added to the apps in Object Explorer or linked using the Links API).

When migrating from pre-4.1.1 versions to 4.1.1, the resulting apps might not contain all of the blobs that they contained prior to migration.

Note
It’s important to stress that this change doesn’t break the apps.

What might change is the blobs that are linked to an app. This can be important if you export and re-import apps.

Recommendation: After migration to version 4.1.1, we recommend that you use either Object Explorer or the Links API to manually link all blobs to the apps in which they are used.

Review known issues

Before upgrading, review the known issues to see whether any of them apply to the circumstances of your upgrade. Some known issues might require actions before upgrading.

Upgrade on Unix

Use this procedure to upgrade Fusion on a single Unix node or on multiple Unix nodes. If there is a single node, perform all steps on that node unless otherwise indicated.

To upgrade Fusion on Unix

Perform the steps in this procedure on the indicated nodes on which Fusion is running. If Solr and/or ZooKeeper instances are also running on other nodes (without Fusion), you don’t need to do anything on the external Solr and/or ZooKeeper instance nodes.

Important
For every step on multiple nodes, ensure that the step completes on all Fusion nodes before going to the next step. There is the notion of a "main node" during the migration process. This node will be used for certain centralized migration activities that do not need to be done on every node, such as downloading connectors that are then uploaded to blob storage that is shared by all, etc. Just pick one of your Fusion nodes to be the "main node"; there’s no special requirement as to which one you pick.
Perform the following tasks on all Fusion nodes:
  1. Download the version of Fusion to which you are upgrading.

  2. Download the latest migrator zip file for Unix. (Do this now, even if you have downloaded the migrator before, to ensure that you have the latest version.)

  3. Install the newer version of Fusion:

    cd /opt
    mv ~/Downloads/fusion-4.1.y.tar.gz ./
    tar -xf fusion-4.1.y.tar.gz

    For example, if Fusion is currently installed in /opt/fusion/4.1.x, then change your working directory to /opt/ and extract the file there. Don’t run the new version of Fusion yet.

  4. (If there are custom jar files) If your deployment has custom jar files, add them to the new Fusion deployment.

  5. (If you are adding new connectors) If you want your new deployment to use connectors that are not in the current deployment, you can add them now. Download the connector zip files from http://lucidworks.com/connectors/ and place them in apps/connectors/bootstrap-plugins for the new deployment.

    Alternatively, you can use the UI or API to install new connectors after the migration is complete.

  6. Verify that there is sufficient disk space for a second copy of the Solr index directory, fusion/4.1.x/data/solr. If there isn’t sufficient disc space, free up space before proceeding.

  7. Create FUSION_OLD and FUSION_NEW environment variables that point to the old and new Fusion installation directories respectively (using the full path).

    export FUSION_OLD="/opt/fusion/4.1.x"
    export FUSION_NEW="/opt/fusion/4.1.y"

    For example, when upgrading from Fusion 4.1.0 to 4.1.1:

    export FUSION_OLD="/opt/fusion/4.1.0"
    export FUSION_NEW="/opt/fusion/4.1.1"
  8. Create an environment variable for the migrator properties file to use:

    export PROPERTIES=4.1.x-4.1.x.properties
  9. Create this directory:

    mkdir $FUSION_OLD/var/upgrade
  10. Install the migrator:

    tar -zxv -C $FUSION_OLD/var/upgrade --strip-components=1 -f fusion-migrator.tar.gz
  11. Start all Fusion services for the old version of Fusion:

    $FUSION_OLD/bin/fusion start
  12. (On the main Fusion node) Run the migrator with the argument -1:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -1

    This message indicates that the step finished successfully:

    Step 1 finished successfully.
  13. (On all Fusion nodes) Stop the old versions of Fusion services and Solr; but not ZooKeeper:

    $FUSION_OLD/bin/log-shipper stop
    $FUSION_OLD/bin/admin-ui stop
    $FUSION_OLD/bin/webapps stop
    $FUSION_OLD/bin/proxy stop
    $FUSION_OLD/bin/connectors-rpc stop
    $FUSION_OLD/bin/connectors-classic stop
    $FUSION_OLD/bin/api stop
    $FUSION_OLD/bin/solr stop

    If Spark and SQL services are running, also stop those:

    $FUSION_OLD/bin/spark-master stop
    $FUSION_OLD/bin/spark-worker stop
    $FUSION_OLD/bin/sql stop
  14. (On all Fusion nodes) Run the migrator with the argument -2:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -2

    This message indicates that the step finished successfully:

    Step 2 finished successfully.
  15. (On all Fusion nodes) Stop ZooKeeper for the old version of Fusion (unless you are using an external ZooKeeper instance, in which case you can ignore this step):

    $FUSION_OLD/bin/zookeeper stop
  16. (On the main Fusion node) Run the migrator with the argument -3:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -3
    Note
    Depending on the size of your Solr index, this step can take a long time (for example, multiple tens of minutes).

    This message indicates that the step finished successfully:

    Step 3 finished successfully.
  17. (On all Fusion nodes except the main node; skip this step for a single-node upgrade) Run the migrator with the argument -7:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -7

    This message indicates that the step finished successfully:

    Step 7 finished successfully.
  18. (On all Fusion nodes) Start ZooKeeper for the new version of Fusion (unless you are using an external ZooKeeper instance, in which case you can ignore this step):

    $FUSION_NEW/bin/zookeeper start
  19. (On the main Fusion node) Run the migrator with the argument -4:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -4

    This message indicates that the step finished successfully:

    Step 4 finished successfully.
  20. (On all Fusion nodes) Start all Fusion services for the new version of Fusion:

    $FUSION_NEW/bin/fusion start
  21. (On the main Fusion node) Run the migrator with the argument -5:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -5

    This message indicates that the step finished successfully:

    Step 5 finished successfully.
  22. (On the main Fusion node) Run the migrator with the argument -6:

    java -jar $FUSION_OLD/var/upgrade/migrator.jar -f $FUSION_OLD -t $FUSION_NEW -p $PROPERTIES -6

    This message indicates that the step finished successfully:

    Step 6 finished successfully.
    Tip
    After migration, you can find details about the results in the fusion/4.1.x/var/upgrade/tmp directory. If the migration produces unexpected results, the files in this directory are helpful for troubleshooting.
  23. (On the main Fusion node) Restart the new version of Fusion (all services defined in fusion.properties):

    $FUSION_NEW/bin/fusion restart
  24. Log into the Fusion UI (your admin password is the same as for the old installation), and confirm the release number of the new version of Fusion:

    1. Clear your browser’s cache.

      Otherwise, you might inadvertently access a cached version of the old Fusion UI and see inconsistent behavior.

    2. In a browser, open the Fusion UI at http://localhost:8764/ (replace localhost with your server name or IP address if necessary).

    3. Log in.

    4. Navigate to admin > About Fusion.

      The About Fusion panel should display the newer Fusion release number.

  25. Validate the installation.

    • Ensure that all connectors were installed automatically during the upgrade. From the Fusion launcher, click the tile for a migrated app. Click System > Blobs. If any connectors are missing from the list, click Add > Connector Plugin and install them manually.

    • Ensure that all customizations you made in the former version of Fusion are present in the new one.

    • If you migrated from a version prior to 4.1.1, confirm associations between blobs and apps and make adjustments if necessary.

    Tip
    When you are satisfied with the migration and you have backed up the fusion/4.1.x/ directory, you can rm -fr fusion/4.1.x/ to remove the older version of Fusion (on all Fusion nodes).

Upgrade on Windows

Use this procedure to upgrade Fusion on a single Windows node or multiple Windows nodes. If there is a single node, perform all steps on that node unless otherwise indicated.

To upgrade Fusion on Windows

Perform the steps in this procedure on the indicated nodes on which Fusion is running. If Solr and/or ZooKeeper instances are also running on other nodes (without Fusion), you don’t need to do anything with the external Solr and/or ZooKeeper instances.

Important
If you are upgrading Fusion on multiple nodes, then, for every step on multiple nodes, ensure that the step completes on all Fusion nodes before going to the next step. There is the notion of a "main node" during the migration process. This node will be used for certain centralized migration activities that do not need to be done on every node, such as downloading connectors that are then uploaded to blob storage that is shared by all, etc. Just pick one of your Fusion nodes to be the "main node"; there’s no special requirement as to which one you pick.
Perform the following tasks on all Fusion nodes:
  1. Download the version of Fusion to which you are upgrading.

  2. Download the latest migrator zip file for Windows. (Do this now, even if you have downloaded the migrator before, to ensure that you have the latest version.)

  3. Move the fusion-4.1.y.zip file to the directory that contains the fusion\ directory.

    For example, if Fusion is installed in C:\lucidworks\fusion\4.1.x, then move the file to C:\lucidworks.

  4. Unzip the fusion-4.1.y.zip file. Don’t run the new version of Fusion yet.

  5. (If there are custom jar files) If your deployment has custom jar files, add them to the new Fusion deployment.

  6. (If you are adding new connectors) If you want your new deployment to use connectors that are not in the current deployment, you can add them now. Download the connector zip files from http://lucidworks.com/connectors/ and place them in apps\connectors\bootstrap-plugins for the new deployment.

    Alternatively, you can use the UI or API to install new connectors after the migration is complete.

  7. Verify that there is sufficient disk space for a second copy of the Solr index directory, fusion\4.1.x\data\solr. If there isn’t sufficient disc space, free up space before proceeding.

  8. Open a Command Prompt window and create FUSION_OLD and FUSION_NEW environment variables that point to the old and new Fusion installation directories respectively. For example:

    set FUSION_OLD=C:\lucidworks\fusion\4.1.0
    set FUSION_NEW=C:\lucidworks\fusion\4.1.1
  9. Create an environment variable for the migrator properties file to use:

    set PROPERTIES=4.1.x-4.1.x.properties
  10. Create a fusion\4.1.x\var\upgrade directory.

  11. Unzip the migrator zip file, and move the contents of the extracted folder to fusion\4.1.x\var\upgrade.

  12. Start all Fusion services for the old version of Fusion:

    %FUSION_OLD%\bin\fusion.cmd start
Perform the following tasks on the indicated nodes:
  1. (On the main Fusion node) Run the migrator with the argument -1:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -1

    This message indicates that the step finished successfully:

    Step 1 finished successfully.
  2. (On all Fusion nodes) Stop the old versions of Fusion services and Solr; but not ZooKeeper:

    %FUSION_OLD%\bin\log-shipper.cmd stop
    %FUSION_OLD%\bin\admin-ui.cmd stop
    %FUSION_OLD%\bin\webapps.cmd stop
    %FUSION_OLD%\bin\proxy.cmd stop
    %FUSION_OLD%\bin\connectors-rpc.cmd stop
    %FUSION_OLD%\bin\connectors-classic.cmd stop
    %FUSION_OLD%\bin\api.cmd stop
    %FUSION_OLD%\bin\solr.cmd stop

    If Spark and SQL services are running, also stop those:

    %FUSION_OLD%\bin\spark-master.cmd stop
    %FUSION_OLD%\bin\spark-worker.cmd stop
    %FUSION_OLD%\bin\sql.cmd stop
  3. (On all Fusion nodes) Run the migrator with the argument -2:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -2

    This message indicates that the step finished successfully:

    Step 2 finished successfully.
  4. (On all Fusion nodes) Stop ZooKeeper for the old version of Fusion (unless you are using an external ZooKeeper instance, in which case you can ignore this step):

    %FUSION_OLD%\bin\zookeeper.cmd stop
  5. (On the main Fusion node) Run the migrator with the argument -3:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -3
    Note
    Depending on the size of your Solr index, this step can take a long time (for example, multiple tens of minutes).

    This message indicates that the step finished successfully:

    Step 3 finished successfully.
  6. (On all Fusion nodes except the main node; skip this step for a single-node upgrade) Run the migrator with the argument -7:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -7

    This message indicates that the step finished successfully:

    Step 7 finished successfully.
  7. (On all Fusion nodes) Start ZooKeeper for the new version of Fusion (unless you are only using an external ZooKeeper instance, in which case you can ignore this step):

    %FUSION_NEW%\bin\zookeeper.cmd start
  8. (On the main Fusion node) Run the migrator with the argument -4:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -4

    This message indicates that the step finished successfully:

    Step 4 finished successfully.
  9. (On all Fusion nodes) Start Solr for the new Fusion version:

    %FUSION_NEW%\bin\solr.cmd start
  10. (On the main Fusion node) Run a script to remove all old plugins from the blob store. Replace solr-address and solr-port as appropriate (as shown in the example):

    java -cp "%FUSION_OLD%\var\upgrade\jython-standalone-2.7.1.jar;%FUSION_OLD%\var\upgrade\migrator.jar" org.python.util.jython "%FUSION_OLD%\var\upgrade\transformations\manual_delete_old_plugin_blobs.py" --solr-address solr-address --solr-port solr-port

    For example:

    java -cp "%FUSION_OLD%\var\upgrade\jython-standalone-2.7.1.jar;%FUSION_OLD%\var\upgrade\migrator.jar" org.python.util.jython "%FUSION_OLD%\var\upgrade\transformations\manual_delete_old_plugin_blobs.py" --solr-address localhost --solr-port 8983

    This message indicates that plugins were deleted successfully:

    Deleted old plugin blobs from solr <?xml version="1.0" encoding="UTF-8"?>
    <response>
    
    <lst name="responseHeader">
      <int name="status">0</int>
      <int name="QTime">246</int>
    </lst>
    </response>
    Old connector plugin blobs were deleted successfully.
  11. (On all Fusion nodes) Start all Fusion services for the new version of Fusion:

    %FUSION_NEW%\bin\fusion.cmd start
  12. (On the main Fusion node) Run the migrator with the argument -5:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -5

    This message indicates that the step finished successfully:

    Step 5 finished successfully.
  13. (On the main Fusion node) Run the migrator with the argument -6:

    java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" -f "%FUSION_OLD%" -t "%FUSION_NEW%" -p "%PROPERTIES%" -6

    This message indicates that the step finished successfully:

    Step 6 finished successfully.
    Tip
    After migration, you can find details about the results in the fusion\4.1.x\var\upgrade\tmp directory. If the migration produces unexpected results, the files in this directory are helpful for troubleshooting.
  14. (On all Fusion nodes) Restart all Fusion services for the new version of Fusion:

    %FUSION_NEW%\bin\fusion.cmd restart
  15. Log into the Fusion UI (your admin password is the same as for the old installation), and confirm the release number of the new version of Fusion:

    1. Clear your browser’s cache.

      Otherwise, you might inadvertently access a cached version of the old Fusion UI and see inconsistent behavior.

    2. In a browser, open the Fusion UI at http://localhost:8764/ (replace localhost with your server name or IP address if necessary).

    3. Log in.

    4. Navigate to admin > About Fusion.

      The About Fusion panel should display the newer Fusion release number.

  16. Validate the installation.

    • Ensure that all connectors were installed automatically during the upgrade. From the Fusion launcher, click the tile for a migrated app. Click System > Blobs. If any connectors are missing from the list, click Add > Connector Plugin and install them manually.

    • Ensure that all customizations you made in the former version of Fusion are present in the new one.

    • If you migrated from a version prior to 4.1.1, confirm associations between blobs and apps and make adjustments if necessary.

    Tip
    When you are satisfied with the migration and you have backed up the fusion\4.1.x directory, you can remove the older version of Fusion by removing that directory (on all Fusion nodes).