Forge Home

gpioflicker

Puppet Module for managing gpioflicker

5,570 downloads

5,570 latest version

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

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

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

Start using this module

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

Add this module to your Puppetfile:

mod 'bodgit-gpioflicker', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bodgit-gpioflicker
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bodgit-gpioflicker --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

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.