Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

foreman_extras

Sets up Foreman Extras, aka, report processor for PuppetServer and Fact collection via cron.
Project URLRSS FeedReport issues

18,225 downloads

17,007 latest version

3.8 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.1.1 (latest)
  • 0.1.0
released Mar 11th 2016

Start using this module

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

Add this module to your Puppetfile:

mod 'sjoeboo-foreman_extras', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sjoeboo-foreman_extras
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sjoeboo-foreman_extras --version 0.1.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

sjoeboo/foreman_extras — version 0.1.1 Mar 11th 2016

foreman_extras

Table of Contents

  1. Description
  2. Setup - The basics of getting started with foreman_extras
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module sets up some etra foreman bits I've found lacking, esspecailly when using foreman for reports/inventory, btu not for building/controlling puppet(master|servers).

Its setup for PuppetServer 2.x, but should work with 1.0 and the older PuppetMaster.

Setup

Beginning with foreman_extras

include foreman_extras

Usage

This section is where you describe how to customize, configure, and do the fancy stuff with your module here. It's especially helpful if you include usage examples and code samples for doing things with your module.

Reference

Parameters

As found in params.pp:

foreman_url

The url (http or https) where foreman can be reached. Type: String Default: https://foreman

config_path Path you'd like the config file for these scripts place. Directory must exist. Type: String Default: /etc/puppetlabs/puppet/foreman.yaml

reports Boolean, disable,enable the report processor (Note, this does NOT add the processor to the 'report' setting in puppet.conf. That is out of the scope of this module) Type: String Default: true

report_processor_dest_path Path to install the report processor into. Varies with Puppetmaser/Puppetserver 1.0/Puppetserver 2.0 Type: String Default: /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/reports/foreman.rb

ssl_ca Path to CA used to verify foreman https IF using https Type: String Default: /etc/puppetlabs/puppet/ssl/certs/ca.pem

ssl_cert Path to cert used to verify foreman https IF using https Type: String Default: /etc/puppetlabs/puppet/ssl/certs/${::fqdn}.pem

ssl_key Path to key used to verify foreman https IF using https Type: String Default: /etc/puppetlabs/puppet/ssl/private_keys/${::fqdn}.pem

puppetdir Path to puppet data for the fact uploader to read. Type: String Default: /opt/puppetlabs/server/data/puppetserver/

puppetuser Local Puppet used Type: String Default: puppet

fact_uploader Enable/Disable fact uploader Type: String Default: true

fact_uploader_dest_path Path to install fact uplaoding script to Type: String Default: /usr/local/bin/foreman_node_info.rb

fact_uploader_facts Turns on fact uploads in the config file Type: String Default: true

fact_uploader_timeout Time out for attempting to upload facts, in seconds Type: String Default: 10

fact_uploader_threads Now many threads to run when uploading facts. Type: String Default: 2

fact_uploader_cron_job Boolean, toggles installation/removal of cronjob to upload facts Type: String Default: true

fact_uploader_cron_min How frequently, in minutes, to run the cron job ('5' = */5, etc) Type: String Default: '5'

fact_uploader_cron_user User to install the cron job into Type: String Default: 'root'

Limitations

Assuming *nix OS