caterer 0.11.2 → 1.0.0

data/README.md

@@ -1,73 +1,22 @@
-# Caterer
+## Caterer
 
-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.
+Caterer is a tool for provisioning production environments.
 
-## Why?
+### Getting Started
 
-Caterer is designed as a workflow-first utility around 3 guiding principles:
+#### Install caterer:
 
-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
-
-Add this line to your application's Gemfile:
-
-    gem 'caterer'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install caterer
-
-## Usage
-
-### 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
+```bash
+gem install caterer
+```
 
-### Caterfile
+#### Define images in a 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'
@@ -78,83 +27,52 @@ Caterer.configure do |config|
       }
     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)
+#### Provision a server with the "rails" image:
 
 ```bash
-cater provision -i basic HOST
+cater provision HOST -i rails
 ```
 
-Provision a server with multiple images (images defined in Caterfile)
+## Documentation
 
-```bash
-cater provision -i basic,rails HOST
-```
+The Caterer Wiki has lots of additional information about Caterer including many usage references, configuration examples, how-to articles, and answers to the most frequently asked questions.
 
-Provision a server with a group (group defined in Caterfile)
+You can view all of the available wiki pages [here](https://github.com/tylerflint/caterer/wiki/_pages).
 
-```bash
-cater provision -g oven HOST
-```
+### Getting started
 
-Provision a server from a member defined in Caterfile
+Here is the basic information to get started: [Soup to Nuts](https://github.com/tylerflint/caterer/wiki/Soup-to-Nuts)
 
-```bash
-cater provision m1
-```
+For answers to the most frequently asked questions: [FAQ](https://github.com/tylerflint/caterer/wiki/FAQ)
 
-Provision a server from a group member
+Some definitions to help you through the rest of the guides: [Definitions](https://github.com/tylerflint/caterer/wiki/Definitions)
 
-```bash
-cater provision oven::oven1
-```
+A few cli usage examples: [cli examples](https://github.com/tylerflint/caterer/wiki/cli-examples)
 
-Provision multiple servers from members defined in Caterfile
+### Configuration
 
-```bash
-cater provision m1,oven::oven1,oven::oven2
-```
+* [general](https://github.com/tylerflint/caterer/wiki/Config:-General)
+* [images](https://github.com/tylerflint/caterer/wiki/Config:-Images)
+* [members](https://github.com/tylerflint/caterer/wiki/Config:-Members)
+* [groups](https://github.com/tylerflint/caterer/wiki/Config:-Groups)
 
-Bootstrap a server
+#### Provisioners 
+* [shell](https://github.com/tylerflint/caterer/wiki/Config:-Provisioners:-Shell)
+* [chef-solo](https://github.com/tylerflint/caterer/wiki/Config:-Provisioners:-chef-solo)
 
-```bash
-cater bootstrap -i basic HOST
-```
+### How To...
 
-Boostrap and provision a server
+Use berkshelf for cookbook dependencies: [Howto: Berkshelf](https://github.com/tylerflint/caterer/wiki/Howto:-Berkshelf)
+
+Display verbose output: [Howto: Verbose Logging](https://github.com/tylerflint/caterer/wiki/Howto:-Verbose-Logging)
+
+Structure a large project: [Howto: Large Projects](https://github.com/tylerflint/caterer/wiki/Howto:-Large-Projects)
+
+Limit chef runlist for iterative provisioning: [Howto: Runlist Override]()
 
-```bash
-cater up -i basic HOST
-```
 
 ## Contributing
 

data/Vagrantfile

@@ -3,12 +3,12 @@
 Vagrant.configure("2") do |config|
 
   # ubuntu
-  # config.vm.box     = 'precise'
-  # config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
+  config.vm.box     = 'precise'
+  config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
 
   # centos
-  config.vm.box     = 'pagoda_cent6_minimal'
-  config.vm.box_url = 'https://s3.amazonaws.com/vagrant.pagodabox.com/boxes/centos-6.4-x86_64-minimal.box'
+  # config.vm.box     = 'pagoda_cent6_minimal'
+  # config.vm.box_url = 'https://s3.amazonaws.com/vagrant.pagodabox.com/boxes/centos-6.4-x86_64-minimal.box'
 
   config.vm.provider "virtualbox" do |v|
     v.customize ["modifyvm", :id, "--cpus", "2", "--memory", "1024", "--cpuexecutioncap", "75"]

data/lib/caterer.rb

@@ -10,6 +10,9 @@ module Caterer
   autoload :Communication,  'caterer/communication'
   autoload :Config,         'caterer/config'
   autoload :Environment,    'caterer/environment'
+  autoload :Group,          'caterer/group'
+  autoload :Image,          'caterer/image'
+  autoload :Member,         'caterer/member'
   autoload :Provisioner,    'caterer/provisioner'
   autoload :Server,         'caterer/server'
   autoload :Util,           'caterer/util'

data/lib/caterer/action.rb

@@ -4,6 +4,7 @@ module Caterer
     autoload :Berkshelf,    'caterer/action/berkshelf'
     autoload :Config,       'caterer/action/config'
     autoload :Environment,  'caterer/action/environment'
+    autoload :Image,        'caterer/action/image'
     autoload :Runner,       'caterer/action/runner'
     autoload :Provisioner,  'caterer/action/provisioner'
     autoload :Server,       'caterer/action/server'

data/lib/caterer/action/berkshelf/install.rb

@@ -44,8 +44,10 @@ module Caterer
           ::Digest::MD5.hexdigest("#{berks_content}/#{lock_content}/#{shelf_content}")
         end
 
+        # default to true for time being...
         def needs_update?
-          !(::File.exists?(cachefile) and ::File.read(cachefile) == shelf_digest)
+          # !(::File.exists?(cachefile) and ::File.read(cachefile) == shelf_digest)
+          true
         end
 
         def update_cache

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

@@ -7,19 +7,25 @@ module Caterer
           def call(env)
 
             if env[:image]
-              provisioner = env[:config].images[env[:image]].provisioner
 
-              if not provisioner
-                env[:ui].error "provisioner for image ':#{env[:image]}' is not defined"
+              provisioners = env[:config].images[env[:image]].provisioners
+
+              if provisioners.empty?
+                env[:ui].error "image ':#{env[:image]}' does not have a provisioner"
                 return
               end
-              
-              if errors = provisioner.errors
-                errors.each do |key, val|
-                  env[:ui].error "image :#{env[:image]} provisioner error -> #{key} #{val}"
-                end
-                return
-              end                        
+
+              provisioners.each do |provisioner|
+
+                if errors = provisioner.errors
+                  errors.each do |key, val|
+                    env[:ui].error "image :#{env[:image]} provisioner error -> #{key} #{val}"
+                  end
+                  return
+                end 
+
+              end
+
             end          
 
             @app.call(env)

data/lib/caterer/action/image.rb

@@ -0,0 +1,9 @@
+module Caterer
+  module Action
+    module Image
+      autoload :Cleanup,  'caterer/action/image/cleanup'
+      autoload :Prepare,  'caterer/action/image/prepare'
+      autoload :Run,      'caterer/action/image/run'
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Caterer
+  module Action
+    module Image
+      class Cleanup < Base
+
+        def call(env)
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.cleanup(server) if env[:ghost_mode]
+
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Caterer
+  module Action
+    module Image
+      class Prepare < Base
+
+        def call(env)
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.prepare(server)
+
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end

data/lib/caterer/action/image/run.rb

@@ -0,0 +1,20 @@
+module Caterer
+  module Action
+    module Image
+      class Run < Base
+
+        def call(env)
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.run(server) if not env[:dry_run]
+
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end

data/lib/caterer/action/provisioner.rb

@@ -1,16 +1,9 @@
 module Caterer
   module Action
     module Provisioner
-      autoload :Bootstrap,  'caterer/action/provisioner/bootstrap'
       autoload :Cleanup,    'caterer/action/provisioner/cleanup'
-      autoload :Install,    'caterer/action/provisioner/install'
-      autoload :Load,       'caterer/action/provisioner/load'
-      autoload :Lock,       'caterer/action/provisioner/lock'
       autoload :Prepare,    'caterer/action/provisioner/prepare'
-      autoload :Provision,  'caterer/action/provisioner/provision'
       autoload :Uninstall,  'caterer/action/provisioner/uninstall'
-      autoload :Unlock,     'caterer/action/provisioner/unlock'
-      autoload :Validate,   'caterer/action/provisioner/validate'
     end
   end
 end

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

@@ -4,10 +4,28 @@ module Caterer
       class Cleanup < Base
 
         def call(env)
-          env[:provisioner].cleanup(env[:server])
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.provisioners.each do |provisioner|
+            %w( cleanup uninstall ).each do |action|
+              send action.to_sym, server, provisioner
+            end
+          end
+
           @app.call(env)
         end
         
+        def cleanup(server, provisioner)
+          provisioner.cleanup(server)
+        end
+
+        def uninstall(server, provisioner)
+          provisioner.uninstall(server) if @env[:ghost_mode]
+        end
+
       end
     end
   end

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

@@ -4,11 +4,29 @@ module Caterer
       class Prepare < Base
 
         def call(env)
-          env[:provisioner].prepare(env[:server])
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.provisioners.each do |provisioner|
+            %w( install prepare ).each do |action|
+              send action.to_sym, server, provisioner
+            end
+          end
+
           @app.call(env)
         end
+        
+        def install(server, provisioner)
+          provisioner.install server if not provisioner.installed? server
+        end
+
+        def prepare(server, provisioner)
+          provisioner.prepare server
+        end
 
-      end     
+      end
     end
   end
 end

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

@@ -4,7 +4,15 @@ module Caterer
       class Uninstall < Base
 
         def call(env)
-          env[:provisioner].uninstall(env[:server])
+
+          config = env[:config]
+          server = env[:server]
+          image  = config.images[env[:image]]
+
+          image.provisioners.each do |provisioner|
+            provisioner.uninstall(server)
+          end
+
           @app.call(env)
         end