Forge Home

flowdock

Report processor that notifies Flowdock when Puppet runs

12,230 downloads

11,771 latest version

4.1 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.2 (latest)
  • 1.0.1
  • 1.0.0
released Jul 23rd 2013

Start using this module

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

Add this module to your Puppetfile:

mod 'maestrodev-flowdock', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add maestrodev-flowdock
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install maestrodev-flowdock --version 1.0.2

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

maestrodev/flowdock — version 1.0.2 Jul 23rd 2013

puppet-flowdock

Description

A Puppet report handler for sending notifications of failed runs to Flowdock.

Requirements

  • flowdock
  • puppet (version 2.6.5 and later)

Installation & Usage

  1. Install the flowdock gem on your Puppet master

    $ sudo gem install flowdock
    
  2. Install puppet-flowdock as a module in your Puppet master's module path.

  3. Create /etc/puppet/flowdock.yaml file in the Puppet master with at least your Flowdock API key, and possibly other config options.

    ---
    {
      :flowdock_api_key: "your_key", # mandatory
      :statuses: ["failed", "changed", "unchanged"], # default to ["failed"]
      :level: :warning, # Puppet output level (warning, notice, info,...)
      :from_address: 'from@acme.com'
    }
    
  4. Enable pluginsync and reports on your master and clients in puppet.conf

    [master]
    report = true
    reports = flowdock
    pluginsync = true
    [agent]
    report = true
    pluginsync = true
    
  5. Run the Puppet client and sync the report as a plugin

Authors

James Turnbull james@lovedthanlost.net

Carlos Sanchez csanchez@maestrodev.com

License

Author:: James Turnbull <james@lovedthanlost.net>, Carlos Sanchez <csanchez@maestrodev.com>
Copyright:: Copyright (c) 2012 James Turnbull, MaestroDev Inc.
License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.