Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
38858b2
Merge pull request #316 from splunk/release/802
nwang92 Feb 13, 2020
dd94f40
Cleaned up some misleading language in top level README.md (#315)
Feb 14, 2020
42c30e6
Bugfix/uf uid gid (#320)
nwang92 Feb 25, 2020
4d4cf3a
Fixed tests for changes in splunk-ansible (#323)
Feb 29, 2020
55af22e
Adding tests for peered standalones (#326)
nwang92 Mar 6, 2020
ba526a2
update exec commands w/ splunk user (#329)
jmeixensperger Mar 9, 2020
ee3527c
Updating image for upgrade test (#330)
nwang92 Mar 10, 2020
4c8287e
Feature/adhoc search head (#327)
nwang92 Mar 10, 2020
231ffa9
Adding new test for idempotent changes to HEC configuration (#328)
nwang92 Mar 12, 2020
8dbbbf8
Updating to latest redhat ubi-minimal (#332)
nwang92 Mar 12, 2020
38a9d25
Updating changelog for release/8021 (#333)
alishamayor Mar 12, 2020
7237130
Package install docs (#335)
jmeixensperger Mar 13, 2020
0ede5cd
Limiting ansible-playbook to localhost only (#336)
nwang92 Mar 16, 2020
0d52a37
Addressing feedback on top-level README (#340)
nwang92 Mar 17, 2020
9eee08d
Removing wrapper-example from splunk-ansible (#337)
nwang92 Mar 17, 2020
80efcd5
Add CODEOWNERS to repo (#341)
alishamayor Mar 17, 2020
57bc245
Sorry Nelson
alishamayor Mar 18, 2020
d0138ce
Fixing username typo
alishamayor Mar 18, 2020
ca5c882
Updating release notes for 7.3.5 and 7.2.10 (#345)
alishamayor Mar 26, 2020
29a811c
Adding new test assertions (#342)
nwang92 Mar 28, 2020
20e3a5b
Bugfix/update statefulset manifest for kubectlv1.18.0 (#348)
emxqm-11 Apr 2, 2020
15a8f15
Adding test for standalone forwarding cases (#347)
nwang92 Apr 3, 2020
b621fbe
Large docs update (#346)
alishamayor Apr 3, 2020
ab3cf94
Docs - Reconcile Jekyll, Kramdown, GFM formatting (#350)
alishamayor Apr 3, 2020
472e12e
Updating Makefile and Changelog for Release/8.0.3 (#349)
alishamayor Apr 3, 2020
6c418b3
Merge branch 'master' into develop
alishamayor Apr 3, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Jenkinsfile
**/test-results
**/molecule
**/*.md
**/wrapper-example
13 changes: 13 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Code owners are automatically requested for review when someone opens a
# pull request modifying code that they own.
# See: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

# Note: Each line is a file pattern followed by one or more owners.
# Order matters: The last matching pattern has the most precedence.

# Default owners for everything in docker-splunk:
# * @splunk/if-01
* @nwang92 @alishamayor @arctan5x @lephino @jrigassio-splunk @jmeixensperger @hendolim @jonathan-vega-splunk

# Docs-only pull requests:
/docs/ @alishamayor @nwang92
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ SPLUNK_ANSIBLE_BRANCH ?= develop
SPLUNK_COMPOSE ?= cluster_absolute_unit.yaml
# Set Splunk version/build parameters here to define downstream URLs and file names
SPLUNK_PRODUCT := splunk
SPLUNK_VERSION := 8.0.2.1
SPLUNK_BUILD := f002026bad55
SPLUNK_VERSION := 8.0.3
SPLUNK_BUILD := a6754d8441bf
ifeq ($(shell arch), s390x)
SPLUNK_ARCH = s390x
else
Expand Down
78 changes: 61 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,42 @@
# docker-splunk: Containerizing Splunk Enterprise

[![Build Status](https://circleci.com/gh/splunk/docker-splunk/tree/develop.svg?style=svg)](https://circleci.com/gh/splunk/docker-splunk/tree/develop)
[![Build Status](https://circleci.com/gh/splunk/docker-splunk/tree/develop.svg?style=svg)](https://circleci.com/gh/splunk/docker-splunk/tree/develop) 
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
[![GitHub release](https://img.shields.io/github/v/tag/splunk/docker-splunk?sort=semver&label=Version)](https://github.com/splunk/docker-splunk/releases)

Welcome to Splunk's official repository containing Dockerfiles for building Splunk Enterprise and Universal Forwarder images using containerization technology.

The provisioning of these disjoint containers is handled by the [splunk-ansible](https://github.com/splunk/splunk-ansible) project. Please refer to [Ansible documentation](http://docs.ansible.com/) for more details about Ansible concepts and how it works.
Welcome to Splunk's official repository of Dockerfiles for building Splunk Enterprise and Splunk Universal Forwarder images using containerization technology.

----

## Table of Contents

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)

----

## Purpose

##### What is Splunk Enterprise?
#### What is Splunk Enterprise?
Splunk Enterprise is a platform for operational intelligence. Our software lets you collect, analyze, and act upon the untapped value of big data that your technology infrastructure, security systems, and business applications generate. It gives you insights to drive operational performance and business results.

Please refer to [Splunk products](https://www.splunk.com/en_us/software.html) for more knowledge about the features and capabilities of Splunk, and how you can bring it into your organization.
Refer to [Splunk products](https://www.splunk.com/en_us/software.html) for more knowledge about the features and capabilities of Splunk, and how you can bring it into your organization.

##### What is docker-splunk?
#### 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.

The provisioning of these containers is handled by the [splunk-ansible](https://github.com/splunk/splunk-ansible) project. See the [Ansible documentation](http://docs.ansible.com/) for more details about Ansible concepts and how it works.

----

## 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:
Expand All @@ -42,23 +47,62 @@ 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>`.

For full usage instructions (including examples, advanced deployments, scenarios), please visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page.
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
Visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page for full usage instructions, including installation, examples, and advanced deployment scenarios.

---

## Support
Please use the [GitHub issue tracker](https://github.com/splunk/docker-splunk/issues) to submit bugs or request features.
Use the [GitHub issue tracker](https://github.com/splunk/docker-splunk/issues) to submit bugs or request features.

If you have additional questions or need more support, you can:
* Post a question to [Splunk Answers](http://answers.splunk.com)
* Join the [#docker](https://splunk-usergroups.slack.com/messages/C1RH09ERM/) room in the [Splunk Slack channel](http://splunk-usergroups.slack.com)
* If you are a Splunk Enterprise customer with a valid support entitlement contract and have a Splunk-related question, you can also open a support case on the https://www.splunk.com/ support portal

For more detailed informations on support, please see the official [support guidelines](docs/SUPPORT.md).
See the official [support guidelines](docs/SUPPORT.md) for more detailed information.

---

## 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.
We welcome feedback and contributions from the community! 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.

Expand Down
Loading