Upgrading HCLDetect

This provides explains step-by-step instructions for upgrading the Detect application from an older version to the latest version. The guide includes procedures for both on-premises and cloud deployments.

Prerequisites

Before beginning the upgrade process, ensure the following prerequisites are met:

  • The currently running Detect version is operational.
  • The latest installer package is available, including:
    • TAR files
    • Docker images
    • Helm charts (for cloud deployments)

Upgrade Procedure

To upgrade the older version of Detect, follow the steps below:

  1. Stop the Existing Detect Application
    1. On-premises: Run the following command:
      cd <~old_install_path>/drive/bin
      ./environment_setter
      ./services_manager stop
    2. Cloud:Stop the Helm charts:
      helm uninstall <detect-helm-chart-name>

      Stop the virtual machine services:

      cd <~old_install_path>/drive/bin
      ./environment_setter
      ./services_manager stop -o -p -s -t
  2. Take a backup of the existing Detect database. For example, back up the drive_acme_core database using your preferred method.
  3. Locate the latest TAR file for the Detect installer, and extract the contents into a preferred directory.
  4. Verify that the parameter configurations in the drive.json file at the old installation path (~old_install_path/drive/etc) match the drive.json file at the new installation path (~new_install_path/drive/etc).
  5. From the new installation path (~new_install_path/drive/bin/installer), run the interactive installer.
  6. Migrate Configuration Directories:
    1. Fastpast:

      Copy the fastpast directory from the old instance home (~old_install_path/instance_home) to the new instance home (~new_install_path/instance_home).

      Edit each .conf file under fastpast to update the dbRootDirectory key with the correct path.

    2. Pinpoint:

      Copy the pinpoint directory from the old instance home (~old_install_path/instance_home/pinpoint) to the new instance home (~new_install_path/instance_home/pinpoint.

      Edit each .conf file under pinpoint to update the dir key accordingly.

  7. From the new installation's bin directory, run the following commands:
    ./environment_setter
    ./database_migration
    Note: For more information about database migration, refer Upgrading HCLDetect Database.
  8. Additional Steps Based on Deployment Type:
    1. For Cloud:

      Replace the Tomcat directory in the persistent volume claim (PVC) with the new Tomcat version (~new_install_path/instance_home/tomcat).

      Copy drive.json and runtime-environment.json from the old Helm chart directory to the new Helm chart directory.

    2. On-premises: Copy drive.json and runtime-environment.json again from the old installer path (~old_install_path/drive/etc) to the new installer path (~new_install_path/drive/etc).
  9. Start the Detect Application.
    1. On-premises:
      ./services_manager start
    2. Cloud:
      Start the VM services:
      ./services_manager start -o -p -s -t

      Reinstall the Helm chart:

      helm install <detect-helm-chart-name>