Migrating from 2.x to 3.0

Content Intelligence Installation and Deployment Guide
Version
3.0.x
File Size
660 KB
Audience
anonymous
Part Number
MK-HCI009-01
ft:lastEdition
2025-04-09

While there is no direct upgrade path from HCI 2.x to 3.0, users can migrate their 2.x configuration and components onto their 3.0 systems.

To do this, you must:
  1. Backup your HCI 2.x Solr 8 indexes.
  2. Export your HCI 2.x system components.
  3. Install HCI 3.0 on your system.
  4. Import your HCI 2.x system components.
  5. Restore your HCI 2.x Solr 8 indexes.

Backup your HCI 2.x Solr 8 indexes.

To backup your HCI 2.x indexes:

  1. Open Workflow Designer.
  2. Click the question mark icon.
  3. Click Workflow API.
  4. Click recovery.
  5. Click POST /recovery/backup/indexes/{indexName}/start.
  6. Click Try it out.
  7. In the Index name field, enter the name of your index.
  8. Click Execute.

Export your HCI 2.x system components.

Your system configuration and components can be exported in HCI 2.x as a package file.

To do this:

  1. In the Admin App, click Configuration.
  2. Click Packages.
  3. Click Export.
  4. Under Customize Package Description, give your package a name and an optional description.
  5. Under Encryption, select a security passphrase for the package. If no passphrase is entered, one will not be required upon import.
  6. Under Configuration, select any configuration items you wish to export.
  7. Under Plugins, select any plugin bundles you wish to export.
  8. Under Components, select any available components you wish to export.
  9. Under Validate, make sure your package is valid and then click Download Package.
  10. Click Finish.

Install HCI 3.0 on your system.

Follow the instructions contained within this guide in order to install HCI 3.0 on your system.

Set up the recovery APIs in HCI 3.0

In order to import your HCI 2.x indexes, you must first set up the HCI 3.0 recovery APIs using the POST /configuration/recovery call found within Workflow Designer.

To do this:

  1. Open Workflow Designer.
  2. Click the question mark icon.
  3. Click Workflow API.
  4. Click recovery.
  5. Click POST /recovery/configuration.
  6. Click Try it out.
  7. In the Edit Value field, modify the nfsServer, nfsExportPath, and nfsMountOptions values to include your current Network File System (NFS) configuration.
  8. Click Execute.

Import your HCI 2.x system components.

There are several necessary steps required when importing your prior HCI 2.x system components into HCI 3.0:

For pipelines and data connectors:

  1. Open Workflow Designer.
  2. Click the question mark icon.
  3. Click Workflow API.
  4. Click workflows.
  5. Click POST /workflows/plugin/import.
  6. Click Try it out.
  7. Click Browse... and select the HCI 2.x package file containing your pipelines and data connectors.
  8. Click Execute.
For plugins and user groups:
Important: From within Keycloak, roles must be created matching the user groups you intend on importing in order for them to be assigned correctly on your HCI 3.0 system.
  1. Open Workflow Designer.
  2. Click the question mark icon.
  3. Click Workflow API.
  4. Click admin.
  5. Click POST /admin/permissions/import.
  6. Click Try it out.
  7. Click Browse... and select the HCI 2.x package file containing your plugins and user groups.
  8. Click Execute.

Restore your HCI 2.x Solr 8 indexes.

Important: Prior to restoring your 2.x indexes onto your 3.0 system, you must first use either chown 1001:1001 -R /<path_to>/solrBackups or chmod 777 /<path_to>/solrBackups to assign the correct permissions needed to the Solr restore directory.
To restore your HCI 2.x indexes onto your 3.0 system:
  1. Open Workflow Designer.
  2. Click the question mark icon.
  3. Click Workflow API.
  4. Click recovery.
  5. Click POST /recovery/restore/indexes/start.
  6. Click Try it out.
  7. In the Edit Value field, modify the sourceIndexName and destinationIndexName values to include the name of your source index and destination index.
  8. Click Execute.