Forge Home

hipchat

A Puppet report handler for sending notifications of failed runs to HipChat

31,586 downloads

7,633 latest version

1.6 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

  • 999.999.999 (latest)
  • 0.6.0
  • 0.5.1
  • 0.5.0
  • 0.4.0
  • 0.1.0 (deleted)
  • 0.0.2 (deleted)
  • 0.0.1 (deleted)
released Jan 17th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'jamtur01-hipchat', '0.4.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jamtur01-hipchat
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jamtur01-hipchat --version 0.4.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

jamtur01/hipchat — version 0.4.0 Jan 17th 2014

puppet-hipchat

Description

A Puppet report handler for sending notifications of Puppet runs to HipChat.

Requirements

  • hipchat >= 0.12.0
  • puppet

Installation & Usage

  1. Install the hipchat gem on your Puppet master

    $ sudo gem install hipchat
    

NOTE FOR PUPPET ENTERPRISE USERS: You must install the hipchat gem using the puppet-bundled gem library:

    $ /opt/puppet/bin/gem install hipchat
  1. Install puppet-hipchat as a module in your Puppet master's module path.

  2. Create a HipChat API key here with a type of Admin. Record the API key that is generated.

  3. Update the hipchat_api and hipchat_room variables in the hipchat.yaml file with your hipchat connection details and copy the file to /etc/puppet/ or for puppet enterpise '/etc/puppetlabs/puppet'. An option to notify users in the room hipchat_notify defaults to false. You can also change the default notification color from yellow to red, green,purple or random. The hipchat_statuses should be an array of statuses to send notifications for and defaults to 'failed'. Specify 'all' to receive notifications from all Puppet runs. In order to send notifications through proxy server set hipchat_proxy to http proxy url using this format 'http://username:password@proxy_host:proxy_port'. An example file is included.

  4. Enable pluginsync and reports on your master and clients in puppet.conf

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

  6. To temporarially disable HipChat notifications add a file named 'hipchat_disabled' in the same path as hipchat.yaml. (Removing it will re-enable notifications)

    $ touch /etc/puppet/hipchat_disabled
    

Author

James Turnbull james@lovedthanlost.net

License

Author:: James Turnbull (<james@lovedthanlost.net>)
Copyright:: Copyright (c) 2011 James Turnbull
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.