Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freedomofpress/ansible-role-beats
Ansible role for installing and configuring elastic beats
https://github.com/freedomofpress/ansible-role-beats
ansible
Last synced: 3 months ago
JSON representation
Ansible role for installing and configuring elastic beats
- Host: GitHub
- URL: https://github.com/freedomofpress/ansible-role-beats
- Owner: freedomofpress
- Created: 2015-08-28T22:53:14.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T23:57:23.000Z (about 1 year ago)
- Last Synced: 2023-11-29T00:44:18.706Z (about 1 year ago)
- Topics: ansible
- Language: Makefile
- Homepage:
- Size: 120 KB
- Stars: 5
- Watchers: 8
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Beats client Ansible role
[](https://circleci.com/gh/freedomofpress/ansible-role-beats)
Ansible role for installing and configuring elastic beats clients. Primarily
used for shipping logs and metrics to an ELK stack.
By default, this role will ship to logstash on the same box using [filebeat] and [metricbeat].
Requirements
------------
* someplace to ship data to - as of the beats 5.x series this includes shipping to
`file`, `kafka`, `redis`, `console`, `elasticsearch`, and/or `logstash`
Role Variables
--------------
You'll need an SSL cert to encrypt logs in transit to the
logstash/elasticsearch. This logic is not provided by this role and encryption
is not enabled by default. You'll need to reference the official beats
documentation output guides to add those options via variables.
Example Playbook
----------------
```
- name: Configure beats clients.
hosts: clients
roles:
- role: freedomofpress.beats
tags: clients
```
Running the tests
-----------------
This role uses [Molecule] and [Testinfra] for testing. To use it:
```
pip install -r requirements.txt
molecule test
```
You can also run selective commands:
```
molecule idempotence
molecule verify
```
To fire up an elasticsearch UI for debugging, run:
```bash
make elastic-ui
```
See the [Molecule] docs for more info.
Contributions
-------------
The following resources were invaluable in creating this role.
* [geerlingguy.logstash](https://github.com/geerlingguy/ansible-role-logstash)
* [DigitalOcean's ELK guide](https://www.digitalocean.com/community/tutorials/how-to-install-elasticsearch-logstash-and-kibana-4-on-ubuntu-14-04)
* [filebeat configuration guide](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html)
License
-------
MIT
[Molecule]: http://molecule.readthedocs.org/en/master/
[Testinfra]: https://testinfra.readthedocs.io/en/latest/
[filebeat]: https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-overview.html
[metricbeat]: https://www.elastic.co/guide/en/beats/metricbeat/current/index.html