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
* First pass of docs editing (#321)
* Add license and version badges
* Fix formatting and broken navigation
* Update language for clarity and concision
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
@@ -21,15 +21,17 @@ The provisioning of these disjoint containers is handled by the [splunk-ansible]
21
21
22
22
## Purpose
23
23
24
-
#####What is Splunk Enterprise?
24
+
#### What is Splunk Enterprise?
25
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.
26
26
27
-
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.
28
28
29
-
#####What is docker-splunk?
29
+
#### What is docker-splunk?
30
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.
31
31
32
-
---
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
+
----
33
35
34
36
## Quickstart
35
37
Use the following command to start a single standalone instance of Splunk Enterprise:
@@ -78,26 +80,26 @@ Additional information on Docker support for Splunk Enterprise can be found [her
78
80
---
79
81
80
82
## Documentation
81
-
For full usage instructions (including examples, advanced deployments, scenarios), please visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page.
83
+
Visit the [docker-splunk documentation](https://splunk.github.io/docker-splunk/) page for full usage instructions, including installation, examples, and advanced deployment scenarios.
82
84
83
85
---
84
86
85
87
## Support
86
-
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.
87
89
88
90
If you have additional questions or need more support, you can:
89
91
* Post a question to [Splunk Answers](http://answers.splunk.com)
90
92
* Join the [#docker](https://splunk-usergroups.slack.com/messages/C1RH09ERM/) room in the [Splunk Slack channel](http://splunk-usergroups.slack.com)
91
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
92
94
93
-
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.
94
96
95
97
---
96
98
97
99
## Contributing
98
-
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.
This document is the single source of truth on contributing towards this codebase. Please feel free to browse the open issues and file new ones - all feedback is welcome!
3
+
This document is the single source of truth on contributing towards this codebase. Feel free to browse the [open issues](https://github.com/splunk/docker-splunk/issues) and file new ones - all feedback is welcome!
*[Setup development environment](#setup-development-environment)
11
10
*[Contribution Workflow](#contribution-workflow)
12
-
*[Feature Requests and Bug Reports](#feature-requests-and-bug-reports)
13
-
*[Fixing Issues](#fixing-issues)
14
-
*[Pull Requests](#pull-requests)
15
-
*[Code Review](#code-review)
11
+
*[Bug reports and feature requests](#bug-reports-and-feature-requests)
12
+
*[Fixing issues](#fixing-issues)
13
+
*[Pull requests](#pull-requests)
14
+
*[Code review](#code-review)
16
15
*[Testing](#testing)
17
16
*[Documentation](#documentation)
18
17
*[Maintainers](#maintainers)
19
18
20
19
## Prerequisites
21
-
When contributing to this repository, please first discuss the change you wish to make via a GitHub issue, Slack message, email, or via other channels with the owners of this repository.
20
+
When contributing to this repository, first discuss the issue with a [repository maintainer](#maintainers) via GitHub issue, Slack message, or email.
22
21
23
-
#####Contributor License Agreement
24
-
At the moment, we can only accept pull requests submitted from either:
25
-
* Splunk employees or
26
-
* Individuals that have signed our contribution agreement
22
+
#### Contributor License Agreement
23
+
We only accept pull requests submitted from:
24
+
* Splunk employees
25
+
* Individuals who have signed the [Splunk Contributor License Agreement](https://www.splunk.com/en_us/form/contributions.html)
27
26
28
-
If you wish to be a contributing member of our community, please see the agreement [for individuals](https://www.splunk.com/goto/individualcontributions) or [for organizations](https://www.splunk.com/goto/contributions).
29
-
30
-
##### Code of Conduct
31
-
Please make sure to read and observe our [Code of Conduct](contributing/code-of-conduct.md). Please follow it in all of your interactions involving the project.
32
-
33
-
##### Setup Development Environment
34
-
TODO
27
+
#### Code of Conduct
28
+
All contributors are expected to read our [Code of Conduct](contributing/code-of-conduct.md) and observe it in all interactions involving this project.
35
29
36
30
## Contribution Workflow
37
31
Help is always welcome! For example, documentation can always use improvement. There's always code that can be clarified, functionality that can be extended, and tests to be added to guarantee behavior. If you see something you think should be fixed, don't be afraid to own it.
38
32
39
-
##### Feature Requests and Bug Reports
40
-
Have ideas on improvements? See something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue. Please report any issues or bugs you find through [GitHub's issue tracker](https://github.com/splunk/docker-splunk/issues).
33
+
####Bug reports and feature requests
34
+
Have ideas on improvements? See something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue. Please report any issues or bugs you find through our [issue tracker](https://github.com/splunk/docker-splunk/issues).
41
35
42
36
If you are reporting a bug, please include:
43
37
* Your operating system name and version
44
-
*Any details about your local setup that might be helpful in troubleshooting (ex. Python interpreter version, Ansible version, etc.)
38
+
*Details about your local setup that might be helpful in troubleshooting (e.g. Python interpreter version, Ansible version, etc.)
45
39
* Detailed steps to reproduce the bug
46
40
47
-
We'd also like to hear about your propositions and suggestions. Feel free to submit them as issues and:
48
-
*Explain in detail how they should work
49
-
*Keep the scope as narrow as possible - this will make it easier to implement
41
+
We'd also like to hear your feature suggestions. Feel free to submit them as issues by:
42
+
*Explaining in detail how they should work
43
+
*Keeping the scope as narrow as possible. This will make it easier to implement
50
44
51
-
#####Fixing Issues
45
+
#### Fixing issues
52
46
Look through our [issue tracker](https://github.com/splunk/docker-splunk/issues) to find problems to fix! Feel free to comment and tag corresponding stakeholders or full-time maintainers of this project with any questions or concerns.
53
47
54
-
#####Pull Requests
55
-
What is a "pull request"? It informs the project's core developers about the changes you want to review and merge. Once you submit a pull request, it enters a stage of code review where you and others can discuss its potential modifications and even add more commits to it later on.
48
+
#### Pull requests
49
+
A pull requestinforms the project's core developers about the changes you want to review and merge. Once you submit a pull request, it enters a stage of code review where you and others can discuss its potential modifications and add more commits later on.
56
50
57
-
If you want to learn more, please consult this [tutorial on how pull requests work](https://help.github.com/articles/using-pull-requests/) in the [GitHub Help Center](https://help.github.com/).
51
+
To learn more, see [Proposing changes to your work with pull requests
52
+
](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) in the [GitHub Help Center](https://help.github.com/).
58
53
59
-
Here's an overview of how you can make a pull request against this project:
60
-
1. Fork the [docker-splunk GitHub repository](https://github.com/splunk/docker-splunk/issues)
61
-
2. Clone your fork using git and create a branch off develop
54
+
To make a pull request against this project:
55
+
1. Fork the [docker-splunk GitHub repository](https://github.com/splunk/docker-splunk/).
56
+
1. Clone your fork and create a branch off of `develop`.
62
57
```
58
+
# Create a local copy (or clone) of the repository
# This project uses 'develop' for all development activity, so create your branch off that
67
-
$ git checkout -b your-bugfix-branch-name develop
62
+
# Create your feature/bugfix branch
63
+
$ git checkout -b your-branch-name develop
68
64
```
69
-
3. Run all the tests to verify your environment
65
+
1. Run tests to verify your environment.
70
66
```
71
67
$ cd docker-splunk
72
68
$ make test
73
69
```
74
-
4. Make your changes, commit and push once your tests have passed
70
+
1. Push your changesonce your tests have passed.
75
71
```
76
-
$ git commit -m "<insert helpful commit message>"
77
-
$ git push
72
+
# Add the files to the queue of changes
73
+
$ git add <modified file(s)>
74
+
75
+
# Commit the change to your repo with a log message
76
+
$ git commit -m "<helpful commit message>"
77
+
78
+
# Push the change to the remote repository
79
+
$ git push
78
80
```
79
-
5. Submit a pull request through the GitHub website using the changes from your forked codebase
81
+
1. Submit a pull request through the GitHub website using the changes from your forked codebase
80
82
81
-
##### Code Review
83
+
#### Code Review
82
84
There are two aspects of code review: giving and receiving.
83
85
84
-
To make it easier for your PR to receive reviews, consider the reviewers will need you to:
85
-
* Follow the project coding conventions
86
-
* Write good commit messages
87
-
* Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue
86
+
A PR is easy to review if you:
87
+
* Follow the project coding conventions.
88
+
* Write good commit messages, concise and descriptive.
89
+
* Break large changes into a logical series of smaller patches. Patches individually make easily understandable changes, and in aggregate, solve a broader issue.
88
90
89
-
Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](contributing/code-of-conduct.md) and must go above and beyond to promote a collaborative, respectful community.
91
+
Reviewers are highly encouraged to revisit the [Code of Conduct](contributing/code-of-conduct.md) and must go above and beyond to promote a collaborative, respectful community.
90
92
91
-
When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with nuances:
93
+
When reviewing PRs from others, [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses, designed to lead new contributors to positive collaboration without inundating them initially with nuances:
92
94
* Is the idea behind the contribution sound?
93
95
* Is the contribution architected correctly?
94
96
* Is the contribution polished?
95
97
96
-
For this project, we require that at least 2 approvals are given and a build from our continuous integration system is successful off of your branch. Please note that any new changes made with your existing pull request during review will automatically unapprove and retrigger another build/round of tests.
98
+
Merge requirements for this project:
99
+
* at least 2 approvals
100
+
* a passing build from our continuous integration system.
101
+
102
+
Any new commits to an open pull request will automatically dismiss old reviews and trigger another build.
97
103
98
-
##### Testing
99
-
Testing is the responsibility of all contributors. In general, we try to adhere to [Google's test sizing philosophy](https://testing.googleblog.com/2010/12/test-sizes.html) when structuring tests.
104
+
#### Testing
105
+
Testing is the responsibility of all contributors. In general, we try to adhere to [Google's test sizing philosophy](https://testing.googleblog.com/2010/12/test-sizes.html) when structuring tests.
100
106
101
107
There are multiple types of tests. The location of the test code varies with type, as do the specifics of the environment needed to successfully run the test.
102
108
@@ -117,28 +123,30 @@ There are multiple types of tests. The location of the test code varies with typ
117
123
118
124
Continuous integration will run all of these tests either as pre-submits on PRs, post-submits against master/release branches, or both.
119
125
120
-
##### Documentation
121
-
We could always use improvements to our documentation! Anyone can contribute to these docs - whether you’re new to the project, you’ve been around a long time, and whether you self-identify as a developer, an end user, or someone who just can’t stand seeing typos. What exactly is needed?
122
-
1. More complementary documentation. Have you perhaps found something unclear?
123
-
2. More examples or generic templates that others can use.
124
-
3. Blog posts, articles and such – they’re all very appreciated.
126
+
#### Documentation
127
+
We can always use improvements to our documentation! Anyone can contribute to these docs, whether you identify as a developer, an end user, or someone who just can’t stand seeing typos. What exactly is needed?
128
+
129
+
1. More complementary documentation. Have you found something unclear?
130
+
1. More examples or generic templates that others can use.
131
+
1. Blog posts, articles and such – they’re all very appreciated.
125
132
126
-
You can also edit documentation files directly in the GitHub web interface, without creating a local copy. This can be convenient for small typos or grammer fixes.
133
+
You can also edit documentation files directly in the GitHub web interface, without creating a local copy. This can be convenient for small typos or grammar fixes.
127
134
128
135
## Maintainers
129
136
130
-
If you need help, feel free to tag one of the active maintainers of this project in a post or comment. We'll do our best to reach out to you as quickly as we can.
137
+
If you need help, tag one of the active maintainers of this project in a post or comment. We'll do our best to reach out to you as quickly as we can.
Copy file name to clipboardExpand all lines: docs/EXAMPLES.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Examples
2
2
3
-
The purpose of this section is to showcase a wide variety of examples on how the `docker-splunk` project can be used.
3
+
The purpose of this section is to showcase a wide variety of examples on how the `docker-splunk` project can be used.
4
4
5
5
Note that for more complex scenarios, we will opt to use a [Docker compose file](https://docs.docker.com/compose/compose-file/) instead of the CLI for the sake of readability.
Copy file name to clipboardExpand all lines: docs/INTRODUCTION.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,16 @@ Splunk Enterprise is most commonly deployed with dedicated hardware, and in conf
3
3
4
4
The overhead of this operation normally leads people down the path of creating virtual machines using a hypervisor. A hypervisor provides a significant improvement to the speed of spinning up more compute resources, but comes with one major drawback: the overhead of running multiple operating systems on one host.
In recent years, [Docker](https://www.docker.com) has become the de-facto tool designed make it easier to create, deploy, and run applications through the use of containers.
10
10
11
11
Containers allow an application to be the only process that runs in a VM-like, isolated environment. Unlike a hypervisor, a container-based system does not require the use of a guest operating system. This allows a single host to dedicate more resources towards the application.
12
12
13
-
For more information on how containers or Docker works, we'll let [Docker do the talking](https://www.docker.com/resources/what-container).
13
+
For more information on how containers or Docker works, we'll [let Docker do the talking](https://www.docker.com/resources/what-container).
The Splunk user community has asked us to support containerization as a platform for running Splunk. The promise of running applications in a microservice-oriented architecture evangelizes the principles of infrastructure-as-code and declarative directives, and we aimed to bring those benefits with the work in this codebase. This project delivers on that request: to provide the rich functionality that Splunk Enterprise offers with the user-friendliness and production-readiness of container-native software.
0 commit comments