Earlier this year, R.I.Pienaar released his brilliant data in modules hack, a few months ago, I got the chance to start implementing it in Puppet-Gluster, and today I have found the time to blog about it.
What is it?
R.I.’s hack lets you store hiera data inside a puppet module. This can have many uses including letting you throw out the nested mess that is commonly params.pp, and replace it with something file based that is elegant and hierarchical. For my use case, I’m using it to build OS independent puppet modules, without storing this data as code. The secondary win is that porting your module to a new GNU/Linux distribution or version could be as simple as adding a YAML file.
How does it work?
(For the specifics on the hack in general, please read R.I. Pienaar’s blog post. After you’re comfortable with that, please continue…)
In the hiera.yaml data/ hierarchy, I define an OS / version structure that should probably cover all use cases. It looks like this:
---
:hierarchy:
- params/%{::osfamily}/%{::operatingsystem}/%{::operatingsystemrelease}
- params/%{::osfamily}/%{::operatingsystem}
- params/%{::osfamily}
- common
At the bottom, you can specify common data, which can be overridden by OS family specific data (think RedHat “like” vs. Debian “like”), which can be overridden with operating system specific data (think CentOS vs. Fedora), which can finally be overridden with operating system version specific data (think RHEL6 vs. RHEL7).
Grouping the commonalities near the bottom of the tree, avoids duplication, and makes it possible to support new OS versions with fewer changes. It would be especially cool if someone could write a script to refactor commonalities downwards, and to refactor new uniqueness upwards.
This is an except of the Fedora specific YAML file:
gluster::params::package_glusterfs_server: 'glusterfs-server'
gluster::params::program_mkfs_xfs: '/usr/sbin/mkfs.xfs'
gluster::params::program_mkfs_ext4: '/usr/sbin/mkfs.ext4'
gluster::params::program_findmnt: '/usr/bin/findmnt'
gluster::params::service_glusterd: 'glusterd'
gluster::params::misc_gluster_reload: '/usr/bin/systemctl reload glusterd'
Since we use full paths in Puppet-Gluster, and since they are uniquely different in Fedora (no more: /bin) it’s nice to specify them all here. The added advantage is that you can easily drop in different versions of these utilities if you want to test a patched release without having to edit your system utilities. In addition, you’ll see that the OS specific RPM package name and service names are in here too. On a Debian system, they are usually different.
Dependencies:
This depends on Puppet >= 3.x and having the puppet-module-data module included. I do so for integration with vagrant like so.
Should I still use params.pp?
I think that this answer is yes. I use a params.pp file with a single class specifying all the defaults:
class gluster::params(
# packages...
$package_glusterfs_server = 'glusterfs-server',
$program_mkfs_xfs = '/sbin/mkfs.xfs',
$program_mkfs_ext4 = '/sbin/mkfs.ext4',
# services...
$service_glusterd = 'glusterd',
# misc...
$misc_gluster_reload = '/sbin/service glusterd reload',
# comment...
$comment = ''
) {
if "${comment}" == '' {
warning('Unable to load yaml data/ directory!')
}
# ...
}
In my data/common.yaml I include a bogus comment canary so that I can trigger a warning if the data in modules module isn’t working. This shouldn’t be a fail as long as you want to allow backwards compatibility, otherwise it should be! The defaults I use correspond to the primary OS I hack and use this module with, which in this case is CentOS 6.x.
To use this data in your module, include the params.pp file, and start using it. Example:
include gluster::params
package { "${::gluster::params::package_glusterfs_server}":
ensure => present,
}
Unfortunately the readability isn’t nearly as nice as it is without this, however it’s an essential evil, due to the puppet language limitations.
Common patterns:
There are a few common code patterns, which you might need for this technique. The first few, I’ve already mentioned above. These are the tree layout in hiera.yaml, the comment canary, and the params.pp defaults. There’s one more that you might find helpful…
The split package pattern:
Certain packages are split into multiple pieces on some operating systems, and grouped together on others. This means there isn’t always a one-to-one mapping between the data and the package type. For simple cases you can use a hiera array:
# this hiera value could be an array of strings...
package { $::some_module::params::package::some_package_list:
ensure => present,
alias => 'some_package',
}
service { 'foo':
require => Package['some_package'],
}
For this to work you must always define at least one element in the array. For more complex cases you might need to test for the secondary package in the split:
if "${::some_module::params::package::some_package}" != '' {
package { "${::some_module::params::package::some_package}":
ensure => present,
alias => 'some_package', # or use the $name and skip this
}
}
service { 'foo':
require => "${::some_module::params::package::some_package}" ? {
'' => undef,
default => Package['some_package'],
},
}
This pattern is used in Puppet-Gluster in more than one place. It turns out that it’s also useful when optional python packages get pulled into the system python. (example)
Hopefully you found this useful. Please help increase the multi-os aspect of Puppet-Gluster by submitting patches to the YAML files, and by testing it on your favourite GNU/Linux distro!
Happy hacking!
James
EDIT: I’ve updated the article to use the new recommended directory naming convention of ‘params’ instead of ‘tree’. Example.
The Technical Blog of James 
