Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.8 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.8 KB
Raw

reportslack

Build Status Coverage Status

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 reportslack
  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 enables notifications from Puppet Enterprise to your Slack channel, when there are changes in your infrastructure.

Module Description

This module configures a Puppet Enterprise custom report processor that sends notifications to your slack channel, whenever an agent run has triggered a change in your infrastructure.

Setup

What reportslack affects

  • Installs the slack-notifier gem that creates the notifications.
  • Adds an extra report processor to puppet.conf .
  • Creates an extra report processor (slack).

Setup Requirements

The module needs pluginsync enabled. It also requires a manual restart of the pe-puppetserver that I've purposely left out of the Puppet code.

Beginning with reportslack

Set up an Incoming Webhook on Slack. Use the "Add to slack" button below and follow the process to get an incoming webhook url.

Add to Slack

Then simply classify your PE Master group with the reportslack class, setting the webhook_url and channel variable as you got from Slack.

You should get notifications similar to the following in the Slack channel you've chosen: Example image

Usage

Look at tests/init.pp for an example implementation.

Limitations

This module has only been tested with Puppet Enterprise

Development

Regular rules apply, fork & PR.

Thanks

Thanks to dylanratcliffe and jamtur01 for their code examples! Also thanks to atarinut for their PRs.