Add-on dobump for Splunk

Usage

This is a Add-on for Splunk to provide a custom search command called '| dobump' to reload application server cache. This is need if you update Javascript or CSS related content in Dashboards.

This should give you a possibility to automate cache refreshing in a development environment or using a CI/CD deployment pipeline.

Testing and reproducing

You'll find a "testcss" app in the subfolder of the app.

• Copy this app to $SPLUNK_HOME$/etc/apps and restart.
• Open the testcss dashboard located in the app..
• Now update the file appserver/static/show_rule_details.js file in the app in line 17:

document.getElementById("outputName").innerHTML = "version5";

and output a new string..

• do a reload of the dashboard and notice, that appserver cache will still deliver javascript "version5".

• run " | dobump", reload the dashboard and notice the new string..

Integration to your CI/CD pipeline

You need to run "| dobump" within you CI pipeline after our apps have been deployed. For triggering from a script you can use the search.py from the Splunk SDK /examples repository. You can trigger the dobump using command python search.py --host localhost --username admin --password THISISMYPASSWORD "| dobump "

Let's assume you are deploying your apps to a searchhead cluster:

• first run your deployment from deployer like: /opt/splunk/bin/splunk apply shcluster-bundle -target https://$SPLUNK_SEARCH_HEAD_CAPTAIN_URL:8089 -auth admin:$SPLUNK_PASSWORD --answer-yes
• run the "| dobump" on every shc cluster node

# running bump on shc1
python search.py --host shc1 --username admin --password THISISMYPASSWORD "| dobump"
# running bump on shc2
python search.py --host shc2 --username admin --password THISISMYPASSWORD "| dobump"
# running bump on shc3
python search.py --host shc3 --username admin --password THISISMYPASSWORD "| dobump"

Support

This is an open source project, no support provided, but you can ask questions on answers.splunk.com and I will most likely answer it. Github repository: https://github.com/schose/TA-dobump

This script have been tested against python2.7 and python3.7.

Supported versions:

• Splunk Enterprise v7.3
• Splunk Enterprise v8.0

Links

• https://answers.splunk.com/answers/31289/can-i-issue-a-bump-from-the-command-line.html
• https://docs.splunk.com/Documentation/Splunk/7.3.1/AdvancedDev/CustomizationOptions
• https://answers.splunk.com/answers/315160/how-to-update-splunk-after-javascript-changes-with.html
• https://answers.splunk.com/answers/390115/how-do-you-programmatically-bump-a-search-head.html