Forge Home

ruby

Install one or more Ruby versions from Software Collections, as well as an optional list of gems

11,526 downloads

11,474 latest version

4.6 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.0.1 (latest)
  • 1.0.0 (deleted)
released Jul 24th 2015
This version is compatible with:

Start using this module

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

Add this module to your Puppetfile:

mod 'covermymeds-ruby', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add covermymeds-ruby
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install covermymeds-ruby --version 1.0.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

covermymeds/ruby — version 1.0.1 Jul 24th 2015

puppet-ruby

This module installs one or more Ruby versions via Red Hat Software Collections, as well as an optional list of gems.

The full functionality of this module requires Hiera.

Rubies

To simply ensure that one or more Ruby versions are installed, use the base ruby class with an array of Ruby Software Collections names:

  class { ruby: 
    $rubies => [ 'ruby200', 'rh-ruby22', ],
  }

The first Ruby in the array will be considered the default Ruby, and will be activated for all bash users.

Gems

Gems can be installed system-wide on a per-Ruby basis.

  ruby::gems { 'ruby193':
    gems => { 'bundler' = { 'version' => '1.0.0' },
              'rails' = { 'version' => '4.0.0' },
            },
  }

  ruby::gems { 'rh-ruby22':
    gems => { 'bundler' = { 'version' => '1.10.6' },
              'rails'   = { 'version' => '4.2.3' },
            },
  }

Any Gem executable (binary or script) will be installed into /opt/rh/<ruby>/root/usr/local/bin, and that directory will be added to the PATH environment variable inside the relevant Software Collection enable script. This ensures that Gem executables will be available when the Software Collection is enabled.

The default Gem installation options include --no-ridoc and --no-rdoc. If you wish to install documentation, you may do so:

  ruby::gems { 'rh-ruby22':
    gems => { 'bundler' = { 'version' => '1.10.16',
                            'ridoc'   => true,
                            'rdoc'    => true,
                          },
            },
  }

Please note that the ruby::gems defined type is a wrapper around the ruby::gem defined type. You may use the latter, if you wish, but please consult the code for details. You're likely better off using ruby::gems unless you have very specific needs.

Hiera

This module is completely compatible with Hiera, and indeed works best with it.

To install multiple Software Collections Rubies from Hiera:

  ---
  ruby::rubies:
    - ruby200
    - rh-ruby22

The first Ruby in the array will be considered the default Ruby, and will be activated for all bash users.

The base Ruby class performs an explicit hiera_hash() lookup for gems to install across all Ruby versions.

One or more gems may be installed for each Ruby version using the ruby::gems Hiera hash. The version of each gem to install is mandatory.

---
ruby::gems:
  bundler:
    version: 1.7.3

If you have gems that are only to be installed to a specific SCL Ruby version, you can add another Hiera hash named after the Ruby version:

---
ruby::gems::ruby193:
  rubygems-bundler:
    version: 1.1.0

The above will ensure that the rubygems-bundler gem will only be installed to Ruby 1.9.3, regardless of what other Rubies are installed.

The default for SCL gems is to pass --no-ridoc and --no-rdoc to the installation command. If you would like to install documentation, add the appropriate boolean to the gem hash entry:

---
ruby::gems:
  bundler:
    version: 1.7.3
    ridoc: true
    rdoc: true

Contributing

Pull requests are warmly welcomed!

Copyright

Copyright 2015 CoverMyMeds and released under the terms of the MIT License.