supply_drop
supply_drop is a capistrano plugin to facitiate provisioning servers with puppet, without using the puppet server. It works by simply rsyncing your puppet configuration files to your servers and running puppet apply. It strives to allow you to write idiomatic puppet scripts while being as lightweight as possible.
Installation
gem install supply_drop
or with Bundler
gem 'supply_drop'
then at the top of your deploy.rb
require 'rubygems'
require 'supply_drop'
Tasks
cap puppet:bootstrap:debian
cap puppet:bootstrap:ubuntu
cap puppet:bootstrap:osx
cap puppet:bootstrap:redhat
This does a simple apt-get install of puppet on the target servers.
cap puppet:bootstrap:puppetlabs:debian
cap puppet:bootstrap:puppetlabs:ubuntu
This is the same as above, but it grabs the most recent versions of puppet via apt repositories provided by puppetlabs.
cap puppet:noop
This will show you a list of the pending changes to be applied server-by-server.
cap puppet:apply
Applies the pending changes to all the servers.
cap puppet:syntax_check
Locally syntax checks all the puppet files and erb templates. Requires you to have puppet installed locally.
cap puppet:unlock
Remove any stale lock files created by supply_drop when locking is used and something went wrong.
You can specify that one of your servers should not be puppeted by setting the :nopuppet flag to true, like so. It will then be skipped by all the above commands.
role :weird_thing, '33.33.33.33', :nopuppet => true
Variables
There are several variables that can be overriden to change how supply_drop works:
set :puppet_source, '.'
defines the base directory containing your puppet configs that will be rsynced to the servers.
set :puppet_destination, '/tmp/supply_drop'
defines where on the server the puppet configuration files are synced to.
set :puppet_command, 'puppet apply'
allows you to override the puppet command that is run if puppet is not on the path.
set :puppet_lib, "#{puppet_destination}/modules"
the value of the PUPPETLIB environment variable, the location of your puppet modules.
set :puppet_parameters, 'puppet.pp'
the parameters that are passed to the puppet call.
set :puppet_excludes, %w(.git .svn)
these are patterns that are passed as rsync --exclude flags when pushing your puppet configs to the box.
set :puppet_parallel_rsync, true
determines whether the rsync commands for multiple servers are run in parallel threads or serially
set :puppet_parallel_rsync_pool_size, 10
sets the maximum number of rsync commands that are run concurrently
set :puppet_syntax_check, false
when true, will syntax check your puppet files and erb templates before rsyncing them to your servers. This is an experimental feature and is quite slow at the moment.
set :puppet_stream_output, false
will write the incremental output from the hosts to the screen instead of waiting until complete and printing by host.
set :puppet_write_to_file, nil
a file to additionally write puppet output to, useful for large noops with small scrollbacks.
set :puppet_runner, nil
allows you to specify the user to execute the puppet command as. Like running sudo -u puppet args from the command line.
set :puppet_lock_file, '/tmp/puppet.lock'
sets a lockfile on each remote host to prevent multiple users from puppeting the same node simultaneously. Set to nil to disable locking. You can alternately temporarily disable locking by setting the NO_PUPPET_LOCKING environment variable to any value.
Handling Legacy Puppet
Puppet deprecated the implicit invocation of apply in the 2.6.x series.
The default behavior of supply_drop includes apply
keyword in its commands, but if you need compatibility with older versions of puppet, set the puppet_command
variable to omit it.
You'll need to do this if you see errors like this:
Could not parse for environment production: Could not find file /home/.../supply_drop/apply.pp
Hiera support
Most distributions don't package versions of puppet that are new enough to support hiera. Use the puppetlabs namespaced bootstrap tasks above to make sure you get hiera support.
How to contribute
If you write anything complicated, write a test for it. Test that your changes work using vagrant. Send a pull request. Easy peezy.
Contributors
- Paul Hinze phinze
- Paul Gross pgr0ss
- Drew Olson drewolson
- Dave Pirotte dpirotte
- Mike Pilat mikepilat
- Dan Manges dan-manges (one soda's worth)
- Brian Cosgrove cosgroveb
Copyright (c) 2012-2013 Tony Pitluga
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.