├── splunk-bash.pptx ├── copytos3.sh ├── install_eventgen.sh ├── install.sh ├── bash ├── README.md └── LICENSE /splunk-bash.pptx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amiracle/splunk-bash/HEAD/splunk-bash.pptx -------------------------------------------------------------------------------- /copytos3.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | aws s3 sync . s3://splunk-bash-installs --exclude '.git*' --exclude 'copytos3.sh' --acl public-read 3 | -------------------------------------------------------------------------------- /install_eventgen.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #prompt to install event-gen 4 | echo "Do you want to install the event-gen on your instance?" 5 | read yneventgen 6 | if [[ "$yneventgen" == *y* ]];then 7 | #open "https://s3.amazonaws.com/splunk-bash-installs/eventgen-develop.tgz" 8 | wget https://s3.amazonaws.com/splunk-bash-installs/eventgen-develop.tgz 9 | echo "Downloaded eventget to $pwd" 10 | #setup eventgen 11 | echo "What is the Splunk instance you want to install the eventget into?" 12 | read splunkhome 13 | 14 | tar xzvf eventgen-develop.tgz -C "/opt/splunk/splunk_$splunkhome/etc/apps" 15 | echo "Splunk Eventgen installed." 16 | fi 17 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # shellcheck disable=SC1090 3 | 4 | # splunk-bash: Simple 5 | # (c) 2017-2018 splunk-bash 6 | # 7 | # 8 | # Installs splunk-bash 9 | # 10 | # This file is copyright under the latest version of the Apache2. 11 | # Please see LICENSE file for your rights under this license. 12 | 13 | # 14 | # 15 | # Install with this command (from your Linux machine): 16 | # 17 | # curl -sSL https://https://s3.amazonaws.com/splunk-bash-installs/install.sh | bash 18 | 19 | # First, let's make sure you have the proper directory and variables set 20 | directory="/opt/upgrade" 21 | 22 | # Go get the bash data from the S3 bucket 23 | curl -Ssl https://s3.amazonaws.com/splunk-bash-installs/bash >> ~/Downloads/bash 24 | 25 | # Backup existing .profile to .orig_profile 26 | mv ~/.profile ~/.orig_profile 27 | 28 | # Append your .profile with the bash commands 29 | cat ~/Downloads/bash >> ~/.profile 30 | 31 | if [ -d "$directory" ];then 32 | echo "Splunk Home exists" 33 | else 34 | echo "Splunk Upgrade Directory does not exist, please download and install Splunk." 35 | open "https://www.splunk.com/download" 36 | fi 37 | echo "Download complete, shell commands installed. Please restart your terminal session for the changes to take effect." 38 | wget https://s3.amazonaws.com/splunk-bash-installs/install_eventgen.sh 39 | sh install_eventgen.sh 40 | -------------------------------------------------------------------------------- /bash: -------------------------------------------------------------------------------- 1 | 2 | # System-wide .bashrc file for interactive bash(1) shells. 3 | if [ -z "$PS1" ]; then 4 | return 5 | fi 6 | 7 | 8 | ##Splunk Commands 9 | export BASE_DIR=/opt/splunk 10 | export SPLUNK_HOME=/opt/splunk 11 | export SPLUNK_LIC="~/Downloads" 12 | 13 | #Stop, start, restart and upgrade individual instances of local Splunk Demos 14 | 15 | startsplunk(){ 16 | export SPLUNK_HOME=/opt/splunk/splunk_$1 | /opt/splunk/splunk_$1/bin/splunk start --accept-license 17 | } 18 | 19 | opensplunk(){ 20 | open http://localhost:8000 21 | } 22 | 23 | stopsplunk(){ 24 | /opt/splunk/splunk_$1/bin/splunk stop 25 | } 26 | 27 | restartsplunk(){ 28 | /opt/splunk/splunk_$1/bin/splunk restart 29 | } 30 | 31 | upgradesplunk(){ 32 | cp -R /opt/upgrade/splunk/* /opt/splunk/splunk_$1 33 | } 34 | 35 | splunkspace() { 36 | du -h /opt/splunk/* | awk '$1 ~ "G" { print $1, $2 }' 37 | } 38 | 39 | cleansplunk() { 40 | /opt/splunk/splunk_$1/bin/splunk clean eventdata -f 41 | } 42 | 43 | createsplunk() { 44 | mkdir -p /opt/splunk/splunk_$1 && cp -R /opt/upgrade/splunk/* /opt/splunk/splunk_$1 45 | } 46 | 47 | addlic() { 48 | export SPLUNK_HOME=/opt/splunk/splunk_$1 | /opt/splunk/splunk_$1/bin/splunk add licenses $SPLUNK_LIC/*.lic 49 | } 50 | 51 | listapps() { 52 | ls $SPLUNK_HOME/splunk_$1/etc/apps 53 | } 54 | 55 | backupsplunk() { 56 | tar czf $SPLUNK_HOME/splunk_$1_archive.tgz -C $SPLUNK_HOME/splunk_$1/etc/apps . -C $SPLUNK_HOME/etc/users | echo Splunk Archive can be found here: $SPLUNK_HOME/splunk_$1_arhive.tgz 57 | } 58 | 59 | restoresplunk() { 60 | tar xzvf /opt/splunk/splunk_$1_archive.tgz -C /opt/splunk/splunk_$2/etc/apps 61 | } 62 | 63 | rmsplunk(){ 64 | rm -Rf $SPLUNK_HOME/splunk_$1 65 | } 66 | 67 | cds(){ 68 | cd $SPLUNK_HOME/splunk_$1 69 | } 70 | 71 | fixperm(){ 72 | sudo chown -R `whoami`:wheel $SPLUNK_HOME/splunk_$1 | sudo chmod -R 755 $SPLUNK_HOME/splunk_$1 73 | } 74 | 75 | svm() { 76 | 77 | if [[ $1 == list ]]; then 78 | if [[ -z $2 || $2 == installed ]]; then 79 | \ls $BASE_DIR/*/bin/splunk | while read path; do 80 | printf "%-10s: %-40s\n" \ 81 | "$(echo $path | sed "s|$BASE_DIR/\([^\/]*\)/bin/splunk|\1|")" \ 82 | "$($path version 2>/dev/null | sed "s/Splunk \([^ ]*\) (build \([^)]*\))/splunk-\1-\2/")" 83 | done 84 | 85 | elif [[ $2 == sourced ]]; then 86 | basename $SPLUNK_HOME 87 | 88 | elif [[ $2 == space ]]; then 89 | du -h /opt/splunk/* | awk '$1 ~ "G" { print $1, $2 }' 90 | 91 | elif [[ $2 == running ]]; then 92 | lsof |grep "/bin/splunk" | awk '{print $9}' | sort -u | awk -F/ '{print $4}' 93 | elif [[ $2 == latest ]]; then 94 | curl http://www.splunk.com/page/release_rss 2>/dev/null | grep "" | sed "s/.* (Build \([^)]*\)).*/\1/" | grep -v title | head -1 95 | fi 96 | 97 | elif [[ -n $1 && -d $BASE_DIR/$1 ]]; then 98 | stripped_path=$(echo $PATH | sed "s|$BASE_DIR/[^:]*:*||g") 99 | export SPLUNK_HOME=$BASE_DIR/$1 100 | export PATH=$SPLUNK_HOME/bin:$stripped_path 101 | export CDPATH=.:~:$BASE_DIR:$SPLUNK_HOME:$SPLUNK_HOME/etc:$SPLUNK_HOME/etc/apps 102 | fi 103 | } 104 | 105 | active_sids() { 106 | svm list running | sed -e :a -e '$!N; s/\n/,/; ta' 107 | } 108 | 109 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # splunk-bash 2 | As a Splunk Sales Engineer I needed a way to quickly build and tear down Splunk instances for creating demos and testing out scenarios. Since I'm also a lasy admin, I wanted a way to do this in a simple and repeatable fashion. What I built was a series of simple commands that live in your `$HOME/.profile` which allow you to do a host of functions. 3 | 4 | For users in ZSH, you'll need to update your `$HOME/.zprofile` with the commands. 5 | 6 | ## Install Process 7 | 8 | 1. Download Splunk (splunk-<version>-<build>-<os>.tgz) from www.splunk.com. * Make sure to get the *.tgz file. * Install it in your /opt/upgrade directory: `tar xzvf splunk-<version>-<build>-<os>.tgz -C /opt/upgrade` This will put the splunk bits in the Splunk Upgrade (`/opt/upgrade/splunk`) Directory 9 | 10 | 2. Get your developer license from [Splunk Dev](dev.splunk.com) dev.splunk.com and put it in your downloads directory. 11 | 12 | ### Install 13 | 14 | Run this command: 15 | `curl -Ssl https://s3.amazonaws.com/splunk-bash-installs/install.sh | bash` 16 | 17 | This will download and install the bash file in this git repo and add it to your local $HOME/.profile . Once it's done, restart your terminal session. 18 | 19 | ### Install EventGen 20 | 21 | I've added the shell script `install_eventgen.sh` to the package which just runs the following commands and installs eventgen on your splunk instance: 22 | 23 | `wget https://s3.amazonaws.com/splunk-bash-installs/install_eventgen.sh 24 | sh install_eventgen.sh` 25 | 26 | Once installed, you can add any TA (that is eventgen enabled) and start seeing sample data flow into your instance. 27 | 28 | ## Commands 29 | 30 | - createsplunk 31 | - creates a local instance of Splunk by copying bits from local repository. 32 | - usage: `createsplunk <instance_name>` 33 | - startsplunk 34 | - starts splunk instance 35 | - usage: `startsplunk <instance_name>` 36 | - stopsplunk 37 | - stops splunk instance 38 | - usage: `stopsplunk <instance_name>` 39 | - cds 40 | - changes directory into splunk instance 41 | - usage: `cds <instance_name>` 42 | - addlic 43 | - adds a license to local splunk instance 44 | - usage: `addlic <instance_name>` 45 | - splunkspace 46 | - displays the total space used by splunk instance 47 | - usage: `splunkspace <instance_name>` 48 | - backupsplunk 49 | - backs up (/etc/apps directory) from splunk instance 50 | - usage: `backusplunk <instance_name>` 51 | - restoresplunk 52 | - restores splunk instance (/etc/apps directory only) 53 | - usage: `restoresplunk <old_instance_name> <new_instance_name>` 54 | - listapps 55 | - lists apps from the local splunk instance 56 | - usage: `listapps <instance_name>` 57 | - fixperm 58 | - fixes permissions with splunk instance 59 | - usage: `fixperm <instance_name>` 60 | - upgradesplunk 61 | - upgrades the local splunk instance 62 | - usage: `upgradesplunk <instance_name>` 63 | - cleansplunk 64 | - cleans splunk instance 65 | - usage: `cleansplunk <instance_name>` 66 | - rmsplunk 67 | - removes splunk instance 68 | - usage: `rmsplunk <instance_name>` 69 | - svm 70 | - parent command that can run some sub-commands 71 | - list 72 | - usage : svm list 73 | - shows list of installed splunk instances with their versions 74 | - running 75 | - usage : svm running 76 | - shows running instances 77 | 78 | ### Directory Structure 79 | 80 | - SPLUNK_HOME = /opt/splunk 81 | - SPLUNK_LIC = ~/Downloads 82 | - BASE_DIR = /opt/splunk 83 | 84 | - Splunk Subdirectories 85 | - /opt/splunk/splunk_test 86 | - /opt/splunk/splunk_test2 87 | - /opt/splunk/splunk_testN 88 | 89 | 90 | 91 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------