Forge Home

dockeragent

Manages docker based agent nodes for education purposes

5,564 downloads

5,564 latest version

1.3 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.0 (latest)
released Aug 22nd 2019
This version is compatible with:
  • Puppet Enterprise 3.7.x
  • Puppet 3.x

Start using this module

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

Add this module to your Puppetfile:

mod 'samuelson-dockeragent', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add samuelson-dockeragent
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install samuelson-dockeragent --version 1.0.0

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

samuelson/dockeragent — version 1.0.0 Aug 22nd 2019

samuelson/dockeragent

This module is used to configure simple Dockerized agent nodes for use in training. Unless you are taking a course to learn puppet, this is probably not the module you are looking for.

That being said, you're welcome to poke through it and see how we set things up.

Usage

include dockeragent

# This will manage 5 containerized agents.
range(1,5).each |$n| {
    dockeragent::node { "agent${n}.${::fqdn}":
        ports => ["${n}0080:80"],
    }
}

Example workloads

One thing that containerized agents are sometimes used for is simulating the load of running an environment against a Puppet master. To facilitate that, we've included a handful of very simple sample testing profiles. They don't really do anything useful other than provide the master with a reasonable, if small, catalog to compile.

node default {
  include dockeragent::sample::wordpress
  include dockeragent::sample::vhosts
}

The modules used by these classes are not set as dependencies, so they will not be installed automatically by puppet module install. If you want to use them, you'll want to install them separately:

  • Requirements for dockeragent::sample::wordpress:
    • hunner/wordpress
    • puppetlabs/apache
    • puppetlabs/mysql
  • Requirements for dockeragent::sample::vhosts:
    • puppetlabs/apache
    • Future parser or Puppet 4.x

Other projects:

For a module intended to be used for load testing the Puppet master, see https://github.com/puppetlabs/clamps.

Contact

josh@joshsamuelson.com

Attribution

This project is a fork of puppetlabs/pltraining-dockeragent. All changes up to 014e17a253817d91b5976d88b9c6784ff28e7c41 (including those made by me) should be attributed to puppelabs. All subsequent updates are my own or are community contributions to this project. -Josh Samuelson