buckknife 0.0.4

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.DS_Store*
+coverage*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in buckknife.gemspec
+gemspec

data/HISTORY.md

@@ -0,0 +1,8 @@
+## 0.0.4 (2011-07-22)
+
+* Add `knife project new PROJECT` command.
+* Add `knife project add role PROJECT [NODE]` command.
+
+## 0.0.3 (2011-07-22)
+
+* Initial open sourcing of AKQA's internal chef tool.

data/README.md

@@ -0,0 +1,65 @@
+# BuckKnife
+
+<img alt="Not a Knife" src="http://img.metro.co.uk/i/pix/2010/08/26/article-1282853100512-00A2E06C00000259-351343_636x300.jpg" />
+
+BuckKnife adds a `knife project` subcommand to Chef's `knife`.
+
+## Caveats
+
+BuckKnife is undergoing active development. A 1.0 version will be released
+when we think the project is in a stable state. Until then, this is alpha
+quality.
+
+## Configuration
+
+Add these configurations to your `.chef/knife.rb`:
+
+``` ruby
+knife[:project_dir] = "path/to/chef-rep/data_bags/projects"
+```
+
+Here is a complete `~/.chef/knife.rb` example:
+
+``` ruby
+chef_repo_dir = "~/Chef"
+
+log_level                :info
+log_location             STDOUT
+interval                 300
+client_key               "~/.chef/clientkey.pem"
+validation_client_name   "chef-validator"
+validation_key           "#{chef_repo_dir}/.chef/validation.pem"
+chef_server_url          "http://chefserver.example.com"
+cache_type               "BasicFile"
+cache_options( :path => "#{chef_repo_dir}/.chef/checksums" )
+cookbook_path            "#{chef_repo_dir}/cookbooks"
+knife[:project_dir] = "#{chef_repo_dir}/data_bags/projects"
+```
+
+## Getting Started
+
+This is the current process to create chef server clusters based on a project
+.json file. There are many improvements that need to be made to make this more
+automated.
+
+1. Edit your ~/.chef/knife.rb to include your project dir
+2. Create a project data bag:
+
+    knife project new myapp
+
+3. Generate create commands
+
+    knife project create myapp
+
+4. Generate add role commands
+
+    knife project add role myapp
+
+5. Generate run client commands
+
+    knife project run client myapp
+
+## TODO
+
+* Move database passwords out of project.json
+* Move ssh user/pass out of capistrano template

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'buckknife/version'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color --format nested]
+  t.verbose = false
+end
+
+if RUBY_VERSION.to_f == 1.8
+  namespace :rcov do
+    task :cleanup do
+      rm_rf 'coverage.data'
+    end
+
+    RSpec::Core::RakeTask.new :spec do |t|
+      t.rcov = true
+      t.rcov_opts = %[-Ilib -Ispec --exclude "gems/*,features"]
+      t.rcov_opts << %[--no-html --aggregate coverage.data]
+    end
+  end
+
+  task :rcov => ["rcov:cleanup", "rcov:spec"]
+end
+
+task :default => :spec

data/buckknife.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "buckknife/version"
+
+Gem::Specification.new do |s|
+  s.name        = "buckknife"
+  s.version     = BuckKnife::VERSION
+  s.authors     = ["Ben Marini", "Kirt Fitzpatrick"]
+  s.email       = ["ben.marini@akqa.com", "kirt.fitzpatrick@akqa.com"]
+  s.homepage    = ""
+  s.summary     = %q{You call that a knife? THIS is a knife}
+  s.description = %q{Extras for Chef's knife command}
+
+  s.rubyforge_project = "buckknife"
+
+  s.add_dependency "chef", "~> 0.10.2"
+  s.add_dependency "highline"
+  s.add_dependency "json"
+  s.add_dependency "escape"
+  s.add_dependency "activemodel", "~> 3.0.9"
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "rcov", "~> 0.9.9"
+  s.add_development_dependency "knife-rackspace"
+  # s.add_development_dependency "knife-eucalyptus"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/buckknife.rb

@@ -0,0 +1,44 @@
+require 'buckknife/version'
+require 'highline'
+require 'json'
+require 'erb'
+require 'chef'
+
+module BuckKnife
+  autoload :DataAccessor, 'buckknife/data_accessor'
+  autoload :Environment,  'buckknife/environment'
+  autoload :Helper,       'buckknife/helper'
+  autoload :Node,         'buckknife/node'
+  autoload :Project,      'buckknife/project'
+
+  autoload :KnifeHelper,       'buckknife/knife_helper'
+  autoload :ProjectBootstrap,  'chef/knife/project_bootstrap'
+  autoload :ProjectNew,        'chef/knife/project_new'
+  autoload :ProjectCapistrano, 'chef/knife/project_capistrano'
+  autoload :ProjectCreate,     'chef/knife/project_create'
+  autoload :ProjectInfo,       'chef/knife/project_info'
+  autoload :ProjectList,       'chef/knife/project_list'
+  autoload :ProjectRunClient,  'chef/knife/project_run_client'
+
+  autoload :Command,           'buckknife/command'
+
+  module Commands
+    autoload :AddRole,         'buckknife/commands/add_role'
+    autoload :Base,            'buckknife/commands/base'
+    autoload :Bootstrap,       'buckknife/commands/bootstrap'
+    autoload :Capistrano,      'buckknife/commands/capistrano'
+    autoload :Create,          'buckknife/commands/create'
+    autoload :RackspaceCreate, 'buckknife/commands/rackspace_create'
+    autoload :EucaCreate,      'buckknife/commands/euca_create'
+    autoload :RunClient,       'buckknife/commands/run_client'
+  end
+
+  class BuckKnifeError < StandardError; end
+  class UnknownProjectRootError < BuckKnifeError; end
+  class UnknownProjectError < BuckKnifeError; end
+  class UnknownDataFieldError < BuckKnifeError; end
+
+  def self.template_root
+    Pathname.new( File.expand_path("../buckknife/templates", __FILE__) )
+  end
+end

data/lib/buckknife/command.rb

@@ -0,0 +1,33 @@
+require 'escape'
+
+module BuckKnife
+  class Command
+    def initialize(cmd="")
+      @cmd = cmd
+      @args, @opts = [], []
+    end
+
+    def arg(*args)
+      @args += args
+      self
+    end
+
+    def opt(*opts)
+      @opts += opts
+      self
+    end
+
+    def to_s
+      [ @cmd ].concat(@args).concat(@opts).map(&:to_s).map { |w| escape(w) }.join(' ')
+    end
+
+    def exec
+      `#{self.to_s}`
+    end
+
+    # http://stackoverflow.com/questions/1306680/shellwords-shellescape-implementation-for-ruby-1-8
+    def escape(str)
+      Escape.shell_single_word(str).to_s
+    end
+  end
+end

data/lib/buckknife/commands/add_role.rb

@@ -0,0 +1,13 @@
+module BuckKnife
+  module Commands
+    class AddRole < Struct.new(:node)
+      include Base
+
+      def command
+        node.run_list_items.map do |item|
+          Command.new('knife').arg('node', 'run_list', 'add', node.name, item)
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/buckknife/commands/base.rb

@@ -0,0 +1,24 @@
+module BuckKnife
+  module Commands
+    module Base
+
+      def command
+        Command.new 'knife'
+      end
+
+      def to_s
+        command.to_s
+      end
+
+      def base_run_list
+        project.base_run_list
+      end
+
+      def build_run_list(roles_and_recipes)
+        roles_and_recipes.map do |type, name|
+          "%s[%s]" % [type, name]
+        end.join(',')
+      end
+    end
+  end
+end

data/lib/buckknife/commands/bootstrap.rb

@@ -0,0 +1,28 @@
+module BuckKnife
+  module Commands
+    # Takes a Project and Node instance
+    # Returns the knife command to bootstrap this server
+    #
+    # NOTE: This does not add the roles and recipes of the node. This is
+    # because currently there are some dependency issues across nodes with
+    # some recipes. The current strategy is to add roles manually one by one
+    # running the chef client as needed.
+    class Bootstrap < Struct.new(:project, :node)
+      include Base
+
+      def command
+        super.tap do |c|
+          c.arg 'bootstrap'
+          c.arg node.address
+          c.opt '-N', node.name
+          c.opt '-x', node.ssh_username
+          c.opt '-P', node.ssh_password
+          c.opt '-r', base_run_list
+          c.opt '-d', project.distro
+          c.opt '--sudo'
+        end
+      end
+
+    end
+  end
+end

data/lib/buckknife/commands/capistrano.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+
+module BuckKnife
+  module Commands
+    class Capistrano < Struct.new(:project)
+      include Base
+
+      def call
+        environments = []
+        project.environments.each do |env|
+
+          app_nodes = env.nodes.select { |n| n.group == "app" }.each { |n| n.address = fetch_ip(n.name) }
+          job_nodes = env.nodes.select { |n| n.group == "job" }.each { |n| n.address = fetch_ip(n.name) }
+
+          unless app_nodes.empty? && job_nodes.empty?
+            environment               = {:app_servers => app_nodes, :job_servers => job_nodes}
+            environment[:primary_db]  = ( job_nodes.empty? ? app_nodes.first : job_nodes.first )
+            environment[:name]        = env.name
+            environment[:domain_name] = env.domain_name
+            environments << environment
+          end
+        end
+
+        deploy_environments_template = BuckKnife.template_root.join("deploy_environments.rb.erb").read
+        return ERB.new(deploy_environments_template, nil, '%>').result(binding)
+      end
+
+      private
+        def fetch_ip(node_name)
+          cmd = Command.new "bundle"
+          cmd.arg "exec", "knife", "node", "show"
+          cmd.arg node_name
+          cmd.opt "--attribute", "ipaddress"
+          cmd.opt "-Fj"
+
+          JSON.parse( cmd.exec )['ipaddress'] rescue nil
+        end
+
+        def ssh(node_name)
+          ipaddress_cmd = fetch_ip(node_name)
+          ipaddress     = JSON.parse `#{ipaddress_cmd}`
+          exec "ssh #{ipaddress['ipaddress']}"
+        end
+    end
+  end
+end

data/lib/buckknife/commands/create.rb

@@ -0,0 +1,42 @@
+module BuckKnife
+  module Commands
+    class Create < Struct.new(:project, :node)
+      include Base
+
+      def self.[](provider)
+        case provider
+        when "rackspace" then RackspaceCreate
+        when "euca"      then EucaCreate
+        else
+          raise ArgumentError, "Buckknife doesn't know how to create for this provider"
+        end
+      end
+
+      def command
+        Command.new('knife').tap do |c|
+          c.arg project.provider, 'server', 'create'
+          c.opt '-r', base_run_list
+          c.opt '-f', flavor
+          c.opt '-I', image_id
+          c.opt '-d', project.distro
+          c.opt '-s', chef_server_url
+          c.opt '-N', node.name
+          c.opt '-i', project.identity_file if project.identity_file
+          c.opt '-x', project.ssh_username if project.ssh_username
+        end
+      end
+
+      def image_id
+        node.image_id
+      end
+
+      def flavor
+        node.flavor
+      end
+
+      def chef_server_url
+        Chef::Config[:chef_server_url]
+      end
+    end
+  end
+end

data/lib/buckknife/commands/euca_create.rb

@@ -0,0 +1,60 @@
+module BuckKnife
+  module Commands
+    class EucaCreate < Create
+      include Base
+
+      # -Z, --availability-zone ZONE     The Availability Zone
+      #     --bootstrap-version VERSION  The version of Chef to install
+      # -N, --node-name NAME             The Chef node name for your new node
+      # -s, --server-url URL             Chef Server URL
+      # -k, --key KEY                    API Client Key
+      #     --color                      Use colored output
+      # -c, --config CONFIG              The configuration file to use
+      #     --defaults                   Accept default values for all questions
+      # -d, --distro DISTRO              Bootstrap a distro using a template
+      # -e, --editor EDITOR              Set the editor to use for interactive commands
+      # -E, --environment ENVIRONMENT    Set the Chef environment
+      # -f, --flavor FLAVOR              The flavor of server (m1.small, m1.medium, etc)
+      # -F, --format FORMAT              Which format to use for output
+      # -i IDENTITY_FILE                 The SSH identity file used for authentication
+      #     --identity-file
+      # -I, --image IMAGE                The AMI for the server
+      #     --no-color                   Don't use colors in the output
+      # -n, --no-editor                  Do not open EDITOR, just accept the data as is
+      #     --no-host-key-verify         Disable host key verification
+      # -u, --user USER                  API Client Username
+      #     --prerelease                 Install the pre-release chef gems
+      #     --print-after                Show the data after a destructive operation
+      # -r, --run-list RUN_LIST          Comma separated list of roles/recipes to apply
+      # -G, --groups X,Y,Z               The security groups for this server
+      # -S, --ssh-key KEY                The Eucalyptus SSH key id
+      # -P, --ssh-password PASSWORD      The ssh password
+      # -x, --ssh-user USERNAME          The ssh username
+      #     --template-file TEMPLATE     Full path to location of template to use
+      # -V, --verbose                    More verbose output. Use twice for max verbosity
+      # -v, --version                    Show chef version
+      # -y, --yes                        Say yes to all prompts for confirmation
+      # -h, --help                       Show this message
+
+      def command
+        super.tap do |c|
+          c.opt '-Z', availability_zone if availability_zone
+        end
+      end
+
+      protected
+
+      def image_id
+        super || "emi-DFB9107F"
+      end
+
+      def flavor
+        super || "m1.large"
+      end
+
+      def availability_zone
+        Chef::Config[:region]
+      end
+    end
+  end
+end