Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF


Splunk Enterprise version 8.0 is no longer supported as of October 22, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk® Enterprise. For documentation on the most recent version, go to the latest release.
Acrobat logo Download topic as PDF

Install the Upgrade Readiness App

Install the Python Upgrade Readiness App on all instances of your Splunk platform deployment that run apps or on a single test Splunk platform instance with all your apps installed on it.

The Python Upgrade Readiness app is installed by default on Splunk Enterprise version 8.2 and higher. If you are on a Splunk Enterprise version prior to 8.2 but after 7.3, you can download the Python Upgrade Readiness App from Splunkbase and install it on your deployment.

The Python Upgrade Readiness app is installed by default on Splunk Cloud Platform version 8.2.2107 and higher. You do not need to install or update the app on Splunk Cloud Platform.

Requirements

  • Splunk Enterprise version 7.3, 8.0, 8.1, or 8.2, or Splunk Cloud Platform version 8.2.2107.
  • Installed apps or add-ons.
  • KV store must be enabled.
  • A role must hold the admin_all_objects capability to install the app on Splunk Enterprise. The admin role holds this capability by default.
  • Consider increasing the splunkd session timeout value, depending on the number of custom apps in the environment. For details, see performance considerations.

Performance considerations

The Python Upgrade Readiness App generates a final report that includes all apps after a few cycles of scanning.

On Splunk Enterprise, since the app scanning process runs asynchronously, there is no visible impact on the performance of standalone instances.

On Splunk Cloud Platform, apps that exist only on the remote location do not immediately appear in scan results. All data from all apps on the remote instance will be available in the final merged report after a few scans.

Note that the user session timeout limit is 60 minutes by default. To ensure the user session does not timeout during the app scan, increase the session timeout limit before scanning large numbers of apps, as mentioned in the requirements section. For more information, see Configure user session timeouts

Install the app on a non-clustered Splunk Enterprise instance

To install the app on an non-clustered search head, forwarder, or single-instance Splunk Enterprise deployment:

  1. Download the Splunk Python Upgrade Readiness App version 2.0.0 from Splunkbase.
  2. In Splunk Web, click the App gear icon.
  3. Click Install app from file.
  4. Locate the app installation package and click Upload.
  5. Restart Splunk.
    The app now appears in the list of apps in the Splunk Web UI.

Install the app on a search head cluster

To install the app on a search head cluster, use the deployer. For detailed instructions, see Use the deployer to distribute apps and configuration updates in the Distributed Search manual.


Next, see Manage permissions for the Python Upgrade Readiness App.

Last modified on 21 January, 2022

This documentation applies to the following versions of Splunk® Enterprise: 8.0.0


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters