caterer 0.0.1 → 0.1.0

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.vagrant
 .yardoc
 Gemfile.lock
 InstalledFiles

data/Berksfile

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+site :opscode

data/README.md

@@ -1,6 +1,18 @@
 # Caterer
 
-TODO: Write a gem description
+Heavily inspired by vagrant, caterer is a remote server configuration tool that caters to your servers using a collaborative, fast, and iterative push model. Caterer supports chef-solo by default.
+
+## Why?
+
+Caterer is designed as a workflow-first utility around 3 guiding principles:
+
+1. Configuration as code. 
+2. Push provisioning.
+3. Modular provisioner. 
+
+Caterer does not replace chef or puppet, but leverages them to provide a faster iterative approach to live infrastructures. If you're familiar with the vagrant workflow, imagine that your 'boxes' are remote servers and you'll feel right at home.
+
+The goal of caterer is that an entire infrastructure definition lives within a git repo. An infrastructure developer can open the Caterfile and read the infrastructure like a map. All provisioning recipes or definitions will live within this repo, and infrastructure developers can interate repidly to provide a hot infrastructure.
 
 ## Installation
 
@@ -18,7 +30,131 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Caterfile
+
+Caterer loads a Caterfile from the current directory. A Caterfile defines your infrastructure in a centralized, familiar ruby dsl. A Caterfile essentially creates a library of images that can be aggregated and applied to live servers.
+
+### Images
+
+An image is a configuration construct that defines the end state of the machine after that image has been applied. An image requires a provisioner. 
+
+### Provisioner
+
+A provisioner is the tool that will provision a server to meet the end requirements of an image. Currently only chef-solo is supported.
+
+### Member
+
+A member is an optional configuration for servers. Storing live server credentials in a version controlled repo is not suitable for many infrastructures, but is there for your convenience if you want it.
+
+### Group
+
+A group is a simply way of grouping images or members to provide agrregate funcionality in a simple, concise way.
+
+## Example
+
+### Caterfile
+
+```ruby
+Caterer.configure do |config|
+
+  config.image :basic do |image|
+    image.provision :chef_solo do |chef|
+      chef.cookbooks_path = ['cookbooks'] # default
+      chef.add_recipe 'ruby'
+    end
+  end
+
+  config.image :rails do |image|
+    image.provision :chef_solo do |chef|
+      chef.bootstrap_script = 'script/bootstrap'
+      chef.cookbooks_path = ['cookbooks'] # default
+      chef.add_recipe 'ruby'
+      chef.add_recipe 'mysql::server'
+      chef.add_recipe 'mysql::client'
+      chef.json = {
+        "ruby" => {
+          "gems" => ['mysql2']
+        }
+      }
+    end
+  end
+
+  config.member :m1 do |member|
+    member.images = [:basic]
+    member.host     = "192.168.1.101"
+    member.password = 'samIam'
+  end
+
+  config.group :oven do |group|
+
+    group.images    = [:basic, :rails]
+    group.user     = 'root' # optional
+    group.password = 'password' # optional
+
+    # optional member configuration
+    group.member :oven1 do |m|
+      m.host = "192.168.1.100"
+    end
+
+    group.member :oven2 do |m|
+      m.host     = "192.168.1.101"
+      m.password = 'samIam'
+    end
+
+  end
+
+end
+```
+
+### Command Line
+
+Provision a server with a basic image (image defined in Caterfile)
+
+```bash
+cater provision -i basic HOST
+```
+
+Provision a server with multiple images (images defined in Caterfile)
+
+```bash
+cater provision -i basic,rails HOST
+```
+
+Provision a server with a group (group defined in Caterfile)
+
+```bash
+cater provision -g oven HOST
+```
+
+Provision a server from a member defined in Caterfile
+
+```bash
+cater provision m1
+```
+
+Provision a server from a group member
+
+```bash
+cater provision oven::oven1
+```
+
+Provision multiple servers from members defined in Caterfile
+
+```bash
+cater provision m1,oven::oven1,oven::oven2
+```
+
+Bootstrap a server
+
+```bash
+cater bootstrap -i basic HOST
+```
+
+Boostrap and provision a server
+
+```bash
+cater up -i basic HOST
+```
 
 ## Contributing
 

data/Vagrantfile

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# require 'berkshelf/vagrant'
+require 'vagrant-vbguest' unless defined? VagrantVbguest::Config
+
+Vagrant::Config.run do |config|
+
+  config.berkshelf.config_path = './knife.rb'
+
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+  config.vm.customize ["modifyvm", :id, "--cpus", 1, "--memory", 512]
+  config.vm.network :hostonly, "33.33.33.10"
+  config.vm.share_folder("v-root", "/vagrant", ".")
+  config.vbguest.auto_update = true
+
+  config.vm.provision :chef_solo do |chef|
+    chef.cookbooks_path = ['cookbooks']    
+    chef.add_recipe 'users'
+  end
+
+end

data/bin/cater

@@ -28,6 +28,15 @@ else
   opts[:ui_class] = Vli::UI::Colored
 end
 
+# strip out a custom config file and set it into the env opts
+if ARGV.include? "-c"
+  index = ARGV.index '-c'
+  value = ARGV[index + 1]
+  opts[:custom_config] = value
+  ARGV.delete('-c')
+  ARGV.delete(value)
+end
+
 env = Caterer::Environment.new(opts)
 
 env.load!

data/caterer.gemspec

@@ -15,6 +15,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'log4r'
   gem.add_dependency 'activesupport'
   gem.add_dependency 'vli'
+  gem.add_dependency 'net-ssh'
+  gem.add_dependency 'net-scp'
+  gem.add_dependency 'tilt'
+  gem.add_dependency 'oj'
+  gem.add_dependency 'multi_json', '>= 1.3'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/cookbooks/users/recipes/default.rb

@@ -0,0 +1,18 @@
+
+package "build-essential" do
+  action :nothing
+end.run_action(:install)
+
+package 'whois'
+chef_gem 'ruby-shadow'
+
+[['bert', 'password'], ['ernie', 'password'], ['tylerflint', 'password']].each do |u, pass|
+  user u do
+    supports :manage_home => true
+    home "/home/#{u}"
+    gid "admin"
+    shell "/bin/bash"
+    password `echo #{pass} | mkpasswd -s -m sha-512`.chomp
+  end
+end
+

data/example/Caterfile

@@ -1,25 +1,43 @@
 Caterer.configure do |config|
 
-  config.role :default do |node|
+  config.image :basic do |image|
+    image.provision :chef_solo do |chef|
+      chef.cookbooks_path = ['cookbooks'] # default
+      chef.add_recipe 'ruby'
+    end
+  end
 
-    node.provision :chef_solo do |chef|
+  config.image :rails do |image|
+    image.provision :chef_solo do |chef|
+      chef.bootstrap_script = 'script/bootstrap'
+      chef.cookbooks_path = ['cookbooks'] # default
       chef.add_recipe 'ruby'
       chef.add_recipe 'mysql::server'
       chef.add_recipe 'mysql::client'
       chef.json = {
         "ruby" => {
           "gems" => ['args_parser', 'mysql2']
-        },
-        "mysql" => {
-          "server_root_password" => "root",
-          "bind_address" => '127.0.0.1',
-          "client" => {
-            "packages" => ["mysql-client", "libmysqlclient-dev"]
-          }
         }
       }
     end
+  end
+
+  config.group :oven do |group|
+
+    group.images    = [:basic, :rails]
+    group.user     = 'root'
+    group.password = 'password'
+
+    group.member :oven1 do |m|
+      m.host = "192.168.1.100"
+    end
+
+    group.member :oven2 do |m|
+      m.host     = "192.168.1.101"
+      m.password = 'samIam'
+    end
 
   end
 
-end
+end
+

data/example/bootstrap.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "hello bootstrap!"

data/knife.rb

@@ -0,0 +1 @@
+#whatev

data/lib/caterer/action/base.rb

@@ -0,0 +1,10 @@
+module Caterer
+  module Action
+    class Base
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+    end
+  end
+end

data/lib/caterer/action/config/validate/image.rb

@@ -0,0 +1,23 @@
+module Caterer
+  module Action
+    module Config
+      module Validate
+        class Image < Base
+
+          def call(env)
+            # check to ensure the image exists
+            image = env[:config].images[env[:image]]
+
+            if not image
+              env[:ui].error "image ':#{env[:image]}' is not defined"
+              return
+            end
+
+            @app.call(env)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/caterer/action/config/validate/provisioner.rb

@@ -0,0 +1,29 @@
+module Caterer
+  module Action
+    module Config
+      module Validate
+        class Provisioner < Base
+          
+          def call(env)
+            provisioner = env[:config].images[env[:image]].provisioner
+
+            if not provisioner
+              env[:ui].error "provisioner for image ':#{env[:image]}' is not defined"
+              return
+            end
+            
+            if errors = provisioner.errors
+              errors.each do |key, val|
+                env[:ui].error "image :#{env[:image]} provisioner error -> #{key} #{val}"
+              end
+              return
+            end
+
+            @app.call(env)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/caterer/action/config/validate.rb

@@ -0,0 +1,10 @@
+module Caterer
+  module Action
+    module Config
+      module Validate
+        autoload :Provisioner,  'caterer/action/config/validate/provisioner'
+        autoload :Image,        'caterer/action/config/validate/image'
+      end
+    end
+  end
+end

data/lib/caterer/action/config.rb

@@ -0,0 +1,7 @@
+module Caterer
+  module Action
+    module Config
+      autoload :Validate, 'caterer/action/config/validate'
+    end
+  end
+end

data/lib/caterer/action/provisioner/base.rb

@@ -0,0 +1,16 @@
+require 'active_support/inflector'
+
+module Caterer
+  module Action
+    module Provisioner
+      class Base < Action::Base
+        
+        def provisioner(env)
+          config = env[:config].images[env[:image]].provisioner
+          "Caterer::Provisioner::#{config.name.to_s.classify}".constantize.new(env[:server], config)
+        end
+
+      end
+    end
+  end
+end

data/lib/caterer/action/provisioner/bootstrap.rb

@@ -0,0 +1,14 @@
+module Caterer
+  module Action
+    module Provisioner
+      class Bootstrap < Base
+        
+        def call(env)
+          provisioner(env).bootstrap(env[:script])
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/caterer/action/provisioner/cleanup.rb

@@ -0,0 +1,14 @@
+module Caterer
+  module Action
+    module Provisioner
+      class Cleanup < Base
+
+        def call(env)
+          provisioner(env).cleanup
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end

data/lib/caterer/action/provisioner/prepare.rb

@@ -0,0 +1,14 @@
+module Caterer
+  module Action
+    module Provisioner
+      class Prepare < Base
+
+        def call(env)
+          provisioner(env).prepare
+          @app.call(env)
+        end
+
+      end     
+    end
+  end
+end

data/lib/caterer/action/provisioner/provision.rb

@@ -0,0 +1,14 @@
+module Caterer
+  module Action
+    module Provisioner
+      class Provision < Base
+
+        def call(env)
+          provisioner(env).provision
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end

data/lib/caterer/action/provisioner.rb

@@ -0,0 +1,11 @@
+module Caterer
+  module Action
+    module Provisioner
+      autoload :Base,       'caterer/action/provisioner/base'
+      autoload :Bootstrap,  'caterer/action/provisioner/bootstrap'
+      autoload :Cleanup,    'caterer/action/provisioner/cleanup'
+      autoload :Prepare,    'caterer/action/provisioner/prepare'
+      autoload :Provision,  'caterer/action/provisioner/provision'
+    end
+  end
+end

data/lib/caterer/action/server/validate/ssh.rb

@@ -0,0 +1,22 @@
+module Caterer
+  module Action
+    module Server
+      module Validate
+        class SSH < Base
+          
+          def call(env)
+            ready = env[:server].ssh.ready?
+
+            if not ready
+              env[:ui].error "unable to ssh into #{env[:server].host}"
+              return
+            end
+
+            @app.call(env)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/caterer/action/server/validate.rb

@@ -0,0 +1,9 @@
+module Caterer
+  module Action
+    module Server
+      module Validate
+        autoload :SSH, 'caterer/action/server/validate/ssh'
+      end
+    end
+  end
+end

data/lib/caterer/action/server.rb

@@ -0,0 +1,7 @@
+module Caterer
+  module Action
+    module Server
+      autoload :Validate, 'caterer/action/server/validate'
+    end
+  end
+end

data/lib/caterer/action.rb

@@ -0,0 +1,9 @@
+module Caterer
+  module Action
+    autoload :Base,         'caterer/action/base'
+    autoload :Config,       'caterer/action/config'
+    autoload :Runner,       'caterer/action/runner'
+    autoload :Provisioner,  'caterer/action/provisioner'
+    autoload :Server,       'caterer/action/server'
+  end
+end

data/lib/caterer/actions.rb

@@ -0,0 +1,48 @@
+# actions
+Caterer.actions.register(:validate) do
+  Vli::Action::Builder.new do
+    use Caterer::Action::Config::Validate::Image
+    use Caterer::Action::Config::Validate::Provisioner
+    use Caterer::Action::Server::Validate::SSH
+  end
+end
+
+Caterer.actions.register(:prepare) do
+  Vli::Action::Builder.new do
+    use Caterer::Action::Provisioner::Prepare
+  end
+end
+
+Caterer.actions.register(:cleanup) do
+  Vli::Action::Builder.new do
+    use Caterer::Action::Provisioner::Cleanup
+  end
+end
+
+Caterer.actions.register(:bootstrap) do
+  Vli::Action::Builder.new do
+    use Caterer.actions.get(:validate)
+    use Caterer.actions.get(:prepare)
+    use Caterer::Action::Provisioner::Bootstrap
+    use Caterer.actions.get(:cleanup)
+  end
+end
+
+Caterer.actions.register(:provision) do
+  Vli::Action::Builder.new do
+    use Caterer.actions.get(:validate)
+    use Caterer.actions.get(:prepare)
+    use Caterer::Action::Provisioner::Provision
+    use Caterer.actions.get(:cleanup)
+  end
+end
+
+Caterer.actions.register(:up) do
+  Vli::Action::Builder.new do
+    use Caterer.actions.get(:validate)
+    use Caterer.actions.get(:prepare)
+    use Caterer::Action::Provisioner::Bootstrap
+    use Caterer::Action::Provisioner::Provision
+    use Caterer.actions.get(:cleanup)
+  end
+end

data/lib/caterer/command/base.rb

@@ -0,0 +1,100 @@
+module Caterer
+  module Command
+    class Base < Vli::Command::Base
+      
+      def parse_options(opts=nil, options={}, force_argv=true)
+        opts ||= OptionParser.new
+        opts.separator ""
+        opts.on("-c CONFIG", 'assumes Caterfile in current directory')
+        opts.separator ""
+        opts.on("-u USER", "--user USER", 'assumes current username') do |u|
+          options[:user] = u
+        end
+        opts.on('-p PASSWORD', '--password PASSWORD', 'assumes key') do |p|
+          options[:pass] = p
+        end
+        opts.on('-P PORT', '--port PORT', 'assumes 22') do |p|
+          options[:port] = p
+        end
+        opts.on('-i IMAGE', '--image IMAGE', 'corresponds to a image in Caterfile') do |i|
+          options[:image] = i
+        end
+        opts.on('-g GROUP', '--group GROUP', 'corresponds to a group in Caterfile') do |g|
+          options[:group] = g
+        end
+        opts.separator ""
+
+        begin
+          argv = super(opts)
+          raise if force_argv and (not argv or argv.length == 0)
+          argv
+        rescue
+          safe_puts(opts.help)
+          nil
+        end
+        
+      end
+
+      def with_target_servers(argv, options={})
+        target_servers(argv, options).each do |server|
+          yield server if block_given?
+        end
+      end
+
+      def target_servers(argv, options={})
+        @servers ||= begin
+          servers = []
+
+          argv.first.split(",").each do |host|
+            
+            if group = @env.config.groups[host.to_sym]
+              group.members.each do |member|
+                servers << init_server(group, member, options)
+              end
+            else
+
+              if not host.match /::/
+                host = "default::#{host}"
+              end
+
+              g, m   = host.split "::"
+              group  = nil
+              member = nil
+
+              if group = @env.config.groups[g.to_sym]
+                member = group.members[m.to_sym]
+              end
+
+              servers << init_server(group, member, options.merge(:host => m))
+            end
+          end    
+
+          servers
+        end
+      end
+
+      def init_server(group=nil, member=nil, options={})
+
+        group ||= Config::Group.new
+        member ||= Config::Member.new
+
+        opts = {}
+        opts[:alias]  = member.name
+        opts[:user]   = options[:user] || member.user || group.user
+        opts[:pass]   = options[:pass] || member.password || group.password
+        opts[:host]   = member.host || options[:host]
+        opts[:port]   = options[:port] || member.port
+        opts[:images] = image_list(options) || member.images || group.images
+
+        Server.new(@env, opts)
+      end
+
+      def image_list(options={})
+        if images = options[:image]
+          images.split(',').map(&:to_sym)
+        end
+      end
+
+    end
+  end
+end