Helpful instructions around docker usage

Author: amysutedja

Makefile

@@ -56,3 +56,23 @@ splunkrc:
 	@echo "$(ATTN_COLOR)==> splunkrc $(NO_COLOR)"
 	@echo "To make a .splunkrc:"
 	@echo "  [SPLUNK_INSTANCE_JSON] | python scripts/build-splunkrc.py ~/.splunkrc"
+
+.PHONY: splunkrc_default
+splunkrc_default:
+	@echo "$(ATTN_COLOR)==> splunkrc_default $(NO_COLOR)"
+	@python scripts/build-splunkrc.py ~/.splunkrc
+
+.PHONY: up
+up:
+	@echo "$(ATTN_COLOR)==> up $(NO_COLOR)"
+	@docker-compose up -d
+
+.PHONY: wait_up
+wait_up:
+	@echo "$(ATTN_COLOR)==> wait_up $(NO_COLOR)"
+	@for i in `seq 0 180`; do if docker exec -it splunk /sbin/checkstate.sh &> /dev/null; then break; fi; printf "\rWaiting for Splunk for %s seconds..." $$i; sleep 1; done
+
+.PHONY: down
+down:
+	@echo "$(ATTN_COLOR)==> down $(NO_COLOR)"
+	@docker-compose stop

README.md

@@ -21,7 +21,6 @@ The Splunk developer platform enables developers to take advantage of the same
 technology used by the Splunk product to build exciting new applications that
 are enabled by Splunk's unique capabilities.
 
-
 ## Getting started with the Splunk SDK for Python
 
 The Splunk SDK for Python contains library code and examples that show how to
@@ -45,7 +44,9 @@ The Splunk SDK for Python requires Python 2.7+, including Python 3. The Splunk S
 If you haven't already installed Splunk, download it
 [here](http://www.splunk.com/download). For more about installing and running
 Splunk and system requirements, see
-[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). The Splunk SDK for Python has been tested with Splunk Enterprise 7.0 and 7.2.
+[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). The Splunk SDK for Python has been tested with Splunk Enterprise 7.3 and 8.0.
+
+You can also run `SPLUNK_VERSION=(VERSION) make up` to run a version of [Splunk from DockerHub](https://hub.docker.com/r/splunk/splunk/).
 
 #### Splunk SDK for Python
 Get the Splunk SDK for Python; [download the SDK as a ZIP](http://dev.splunk.com/view/SP-CAAAEBB)
@@ -74,6 +75,17 @@ Alternatively, you can use **setup.py** on the sources you cloned from GitHub:
 However, it's not necessary to install the libraries to run the
 examples and unit tests from the SDK.
 
+## Testing Quickstart
+
+You'll need `docker` and `docker-compose` to get up and running using this method.
+
+```
+SPLUNK_VERSION=8.0 make up
+make wait_up
+make splunkrc_default
+make test
+make down
+```
 
 ### Running the examples and unit tests
 

scripts/build-splunkrc.py

@@ -25,9 +25,9 @@
     'host': 'localhost',
     'port': '8089',
     'username': 'admin',
-    'password': 'changeme',
+    'password': 'changed!',
     'scheme': 'https',
-    'version': '6.3'
+    'version': '8.0'
 }
 
 DEFAULT_SPLUNKRC_PATH = os.path.join(str(Path.home()), '.splunkrc')