Forge Home

sensu_wrapper

Set up and install sensu-wrapper, a tool to send sensu alerts from arbitrary commands

6,490 downloads

6,490 latest version

4.3 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.1.0 (latest)
released Dec 1st 2016
This version is compatible with:
  • Puppet Enterprise >=3.7.0 < 2015.3.0
  • Puppet >=3.3.0 <5.0.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'jaxxstorm-sensu_wrapper', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jaxxstorm-sensu_wrapper
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jaxxstorm-sensu_wrapper --version 0.1.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

jaxxstorm/sensu_wrapper — version 0.1.0 Dec 1st 2016

puppet-sensu_wrapper

Build Status

Table of Contents

  1. Module Description - What the module does and why it is useful
  2. Setup - The basics of getting started with puppet-sensu_wrapper
  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

Module description

This module will set up and install sensu-wrapper, a tool designed to run arbitrary commands and return the result to sensu.

This will:

  • Download the golang binary for Linux, and install it for you (by default in /usr/local/bin)

Setup

What puppet-cron affects

  • puppet-sensu_wrapper simply downloads the binary for sensu_wrapper using the puppet-archive module and make it available to run

Beginning with puppet-cron

Simply include the module like so:

  include ::sensu_wrapper

You may want to use a class include if you wish to override parameters:

  class { '::sensu_wrapper' :
    version => 'v0.2',
  }

Usage

I just want to manage sensu_wrapper, what's the minimum I need

  include ::sensu_wrapper

I want to download from a custom URL

If you need to pull the binary from a local HTTP repository rather than github, you'll need to specify a URL like so:

  class { '::sensu_wrapper':
    download_url => 'http://my-http-server/sensu_wrapper/v0.2/sensu_wrapper.tar.gz,
    version      => 'v0.2',
  }

Please note, you should still set the version to ensure the symlink/directories and upgrades work

Reference

Classes

Public Classes

Private Classes

  • [sensu_wrapper::install]: Installs the required sensu_wrapper binary and symlinks to a path of your choice
  • [sensu_wrapper::configure]: Configures sensu_wrapper's required config dir

sensu_wrapper

Parameters

version [String]

The version of the sensu-wrapper to deploy, see https://github.com/jaxxstorm/sensu-wrapper/releases

archive_path [String]

Full path to store the tar gzip archive of the sensu wrapper (default: /tmp/sensu-wrapper.tar.gz)

extract_path [String]

Where to extract the downloaded sensu_wrapper tar gzip archive (default: /opt/sensu-wrapper)

bin_dir [String]

The bin to symlink the executable (default: /usr/local/bin/sensu-wrapper)

config_dir [String]

Config directory for sensu_wrapper (default: /etc/sensu-wrapper.d)

download_url_base [String]

Base URL from github release for grabbing sensu-wrapper binary (default: https://github.com/jaxxstorm/sensu-wrapper/releases/download/')

download_url [String]

Override URL for downloading sensu-wrapper (default: undef)

Limitations

  • Only works on Linux, like the sensu-wrapper binary