Upgrade Fusion Server 4.2.x to 4.2.y

Introduction

This article describes how to perform the following upgrade:

From version: Fusion 4.2.x
To version: Fusion 4.2.y

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

For more information, see Fusion 4.x.

For Fusion 3.1 and later releases, a migrator is available for upgrading Fusion.

During the upgrade process, the migrator uses a properties file. After downloading and installing the migrator, the properties files is in the /opt/lucidworks/fusion/4.2.x/var/upgrade directory (on Unix or MacOS) or the C:\lucidworks\fusion\4.2.x\var\upgrade\ directory (on Windows). The file names reference the versions you are upgrading from and to. For example:

To upgrade 4.2.3 to 4.2.5, the migrator uses the 4.2.x-4.2.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.

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

About the upgrade

This section describes how connectors, object migrations, and signals are migrated during an upgrade.

Connectors

In Fusion 3.1.0 and later, 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.2.y. This step requires an Internet connection. If no connection is available, then download the connectors from Fusion 4.x Connector Downloads and install them as bootstrap plugins.

If a connector to be upgraded was not available during the upgrade, then a message in /opt/lucidworks/fusion/4.2.x/var/upgrade/tmp/migrator.log (on Unix) or C:\lucidworks\fusion\4.2.x\var\upgrade\tmp\migrator.log (on Windows) indicates this.

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

If no Internet connection is available

If no Internet connection is available during an upgrade, the migrator cannot automatically download the connectors it needs. Using the Fusion UI or API later to install the connectors also might not be an option.

In this case, download the connectors from Fusion 4.x Connector Downloads for all existing connectors and place them in apps/connectors/bootstrap-plugins for the new deployment (on all Fusion nodes). Do so at the time indicated in the procedures that follow.

Adding connectors during an upgrade

You can add connectors during an upgrade (that is, add connectors that are not in the old deployment).

Download the connectors from Fusion 4.x Connector Downloads and place them in apps/connectors/bootstrap-plugins for the new version (on all Fusion nodes).

Object migrations and transformations

The migrator automatically migrates these Fusion 4.2 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

In Fusion Server 4.0 and later, most objects exist in the context of apps. When you upgrade from Fusion Server 4.2.x to 4.2.y, the migrator upgrades 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 upgrades all access control configurations:

Security realms
Roles
Users

None of these should require adjustments after migration.

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.

That article also contains instructions regarding what to do if an upgrade step fails.

Upgrade on Unix

Use this procedure to upgrade Fusion on a single Unix node or on multiple Unix nodes.

Perform the steps in this procedure on the indicated nodes on which Fusion is running ("Fusion nodes"). To perform an upgrade, Fusion nodes must have at least these services running:

API service (api)
Proxy service (proxy)

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 is no special requirement as to which one you pick.

Ensure that your current version of Fusion has a valid license

Ensure that your current version of Fusion has a valid permanent Fusion license before proceeding with the upgrade. Place a valid license.properties file in the /opt/lucidworks/fusion/4.2.x/conf directory.

Download and install the newer version of Fusion

Perform these tasks on all Fusion nodes:

Select the Fusion release to which you are upgrading from Fusion Server 4.x File Download Links.
Extract the newer version of Fusion:
```
cd /opt/lucidworks
mv ~/Downloads/fusion-4.2.y.tar.gz ./
tar -xf fusion-4.2.y.tar.gz
```
For example, if Fusion is currently installed in /opt/lucidworks/fusion/4.2.x, then change your working directory to /opt/lucidworks/ and extract the file there. do not run the new version of Fusion yet.
Ensure that the new version of Fusion has a valid permanent Fusion license before proceeding with the upgrade. Place a valid license.properties file in the /opt/lucidworks/fusion/4.2.y/conf directory.
(If there are custom jar files) If your deployment has custom jar files, add them to the new Fusion deployment.
(If you are performing an upgrade without Internet access) Without Internet access, the migrator cannot download new versions of connectors automatically. Download the new versions of connector zip files for your current connectors from Fusion 4.x Connector Downloads and place them in apps/connectors/bootstrap-plugins for the new deployment.
(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 Fusion 4.x Connector Downloads and place them in apps/connectors/bootstrap-plugins for the new deployment.
Verify that there is sufficient disk space for a second copy of the Solr index directory, fusion/4.2.x/data/solr. If there is not sufficient disk space, free up space before proceeding.

Download and install the Fusion migrator

Perform these tasks on all Fusion nodes:

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.)
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/lucidworks/fusion/4.2.x"
export FUSION_NEW="/opt/lucidworks/fusion/4.2.y"
```
For example, when upgrading from Fusion 4.2.0 to 4.2.6:
```
export FUSION_OLD="/opt/lucidworks/fusion/4.2.0"
export FUSION_NEW="/opt/lucidworks/fusion/4.2.6"
```
Create this directory:
```
mkdir $FUSION_OLD/var/upgrade
```

Install the migrator:

tar -zxv -C $FUSION_OLD/var/upgrade --strip-components=1 -f fusion-migrator.tar.gz

Run the migrator

Perform these tasks on the indicated nodes:

(On all Fusion nodes) Start all Fusion services for the old version of Fusion:
```
$FUSION_OLD/bin/fusion start
```
(Only on the main Fusion node) Run the migrator to export the configuration data from the old version of Fusion:
```
java -jar $FUSION_OLD/var/upgrade/migrator.jar --export
```
This message indicates that the step finished successfully:
```
Old Fusion configuration export (--export) finished successfully.
```

(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/sql 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 services are running, also stop those:

$FUSION_OLD/bin/spark-master stop
$FUSION_OLD/bin/spark-worker stop

You can see what is running with $FUSION_OLD/bin/fusion status.

(Only on secondary Fusion nodes) Prepare secondary nodes:

java -jar $FUSION_OLD/var/upgrade/migrator.jar --prepare-secondary

This message indicates that the step finished successfully:

Prepare secondary nodes (--prepare-secondary) finished successfully.

(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
```
(Only on the main Fusion node) Transform configuration data on the main Fusion node:
```
java -jar $FUSION_OLD/var/upgrade/migrator.jar --main-transform
```
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:
```
Fusion data transformations on main node (--main-transform) finished successfully.
```
(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
```
(Only on the main Fusion node) Import the first part of configuration data into the new version of Fusion:
```
java -jar $FUSION_OLD/var/upgrade/migrator.jar --zookeeper-import
```
This message indicates that the step finished successfully:
```
New Fusion Zookeeper import (--zookeeper-import) finished successfully.
```
(On all Fusion nodes) Start all Fusion services for the new version of Fusion:
```
$FUSION_NEW/bin/fusion start
```

(Only on the main Fusion node) Import the second part of configuration data into the new version of Fusion:

java -jar $FUSION_OLD/var/upgrade/migrator.jar --fusion-import

This message indicates that the step finished successfully:

New Fusion object import (--fusion-import) finished successfully.

After migration, you can find details about the results in the fusion/4.2.x/var/upgrade/tmp directory. If the migration produces unexpected results, the files in this directory are helpful for troubleshooting.

Validate the new version of Fusion

How to validate the new version of Fusion

(Only on the main Fusion node) Restart the new version of Fusion (all services defined in fusion.properties):
```
$FUSION_NEW/bin/fusion restart
```
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.
Ensure that all connectors were installed automatically during the upgrade.
- For Fusion 4.x 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.
- For Fusion 3.x from the Fusion launcher, click Devops > Home > 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.
When you are satisfied with the migration and you have backed up the fusion/4.2.x/ directory, you can rm -fr fusion/4.2.x/ to remove the older version of Fusion (on all Fusion nodes).

Add support for business rules to existing apps

Fusion AI 4.2 introduces functionality for using business rules, that is, manually created formulas for rewriting queries and responses.

You can add support for business rules to apps that were created in versions of Fusion AI prior to version 4.2. To do so, perform the steps in this section.

The add-rule-objects-xyz.zip file (where xyz is a version number) specifies the objects to add to an app. It is supplied in the Fusion migrator zip file at the top level. After installing the migrator, the location is $FUSION_OLD/var/upgrade/import-files.

Adding support for business rules has a costs. Additional collections and objects are created. Only add support for business rules to apps in which you plan to use them.

You have a choice. You can update each app using the Fusion UI or the Fusion API.

Fusion UI

For each app in which you plan to use business rules, import the objects in the add-rule-objects-xyz.zip file into the app.

How to import business rule objects

In the Fusion launcher, click the app into which you want to import objects.

The Fusion workspace appears.
In the upper left, click System > Import Fusion Objects.

The Import Fusion Objects window opens.
For the data file, select add-rule-objects-xyz.zip from your local filesystem. The location in the extracted migrator files is $FUSION_OLD/var/upgrade/import-files.
Click Import.
Edit the Application ID parameter value to use the app name. If the app name contains spaces, replace those with underscore characters. For example, Lucene Revolution would become Lucene_Revolution.
Click Import.
If there are conflicts, Fusion prompts you to specify an import policy. Click Merge to skip all conflicting objects and import only the non-conflicting objects.

Fusion confirms that the import was successful.
Click Close to close the Import Fusion Objects window.

Fusion API

For each app in which you plan to use business rules, import the objects in the add-rule-objects-xyz.zip file into the app.

How to import business rule objects

Create an app-name.txt file with the following content:
```
{"app.id" : "_name-of-migrated-app_"}
```
For example, for the app Lucene Revolution:
```
{"app.id" : "Lucene_Revolution"}
```
Here, we assume that you create the files in your home directory, for which the $HOME environment variable is defined.

Import the business rule objects:

curl -u USERNAME:PASSWORD -H "Content-Type:multipart/form-data" -X POST -F 'variableValues=path-to-txt-file/app-name.txt' -F "importData=path-to-zip-file/add-rule-objects-xyz.zip" "http://localhost:8765/api/v1/objects/import?importPolicy=merge"

For example:

curl -u admin:Very-SecurePW8 -H "Content-Type:multipart/form-data" -X POST -F 'variableValues=$HOME/Lucene_Revolution.txt' -F "importData=$FUSION_OLD/var/upgrade/import-files/add-rule-objects-001.zip" "http://localhost:8765/api/v1/objects/import?importPolicy=merge"

Upgrade on Windows

Use this procedure to upgrade Fusion on a single Windows node or multiple Windows nodes.

Perform the steps in this procedure on the indicated nodes on which Fusion is running ("Fusion nodes"). To perform an upgrade, Fusion nodes must have at least these services running:

API service (api)
Proxy service (proxy)

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 is no special requirement as to which one you pick.

Ensure that your current version of Fusion has a valid license

Ensure that your current version of Fusion has a valid permanent Fusion license before proceeding with the upgrade. Place a valid license.properties file in the C:\lucidworks\fusion\4.2.x\conf directory.

Download and install the newer version of Fusion

Perform these tasks on all Fusion nodes:

Select the Fusion release to which you are upgrading from Fusion Server 4.x File Download Links.
Move the fusion-4.2.y.zip file to the directory that contains the fusion\ directory.

For example, if Fusion is installed in C:\lucidworks\fusion\4.2.x, then move the file to C:\lucidworks.
Unzip the fusion-4.2.y.zip file. do not run the new version of Fusion yet.
For Fusion 4.x, ensure that the new version of Fusion has a valid permanent Fusion license before proceeding with the upgrade. Place a valid license.properties file in the C:\lucidworks\fusion\4.2.y\conf directory.
(If there are custom jar files) If your deployment has custom jar files, add them to the new Fusion deployment.
(If you are performing an upgrade without Internet access) Without Internet access, the migrator cannot download new versions of connectors automatically. Download the new versions of connector zip files for your current connectors from Fusion 4.x Connector Downloads and place them in apps\connectors\bootstrap-plugins for the new deployment.
(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 Fusion 4.x Connector Downloads and place them in apps\connectors\bootstrap-plugins for the new deployment.
Verify that there is sufficient disk space for a second copy of the Solr index directory, fusion\4.2.x\data\solr. If there is not sufficient disk space, free up space before proceeding.

Download and install the Fusion migrator

Perform these tasks on all Fusion nodes:

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.)
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.2.0
set FUSION_NEW=C:\lucidworks\fusion\4.2.6
```
Create a fusion\4.2.x\var\upgrade directory.
Unzip the migrator zip file, and move the contents of the extracted folder to fusion\4.2.x\var\upgrade.

Run the migrator

Perform these tasks on the indicated nodes:

(On all Fusion nodes) Start all Fusion services for the old version of Fusion:
```
%FUSION_OLD%\bin\fusion.cmd start
```
(Only on the main Fusion node) Run the migrator to export the configuration data from the old version of Fusion:
```
java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" --export
```
This message indicates that the step finished successfully:
```
Old Fusion configuration export (--export) finished successfully.
```

(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\sql.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

You can see what is running with %FUSION_OLD%\bin\fusion status.

(Only on secondary Fusion nodes) Prepare secondary nodes:

java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" --prepare-secondary

This message indicates that the step finished successfully:

Prepare secondary nodes (--prepare-secondary) finished successfully.

(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
```
(Only on the main Fusion node) Transform configuration data on the main Fusion node:
```
java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" --main-transform
```
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:
```
Fusion data transformations on main node (--main-transform) finished successfully.
```
(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
```
(Only on the main Fusion node) Import the first part of configuration data into the new version of Fusion:
```
java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" --zookeeper-import
```
This message indicates that the step finished successfully:
```
New Fusion Zookeeper import (--zookeeper-import) finished successfully.
```
(On all Fusion nodes) Start Solr for the new Fusion version:
```
%FUSION_NEW%\bin\solr.cmd start
```

(Only 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.

(On all Fusion nodes) Start all Fusion services for the new version of Fusion:
```
%FUSION_NEW%\bin\fusion.cmd start
```

(Only on the main Fusion node) Import the second part of configuration data into the new version of Fusion:

java -jar "%FUSION_OLD%\var\upgrade\migrator.jar" --fusion-import

This message indicates that the step finished successfully:

New Fusion object import (--fusion-import) finished successfully.

After migration, you can find details about the results in the fusion\4.2.x\var\upgrade\tmp directory. If the migration produces unexpected results, the files in this directory are helpful for troubleshooting.

Validate the new version of Fusion

How to validate the new version of Fusion

(On all Fusion nodes) Restart all Fusion services for the new version of Fusion:
```
%FUSION_NEW%\bin\fusion.cmd restart
```
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.
Ensure that all connectors were installed automatically during the upgrade.
1. For Fusion 4.x 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.
2. For Fusion 3.x from the Fusion launcher, click Devops > Home > 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.
When you are satisfied with the migration and you have backed up the fusion\4.2.x directory, you can remove the older version of Fusion by removing that directory (on all Fusion nodes).

Add support for business rules to existing apps

Fusion AI 4.2 introduces functionality for using business rules, that is, manually created formulas for rewriting queries and responses.

You can add support for business rules to apps that were created in versions of Fusion AI prior to version 4.2. To do so, perform the steps in this section.

You have a choice. You can update each app using the Fusion UI or the Fusion API.

Fusion UI

For each app in which you plan to use business rules, import the objects in the add-rule-objects-xyz.zip file into the app.

How to import business rule objects

In the Fusion launcher, click the app into which you want to import objects.

The Fusion workspace appears.
In the upper left, click System > Import Fusion Objects.

The Import Fusion Objects window opens.
For the data file, select add-rule-objects-xyz.zip from your local filesystem. The location in the extracted migrator files is %FUSION_OLD%\var\upgrade\import-files\.
Click Import.
Edit the Application ID parameter value to use the app name. If the app name contains spaces, replace those with underscore characters. For example, Lucene Revolution would become Lucene_Revolution.
Click Import.
If there are conflicts, Fusion prompts you to specify an import policy. Click Merge to skip all conflicting objects and import only the non-conflicting objects.

Fusion confirms that the import was successful.
Click Close to close the Import Fusion Objects window.

Fusion API

For each app in which you plan to use business rules, import the objects in the add-rule-objects-xyz.zip file into the app.

How to import business rule objects

Create an app-name.txt file with the following content:
```
{"app.id" : "_name-of-migrated-app_"}
```
For example, for the app Lucene Revolution:
```
{"app.id" : "Lucene_Revolution"}
```
Here, we assume that you create the files in your home directory, for which the %HOMEPATH% environment variable is defined.

Import the business rule objects:

curl -u USERNAME:PASSWORD -H "Content-Type:multipart/form-data" -X POST -F 'variableValues=path-to-txt-file\app-name.txt' -F "importData=path-to-zip-file\add-rule-objects-xyz.zip" "http://localhost:8765/api/v1/objects/import?importPolicy=merge"

For example:

curl -u admin:Very-SecurePW8 -H "Content-Type:multipart/form-data" -X POST -F 'variableValues=%HOMEPATH%\Lucene_Revolution.txt' -F "importData=%FUSION_OLD%\import-files\add-rule-objects-001.zip" "http://localhost:8765/api/v1/objects/import?importPolicy=merge"