Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

report_consul_kv

Puppet reporter which save details to Consul KV
Project URLRSS FeedReport issues

7,889 downloads

7,889 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

  • 0.2.0 (latest)
released Nov 25th 2015

Start using this module

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

Add this module to your Puppetfile:

mod 'udzura-report_consul_kv', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add udzura-report_consul_kv
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install udzura-report_consul_kv --version 0.2.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

udzura/report_consul_kv — version 0.2.0 Nov 25th 2015

udzura-report_consul_kv

Table of Contents

  1. Overview
  2. Setup - The basics of getting started with report_consul_kv
  3. Usage - Configuration options and additional functionality
  4. Development - Guide for contributing to the module

Overview

Puppet reporter which save details to Consul KV

Setup

Run:

puppet module install udzura-report_consul_kv
# or use librarian-puppet

Usage

Create config file /etc/puppet/consul_kv.yaml on your master:

---
consul_url: "http://consul.host:8500" # default to localhost:8500
event_name: "puppet-apply"

event_name is optional, and if it is set, puppet master kicks consul event every time agent runs.

If you have any REVISION file(e.g. when you deployed manifests with Capistrano), please set revision_file.

Then set and restart puppetserver:

[master]
#...

report  = true
reports = consul_kv

After this, puppet will save the reports to consul keys:

  • "/puppet_reports/${hostname}/last_report" for the time last provisioned
  • "/puppet_reports/${hostname}/last_report" for detail

Development

Fork, modify, pull request.

License

See LICENSE