arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

On Premise to Cloud Upgrade Procedures

This section provides instructions for upgrading existing on premise Clarity LIMS deployments to cloud hosted deployments. For assistance with upgrade steps, contact the Clarity LIMS Support team.

hashtag
From Versions 4.2 / 4.3 / 5.0 / 5.1 / 5.2 / 6.0 / 6.1 (PostgreSQL) and 4.3 / 5.2 (Oracle) to 6.2

This section provides the steps required to upgrade an existing on-premise deployment of Clarity LIMS to a RedHat Enterprise Linux/Oracle Linux compatible Illumina cloud hosted deployment of Clarity LIMS v6.2.

For installation requirements, see Technical Requirements.

hashtag
Migration Paths

The following table shows the applicable migration paths.

From
To
Notes

hashtag
Prerequisites

Before Illumina can proceed with the upgrade, complete the following prerequisite steps.

hashtag
Provision the New Instance

Illumina provisions an instance installed with the latest qualified Oracle Linux version in the cloud.

circle-info

Upgrades are only supported from Clarity LIMS versions 4.2, 4.3, 5.0, 5.1, 5.2, 6.0, and 6.1 (on-premise).

  • Custom configurations: If you have made any additional configurations that are not part of the Clarity LIMS preinstallation requirements, apply these configurations to the new instance.

  • Passwords: Configure all passwords to be same as the existing instance. After you have verified the new instance, you can change passwords as needed.

hashtag
Verify User Accounts Email Addresses

Make sure that all user accounts have email addresses associated with them. User passwords must be reset after the upgrade is complete.

hashtag
Install and Run the Pre-Validation Script on the Source Server

To assist with validating the system before an upgrade, install the UpgradePreValidation RPM on the source server.

  • This RPM is installed temporarily, and provides tools to help check the system before an upgrade.

  • If validation is successful, you can remove this RPM and proceed with the upgrade.

  1. Install the UpgradePreValidation RPM. Make sure you have the correct repo enabled.

    • On the source server, as the root user, run the following command:

  2. [Optional] Set up Secret Utility.

hashtag
Back Up the Current Database and Clarity LIMS

Archive the backup in case a rollback is required.

Before performing the backup, stop Clarity LIMS. The following command stops all Clarity LIMS components, including Automation Worker and integration services.

  1. Stop Clarity LIMS:

    • On the command-line interface, run the following command as the root user:

  2. Back up Postgresql database:

    On the PostgreSQL server, best practice recommends backing up the database using the pg_dump utility.

If ClarityLIMS-SecretUtil was installed previously, run the following command to set up Secret Utility as the glsjboss user:

NOTE: Using a vault is the safer way of storing application secrets. If using a vault is not possible, the configuration script supports file-based storage.

For more information on the prompts, see section of Guide to Secret Management.

  • Run the validation script as follows.

    1. Make sure that the Clarity LIMS server is running.

    2. As the root user, run the following command:

    3. Review the output of the script to determine if you can proceed with the upgrade. If the script outlines any issues with the potential upgrade, review the generated log files and contact the Clarity LIMS Support team for further assistance.

  • Remove the PreValidation RPM.

    Remove the PreValidation RPM only after you confirm that you can upgrade. If you are unsure, consult the Clarity LIMS LIMS Support team.

    • As the root user, run the following command:

  • The following example assumes the following:
    • The database server and the application server are on the same server.

    • The pg_dump utility is accessible to the glsjboss user.

      Example

      The Postgres DBA uses the following commands to create a database backup in the glsjboss home directory. Substitute the variables as appropriate for the specific environment.

      • As the glsjboss user:

  • Make sure that the following items, and any other files and configurations, are backed up safely:

    • crontab -l

    • custom scripts

    • OS configuration files

    • firewall rules

    • network configuration

    • etc.

    If there are custom changes to any application configurations (to increase performance, security, etc.), restore/configure these items manually later by referencing the backup.

    We recommend that you back up the items into a single zip file and transfer them to the new Cloud instance.

    Directories

    /opt/gls/clarity/users/glsftp or /home/glsftp (Clarity LIMS file store location)

    /opt/gls/clarity/customextensions

    /opt/gls/clarity/glscontents

    Additional configurations:

    rpm -qa | grep "BaseSpace\|Clarity" > clarityrpms.txt

  • PostgreSQL:

    v4.2 On-premise

    v5.0 On-premise

    v5.1 On-premise

    v6.2 Cloud hosted

    Upgrading from CentOS6 to Oracle Linux v8.8 and v8.9 (on-premise to cloud hosted).

    PostgreSQL:

    v4.3 On-premise

    v5.2 On-premise

    v6.0 On-premise

    v6.1 On-premise

    v6.2 Cloud hosted

    Upgrading from CentOS7 to Oracle Linux v8.8 and v8.9 (on-premise to cloud hosted).

    Oracle:

    v4.3 On-premise

    v5.2 On-premise

    v6.2 Cloud hosted

    Migrating from Oracle to PostgresQL.

    v6.2 supports PostgreSQL only.

    Provision the New Instance
    Verify User Accounts Email Addresses
    Install and Run the Pre-Validation Script on the Source Server
    Back Up the Current Database and Clarity LIMS
    ./opt/gls/clarity/config/pending/05_configure_claritylims_secretutil.sh
    bash /opt/gls/ClarityUpgradeValidation/bin/validate.sh
    yum remove ClarityLIMS-UpgradePreValidation
    yum --enablerepo=GLS_Clarity62 install ClarityLIMS-UpgradePreValidation
    /opt/gls/clarity/bin/run_clarity.sh stop 
    cd ~glsjboss
    mkdir -p backups/database
    pg_dump -U <database_user> -O -b -Ft <database_name> -f ~glsjboss/backups/database/clarity-old_version-`date +%Y%m%d%H%M`.tar
    Configuration Script