voxpupuli/puppet-report_hipchat

Name: puppet-report_hipchat

Owner: Vox Pupuli

Description: null

Created: 2016-11-24 03:42:02.0

Updated: 2018-05-21 15:53:12.0

Pushed: 2018-05-22 19:52:39.0

Homepage: https://forge.puppet.com/puppet/report_hipchat

Size: 155

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Puppet Hipchat

Description

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

TravisCI status

Requirements

• hipchat >= 0.12.0
• puppet >= 4.6.1
• puppetserver >= 2

Obtaining Hipchat Auth Token

For the room in which you want to receive puppet notifications, add a new BYO Integration. This will return an example url: https://example.hipchat.com/v2/room/123456789/notification?auth_token=WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S

    `https://example.hipchat.com` is the server (you can use on premise hipchat servers as well)
    `v2` is the api version
    `123456789` is the room
    `WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S` is the api_key

Usage / Installation

s { 'report_hipchat':
rver         => 'https://example.hipchat.com',
i_version    => 'v2',
i_key        => 'WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S',
om           => '123456789',
stall_hc_gem => true,
ovider       => 'puppetserver_gem',

With puppetboard link:

s { 'report_hipchat':
rver         => 'https://example.hipchat.com',
i_version    => 'v2',
i_key        => 'WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S',
om           => '123456789',
stall_hc_gem => true,
ovider       => 'puppetserver_gem',
ppetboard    => 'https://puppetboard.test.local',

With dashboard link:

s { 'report_hipchat':
rver         => 'https://example.hipchat.com',
i_version    => 'v2',
i_key        => 'WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S',
om           => '123456789',
stall_hc_gem => true,
ovider       => 'puppetserver_gem',
shboard      => 'https://dashboard.test.local',

Proxy

s { 'report_hipchat':
rver         => 'https://example.hipchat.com',
i_version    => 'v2',
i_key        => 'WzP0dc4oEESuSmF2WJT23GtL5mili9uXof73M48S',
om           => '123456789',
stall_hc_gem => true,
ovider       => 'puppetserver_gem',
oxy          => 'http://proxy.test.local:8080',

Provider

Deprecated. Only puppetserver_gem is supported.

Configure the report in puppet.conf

 puppet master
setting {'pluginsync-master':
sure  => present,
th    => '/etc/puppetlabs/puppet/puppet.conf',
ction => 'master',
tting => 'pluginsync',
lue   => 'true', 
tify  => Service['puppetserver'],

setting {'report':
sure  => present,
th    => '/etc/puppetlabs/puppet/puppet.conf',
ction => 'master',
tting => 'report',
lue   => 'true', 
tify  => Service['puppetserver'],
    
setting {'reports':
sure  => present,
th    => '/etc/puppetlabs/puppet/puppet.conf',
ction => 'master',
tting => 'reports',
lue   => 'hipchat',
tify  => Service['puppetserver'],


 puppetmaster and agents
setting {'pluginsync-agent':
sure  => present,
th    => '/etc/puppetlabs/puppet/puppet.conf',
ction => 'agent',
tting => 'pluginsync',
lue   => 'true',
tify  => Service['puppetserver'],

Result:

ter]
rt = true
rts = hipchat
insync = true
nt]
rt = true

Params

key:        Hipchat API key String[required]
version:    Hipchat API version: String[default: 'v1']
:           Hipchat Room String[required]
fy_room:    Notify room: Boolean[default: false]
fy_color:   Notification Color: String[default: 'red'] options['red', 'green', 'purple', 'random']
uses:       Array of statuses to notify: Array[Defailt ['failed'] ], options['failed', 'all']
er:         Hipchat Sever String[default: 'https://api.hipchat.com']
ig_file:    Hipchat config file: String[default: "{confdir}/hipchat.yaml"]
r:          hipchat.conf owner: String[default: Varies based on puppet version]
p:          hipchat.conf group: String[default: Varies based on puppet version]

age_name:   Hipchat gem: String[default: 'hipchat']
all_hc_gem: Install Hipchat Gem: Boolean[default: Varies based on puppet version]
ider:       Package Provider to use: String[default: Varies based on puppet version]

etboard:    URL to puppetboard: String[optional]
board:      URL to dashboard: String[optional]
y:          proxy url and port to reach hipchat: String[optional] Format: 'http://username:password@proxy_host:proxy_port'

NOTE FOR PUPPETBOARD 1.1.2+ USERS:

if you are using environments other than production you will need to either configure puppetboard default environment to * or set hipchat_server to append /%2A, ex: :hipchat_server: http://hipchat.test.local/%2A otherwise you will receive a not found error for any nodes in environments other than production.

Disabling notifcations temporarily

• To temporarily 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

Team

Maintainer: James Powis

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