forked from idealista/fluentd-role
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.md.idealista
90 lines (57 loc) · 2.49 KB
/
README.md.idealista
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
[](https://travis-ci.org/idealista/fluentd-role)
# Fluentd Ansible role
This ansible role installs fluent agent in a Debian environment.
- [Getting Started](#getting-started)
- [Prerequisities](#prerequisities)
- [Installing](#installing)
- [Usage](#usage)
- [Testing](#testing)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#contributing)
## Getting Started
These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install a [fluentd](https://fluentd.io/) agent.
### Prerequisities
Ansible 2.2.1.0 version installed.
Inventory destination should be a Debian environment.
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Vagrant](https://www.vagrantup.com/) as driver (with [landrush](https://github.com/vagrant-landrush/landrush) plugin) and [VirtualBox](https://www.virtualbox.org/) as provider.
### Installing
Create or add to your roles dependency file (e.g requirements.yml):
```
- src: idealista.fluentd-role
version: 1.0.0
name: fluentd
```
Install the role with ansible-galaxy command:
```
ansible-galaxy install -p roles -r requirements.yml -f
```
Use in a playbook:
```
- hosts: someserver
roles:
- role: fluentd
```
## Usage
Look to the [defaults](defaults/main.yml) properties file to see the possible configuration properties.
It is mandatory to include a fluent.conf, you could use the defined default path or override var.
## Testing
```sh
molecule test
```
## Built With
## Versioning
For the versions available, see the [tags on this repository](https://github.com/idealista/fluentd-role/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/fluentd-role/contributors) who participated in this project.
## License
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.