You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to Splunk's official repository containing Dockerfiles for building Splunk Enterprise and Universal Forwarder images using containerization technology.
6
-
7
-
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.
7
+
Welcome to Splunk's official repository of Dockerfiles for building Splunk Enterprise and Splunk Universal Forwarder images using containerization technology.
8
8
9
9
----
10
10
11
11
## Table of Contents
12
12
13
13
1.[Purpose](#purpose)
14
14
2.[Quickstart](#quickstart)
15
-
3.[Support](#support)
16
-
4.[Contributing](#contributing)
17
-
5.[License](#license)
15
+
3.[Documentation](#documentation)
16
+
4.[Support](#support)
17
+
5.[Contributing](#contributing)
18
+
6.[License](#license)
18
19
19
20
----
20
21
21
22
## Purpose
22
23
23
-
#####What is Splunk Enterprise?
24
+
#### What is Splunk Enterprise?
24
25
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.
25
26
26
-
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.
27
+
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.
27
28
28
-
#####What is docker-splunk?
29
+
#### What is docker-splunk?
29
30
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.
30
31
32
+
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.
33
+
34
+
----
35
+
31
36
## Quickstart
32
37
Use the following command to start a single standalone instance of Splunk Enterprise:
@@ -42,23 +47,62 @@ Let's break down what this command does:
42
47
43
48
After the container starts up successfully, you should be able to access SplunkWeb at http://localhost:8000 with `admin:<password>`.
44
49
45
-
For full usage instructions (including examples, advanced deployments, scenarios), please visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page.
50
+
To view the logs from the container created above, run:
51
+
```bash
52
+
$ docker logs -f so1
53
+
```
54
+
55
+
To enter the container and run some Splunk CLI commands:
56
+
```bash
57
+
# Defaults to "ansible" user
58
+
docker exec -it so1 /bin/bash
59
+
# Run shell as "splunk" user
60
+
docker exec -u splunk -it so1 bash
61
+
```
62
+
63
+
For an example of how to enable TCP 10514 for listening:
Additional information on Docker support for Splunk Enterprise can be found [here](https://docs.splunk.com/Documentation/Splunk/latest/Installation/DeployandrunSplunkEnterpriseinsideDockercontainers).
79
+
80
+
---
81
+
82
+
## Documentation
83
+
Visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page for full usage instructions, including installation, examples, and advanced deployment scenarios.
84
+
85
+
---
46
86
47
87
## Support
48
-
Please use the [GitHub issue tracker](https://github.com/splunk/docker-splunk/issues) to submit bugs or request features.
88
+
Use the [GitHub issue tracker](https://github.com/splunk/docker-splunk/issues) to submit bugs or request features.
49
89
50
90
If you have additional questions or need more support, you can:
51
91
* Post a question to [Splunk Answers](http://answers.splunk.com)
52
92
* Join the [#docker](https://splunk-usergroups.slack.com/messages/C1RH09ERM/) room in the [Splunk Slack channel](http://splunk-usergroups.slack.com)
53
93
* 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
54
94
55
-
For more detailed informations on support, please see the official [support guidelines](docs/SUPPORT.md).
95
+
See the official [support guidelines](docs/SUPPORT.md) for more detailed information.
96
+
97
+
---
56
98
57
99
## Contributing
58
-
We welcome feedback and contributions from the community! Please see our [contribution guidelines](docs/CONTRIBUTING.md) for more information on how to get involved.
100
+
We welcome feedback and contributions from the community! See our [contribution guidelines](docs/CONTRIBUTING.md) for more information on how to get involved.
101
+
102
+
---
59
103
60
104
## License
61
-
Copyright 2018-2019 Splunk.
105
+
Copyright 2018-2020 Splunk.
62
106
63
107
Distributed under the terms of our [license](docs/LICENSE.md), splunk-ansible is free and open source software.
0 commit comments