Updating ItemPath (ItemPath 3)

ItemPath updates do not install automatically. Use the itempath-deploy utility to check the current version, apply the target version, and confirm the update completed.

Note: These instructions are for updates from ItemPath from 3.0.0 to later versions. If you are updating from ItemPath 2 to ItemPath 3, use these instructions instead.

Before You Start

• Docker must be installed and running.
• Docker Compose v2 must be available through docker compose.
• The Docker engine must run Linux containers.
• The operator must have permission to run Docker commands.
• The host must be able to pull ItemPath images from the registry, unless the images are already loaded locally.
• Save the installer file on the ItemPath host.

In the instructions below, replace <target-version> with the ItemPath version being installed, such as 3.4.7. 

Follow These Steps to Perform the Update

1. Make note of the current version of ItemPath installed in your environment.
2. Confirm the Deployment Manager is installed and on the latest version before continuing.

   1. Linux:

      bash install-deployment-manager.sh <target-version>

   2. Windows:

      cd $HOME
      .\Install-ItemPathDeploymentManager.cmd <target-version>

3. Apply the Update. The upgrade command will back up the current deployment and apply the update to the specified version.

   1. Linux:

      itempath-deploy upgrade <target-version>

   2. Windows:

      cd $HOME
      .\itempath-deploy.cmd upgrade <target-version>

4. If prompted INSTALL_TYPE is not set in .env. Is this a cloud or on premise install? enter on premise. Follow any additional confirmation prompts that appear.
5. Confirm that the current version is now the specified version of ItemPath 3.

   1. Linux:

      itempath-deploy status

   2. Windows:

      cd $HOME
      .\itempath-deploy.cmd status

6. Open your ItemPath application and confirm it loads as expected.

Rollback the Update

If for any reason, you need to roll back the upgrade, use the following command to restore the earlier deployment state.

Linux:

itempath-deploy rollback

Windows:

cd $HOME
.\itempath-deploy.cmd rollback

Note: the rollback command does not preserve changes made after the migration. It will restore the backup of your environment prior to the upgrade.

If your ItemPath environment is not loading after the rollback, use the following command to restart the environment.

Linux:

itempath-deploy restart

Windows:

cd $HOME
.\itempath-deploy.cmd restart

What Not To Do

• Do not manually edit ItemPath deployment files.
• Do not stop, start, or update ItemPath with manual Docker commands as the migration path.
• Do not move or delete ItemPath data while updating.
• Do not remove deployment backups unless support confirms it is safe.
• Do not roll back without understanding that changes made after the migration will be discarded.