Forge Home

xmpp

A Puppet report handler for sending notifications of failed runs to Jabber/XMPP

103,892 downloads

103,187 latest version

3.5 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

  • 0.0.2 (latest)
  • 0.0.1 (deleted)
released Feb 19th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'jamtur01-xmpp', '0.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install jamtur01-xmpp --version 0.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
Tags: xmpp, report

Documentation

jamtur01/xmpp — version 0.0.2 Feb 19th 2014

puppet-xmpp

Description

A Puppet report handler for sending notifications of failed runs to Jabber/XMPP.

Requirements

  • xmpp4r
  • puppet

Installation & Usage

  1. Install the xmpp4r gem on your Puppet master

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

  3. Update the xmpp_jid, xmpp_password, and xmpp_target variables in xmpp.yaml and copy the file to /etc/puppet. An example file is included.

    Set xmpp_muc to true if your target is a MUC.

  4. Add xmpp_environment in xmpp.yaml. You can set this value to a string or an array of strings. These strings are the names of acceptable environments to send alerts for. This option defaults to ALL, the processor will send an alert for errors in all environments.

  5. If you don't have SRV records you can specify the server hostname with xmpp_server.

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

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

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.