Forge Home

logstash_kafka

A module for managing the installation the kafka plugin for logstash

9,691 downloads

9,691 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.0 (latest)
released Oct 10th 2014
This version is compatible with:
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'opentable-logstash_kafka', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opentable-logstash_kafka
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opentable-logstash_kafka --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

opentable/logstash_kafka — version 1.0.0 Oct 10th 2014

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
  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

Build
Status

##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.