mirror of
https://github.com/dj-wasabi/ansible-telegraf.git
synced 2025-07-17 08:46:37 +00:00
Added bunch of files
This commit is contained in:
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Help to improve this Ansible role.
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
<!--- A clear and concise description of what the bug is. -->
|
||||
|
||||
**Installation method/version**
|
||||
<!--- Please provide the installation method and version of the role. -->
|
||||
|
||||
* Github / latest
|
||||
* Ansible Galaxy / 1.1.0
|
||||
|
||||
**Ansible Version**
|
||||
|
||||
```
|
||||
<!--- Paste output from "ansible --version" -->
|
||||
```
|
||||
|
||||
**Targetted hosts**
|
||||
Concerns the following OS(es):
|
||||
<!--- Pick one below and delete the rest -->
|
||||
|
||||
* Ubuntu
|
||||
* Debian
|
||||
* CentOS
|
||||
* Mint
|
||||
|
||||
**Expected behavior**
|
||||
<!--- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
**Additional context**
|
||||
<!--- Add any other context about the problem here. Configuration of the role/group_vars information etc. -->
|
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this Ansible role
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
3
CODE_OF_CONDUCT.md
Normal file
3
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Code of Conduct
|
||||
|
||||
The Code of Conduct from Ansible found [here](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) applies to this Ansible role as well.
|
88
CONTRIBUTING.md
Normal file
88
CONTRIBUTING.md
Normal file
@ -0,0 +1,88 @@
|
||||
# Contributing to this role
|
||||
|
||||
**Table of content**
|
||||
|
||||
- [Contributing to this role](#contributing-to-this-role)
|
||||
* [Contributing](#contributing)
|
||||
* [(local) Development](#-local--development)
|
||||
+ [Requirements](#requirements)
|
||||
+ [Execution](#execution)
|
||||
- [Other](#other)
|
||||
* [Virtualenv](#virtualenv)
|
||||
* [Links](#links)
|
||||
|
||||
Thank you very much for making time to improve this Ansible role.
|
||||
|
||||
## Contributing
|
||||
|
||||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. [Contributor Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
|
||||
|
||||
1. Fork the repo
|
||||
|
||||
2. Create a branch and apply your changes to this branch.
|
||||
|
||||
a. Make sure you have updated the documentation when adding new variables;
|
||||
|
||||
b. Don't forget to add/update tests so we can test the functionality during each Pull Request;
|
||||
|
||||
c. Make sure the tests will succeed.
|
||||
|
||||
3. Push the branch to your fork and submit a pull request.
|
||||
|
||||
**Note**
|
||||
|
||||
Pull Requests that fails during the tests will not be merged.
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
Style guides are important because they ensure consistency in the content, look, and feel of a book or a website.
|
||||
|
||||
* [Ansible Style Guide](http://docs.ansible.com/ansible/latest/dev_guide/style_guide/)
|
||||
* It's "Ansible" when referring to the product and ``ansible`` when referring to the command line tool, package, etc
|
||||
* Playbooks should be written in multi-line YAML with ``key: value``. The form ``key=value`` is only for ``ansible`` ad-hoc, not for ``ansible-playbook``.
|
||||
* Tasks should always have a ``name:``
|
||||
|
||||
## (local) Development
|
||||
|
||||
This role make use of Molecule to test the execution of the role and verificate it. In the root of the repository, a file named `requirements.txt` exists and contains the versions used by the tests.
|
||||
|
||||
### Requirements
|
||||
|
||||
You can install them with the following command:
|
||||
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
Once the dependencies are installed, please install Docker as Molecule is configured in this repository to create Docker containers. See [this](https://docs.docker.com/install/) link to install Docker on your system.
|
||||
|
||||
### Execution
|
||||
|
||||
Once everything is installed, you can validate your changes by executing:
|
||||
```
|
||||
molecule test
|
||||
```
|
||||
|
||||
It should run without any issues.
|
||||
|
||||
# Other
|
||||
|
||||
## Virtualenv
|
||||
|
||||
Suggestion is to create a virtualenv so you won't have issues with other projects.
|
||||
|
||||
Some web pages describing for virtual env:
|
||||
|
||||
* http://thepythonguru.com/python-virtualenv-guide/
|
||||
* https://realpython.com/python-virtual-environments-a-primer/
|
||||
* https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/
|
||||
|
||||
## Links
|
||||
|
||||
[Molecule](https://molecule.readthedocs.io/)
|
||||
|
||||
[Ansible](https://www.ansible.com/)
|
||||
|
||||
[Molecule V2 with your own role](https://werner-dijkerman.nl/2017/09/05/using-molecule-v2-to-test-ansible-roles/)
|
||||
|
||||
**End note**: Have fun making changes. If a feature helps you, then others find it helpful too and I will happily have it merged.
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2018 Werner Dijkerman
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
12
PULL_REQUEST_TEMPLATE.md
Normal file
12
PULL_REQUEST_TEMPLATE.md
Normal file
@ -0,0 +1,12 @@
|
||||
**Description of PR**
|
||||
<!--- Describe what the PR holds -->
|
||||
|
||||
**Type of change**
|
||||
<!--- Pick one below and delete the rest: -->
|
||||
|
||||
Feature Pull Request
|
||||
Bugfix Pull Request
|
||||
Docs Pull Request
|
||||
|
||||
**Fixes an issue**
|
||||
<!--- If this PR fixes an issue, please mention it. -->
|
Reference in New Issue
Block a user