About the Splunk Platform Upgrade Readiness App
Use the Splunk Platform Upgrade Readiness App to prepare your Splunk platform instance for upgrade to the next version. The Upgrade Readiness App scans selected Splunk apps installed on a Splunk Enterprise version 7.3 instance for features and code that will not work in future versions of the Splunk platform.
The scan results describe how to take action to ensure the apps and customizations you are responsible for work as expected after you upgrade to a new version of the Splunk platform. For example, the scan results indicate if any apps and customizations rely on Python 2. This is important because support for Python 2 is being phased out. Before the Python 2 end of life date, Splunk plans to release a version of Splunk Enterprise, referred to as the Splunk Enterprise Python 3 release, which supports the migration from Python 2 to Python 3. The Splunk Enterprise Python 3 release will include both the Python 2.7 and Python 3.7 runtimes to help customers transition from Python 2 to Python 3. Splunk will remove the Python 2.7 runtime altogether in a future release.
For more information about the Splunk Enterprise Python 3 release, see Python 3 migration with the Splunk platform.
The Splunk Platform Upgrade Readiness App is tool for assisting with your transition between Python 2 and Python 3. Even if your deployment passes all checks, you still need to independently test your private and customized apps and add-ons for incompatibilities.
What the scan checks for
The Upgrade Readiness App checks for:
- Use of Advanced XML
- Use of SplunkWeb legacy mode
- The existence of files named
- Dependency on the M2Crypto module
- Use of custom Mako templates
- Use of custom CherryPy endpoints
- Python scripts
For more information about these checks and what to do with the results, see Scan your instance with the Splunk Platform Upgrade Readiness App.
What apps are included in the scan
When you install the Splunk Platform Upgrade Readiness App on a Splunk platform instance, it scans all apps and add-ons in the
$SPLUNK_HOME/etc/apps folder, with some exceptions. The app scans the private apps that you have created for your own organization as well as apps that you have installed from Splunkbase, whether they are third-party apps or Splunk Supported apps. The scan includes disabled apps.
Even if you have them installed, 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
To get started, see Install the Splunk Platform Upgrade Readiness App.
For instructions on how to use the app, see Scan your instance with the Splunk Platform Upgrade Readiness App.
For information about features, fixed issues, and known issues in this app, see the Release notes for the Splunk Platform Upgrade Readiness App.
Install the Splunk Platform Upgrade Readiness App
This documentation applies to the following versions of Splunk® Platform Upgrade Readiness App: 0.1.0, 1.0.0, 2.0.0