Forge Home

psquared

Puppet Squared

9,162 downloads

6,770 latest version

2.5 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.

Version information

  • 0.3.1 (latest)
  • 0.3.0
  • 0.2.0
  • 0.1.1
  • 0.1.0
released May 25th 2017

Start using this module

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

Add this module to your Puppetfile:

mod 'geoffwilliams-psquared', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add geoffwilliams-psquared
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install geoffwilliams-psquared --version 0.3.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

geoffwilliams/psquared — version 0.3.1 May 25th 2017

Build Status

psquared

Table of Contents

  1. Description
  2. Setup - The basics of getting started with psquared
  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

Description

PSquared brings additional features and an easier UX for users of Puppet Enterprise by supporting:

  • Download of all known agent installer repositories
  • Built in git server with pre-configured SSH access
  • Automatic configuration of Code Manager
  • Automatic Code Manager token creation and installation

Usage

Most classes will need to be loaded using the class resource syntax in order to pass the appropriate class defaults, eg:

class { "foo:bar":
  param1 => "value1",
  param2 => "value2",
}

Parameters, where available, are documented inside the individual classes. See Reference section.

Git Server

Change the master branch to be production

git clone ssh://psquared@PUPPETMASTER.HOST.NAME/var/lib/psquared/r10k-control/
git symbolic-ref HEAD refs/heads/production
git push origin production

Reference

Reference documentation is generated directly from source code using puppet-strings. You may regenerate the documentation by running:

bundle exec puppet strings

Or you may view the current generated documentation.

The documentation is no substitute for reading and understanding the module source code, and all users should ensure they are familiar and comfortable with the operations this module performs before using it.

Limitations

  • RHEL 6/7 only
  • Not supported by Puppet, Inc.
  • Not all classes are fully functional! Use only those with accompanying spec tests

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
bundle exec pdqtest all

See .travis.yml for a working CI example