Splunk® Enterprise

Upgrade Readiness

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

About the Upgrade Readiness App

The Upgrade Readiness App 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. You can also use the Upgrade Readiness App versions 4.0.0 and higher to scan for Splunk platform compatibility. The Splunk platform compatibility scan helps you determine if your deployment is prepared for upgrade to Splunk Enterprise version 9.0 and higher.

To see the latest version of the Upgrade Readiness App, and learn which versions of the Upgrade Readiness App are compatible with your version of Splunk Cloud Platform or Splunk Enterprise, see the Upgrade Readiness App on Splunkbase.

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 Splunk Enterprise 9.0 or higher, or 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.

In Splunk Enterprise 9.0 and higher, Python 2 is no longer an option for Splunk Enterprise. You must use Python 3 only. Splunk Cloud Platform continues to default to Python 2.

On Splunk Cloud Platform only, 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 to Python 3 and jQuery 3.5, and upgrading your deployment to Splunk Enterprise 9.0 or higher. 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

The Upgrade Readiness App checks app default folders for the following issues:

Python

  • Python 3 incompatible code in custom Mako templates.
  • Python scripts that might fail in Python 3.
  • Uses out of date Python SDKs.

jQuery

  • 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.
  • Uses of HTML files that rely on lower versions of jQuery.

Splunk platform compatibility

  • Imports of Python libraries that are making outbound TLS connections.
  • Disabled TLS configurations for search peers in a clustered instance.
  • Disabled TLS configurations for MongoDB and indexers.

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.

The Upgrade Readiness App also completes the following checks on Splunkbase apps:

Python

  • Compatibility with the current Splunk Cloud Platform or Splunk Enterprise version.
  • Listed version of the target app.
  • SDK version of the target app. Splunkbase apps with SDKs with a version lower than 1.6.14 are flagged as an issue, but the app does not fail.

jQuery

  • jQuery dashboard version. Apps that do not have version='1.1' in the root note of the XML file do not pass.
  • Lower versions of jQuery prior to jQuery 3.5.
  • Hotlinking to web libraries. Libraries on the disallowed list cannot be used in JS or HTML files.
  • HTML dashboards. Apps do not pass if they include any HTML files in the /default/data/ui/html/ or /local/data/ui/html/ directories.

Splunk platform compatibility

  • Imports of Python libraries that are making outbound TLS connections.

If the app is marked on Splunkbase as compatible with Splunk Enterprise 9.x, the app passes automatically and does not need this check.

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/peer-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 28 June, 2023
  NEXT
Install the Upgrade Readiness App

This documentation applies to the following versions of Splunk® Enterprise: 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.2.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