puppetserver_gem module

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with puppetserver_gem
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

Module description

This module provides management of Ruby gems for both PE and FOSS Puppet Server. It supercedes the deprecated pe_puppetserver_gem. This uses gem as a parent and uses puppetserver gem command for all gem operations.

Setup

To install a gem from RubyGems into Puppet Server:

    package { 'json':
      ensure   => present,
      provider => puppetserver_gem,
    }

Usage

To add the 'json' gem from the default gem sources:

By default there is one gem source which is https://rubygems.org

    package { 'json':
      ensure   => present,
      provider => puppetserver_gem,
    }

To uninstall the 'json' gem:

    package { 'json':
      ensure   => absent,
      provider => puppetserver_gem,
    }

This is equivalent to the command line: puppetserver gem install --no-rdoc --no-ri json

To add a specifc version of a gem from a specific gem repository without first checking the default gem sources:

    package { 'mygem':
      ensure          => '1.2',
      install_options => ['--clear-sources', '--no-document'],
      provider        => puppetserver_gem,
      source          => "https://some-gem-repo.org",
    }

This is equivalent to the command line: puppetserver gem install -v 1.2 --clear-sources --no-document --source https://some-gem-repo.org mygem

Reference

Proxy support

Proxy servers are supported via through the .gemrc file which is normally present at /root/.gemrc:

http_proxy: http://proxy.megacorp.com:8888
https_proxy: http://proxy.megacorp.com:8888

Limitations

This module has been tested on PE and FOSS, and no issues have been identified. It is a wrapper around the puppetserver gem command line, and so has the same limitations around Gems with native (C) extensions

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

Testing

At the minute, there is only an acceptance test for FOSS Puppet Server.

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[1.1.1]

Summary

Minor changes to gem documentation params.

Fixed

• (FM-7681) puppetserver_gem - match gem documentation params

1.1.0

Summary

This release includes minor documentation updates, a compatibility update which means this module is now compatible with Puppet versions less than 7.0.0 and finally a feature to accelerate the puppetserver_gem list.

Fixed

• ensure that the HOME component of the environment is passed through to the puppetserver script to enable access to proxy server settings that are usually in /root/.gemr

Added

• (FM-7145) accelerate puppetserver_gem list

1.0.0

Summary

This is the first officially stable release of puppetserver_gem. This is a bugfix release and no backwards-incompatible changes have been made.

Fixed

• MODULES-4815 Make install_options come before source to allow flags such as --clear-sources to work.

0.2.0

Features:

This adds the ability to use install & uninstall options as in the parent provider.

0.1.0 - 2015-05-28

Summary:

This module provides management of Ruby gems on puppet. This is the initial release of the puppetserver_gem it supersedes the module pe_puppetserver_gem. This module will support both FOSS and PE. With Puppet 4 the path to the puppetserver binary has changed.

Notes:

To test manually against the default nodeset. Run the acceptance test as normal. curl -O http://apt.puppetlabs.com/puppetlabs-release-pc1-trusty.deb ; dpkg -i puppetlabs-release-pc1-trusty.deb apt-get update apt-get install puppetserver optional, make sure that the puppetserver_gem is in the correct place cp -r /etc/puppet/modules/puppetserver_gem /etc/puppetlabs/code/environments/production/modules/ /opt/puppetlabs/bin/puppet apply apply_manifest.pp.****