Forge Home

puppetserver_gem

Puppet Labs Puppetserver Gem Module

4,483,133 downloads

1,830,308 latest version

5.0 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

  • 1.1.1 (latest)
  • 1.1.0
  • 1.0.0
  • 0.2.0
  • 0.1.0
released Jul 2nd 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=4.0.0 < 7.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-puppetserver_gem', '1.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-puppetserver_gem
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-puppetserver_gem --version 1.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

puppetlabs/puppetserver_gem — version 1.1.1 Jul 2nd 2019

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.