Install or Update the Deployment Manager Tool for On-Premise Software Updates (ItemPath 3)

Updating an On-Premise installation of ItemPath to version 3.0.0.0 and later requires ItemPath's Deployment Manager Tool. This tool is used to update, start, stop, and check an ItemPath deployment.

The ItemPath support team will provide the installer files for your operating system:

• Linux: install-deployment-manager.sh
• Windows: Install-ItemPathDeploymentManager.cmd and Install-ItemPathDeploymentManager.ps1

Replace <target-version> with the ItemPath version being installed, such as 3.3.1. 

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. In the event of a firewall issue preventing this, please reach out to ItemPath support.
• Save the installer file on the ItemPath host.

Install or Refresh the Deployment Manager

For a fresh install of ItemPath, you'll need to do an initial installation of the Deployment Manager. For future updates, you may need to refresh to the Deployment Manager to ensure you're running the latest version.

Open a terminal in the folder that contains install-deployment-manager.sh.

Install the utility: 

Linux:

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

If the ItemPath deployment root is not the operator home directory, include it:

bash install-deployment-manager.sh <target-version> --deployment-root /path/to/itempath-root

Check that the command works:

 itempath-deploy status

If itempath-deploy is not found, use the full wrapper path printed by the installer.

Windows Instructions

Open PowerShell or Command Prompt in the folder that contains both Windows installer files from support.

Install the utility: 

.\Install-ItemPathDeploymentManager.cmd -Version <target-version>

If the ItemPath deployment root is not the operator home directory, include it:

 .\Install-ItemPathDeploymentManager.cmd -Version <target-version> -DeploymentRoot C:\ItemPathHost

Check that the command works:

 cd $HOME
.\itempath-deploy.cmd status

The Windows installer creates the launcher here:

 $HOME\itempath-deploy.cmd

After Installation

Use the update instructions support provides for your ItemPath version.

Common checks:

Linux:

itempath-deploy status

Windows: 

 cd $HOME
.\itempath-deploy.cmd status