Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet_module

puppet_module type and provider for managing puppet modules as resources
Project URLRSS FeedReport issues

84,839 downloads

84,203 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.0.3 (latest)
  • 0.0.2
  • 0.0.1
released Jan 11th 2013

Start using this module

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

Add this module to your Puppetfile:

mod 'rcoleman-puppet_module', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add rcoleman-puppet_module
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install rcoleman-puppet_module --version 0.0.3

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: module, provider, forge

Documentation

rcoleman/puppet_module — version 0.0.3 Jan 11th 2013

Puppet_Module Type and Provider

Overview

This module provides a module type and a forge provider for managing Puppet modules from the Forge as resources in the DSL.

This work is a prototype and should be used with caution in non-production deployments.

The code behind version 0.0.1 is the work of Pieter van de Bruggen. Thanks Pieter!

Installation & Usage

The simplest way to get started is to install this module with the Puppet Module Tool, available in Puppet 2.7.14+

puppet module install rcoleman/puppet_module

Then, in your puppet manifests, build module resources to suit. The resource title should be the fully name-spaced module name from the Puppet Forge. ex. author/module By default, modules are installed into the first modulepath configured in puppet.conf (or default settings)

Simple example:

module { 'author/mymodule':
  ensure   => present,
}

More Examples

Ensure a module is present from the Puppet Forge

module { 'puppetlabs/stdlib':
  ensure   => installed,
}

Ensure a module is absent

module { 'puppetlabs/stdlib':
  ensure   => absent,
}

Install a particular version of a module from the Puppet Forge

module { 'puppetlabs/stdlib':
  ensure => '2.6.0',
}

Install a module into a particular directory or 'module path'

module { 'puppetlabs/stdlib':
  ensure     => present,
  modulepath => '/etc/puppet/modules',
}

Requirements

In addition to this module, you will need a version of Puppet that contains the Puppet Module Face, the library that this module uses for its work. The Puppet Module Face comes with Puppet versions 2.7.14 and later (PE 2.5+).

Limitations

What works?

  • Install a module
  • Uninstall a module
  • Upgrade a module to a specific version
    • The above three with a user-supplied modulepath

What doesn't work?

  • Using a user-supplied modulepath for determining the existance of a module (exists? method)
  • Some operations involving specific module versions, especially when dealing with dependencies are wonky
  • Anything to do with environments (though the face is broken in this regard too)
  • No puppet resource inspection (self.instances)
  • Upgrade a module to 'latest'
  • Lots of other things that I haven't found yet

Please Contribute!

This work is obviously a prototype and may behave completely differently by its 1.0.0 release. It needs a lot of work, so please contribute! Here are a few particular items that are missing from this provider.

  • RSpec Tests
  • Proper Pre-fetching
  • Bug Fixes
  • Features!

If you're interested in any other contributions, please file an issue, create your work in a feature branch and submit a pull request against this repo. For more information, see the CONTRIBUTING.md