Forge Home

puppet_zulip

A Puppet report handler for sending notifications to zulip

9,926 downloads

9,926 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.1 (latest)
released Dec 5th 2013

Start using this module

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

Add this module to your Puppetfile:

mod 'mbarr-puppet_zulip', '0.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add mbarr-puppet_zulip
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install mbarr-puppet_zulip --version 0.0.1

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

mbarr/puppet_zulip — version 0.0.1 Dec 5th 2013

puppet-zulip

Description

A Puppet report handler for sending notifications to Zulip. You'll need a Zulip account.

Based on handlers by James Turnbull!

Requirements

  • puppet

Installation & Usage

  1. Install puppet_zulip as a module in your Puppet master's module path.

  2. Get an API bot email & key from zulip [here][https://zulip.com/#settings]

  3. Update the botemail, key from above. Update thetype (stream or private), , to (Stream name or email to send a private message), & subject (for stream subjects) variables in the file zulip.yaml and then copy the file to /etc/puppet/ or for puppet enterpise '/etc/puppetlabs/puppet'. The zulip_statuses should be an array of statuses to send notifications for and defaults to 'failed'. Specify 'all' to receive notifications from all Puppet runs.

  4. You can also use this by including the class in a manifest, with either parameters or hiera to set the settings. It will create the settings file in the correct place for you.

  5. Enable reports on your master puppet.conf

    [master]
    report = true
    reports = zulip
    
  6. Run the Puppet client and sync the report as a plugin

  7. To temporarially disable Zulip notifications add a file named 'zulip_disabled' in the same path as zulip.yaml. (Removing it will re-enable notifications)

    $ touch /etc/puppet/zulip_disabled
    

Author

Matthew Barr mbarr@mbarr.nett

Based on code by James Turnbull james@lovedthanlost.net (puppet-hipchat & puppet-twilio )

License

Author:: Matthew Barr (<mbarr@mbarr.nett>)
Copyright:: Copyright (c) 2013 Matthew Barr
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.