Addressing feedback on top-level README (#340)

Author: nwang92

README.md

@@ -12,9 +12,10 @@ The provisioning of these disjoint containers is handled by the [splunk-ansible]
 
 1. [Purpose](#purpose)
 2. [Quickstart](#quickstart)
-3. [Support](#support)
-4. [Contributing](#contributing)
-5. [License](#license)
+3. [Documentation](#documentation)
+4. [Support](#support)
+5. [Contributing](#contributing)
+6. [License](#license)
 
 ----
 
@@ -28,10 +29,12 @@ Please refer to [Splunk products](https://www.splunk.com/en_us/software.html) fo
 ##### What is docker-splunk?
 This is the official source code repository for building Docker images of Splunk Enterprise and Splunk Universal Forwarder. By introducing containerization, we can marry the ideals of infrastructure-as-code and declarative directives to manage and run Splunk Enterprise.
 
+---
+
 ## Quickstart
 Use the following command to start a single standalone instance of Splunk Enterprise:
-```
-$ docker run -it -p 8000:8000 -e "SPLUNK_PASSWORD=<password>" -e "SPLUNK_START_ARGS=--accept-license" splunk/splunk:latest
+```bash
+$ docker run -it --name so1 -p 8000:8000 -e "SPLUNK_PASSWORD=<password>" -e "SPLUNK_START_ARGS=--accept-license" splunk/splunk:latest
 ```
 
 Let's break down what this command does:
@@ -42,8 +45,43 @@ Let's break down what this command does:
 
 After the container starts up successfully, you should be able to access SplunkWeb at http://localhost:8000 with `admin:<password>`.
 
+To view the logs from the container created above, run:
+```bash
+$ docker logs -f so1
+```
+
+To enter the container and run some Splunk CLI commands:
+```bash
+# Defaults to "ansible" user
+docker exec -it so1 /bin/bash
+# Run shell as "splunk" user
+docker exec -u splunk -it so1 bash
+```
+
+For an example of how to enable TCP 10514 for listening:
+```bash
+docker exec -u splunk so1 /opt/splunk/bin/splunk add tcp 10514 \
+    -sourcetype syslog -resolvehost true \
+    -auth "admin:${SPLUNK_PASSWORD}"
+```
+
+To install an app:
+```bash
+# Alternatively, apps can be installed at Docker run-time, ex:
+# docker run -e SPLUNK_APPS_URL=http://web/app.tgz ...
+docker exec -u splunk so1 /opt/splunk/bin/splunk install \
+	/path/to/app.tar -auth "admin:${SPLUNK_PASSWORD}"
+```
+
+Additional information on Docker support for Splunk Enterprise can be found [here](https://docs.splunk.com/Documentation/Splunk/latest/Installation/DeployandrunSplunkEnterpriseinsideDockercontainers).
+
+---
+
+## Documentation
 For full usage instructions (including examples, advanced deployments, scenarios), please visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page.
 
+---
+
 ## Support
 Please use the [GitHub issue tracker](https://github.com/splunk/docker-splunk/issues) to submit bugs or request features.
 
@@ -54,11 +92,15 @@ If you have additional questions or need more support, you can:
 
 For more detailed informations on support, please see the official [support guidelines](docs/SUPPORT.md).
 
+---
+
 ## Contributing
 We welcome feedback and contributions from the community! Please see our [contribution guidelines](docs/CONTRIBUTING.md) for more information on how to get involved. 
 
+--- 
+
 ## License
-Copyright 2018-2019 Splunk.
+Copyright 2018-2020 Splunk.
 
 Distributed under the terms of our [license](docs/LICENSE.md), splunk-ansible is free and open source software.
 

docs/SUPPORT.md

@@ -21,7 +21,7 @@ At the current time, this image only supports the Docker runtime engine and requ
 5. `overlay2` Docker daemon storage driver
     * Create a file /etc/docker/daemon.json on Linux systems, or C:\ProgramData\docker\config\daemon.json on Windows systems. Add {"storage-driver": "overlay2"} to the daemon.json. If you already have an existing json, please only add "storage-driver": "overlay2" as a key, value pair.
 
-For more details, please see the official [supported architectures and platforms for containerized Splunk environments](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements#Containerized_computing_platforms) as well as [hardware and capacity recommendations](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements). 
+For more details, please see the official [supported architectures and platforms for containerized Splunk environments](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements#Containerized_computing_platforms) as well as [hardware and capacity recommendations](https://docs.splunk.com/Documentation/Splunk/latest/Installation/Systemrequirements). Basic usage on how to [deploy and run Splunk Enterprise inside containers](https://docs.splunk.com/Documentation/Splunk/latest/Installation/DeployandrunSplunkEnterpriseinsideDockercontainers) is also available.
 
 If you intend for this containerized Splunk Enterprise deployment to be supported in your Enterprise Support Agreement, you must verify you meet all of the above "supported" requirements. Failure to do so will render your deployment in an "unsupported" state.