Forge Home

flowtools

Module to install flow-tools and manage flow-capture

10,551 downloads

9,709 latest version

3.0 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

  • 0.0.5 (latest)
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Oct 11th 2014
This version is compatible with:
  • Puppet Enterprise 3.x
  • Puppet >=2.7.20 <4.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'nextrevision-flowtools', '0.0.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add nextrevision-flowtools
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install nextrevision-flowtools --version 0.0.5

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

nextrevision/flowtools — version 0.0.5 Oct 11th 2014

#puppet-flowtools

Build Status

####Table of Contents

  1. Overview
  2. Module Description
  3. Setup - The basics of getting started with puppet-flowtools
  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

This module is responsible for installing flow-tools, configuring flow-capture, and running flow-capture on specified interfaces and ports for specified devices.

##Module Description

This module is responsible for installing flow-tools on the system. Once flow-tools has been successfully installed, the module will generate an empty config file (default: /etc/flow-tools/flow-capture). The service is then started/enabled if specified (default: true), and will begin receiving flow data and writing it to a directory (default: /var/flow).

The module has a device type which configures flow-capture to listen on an interface/port for a device. If using flow-capture, this is required for the module to function properly, otherwise flow-capture will fail to start due to the emtpy config file.

This module can be used to only install flow-tools, with the use of the capture parameter described below.

##Setup

###What flowtools affects

  • /etc/init.d/flow-capture
  • /etc/flow-tools/flow-capture.conf
  • /usr/local/flow-tools/ (RedHat family systems only)

###Setup Requirements

This module is dependent on puppetlabs/concat and puppetlabs/stdlib. As for puppetlabs/concat, you must have pluginsync set to true on systems you wish to use with this module.

###Beginning with puppet-flowtools

To get started, simply include the flow-tools class and define a capture device:

include flowtools
flowtools::device { 'device1':
  ip_address => '192.168.1.1',
  port       => '9996'
}

This will create and entry in flow-capture.conf to listen on all interfaces on UDP port 9996 for flow data sent from 192.168.1.1.

##Usage

The basic usage of the module is listed above, and different examples will be explored below.

Passing custom options to flow-capture

include flowtools
flowtools::device { 'device1':
  ip_address => '192.168.1.1',
  port       => '9996',
  options    => '-V 5'
}

Specify a custom capture directory

class { 'flowtools':
  flow_dir => '/data/flows'
}
flowtools::device { 'device1':
  ip_address => '192.168.1.1',
  port       => '9996'
}

Listening for all devices sending flow data to port 9996

include flowtools
flowtools::device { 'all':
  ip_address => '0.0.0.0',
  port       => '9996'
}

Listening on a specific interface with custom options

include flowtools
flowtools::device { 'device1':
  ip_address => '192.168.1.1',
  port       => '9996',
  listen     => '192.168.1.33'
  options    => '-V 5'
}

Just install flow-tools, don't start flow-capture

class { 'flowtools':
  capture => false,
}

Using Hiera data with flow-tools

---
flowtools:
  capture: true
  flow_dir: '/mnt/flows'
  devices:
    router1:
      ip_address: '10.1.1.1'
      port: '9997'
    router2:
      ip_address: '10.2.1.1'
      port: '9998'

##Reference Classes:

  • flowtools

Types:

  • flowtools::device

Flow-Tools project:

##Limitations

This module only supports Debian and RedHat family operating systems. For Debian family systems, flow-tools must be availlable via apt. For RedHat systems, flow-tools is installed via a RPM of the latest version due to flow-tools not being available in the Epel, RPMForge or standard repos. This module has been tested on pristine versions of:

  • RHEL/CentOS 6.4
  • Ubuntu 10.04
  • Ubuntu 12.04
  • Debian 6
  • Debian 7

##Development

Feel free to make any additions to the module and issue a pull request. If you have a more elegant solution to some of the ways I've gone about things here, I'm certainly eager to hear about/implement them.