This repository has been archived
This repository is no longer maintained.
- Overview
- Module Description - What beats does and why it is useful
- Setup - The basics of getting started with [beats]
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to beats
Deploy one or more data shippers from Elastic's Beats platform.
Tested with Ubuntu 14.04, but should work on other versions of Ubuntu and other Debian derivatives. Preliminary support for RHEL is in place but is currently untested.
This module will eventually manage the three Beats data shippers (filebeat, packetbeat and topbeat) provided by Elastic, and to a lesser extent manages custom Beats data shippers. In the current version only filebeat and topbeat are supported.
- Installs the Beats package repository
- Installs required packages
- Writes configuration files
- Manages services for each data shipper installed
Requires the puppetlabs/stdlib module.
To override any of the default settings in the beats class, use Hiera:
beats::output_es: true
beats::output_es_hosts:
- 'elasticsearch-01.example.com:9200'
- 'elasticsearch-02.example.com:9200'In your puppet manifests instantiate filebeat and/or topbeat:
class { 'beats::filebeat':
tls_certificate => '/etc/ssl/client-cert.pem',
tls_certificate_key => '/etc/ssl/client-key.pem',
}If you instantiated the filebeat class, you'll also need at least one propector before it's useful:
beats::filebeat::prospector { 'syslog':
paths => [ 'var/log/syslog' ],
}Full documentation of parameters is included in the init.pp manifest file.
Contributions are welcome. Open an issue or fork and open a pull request. Passing tests are appreciated with pull requests, but not a hard requirement. Please ensure your commit message clearly explains the problem your patch solves.
Written by Mark Mickan mark.mickan@articul-8.com.