The app comes with two custom search commands.
| getsplunkversionswhich reaches out to doc.splunk.com to get a list of available splunk versions. Those are used within the "Target Splunk Version" drop down.| checkappcompatibility target_version=x.x.xdoes the heavy lifting. It depends on a list of apps provided by splunks REST API| rest /services/apps/localbut it is intentionally kept separated. To be able to reach out to the splunkbase API we need the ID's of the apps to check. Thereforecheckappcompatibilitylooks for that information withinupdate.homepage. If there is no URL provided it tries to retrieve the ID using the app'stitlefield.
There are three options to use the app.
- You can use the provided dashboard which lets you check locally installed apps against a "Target Splunk Version".
- You can use the CSC
checkappcompatibilitymanually like that:| rest /services/apps/local | checkappcompatibility target_version=8.2.1if you have usecases not covered by the dashboard. - You can export the results of the REST call and ingest them into another splunk box to let the app check the status there. This comes quite handy if you prepare to upgrade an air-gapped splunk deployment.
- Sometimes splunkbase does not list multiple versions of an app. If your version is not listed, the compatibility can't be checked. I'm assuming that if an existing older version is already compatible with your target version, your version is too.
- Obviously there a couple of apps which are not listed within the splunkbase so they cannot be checked. They will marked as "undecided" (see belows screenshot).
- This app is by no means a substitution of Splunk's python upgrade readiness app as it does not analyze any code. It simply reach out to splunkbase to check compatibility information listed there.
- You technically could check deployment apps but the REST API call mentioned does only contain apps installed locally.
