Forge Home

modman

A puppet module for managing puppet modules

6,544 downloads

6,490 latest version

1.9 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.9.0 (latest)
  • 0.1.0 (deleted)
released Oct 19th 2016

Start using this module

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

Add this module to your Puppetfile:

mod 'jdshewey-modman', '0.9.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jdshewey-modman
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jdshewey-modman --version 0.9.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

jdshewey/modman — version 0.9.0 Oct 19th 2016

Modman

Table of Contents

  1. Description
  2. Setup
  3. Usage
  4. Development - Guide for contributing to the module

Description

Modman is a Puppet module for managing Puppet modules. Perhaps you have multiple environments or locations and you need a puppet master for each location. If so, this module can Puppetize the setup of the Puppet server in your new environment by installing any missing modules from a given list.

This module can also ensure that all of your modules are at the latest versions by installing updates. While Code Manager or r10k can do this and much more, Code Manager requires a Puppet Enterprise licese and r10k setup and management is extremely complicated. This is a much simpler system and can be thought of at Code Manager/r10k lite. It is perfect for those who are not coding much more than a basic module and are using mostly off-the-shelf Puppet Forge modules.

Setup

To install modman, use

puppet module install jdshewey-modman

Usage

In it's least complicated usage, simply include the modman class in your main init.pp manifest with a list of modules you want to install or keep up to date

class
{
         'modman':
                 modules => [
                         { name  => "crayfishx-firewalld"},
                         { name  => "puppetlabs-stdlib"}
                 ]
}

In the above example, if a module is not detected, the latest version will be installed. If it is if it is already installed, then modman will check for updates.

However, you may find that you need need to pin to a specific version of a module and/or that you have dependancy conflicts and you need to ignore dependancies. If you need all of these, then the most complicated usage of modman would be:

class
{
        'modman':
                modules     => [
                        { name  => "puppetlabs-stdlib", version => "4.10" },  #try_get_value deprecated in version 4.12, but we require it
                        { name  => "puppetlabs-firewall" },
                        { name  => "example42-nfs", ignore_dependancies => true }
                ]
}

Optionally, the ignore_dependancies and version options can be combined if needed.

Development

Development of modman takes place at https://github.com/jdshewey/modman. If you wish to contribute or have an issue to file, you may do so there.

Release Notes

  • We are planning to allow you to supply a cron-style time to the class to allow you to schedule the updates for a specific maintenance window