Showing results for 
Search instead for 
Did you mean: 


The aim of this article is to provide a workflow with detailed steps and a checklist to be used when upgrading Incorta.



  • Upgrade process workflow
  • Upgrade process checklist

Upgrade Main Phases

There are three main phases for doing an upgrade:

  1. Upgrade Preparation
  2. Upgrade
  3. Post-Upgrade Validation

1. Upgrade Preparation

The aim of this phase is to collect information required for the upgrade, collect environment details, install pre-upgrade tools, run pre-upgrade tools, install 3rd party tools, install OS packages and prepare any other considerations.

Upgrade Preparation Steps

  1. Collect environment details, such as current incorta version, target incorta version, required access credentials to the front end and back end, environment type, cluster architecture, and any other important information that is required to upgrade incorta successfully
  2. Get the release package download link and confirm readiness, check Incorta documentation for upgrade readiness and the upgrade guide
  3. If the metadata database is Oracle and upgrade target version is 5.2 or above, a Metadata Database Migration to MySQL is required
  4. If the target version is 5.2.3 or above, request an On Premises license via the License Registration process
  5. Pre-upgrade checks: review the attached checklist for details: Upgrade Process _ Checklist Template.xlsx
    1. Data Agent correct version (if required)
    2. Backend Checks
    3. Frontend Checks
    4. CMC Checks
  6. Run pre-upgrade tools
    1. Alias Sync
    2. Inspector tool
    3. Formula validation
  7. Fix issues reported by the Inspector tool, especially SEV 1 issues, and fix failed formulas
  8. Download, install and configure
    1. Download Data Agent: Tools → Data Agent
    2. Download Incorta package to all nodes
    3. Install Chromium Headless Browser, (for an upgrade to 5.1.x or higher), Install the Chromium headless browser
  9. Schedule the Upgrade Date and Time
  10. Review pre-upgrade preparation and approve to proceed with the upgrade

2. Upgrade

The aim of this phase is to do the actual upgrade.

Upgrade Steps

  1. Pause all scheduled jobs from CMC, check the docs: Pause All Scheduled Load Jobs
  2. Stop Incorta Cluster
  3. Do Backups: more details here, Backup and Restore Strategy
    1. Incorta Metadata
    2. IncortaAnalytics folder w/out logs and spark folders: work and eventlogs
    3. Custom jars
 (if required)
    4. Spark conf files
    5. Tenant(s) folder (if required)
  4. Run Installer from the backend to upgrade CMC, and incorta nodes, check docs link: Upgrade the Incorta cluster
  5. Upgrade Spark if required
  6. Start Incorta Cluster
  7. Upgrade Incorta metadata from CMC UI (If required)
  8. Data Agent Installation & Status Check, check Tools → Data Agent

3. Post-Upgrade Validation

The aim of this phase is to do a sanity check after the upgrade and confirm the success of the upgrade.

Post-Upgrade Steps

  1. Post-Upgrade Checks, check the attached checklist for checks details: Upgrade Process _ Checklist Template.xlsx
    1. Backend Checks
    2. Frontend Checks
    3. CMC Checks
  2. Sanity checks: schema loading, dashboard rendering
  3. Unpause all scheduled jobs from the CMC, check docs Re-enable Scheduled Load Jobs
  4. Handover the environment to the business for review for a couple of days
  5. Confirm the successful upgrade

Related Materials

Best Practices Index
Best Practices

Just here to browse knowledge? This might help!

Version history
Last update:
‎11-16-2022 09:09 AM
Updated by: