Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Acrobat logo Download topic as PDF

About the Upgrade Readiness App

The Upgrade Readiness App version 3.1.0 is an extension of the Upgrade Readiness App 3.0.2, which replaced the Splunk Platform Upgrade Readiness App. Use the Upgrade Readiness App to prepare your Splunk platform deployment for upgrade to Python 3 and jQuery 3.5.

This version of the app is present by default in Splunk Cloud Platform 8.2.2201 and higher. You can use the Upgrade Readiness App 3.1.0 on Splunk Enterprise versions 8.0 and higher, or Splunk Cloud Platform versions 8.2.2201 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.

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.
  • Uses of out of date Python SDKs.
  • 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.

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.

Get started

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.

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:

  • Search & Reporting
  • splunk_archiver
  • splunk_instrumentation
  • splunk_monitoring_console
  • learned
  • splunk_gdi
  • splunk_metrics_workspace
  • splunk_httpinput
  • SplunkLightForwarder
  • SplunkForwarder
  • sample_app
  • legacy
  • launcher
  • user-prefs
  • introspection_generator_addon
  • gettingstarted
  • appsbrowser
  • default
  • alert_webhook
  • alert_logevent
  • python_upgrade_readiness_app
  • framework
  • splunk_rapid_diag
  • splunk_secure_gateway
  • splunk_internal_metrics
  • journald_input
  • upgrade_readiness_app
  • _cluster
  • splunk_essentials_8_2
  • splunk-dashboard-studio
  • 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
  • cloud_administration
  • dmc
  • dynamic-data-self-storage-app
  • splunk_instance_monitoring
  • tos
  • data_manager
  • splunk_product_guidance
  • DA-ITSI-APPSERVER
  • DA-ITSI-DATABASE
  • DA-ITSI-EUEM
  • DA-ITSI-LB
  • DA-ITSI-OS
  • DA-ITSI-STORAGE
  • DA-ITSI-VIRTUALIZATIONDA-ITSI-WEBSERVER
  • SA-IndexCreation
  • SA-ITOA
  • SA-ITSI-ATAD
  • SA-ITSI-CustomModuleViz
  • SA-ITSI-Licensechecker
  • SA-ITSI-MetricAD
  • SA-UserAccess
  • ITSI
  • Splunk_TA_mint
  • splunk_app_mint
  • Splunk_SA_Scientific_Python_linux_x86
  • Splunk_SA_Scientific_Python_windows_x86_64
  • Splunk_SA_Scientific_Python_darwin_x86_64
  • Splunk_SA_Scientific_Python_linux_x86_64
  • Splunk Enterprise Security
  • DA-ESS-AccessProtection
  • DA-ESS-EndpointProtection
  • DA-ESS-IdentityManagement
  • DA-ESS-NetworkProtection
  • DA-ESS-ThreatIntelligence
  • SA-AccessProtection
  • SA-AuditAndDataProtection
  • SA-EndpointProtection
  • SA-IdentityManagement
  • SA-NetworkProtection
  • SA-ThreatIntelligence
  • SA-UEBA
  • SA-Utils
  • splunk-business-flow
  • splunk_for_vmware
  • SA-VMW-Performance
  • SA-VMW-LogEventTask
  • SA-VMW-HierarchyInventory
  • SA-Threshold
  • Splunk_DA-ESS_PCICompliance
  • splunk_app_cloudgateway
  • splunk_app_infrastructure
  • Splunk_TA_opc
  • splunk_app_addon-builder
  • Splunk_TA_ueba
  • SA-Hydra
  • Splunk_TA_vmware
  • DA-ITSI-CP-aws-dashboards
  • DA-ITSI-CP-unix-dashboards
  • DA-ITSI-CP-microsoft-exchange
  • DA-ITSI-CP-vmware-dashboards
Last modified on 02 June, 2022
  NEXT
Install the Upgrade Readiness App

This documentation applies to the following versions of Splunk® Enterprise: 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8


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