About the Splunk Python Upgrade Readiness App

The Python Upgrade Readiness App version 2.0.0 now supports both Splunk Enterprise and Splunk Cloud Platform.

Use the Python Upgrade Readiness App to prepare your deployment for upgrade to Python 3. This app scans Splunk apps installed on Splunk Enterprise version 7.3, 8.0, 8.1, or 8.2, and Splunk Cloud Platform 8.2.2107 for features and code that might not work with Python 3.

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 are upgraded to a new version of Python on the Splunk platform. For example, scan results show if any apps and customizations rely on Python 2. This is important as support for Python 2 is being phased out of Splunk software.

On Splunk Cloud Platform, the Python 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

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

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

What the scan checks for

On Splunk Enterprise, the Python Upgrade Readiness App checks for:

• Python 3 incompatible code in custom Mako templates.
• Python scripts that might fail in Python 3.

On Splunk Cloud Platform, the app performs the above checks on search heads and indexers.

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

Which apps does the scan include

This 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 Python 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

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 made by the user are listed on the 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 Python Upgrade Readiness App.

For instructions on how to use the app, see Scan your instance with the Python Upgrade Readiness App.

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