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

The kafka module for managing the installation and configuration of Apache Kafka

Build Status

Module Description

The kafka module for managing the installation and configuration of Apache Kafka: it's brokers, producers and consumers.

Setup

What kafka affects

Installs the kafka package and creates a new service.

Beginning with kafka

To install the kafka binaries:

  class { 'kafka': }

To install a new kafka broker:

   class { 'kafka::broker': }

Usage

Classes and Defined Types

Class: kafka

One of the primary classes of the kafka module. This class will install the kafka binaries

Parameters within kafka:

version

The version of kafka that should be installed.

scala_version

The scala version what kafka was built with.

install_dir

The directory to install kafka to.

mirror_url

The url where the kafka is downloaded from.

config

A hash of the configuration options.

install_java

Install java if it's not already installed.

Class: kafka::broker

One of the primary classes of the kafka module. This class will install a kafka broker.

Parameters within kafka::broker:

version

The version of kafka that should be installed.

scala_version

The scala version what kafka was built with.

install_dir

The directory to install kafka to.

mirror_url

The url where the kafka is downloaded from.

config

A hash of the configuration options.

install_java

Install java if it's not already installed.

Reference

Classes

Public Classes

  • kafka: Guides the basic installation of kafka binaries
  • kafka::broker: Guides the basic installation of a kafka broker

Private Classes

  • [kafka::broker::config] Manages all the default configuration of the kafka application
  • [kafka::broker::install] Manages the installation of the kafka packages
  • [kafka::broker::service] Manages the kafka server service

Limitations

This module is tested on the following platforms:

  • CentOS 5
  • CentOS 6
  • Ubuntu 10.04.4
  • Ubuntu 12.04.2
  • Ubuntu 13.10

It is tested with the OSS version of Puppet only.

Development

Contributing

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

Running tests

This project contains tests for both rspec-puppet and beaker to verify functionality. For in-depth information please see their respective documentation.

Quickstart:

gem install bundler
bundle install
bundle exec rake spec
BEAKER_DEBUG=yes bundle exec rspec spec/acceptance