gpioflicker

Puppet Module for managing gpioflicker

Matt Dainty

bodgit

4,055 downloads

4,055 latest version

5.0 quality score

Version information

  • 1.0.0 (latest)
released Jun 20th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=4.5.0 <6.0.0
  • OpenBSD

Start using this module

Documentation

bodgit/gpioflicker — version 1.0.0 Jun 20th 2018

gpioflicker

Tested with Travis CI

Build Status Coverage Status Puppet Forge

Table of Contents

  1. Description
  2. Setup - The basics of getting started with gpioflicker
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module manages gpioflicker which toggles a GPIO output (which is usually wired to an LED) on the host every time a network packet is logged.

OpenBSD is supported using Puppet 4.5.0 or later.

Setup

Beginning with gpioflicker

You will need to specify the GPIO device and the pin. The below is for a Soekris Engineering net6501 using the error LED:

class { '::gpioflicker':
  device => '/dev/gpio1',
  pin    => 0,
}

Usage

To make the LED blink for 200 milliseconds:

class { '::gpioflicker':
  device      => '/dev/gpio1',
  pin         => 0,
  active_time => 200,
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-gpioflicker/.

Limitations

This module has been built on and tested against Puppet 4.5.0 and higher.

The module has been tested on:

  • OpenBSD 6.2/6.3

Development

The module has both rspec-puppet and beaker-rspec tests. Run them with:

$ bundle exec rake test
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>

Please log issues or pull requests at github.