Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

simmons

Exercise the Master HTTP API indirectly via Puppet resources
Project URLRSS FeedReport issues

143,142 downloads

140,150 latest version

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

  • 0.3.3 (latest)
  • 0.3.2 (deleted)
  • 0.3.1
  • 0.3.0
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.0
released May 19th 2015

Start using this module

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

Add this module to your Puppetfile:

mod 'nwolfe-simmons', '0.3.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add nwolfe-simmons
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install nwolfe-simmons --version 0.3.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

Documentation

nwolfe/simmons — version 0.3.3 May 19th 2015

simmons

A twisted module to exercise the Puppet Master HTTP API.

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with simmons
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how

Overview

The simmons module contains very particular Puppet manifests and resources that will result in specific parts of the Puppet master's HTTP API being exercised during agent runs.

It is not meant to do anything useful on the agents themselves, but is instead useful for Puppet developers (mostly server, but also client-side) to effectively test the HTTP API.

Module Description

Simmons is designed in a somewhat odd fashion in order for it to essentially undo itself during the agent run. This is necessary in order to be able to do successive agent runs that each hit the entire HTTP API (that is being exercised). Without this, only the first agent run would hit the HTTP API and subsequent runs would find all the resources already on the agent.

To this end, classes typically contain a proper Puppet resource (usually file) and a corresponding "poor mans Puppet" exec resource that negates it.

Setup

File Server

In order to exercise the custom mount points supported by the master fileserver, you will need to configure the fileserver to look for files contained within the module under the mount-point-files directory.

Enable custom mount point in fileserver.conf:

[simmons_custom_mount_point]
path /path/to/modules/simmons/mount-point-files
allow *

Structured Facts

Enable structured facts in the agent's puppet.conf:

stringify_facts=false

What simmons affects

Simmons operates entirely within the studio directory parameter that is supplied to the main simmons class.

Usage

The entry class is simmons, which takes a required directory parameter and optional list of simmons class names for the exercises to run.

####studio

Absolute path to a sandbox directory where simmons can operate in. If the directory doesn't exist it will be created.

####exercises

Array of class names corresponding to the exercises to perform during the agent run.

For example, to test custom facts and binary files the value for this parameter would be ['simmons::custom_fact_output', 'simmons::binary_file'].

Reference

Classes

  • simmons::binary_file: exercise file endpoints with binary files
  • simmons::content_file: exercise file endpoints with content-attribute files
  • simmons::source_file: exercise file endpoints with source-attribute files
  • simmons::recursive_directory: exercise file endpoints with recursive directories
  • simmons::custom_fact_output: exercise pluginsync endpoints with custom facts
  • simmons::external_fact_output: exercise pluginsync endpoints with external facts
  • simmons::mount_point_source_file: exercise file server endpoints using custom mount points and source-attribute files
  • simmons::mount_point_binary_file: exercise file server endpoints using custom mount points and binary files