ITRS Analytics Upgrade Notes
This document provides important upgrade considerations for ITRS Analytics. Please read the applicable sections thoroughly prior to initiating the upgrade to ensure successful upgrade process and minimize disruption.
For detailed procedures on upgrading in BYO and Embedded Cluster environments, refer to the following sections:
- Upgrade in an online BYO environment
- Upgrade in an air-gapped BYO environment
- Upgrade in an online Embedded Cluster environment
- Upgrade in an air-gapped Embedded Cluster environment
General upgrade instructions (all versions) Copied
Regardless of the version, upgrading ITRS Analytics from a lower version may reset some configurations. It is strongly recommended that you follow these steps during the upgrade process.
Verify and adjust hostnames Copied
If you configured a custom hostname in your existing installation, make sure to manually verify and update the hostname setting after the upgrade. It may not persist automatically.
Reinstall optional apps Copied
Optional apps are not retained automatically through the upgrade. Re-select and reinstall any apps you had previously chosen to ensure feature parity post-upgrade.
Downgrading to earlier versions Copied
Downgrading to an earlier version is not supported. Please ensure you back up all configurations and data before upgrading.
Version-specific considerations Copied
Upgrading to version 2.12.0+2 Copied
Manual selection required for Traces (GA) app Copied
During the upgrade process, the ITRS Analytics Traces (Beta) app will be automatically uninstalled and replaced by the General Availability (GA) version. However, the GA version will not be enabled by default. If you want to continue using ITRS Analytics Traces app, you’ll need to manually select and configure the GA version either before or after the upgrade process.
Note
Your license must include access to the ITRS Analytics Traces app (GA) for this option to be available. If you do not manually select the Traces app during the upgrade, it will not be installed or enabled afterward.
Mandatory use of FQDN for Apps and Ingestion hosts Copied
You are required to enter a fully qualified domain name (FQDN) for both the Apps external host name and Ingestion external host name where the application will be accessible. Before upgrading to version 2.12.0+2, ensure that your Apps and Ingestion hostnames are updated to valid FQDNs.
Impact on existing deployments:
- Upgrading without changing configuration — If you upgrade from a lower version where a short hostname is used and no configuration changes are made after upgrading to 2.12.0+2, the deployment itself will not fail. However, as soon as you attempt to update the configuration (for example, modifying other fields), you will no longer be able to save changes. You will encounter an error message prompting you to enter a valid FQDN in the correct domain format.
- Upgrading with configuration changes — If you upgrade from a lower version with a short hostname and make any configuration changes (even if unrelated to hostnames) after upgrading to 2.12.0+2, you will be unable to save the configuration. The system will display an error requiring you to provide a valid FQDN with the correct domain format.
Upgrading to version 2.12.0+1 Copied
Kafka Controller Replica upgrade for HA Copied
Warning
Before upgrading ITRS Analytics to version 2.12.0+1, you must first complete a prerequisite upgrade. The upgrade may fail if the Kafka controller replica count was modified in the ITRS Analytics configuration file without first completing the upgrade steps. If the upgrade fails due to this configuration, do not attempt to uninstall or manually re-run the ITRS Analytics upgrade.
Please contact ITRS Support for assistance.
For high availability (HA) installations running with only one Kafka Controller replica, manual intervention is required prior to upgrading to ITRS Analytics 2.12.0+1. Please refer to Upgrading Kafka Controller Replica for HA installations, which must be followed carefully to ensure a successful upgrade.
Preflight checks for CSI VolumeSnapshot and Backup configuration Copied
A new preflight check has been introduced to validate support for CSI VolumeSnapshots in the configured StorageClass
. This check must be performed prior to initiating any backup operations to ensure support and backup consistency.
Additionally, backup and restore support is now enabled by default in this release. You can manage this feature through the KOTS Admin Console by navigating to Advanced Settings > Backup and Restore, where the Enable IAX backup and restore setting can be toggled on or off as needed.
Upgrading to version 2.11.0+12 Copied
A new option, Include Disk I/O Test for Support Bundle, has been introduced. The Disk I/O performance check is enabled by default for both preflight checks and support bundle. You can manage these settings independently through the KOTS Admin Console under Advanced Settings > Preflight and Support Bundle Settings.
The Support Bundle is managed independently using the Include Disk I/O Test for Support Bundle option. It operates independently of the Preflight check configuration and remains enabled by default unless explicitly disabled.
For more information, see Preflight checks for Disk I/O performance.
Upgrading to version 2.10.1+6 Copied
The Disk I/O performance check is enabled by default as part of the preflight checks. You can manage this setting independently through the KOTS Admin Console under Advanced Settings > Preflight Settings.
The Preflight check can be disabled via the Run Disk I/O Performance Test option. During reconfiguration, the test is skipped unless it has been explicitly enabled.
For more information, see Preflight checks for Disk I/O performance.
Upgrading to version 2.9.0 Copied
Direct upgrades from ITRS Analytics 2.8.1 or earlier to 2.9.0 are not supported. However, an upgrade path is available to version 2.9.1.
Upgrading to version 2.8.0+5 Copied
If you are running version 2.8.0+4 or an earlier release, the Storage Class name field is read-only and cannot be modified. This setting becomes configurable only during a fresh installation starting with version 2.8.0+5.
Once the cluster has been installed, these values can no longer be modified. This limitation applies even if you update the configuration using the KOTS Admin Console, attempt to make changes through the advanced configuration settings, or upgrade to newer IAX versions.
Note
Any storage class configured in versions earlier than 2.8.0+5 will be retained and carried over when upgrading to version 2.8.0+5 or later.
If you need to change the Storage Class name after installation, this must be done manually, outside of the KOTS Admin Console. Make sure the correct Storage Class names are set before starting the initial install.
Upgrading to or installing version 2.8.0+6 or later Copied
Upon the initial installation or upgrade to ITRS Analytics version 2.8.0+6 or later, you must select whether to install:
- Production apps
- Production and Beta apps
This selection is permanent and cannot be changed in future upgrades. Please carefully consider your requirements before making this choice.
Required releases and upgrade paths Copied
A required or mandatory release means that all users must upgrade to that version to maintain support, security, or compatibility. These releases often include critical patches, changes needed for future upgrades, or updates that address deprecations in earlier versions.
Required releases Copied
Refer to the latest ITRS Analytics Release Notes for complete information.
Supported upgrade paths Copied
- All lower versions to 2.9.1
- Version 2.9.0 to 2.9.1