boucher 0.1.1 → 0.1.2

data/README.md

@@ -1,31 +1,57 @@
 <img src="" alt="boucher logo" title="Boucher" align="right"/>
 # Boucher
 
-...
+Boucher, pronounced [boo-shay], and meaning Butcher in French, is a suite of Rake tasks that simplfy your AWS
+deployment strategy.  It's built ontop of Chef and Fog giving your fingers the power to create new servers,
+install required software, and deploy your system all in a single command.
+
+It also helps manage your system with support for different environments and tasks to:
+
+ * list all your servers
+ * start/stop/terminate servers
+ * run chef on a given server
+ * easily ssh into a server
+ * attach volumes or elastic IPs to your servers
 
 ## Getting Started
 
+Getting up and running with Boucher might take a little while depending your your familiarity with AWS and Linux.
+Once you're up and running though, it'll save you countless hours in the long run.
+
+### Creating your infrastructure project.
+
+Boucher assumes a certain directory structure.  Bummer I know, but c'est la vie.  To help you out, we've provided a git repo
+that'll get you off the ground.  We recomend
+
+    git clone git://github.com/8thlight/boucher_template.git infrastructure
+    rm -rf infrastructure/.git
+
+You'll probabaly want to create a repository for your own to track the work here.
+
+Read config/env/shared.rb to get a feel for the configuration options.  You'll fill in some of those values as your continue to get started below.
 
 ### Creating a base image
 
-1. Launch new instance: Ubuntu Server 12.04.1 LTS
-    * Create a new key saved in your infrastructure project
-    * Be sure to add a security group that opens port 22 for SSH
+1) Launch new instance: Ubuntu Server 12.04.1 LTS
+
+ * Create a new key saved in your infrastructure project
+ * Be sure to add a security group that opens port 22 for SSH
+
+2) Update config/env/shared.rb
 
-2. Update config/env/shared.rb
-    * :aws_key_filename - name of the .pem file you just created and saved in the project root
-    * :aws_region - which AWS region did you use?
-    * :aws_access_key_id and aws_secret_access_key - available in the AWS Management Console under Security Credentials
+ * :aws_key_filename - name of the .pem file you just created and saved in the project root
+ * :aws_region - which AWS region did you use?
+ * :aws_access_key_id and aws_secret_access_key - available in the AWS Management Console under Security Credentials
 
-3. List servers
+3) List servers
 
     rake servers:list
 
-4. SSH into new server.  (:username config must be 'ubunutu' at this point)
+4) SSH into new server.  (:username config must be 'ubunutu' at this point)
 
     rake servers:ssh[<instance id>]
 
-5. Create new poweruser (unless you like 'unubutu' as your poweruser).
+5) Create new poweruser (unless you like 'unubutu' as your poweruser).
 
     sudo adduser <username>
     sudo adduser <username> sudo
@@ -33,28 +59,28 @@
     sudo cp .ssh/authorized_keys /home/<username>/.ssh/
     sudo chown -R <username>:<username> /home/<username>/.ssh
 
-6. Logout.  Update config :username. Log back in.
+6) Logout.  Update config :username. Log back in.
 
     rake servers:ssh[<instance id>]
 
-7. Delete the ubuntu user.
+7) Delete the ubuntu user.
 
     deluser ubuntu
 
-8. Enable sudo without typing password
+8) Enable sudo without typing password
 
     sudo visudo
     # add the following line at the end of the file:
     <username> ALL=(ALL) NOPASSWD: ALL
 
-9. Install required pacakges and gems.
+9) Install required pacakges and gems.
 
     sudo apt-get update
     sudo apt-get install ruby1.9.1 ruby1.9.1-dev git gcc make libxml2-dev libxslt1-dev
     sudo apt-get upgrade
     sudo gem install bundler chef
 
-10. Checkout your infrstructure repo.  (Yes.  You should push your repo even in this early stage.)
+10) Checkout your infrstructure repo.  (Yes.  You should push your repo even in this early stage.)
 If you use github, you'll have to generate ssh keys and add them to the github repo.
 
     cd ~/.ssh
@@ -63,10 +89,12 @@ If you use github, you'll have to generate ssh keys and add them to the github r
     cd ..
     git clone git@github.com:<github account name>/<your infratructure project name>.git infrastructure
 
-11. Customize to your liking.
+11) Customize to your liking.
 
-  * install your preferred vim dot files
-  * etc...
+ * install your preferred vim dot files
+ * etc...
+
+12) Create an AMI using the AWS Management console.  Grab the AMI id and put it in config/env/shared.rb as the :default_image_id config value.
 
 ## Usage
 
@@ -74,6 +102,54 @@ Run rake to see the list of tasks provided.
 
     rake -T
 
+### Meals
+
+We're sticking with the metephore here.  A Meal is basically a set of recipes for a single server.
+Boucher will expect meals to exist in the config directory.  They are JSON files usable by chef-solo, and Boucher
+allows you too add extra configuration information under the "Boucher": key.  For example:
+
+    {
+      "run_list": [
+        "recipe[boucher::base]"
+        ],
+
+      "boucher": {
+        "base_image_id": "ami-abcd1234", // overides :default_image_id config
+        "flavor_id": "t1.micro", // overides :default_flavor_id config
+        "groups": ["SSH"], // overides :default_groups config
+        "key_name": ["some_key"], // overides :aws_key_filename config
+        "elastic_ips": ["1.2.3.4"], // a list of elastic IPs that'll be attached to the server.  Elastic IP's acquired via AWS management console.
+        "volumes": ["some_volume"] // a list of volume names that'll be attached to the server.  Volumes acquired via AWS management console.
+      }
+    }
+
+ERB: The "boucher": content can contain ERB.  So you can use config params like so:
+
+         {
+           "run_list": ...
+
+           "boucher": {
+             "flavor_id": "<%= Boucher::Config[:customer_flavor_id] %>"
+           }
+         }
+
+### Environments
+
+Enviroments are configured in config/env/<env_name>.rb. The project template we checked out earlier only provides one: dev.
+You're welcome to create as many environments as you like.  At the top of each environment config file, require the shared
+config and then you can overide or add any configuration below.
+
+
+Environment configuration is available in your chef recipes.  Just require 'boucher/env' in any recipe and extract values like so:
+
+    Boucher::Config[:my_config_value]
+
+### Recipes
+
+We'll assume you're familiar with Chef.  So you know, there are plany of open source cookbooks/recipes on the intertubes.
+Convention is to grab the files, put them in your cookbooks folder and take ownership of them.  There's a good chance you'll
+want to change them.
+
 ## License
 
 Copyright (c) 2012 8th Light, Inc.

data/boucher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "boucher"
-  s.version     = "0.1.1"
+  s.version     = "0.1.2"
   s.authors     = ["'Micah Micah'"]
   s.email       = ["'micah@8thlight.com'"]
   s.homepage    = "http://github.com/8thlight/boucher"
@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-  s.autorequire = 'boucher/tasks'
 
   s.add_dependency('rake', '>= 0.9.2.2')
   s.add_dependency('fog', '>= 1.6.0')

data/lib/boucher/meals.rb

@@ -1,10 +1,13 @@
 require 'boucher/env'
 require 'boucher/util'
+require 'erb'
 require 'json'
 
 module Boucher
 
   def self.json_to_meal(json)
+    template = ERB.new(json)
+    json = template.result(binding)
     parser = JSON.parser.new(json, :symbolize_names => true)
     config = parser.parse
     config[:boucher] || {}
@@ -29,9 +32,9 @@ module Boucher
   end
 
   def self.setup_meal(server, meal)
-    server.image_id = meal[:base_image_id] || Boucher::Config[:base_image_id]
-    server.flavor_id = meal[:flavor_id] || Boucher::Config[:default_instance_flavor_id]
-    server.groups = meal[:groups] || Boucher::Config[:default_instance_groups]
+    server.image_id = meal[:image_id] || Boucher::Config[:default_image_id]
+    server.flavor_id = meal[:flavor_id] || Boucher::Config[:default_flavor_id]
+    server.groups = meal[:groups] || Boucher::Config[:default_groups]
     server.key_name = meal[:key_name] || Boucher::Config[:aws_key_filename]
     server.tags = {}
     server.tags["Name"] = "#{meal[:meal_name] || "base"} #{Time.new.strftime("%Y%m%d%H%M%S")}"

data/spec/boucher/meals_spec.rb

@@ -17,14 +17,20 @@ describe "Boucher Server Meals" do
     Boucher.json_to_meal(json).should == {}
   end
 
+  it "meal config can have ERB content" do
+    Boucher::Config[:foo] = "FOOEY!"
+    json = "{\"boucher\": {\"foo\": \"<%= Boucher::Config[:foo] %>\"}}"
+    Boucher.json_to_meal(json).should == {:foo => "FOOEY!"}
+  end
+
   it "can classify base server" do
     some_class = {:meal_name => "base",
                   :meals => ["base"]}
-    Boucher::Config[:default_instance_flavor_id] = 'm1.small'
-    Boucher::Config[:default_instance_groups] = ["SSH"]
+    Boucher::Config[:default_flavor_id] = 'm1.small'
+    Boucher::Config[:default_groups] = ["SSH"]
     Boucher.setup_meal(@server, some_class)
 
-    @server.image_id.should == Boucher::Config[:base_image_id]
+    @server.image_id.should == Boucher::Config[:default_image_id]
     @server.flavor_id.should == 'm1.small'
     @server.groups.should == ["SSH"]
     @server.key_name.should == "test_key"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: boucher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
 - ! '''Micah Micah'''
-autorequire: boucher/tasks
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2012-09-26 00:00:00.000000000 Z
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3836006143599038364
+      hash: 3778709773392559324
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: