2014-08-19 Multiple Approaches to Managing Puppet Modules @ Puppet Camp Chicago

Multiple approaches to
managing your Puppet
modules
Puppet Camp Chicago
2014-08-19
Chicago, IL
LearnPuppet.com
Garrett Honeycutt
gh@learnpuppet.com
@learnpuppet

# whoami
© 2014 GH Solutions, LLC

LearnPuppet.com
Audits
Consulting
Training
Advanced Topics with Test Driven Development

What is a Module?

Modules
A module is a self contained directory structure for encapsulating
puppet code.

Metadata
# Modulefile
name 'ghoneycutt-nscd'
version '1.0.2'
source 'git://github.com/ghoneycutt/puppet-module-nscd.git'
author 'ghoneycutt'
license 'Apache License, Version 2.0'
summary 'manage NSCD - name service cache daemon'
description 'Manage every aspect of NSCD - name service cache daemon'
project_page 'https://github.com/ghoneycutt/puppet-module-nscd'
dependency 'puppetlabs/stdlib', '>= 3.2.0'

Metadata
# metadata.json
{
"name": "ghoneycutt-nscd",
"version": "1.0.2",
"author": "ghoneycutt",
"summary": "manage NSCD - name service cache daemon",
"license": "Apache License, Version 2.0",
"source": "git://github.com/ghoneycutt/puppet-module-nscd.git",
"project_page": "https://github.com/ghoneycutt/puppet-module-nscd",
"issues_url": "https://github.com/ghoneycutt/puppet-module-nscd/issues",
"description": "Manage every aspect of NSCD - name service cache daemon",
"dependencies": [
{"name":"puppetlabs/stdlib","version_requirement":">= 3.2.0"}
]
}

Skeleton
Provides a template for generating new modules
https://github.com/ghoneycutt/puppet-module-skeleton
$ git clone https://github.com/ghoneycutt/puppet-module-skeleton
$ VARDIR=`puppet config print vardir`
$ mkdir -p $VARDIR/puppet-module/skeleton/
$ rsync -avp --exclude .git puppet-module-skeleton/
$VARDIR/puppet-module/skeleton/

Generate a module
$ cd /etc/puppet/modules
$ puppet module generate <forgename>-<modulename>
$ mv <forgename-modulename> <modulename>

Components
ghoneycutt-motd
ghoneycutt-motd/.fixtures.yml
ghoneycutt-motd/.gitignore
ghoneycutt-motd/.travis.yml
ghoneycutt-motd/Gemfile
ghoneycutt-motd/LICENSE
ghoneycutt-motd/Modulefile
ghoneycutt-motd/README.md
ghoneycutt-motd/Rakefile
ghoneycutt-motd/manifests
ghoneycutt-motd/manifests/init.pp
ghoneycutt-motd/spec
ghoneycutt-motd/spec/classes
ghoneycutt-motd/spec/classes/init_spec.rb
ghoneycutt-motd/spec/fixtures
ghoneycutt-motd/spec/fixtures/manifests
ghoneycutt-motd/spec/fixtures/manifests/site.pp
ghoneycutt-motd/spec/fixtures/modules
ghoneycutt-motd/spec/spec_helper.rb
ghoneycutt-motd/tests
ghoneycutt-motd/tests/init.pp

In the beginning

In the beginning...
Things were simple. We stuck all of our modules into one repo.
Luke Kanies told me it was a good idea and we spent time
puppetizing the setup.

In the beginning...
That was 2008.

There are better ways!

Looking back
Everyone has to be on the same release cycle or you get
dependency issues.

Scale
This scales to one organization with one release cycle who are
not concerned with others using their code.

Pro's
Easy to get started

Con's
Everything is released at the same time
Promotes forking
Merge hell

Analysis
Avoid at all costs.
Separate repo for each module

Puppetfile

Puppetfile
Simple file that lists your modules, where to get them, and at what
version.
# git repo
mod 'nscd',
:git => 'git://github.com/ghoneycutt/puppet-module-nscd.git'
:ref => 'v1.0.0'

Puppetfile
Also supports the Puppet Forge
# puppet forge
forge 'https://forgeapi.puppetlabs.com'
mod 'puppetlabs/stdlib', '4.2.1'

Puppetfile
Can be validated and kept under revision control.
ruby -c Puppetfile

ghoneycutt's puppet-modules
https://github.com/ghoneycutt/puppet-modules
All of the modules and their dependencies that I write, use, and support.
apache inittab pam ruby
apt localization passenger selinux
common make pe_gem ssh
concat motd portage stdlib
dnsclient mysql postgresql sysklogd
facter network puppet timezone
firewall nfs puppetdb types
gcc nisclient r10k utils
git nrpe rancid vcsrepo
hosts nscd redhat vim
htpasswd nsswitch rpcbind wget
inifile ntp rsyslog xinetd

modulepath

Puppet < 3.6
Search path for modules
modulepath =
/etc/puppet/environments/$environment/modules:/etc/puppet/modules

Puppet >= 3.6
modulepath is deprecated
Warning: Setting modulepath is deprecated in puppet.conf. See
http://links.puppetlabs.com/env-settings-deprecations (at
/usr/lib/ruby/site_ruby/1.8/puppet/settings.rb:1095:in
`issue_deprecations')

Puppet >= 3.6
environmentpath = /etc/puppet/environments
basemodulepath = /etc/puppet/modules

environmentpath
A search path for directory environments. Under $environmentpath are directories for each
$environment and under those are modules and manifests.
/etc/puppet/environments
├── dev
│ ├── manifests
│ │ └── site.pp
│ └── modules
│ ├── apache
│ ├── ...
│ └── zookeeper
├── fix_it
│ ├── manifests
│ │ └── site.pp
│ └── modules
│ ├── apache
│ ├── ...
│ └── zookeeper
└── production
├── manifests
│ └── site.pp
└── modules
├── apache
├── ...
└── zookeeper

basemodulepath
Search path for global modules. This is essentially appended to the modulepath.
basemodulepath = /var/local/ghoneycutt-modules

Puppet Forge

Managed by Ryan
Coleman
@ryanycoleman

Puppet Forge
Repo of puppet modules with dependency tracking.

Puppet Forge -- Demo Time
search
# puppet module search openstack
install
This is buggy!
# puppet module install puppetlabs-openstack -i /tmp

Search by metadata

Pro's
Great way to find new modules
Can filter by OS and Puppet version
Can install from command line
Resolves dependencies

Con's
Installing from the command line leaves
you without something to track in
version control
Resolving dependencies is buggy (fixes
have been coming in, Thanks!)

Analysis
Use the forge to find modules
Install from the command line when
developing to make note of your
dependencies
Potentially use forge in your Puppetfile

librarian-puppet

Written by Tim Sharpe
@rodjek

librarian-puppet
Iterates through Puppetfile and recursively solves dependencies
for you.

Installation
# sudo gem install -V librarian-puppet
Usage
# cd /path/to/dir_with_Puppetfile
# librarian-puppet install -v

Pro's
Uses a Puppetfile, so you have
something in version control
Handles dependencies

Con's
Handles dependencies - this is a
nightmare with a large set of diverse
modules

Analysis
After experiencing a lot of frustration with the dependency
management, I gave up on this and moved to librarian-puppet-
simple. Big props to Tim for writing this and Puppetfile which has
became a standard.

librarian-puppet-simple

Written by Dan Bode
@bodepd

librarian-puppet-simple
Iterates through Puppetfile without any dependency management.

Installation
# sudo gem install -V librarian-puppet-simple
Usage
Similar to librarian-puppet
# cd /path/to/dir_with_Puppetfile
# librarian-puppet install -v

Pro's
No dependency management

Con's
..nope..

Analysis
Dan is my hero. After becoming frustrated with librarian-puppet's
dependency management, this tool simply iterates over a list of
modules, which is awesomely simple.

r10k

Written by Adrien Thebo
@nullfinch

r10k
Creates an environment for every branch in your puppet-modules
git repo.

Installation
There's a module for that https://github.com/acidprime/r10k

Work flow
[foo@laptop]# git checkout -b fixit
vi Puppetfile
ruby -c Puppetfile
git commit -a
git push origin fixit
[root@puppet]# r10k deploy environment -vp
service httpd graceful

Automate deploy step with ssh keys
# Hiera entry using ghoneycutt/ssh
ssh::keys:
r10k:
ensure: 'present'
user: 'root'
type: 'rsa'
key: 'AAAAB3Nz....'
options: 'command="/usr/bin/r10k deploy environment -vp
&& /sbin/service httpd graceful"'
# ~/.ssh/config on your workstation
Host r10k
User root
Hostname puppet.example.com
IdentityFile /Users/gh/.ssh/r10k
[foo@laptop]# ssh r10k

Add a rake task
# Rakefile
task :deploy do
sh 'ssh r10k'
end
[foo@laptop]# rake deploy

Pro's
Make's it really easy to do development
Do not need access to the puppet
master

Con's
..nope..
You need a centralized git repo, which hopefully you already have
:)

Analysis
Thebo is my hero, r10k provides an easy work flow for developers
to make changes in their environment all without shell access on
the puppet master.

Continued Learning

Continued Learning
Puppet modules
Use my modules https://github.com/ghoneycutt/puppet-modules
and send me pull requests.

Continued Learning
Ruby
Follow facter and submit pull requests.

Continued Learning
Ask and Solve Puppet questions
https://ask.puppetlabs.com - Recommend the weekly digest.

Continued Learning
Puppet modules
Use my modules https://github.com/ghoneycutt/puppet-modules
and send me pull requests.
Ruby
Follow facter and submit pull requests.
Ask and Solve Puppet questions
https://ask.puppetlabs.com - Recommend the weekly digest.

2014-08-19 Multiple Approaches to Managing Puppet Modules @ Puppet Camp Chicago

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to 2014-08-19 Multiple Approaches to Managing Puppet Modules @ Puppet Camp Chicago

Similar to 2014-08-19 Multiple Approaches to Managing Puppet Modules @ Puppet Camp Chicago (20)

More from garrett honeycutt

More from garrett honeycutt (16)

Recently uploaded

Recently uploaded (20)

2014-08-19 Multiple Approaches to Managing Puppet Modules @ Puppet Camp Chicago