Forging Great Modules: Standards, Tools and Patterns - PuppetConf 2013

Forging Great Modules:
Standards,Tools and Patterns
Ryan Coleman
Product Owner | Puppet Labs
@ryanycoleman
Friday, August 23, 13

puppetconf.com #puppetconf
Outline
• What’s Forge & What’s There
• Where the Forge is Going
• Module Writing Practices and Tips

What is the Puppet Forge?
Just the basics

#PuppetCamp

#PuppetCamp
$ puppet help module

The Puppet Forge Team
Professional Blacksmiths

Ryan Coleman
Product Owner

Melinda Campbell
User Experience Designer

Alex Dreyer
Pieter Van De Brugen
Forge Engineering

Hunter Haugen
Ashley Penney
Forge Module Engineering

Recent Updates
Slowly but surely, we’re getting there!

Top Ten Search Terms

Puppet Labs Module Engineering

Coming Soon
to a forge near you

Quality Over Quantity

• Module Quality
Design Jam
• Friday 4:20 - 6:00
• Hunt (Mezzanine
Level)
• http://sched.co/
17fAJn7

Tools built with the Forge API
• Geppetto IDE
• librarian-puppet
• `puppet module`
• R10K
• MaestroDev Blacksmith

Email me or talk to
me about the API!
ryan@puppetlabs.com

Email ryan@puppetlabs.com for a Travis-driven preview

GitHub
Flavored
Markdown on
Forge!

Supported
Puppet Labs
Modules

The Puppet Forge
Extended Family
Artisan and Apprentice Blacksmiths

CLI!
Ruby Code!
Functions!
Oh My!

Development Tools

TextMate
w/Puppet!

Vim
• vim-pathogen or vundle (for plugins)
• snipmate (like TextMate)
• tabular
• syntastic
• mv-vim-puppet

Module Design Patterns
Some thoughts to guide you in the right direction

Keep it modular

An Example: PuppetDB

Class Layout and Naming
the boring stuff

Text
http://ruth-tay.deviantart.com/art/Hydra-121089045

Public vs (pseudo) Private Classes

Private classes should be discrete

Public classes are for
parameters,
validation and
interacting with
private classes.

https://github.com/stdmod/puppet-modules
A community-driven effort to standardize on param names

#PuppetCamp
The Style Guide

Style Guide Update Soon!
Email suggestions/feedback to ryan@puppetlabs.com

Documentation
the most important part!

Answer these questions
• What technology does your module
manage?
• What does it intend to do?
• How does it do it? (impact on the system)
• How should one use it?

http://docs.puppetlabs.com/puppet/3/reference/
modules_documentation.html

Module Testing
become a mad scientist!

http://www.dsrsd.com/img/img_wwrw/Sewer_Web.png
Smoke Testing

puppet apply ./tests/apache.pp

http://www.pieterg.com/Media/277
Unit Testing

http://robots.thoughtbot.com/post/33771089985/rspec-integration-tests-with-capybara
Integration Testing

Versioning & Releasing

Semantic Versioning
• Based on Major.Minor.Patch scheme
• X.0.0 Major version for breaking change
• 0.X.0 Minor version for new non-
breaking functionality
• 0.0.X Patch version for backwards
compatible bug ﬁxes

Data In-Modules
Overview & Call To Action

Params.pp Meet
Hiera Data
./data/operatingsystem/
Amazon.yaml

Why put Hiera in modules?
• Eliminate the params.pp pattern
• Allow for swappable data sets
• Introspect data in ruby code
• ??? <--- we need your help

http://links.puppetlabs.com/bgtm

Network Too!

• forge.puppetlabs.com/puppetlabs/gce_compute
• certname == GCE project ID
•

Thank You
Ryan Coleman
Product Owner | Puppet Labs
@ryanycoleman
Collaborate. Automate. Ship.

Don’t Forget...
• Beginners Guide to Writing Modules!
• links.puppetlabs.com/bgtm
• Design Jam on Module Quality
• http://sched.co/16C7ET3
• Spend your GCE Credit with our Module!
• http://forge.puppetlabs.com/puppetlabs/gce_compute
• forge.puppetlabs.com Ryan Coleman
Product Owner | Puppet Forge
@ryanycoleman
ryan@puppetlabs.com

Forging Great Modules: Standards, Tools and Patterns - PuppetConf 2013

More Related Content

Viewers also liked

Similar to Forging Great Modules: Standards, Tools and Patterns - PuppetConf 2013

More from Puppet

Recently uploaded

Forging Great Modules: Standards, Tools and Patterns - PuppetConf 2013