About the Upgrade Readiness App

This documentation applies to the Upgrade Readiness App version 3.0.2. For information about the Upgrade Readiness App version 3.1.0, see About the Upgrade Readiness App.

The Upgrade Readiness App version 3.0.2 is an extension of the Splunk Python Upgrade Readiness App 2.0.0, which replaced the Splunk Platform Upgrade Readiness App. In addition to scanning your Splunk platform deployment for features and code that might not work with Python 3, this app also scans for jQuery vulnerabilities.

Use the Upgrade Readiness App to prepare your Splunk platform deployment for upgrade to Python 3 and jQuery 3.5. This app can scan Splunk apps installed on Splunk Cloud Platform 8.2.2107 and higher and Splunk Enterprise version 7.3 and higher.

The app's scan results describe the remediation actions you must take to ensure that your public and private apps work as expected after you upgrade to a new version of Python on the Splunk platform, as well as actions you must take to remove dependency on vulnerable versions of jQuery. For example, scan results show if any apps and customizations rely on Python 2 so that you can update them, because support for Python 2 is being phased out of Splunk software.

On Splunk Cloud Platform, the Upgrade Readiness App provides these additional features:

• Scan search heads and indexers and view a combined report from both types of instances.
• Request an upgrade of the default Python version from Python 2 to Python 3.

For more information on the Splunk Enterprise Python 3 release, see Python 3 migration with the Splunk platform.

For more information on jQuery 3.5 support in Splunk software, see Overview of the jQuery 3.5 upgrade.

The Upgrade Readiness App is a tool that assists you with your transition from Python 2 to Python 3, and to jQuery 3.5. Even if your deployment passes all checks, you must still independently test your private and customized apps and add-ons for incompatibilities.

The Upgrade Readiness App comes with Splunk Cloud Platform version 8.2.2109 and higher. You do not need to install the app on these versions of Splunk Enterprise or Splunk Cloud Platform.

What the Upgrade Readiness App scans for in the app default folders

The Upgrade Readiness App checks app default folders for these things:

• Python 3 incompatible code in custom Mako templates.
• Python scripts that might fail in Python 3.
• Lower versions of jQuery prior to jQuery 3.5.
• Templates and dashboards with versions lower than 1.1.
• References to JavaScript files that Splunk software does not support.

In clustered environments, the app performs these checks on search heads and indexers and provides a merged report with remediation steps.

For more information about these checks and what to do with the results, see Scan a Splunk platform instance with the Upgrade Readiness App.

Which apps the Upgrade Readiness App scans

The Upgrade Readiness App scans all apps and add-ons in the $SPLUNK_HOME/etc/apps and $SPLUNK_HOME/etc/slave-apps directories, with some exceptions. The app scans private apps that you have created for your own organization, as well as public apps installed from Splunkbase, including third-party apps and Splunk supported apps.

Exceptions

The Upgrade Readiness App excludes the following apps from the scan:

• Python for Scientific Computing
• Search & Reporting
• Splunk App for Infrastructure
• Splunk App for PCI Compliance
• Splunk App for VMWare
• Splunk Business Flow
• Splunk Cloud Gateway
• Splunk Enterprise Security
• Splunk Industrial Asset Intelligence
• Splunk IT Service Intelligence
• Splunk Platform Upgrade Readiness App
• Splunk RapidDiag
• Splunk Secure Gateway
• Splunk Add-on Builder
• 075-cloudworks
• 100-cloudworks-wlm
• 100-whisper
• 100-whisper-common
• 100-whisper-searchhead
• prometheus
• splunk_datasets_addon
• splunkclouduf
• 100-s2-config
• 100-whisper-clusterapp
• 100-whisper-indexer
• _cluster_admin
• splunk_instance_monitoring

In the Upgrade Readiness App versions 3.0.2 and higher, the following apps are also excluded from scans:

• Splunk User Behavior Analytics
• Splunklib

Python version switch on Splunk Cloud Platform

On the Splunk Cloud Platform version of the app, the Python Version tab is enabled by default for the sc_admin role. This lets Splunk Cloud Platform admins see the current default Python version of the cluster and, if the default version is Python 2, request an upgrade to Python 3. All upgrade requests that users make are listed on this page.

When you request an upgrade from Python 2 to Python 3, the application sends a request to Splunk Support to upgrade the default version of Python across the entire cluster.

See also

To get started, see Install the Upgrade Readiness App.

For instructions on how to use the app, see Scan a Splunk platform instance with the Upgrade Readiness App.

For information about features, fixed issues, and known issues in this app, see Release notes.