Updating R10K with git hooks and MCollective
This article was written for an old version of Puppet Enterprise and exists for reference purposes only.
Manually updating R10K after changes are pushed to git is a major pain.
There are a few ways this can be made to work transparently and this article discusses one possible option: Using a post-receive hook to publish an R10K update request to MCollective.
All of the scripts and software to do this task already exists on the Internet, so all we have to do is plug things together to get it working.
There’s a Forge Module that does all the work.
While researching this article, I did the steps the puppet module does manually so that I could better understand what was going on. The Steps to get R10K updates working with Puppet Enterprise are:
- Install MCollective client on the git server and get it talking to the puppet master
- Install the R10K plugins for MCollective
- Install a post-receive hook into the git server I’m using the Atlassian Stash git server to research this article
- Install MCollective client and certificates on machine running git server Support for MCollective is available by installing the pe-mcollective-client package on the git server. Follow the instructions in the r10K puppet module documentation to install the RPM and copy the certificates and configuration files to your git server.
In my case, I was running my stash server as a user called ‘stash’ so I had to change the MCollective configuration file and accordingly.
- Test MCollective functionality from git server
Once MCollective is setup on the git server, you can try it out by becoming the user who’s allowed to run the
mcocommand (‘stash’ in my case) and then typing ‘mco ping’.
If you get output that looks like this, it’s working:
[root@git ~]# sudo -u stash /opt/puppet/bin/mco ping puppet.puppetlabs.vm time=123.93 ms git.puppetlabs.vm time=125.38 ms ---- ping statistics ---- 2 replies max: 125.38 min: 123.93 avg: 124.66
- Install MCollective plugins for R10K
To install the MCollective plugins, I manually copied the following directories from the unpacked puppet module to the place MCollective expects to find it:
# cp files/agent /opt/puppet/libexec/mcollective/mcollective/ -r # cp files/application /opt/puppet/libexec/mcollective/mcollective/ -r
The module can of-course do this automatically but this is a learning exercise ;-)
Note that this must be done on both the puppet master and the git server! There is no mechanism to automatically distribute MCollective plugins unless you get the module to manually copy the files for you.
Once you’ve installed the plugins you must restart both MCollective servers:
# /etc/init.d/pe-mcollective restart
- Test R10K MCollective functionality on git server To test the newly installed R10K plugin I pushed some git changes and then ran the plugin. To check everything worked, I inspected the puppet code on the server to make sure it had been updated.
Running the synchronize command manually looks like this:
# sudo -u stash /opt/puppet/bin/mco r10k synchronize * [ ============================================================> ] 2 / 2 git.puppetlabs.vm: puppet.puppetlabs.vm: Finished processing 2 / 2 hosts in 1138.35 ms
- Install post-receive hook in git repository
Unfortunately the Stash web front-end doesn’t support an easy way to add post receive hooks to git without buying them but once you’ve located the repository on disk it’s possible to add hooks manually by dropping them inside the repository’s
hooks/post-receive.ddirectory. If doing this, start your filename with a number to control execution order.
You can find a complete hook script inside the R10K module in the file
files/post-receive I had to comment line 5 (repository=…) to get the hook to work on my system
- Test the whole process
You should now be able to do an end-to-end test of the system. Try making a change to your
PuppetFilein git and push the changes to your git server. After a few minutes your changes should be live on the puppet master (it can take a while to update if you have a few modules to download)
If things don’t work, test the components individually until you find the fault:
- Test manually running the R10K synchronize command on the puppet master:
# /opt/puppet/bin/r10k deploy environment -pv
- The MCollective plugin expects to be able to find the
r10kcommand in the search path (
$PATHvariable). I had to symlink the
/usr/bin/r10kto get the plugin to work
- Test MCollective is working with the
mco pingcommand. If there are problems try restarting the
pe-mcollectivedaemon and ensure clocks are synchronized.
- Make sure the R10K plugin is installed and working on both the puppet master and the git server. You have to do this by manually copying the files if your not having the forge module do it for you
- Increase the logging output for MCollective by editing the file /etc/puppetlabs/mcollective/server.cfg and restarting the pe-mcollective daemon and checking the output in the log file
- If debug output doesn’t help, you could try putting extra logging into the MCollective pluggin to log to a file but don’t forget you must re-start the pe-mcollective daemon for changes to take effect
- Check the git hook has execute permission (
- Carefully look at the output of the git push command - there may be a script error hiding in there
- Ensure the ruby interpreter runs when you type
/usr/bin/env ruby. You may need a symlink if not
- Alter the hook to add debug output and log it to a file somewhere