puppet-logstash_kafka

####Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with logstash_kafka
   • What logstash_kafka affects
   • Setup requirements
   • Beginning with logstash_kafka
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

Install logstash-kafka plugin to allow you to use kafka as a input/output to/from logstash

##Module Description

The purpose of this module is to install the logstash-kafka plugin to logstash to enable it to be configured as a kafka consumer or producer.

##Setup

###What logstash_kafka affects

• Installation of the logstash-kafka plugin
• Adds new libraries into your existing logstash installation

###Beginning with logstash_kafka

Installing the logstash-kafka plugin to a custom logstash installation:

   logstash { 'version 0.5.1':
     version              => '0.5.1',
     logstash_install_dir => '/opt/custom_logstash_dir'
   }

##Usage

###Classes and Defined Types

####Class: logstash_kafka

Parameters within logstash_kafka: ####version The version of the the plugin to be installed.

####install_dir The directory in which to install the plugin source

####kafka_install_dir The directory of the kafka installation

####logstash_install_dir The directory of the logstash installation

####logstash_package_url If installing logstash at the same time as this plugin, the url to the logstash package

##Reference

###Classes ####Public Classes

• logstash_kafka: Guides the installation of the logstash-kafka plugin

##Limitations

This module is tested on the following platforms:

• CentOS 5
• CentOS 6
• Ubuntu 12.04
• Ubuntu 14.04

It is tested with the OSS version of Puppet only.

###Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.

##2014-10-10 - Release 1.0.0 ###Summary

Initial release. Support for installing and configuring logstash_kafka kafka plugin.