blender-chef 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0678c7aeb1d0d4a93bc0a1cf94807248d3860b7a
-  data.tar.gz: 6a3369819b869119d59021f45d65af65ff380858
+  metadata.gz: 227b93ae896e5908d4a492d8bb0962652810ebcb
+  data.tar.gz: dd20886e6a0cd3691853ea131763cd482b9dfc89
 SHA512:
-  metadata.gz: a931c089da34be8cc2811ee8f1a7b0c266307967f0ab8932c31476bebe1e1e9e4480247c3d7faefe17644d152495695fb870d3d983f379be3ce0a24ebc16ab92
-  data.tar.gz: ac3bb2c4e26e32671b44120bd60b0c98923149631c9673f06482d3a42dac2560a23ae46625dd84cbcfbcad466887a3bf12632519f0d94a26749b7609071f8a16
+  metadata.gz: 4f6879284bbb5c572d8f3c4f9f203216e195866a236334381b33f6201893a023be4146cf2f81577e723e3b60d8e67c5614f9557ae790b1c6717b59b5fba5b90d
+  data.tar.gz: 47bf4c4b37718ecd3611f6b9da590eac1682a862979fe016efbc8029cc9aae2187f98d0f8ef81270e7ff2426b9c95ac889984512c36e4686285799882237a4f9

data/.travis.yml

@@ -2,7 +2,7 @@ before_install:
   - bundle install --path .bundle
 rvm:
   - 2.1.0
-  - 2.1.2
+  - 2.2.0
 branches:
   only:
     - master

data/README.md

@@ -14,7 +14,7 @@ fetched from Chef server. Following is an example of dynamically obtaining
 all servers with `db` role, and enlisting their `iptables` rule.
 
 ```ruby
-require 'belnder/chef'
+require 'blender/chef'
 config(:chef, chef_sever_url: 'https://foo.bar.com', node_name: 'admin', client_key: 'admin.pem')
 members(search(:chef, 'roles:db'))
 ssh_task 'sudo iptables -L'
@@ -40,6 +40,67 @@ config(:chef, node_name: 'admin', client_key: 'admin.pem')
 members(search(:chef, 'roles:db', attribute: 'ec2_public_ipv4'))
 ```
 
+### Knife integration
+
+Blender-chef comes with a knife plugin that allows job or chef recipe or node bootstrapping
+from command line interface.
+
+- Blender-mode, for running raw blender jobs
+  Given the following job present in file `jobs/upgrade_chef.rb`
+
+  ```ruby
+  ssh_task 'sudo apt-get remove chef --purge'
+  ssh_task 'sudo apt-get remove chef --purge'
+  ssh_task 'wget -c https://opscode-omnibus-packages.s3.amazonaws.com/ubuntu/13.04/x86_64/chef_12.0.3-1_amd64.deb'
+  ssh_task 'sudo dpkg -i chef_12.0.3-1_amd64.deb'
+  ssh_task 'sudo chef-client'
+  ```
+
+  It can be executed against all chef nodes having `db` role as:
+
+  ```sh
+  knife blend --search 'roles:db' jobs/upgrade_chef.rb
+  ```
+  this is equivalent to
+  ```sh
+  knife blend --mode blender --search 'roles:db' jobs/upgrade_chef.rb
+  ```
+  as blender mode is the default mode.
+
+- Recipe mode, for running one-off chef recipes against remote nodes using blender
+  Given the following chef recipe present ina local file `recipes/nginx.rb`
+
+  ```ruby
+  package 'nginx'
+  service 'nginx' do
+    action [:start, :enable]
+  end
+  ```
+
+  It can be executed against all chef nodes having `web` role as:
+
+  ```sh
+  knife blend --mode recipe --search 'roles:web' recipes/nginx.rb
+  ```
+  In recipe mode blender will treat the input file(s) as chef recipe
+  and build necessary scp and ssh tasks to upload the recipe, execute it
+  and remove the uploaded recipe.
+
+- Berkshelf mode, for bootstrapping server with chef solo. In this mode blender-chef
+  will assume the specifid file is a Berksfile, and use it to vendor cookbooks, then
+  upload it to the remote server using scp, and finally run chef in localmode against
+  the vendored cookbook directory. In berkshelf mode run list is specified via `--run-list`
+  option.
+
+  ```sh
+  knife blend Berksfile --mode berkshelf -h foo.bar.com -i id_rsa --run-list recipe[nginx]
+  ```
+
+  Note: You have to install berkshelf explicitly (vie bundler or using raw gem commands).
+
+
+  Additional options are provided to control strategy, ssh credentials etc.
+
 
 ## Supported ruby versions
 
@@ -47,7 +108,6 @@ Blender-chef uses Chef 12 (for partial search). For chef 11, use 0.0.1 version o
 
 Blender-chef currently support the following MRI versions:
 
-* *Ruby 1.9.3*
 * *Ruby 2.1.0*
 * *Ruby 2.1.2*
 

data/blender-chef.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'blender-chef'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Ranjib Dey']
   spec.email         = ['ranjib@pagerduty.com']
   spec.summary       = %q{Chef search based host discovery for blender}
@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'pd-blender'
-  spec.add_dependency 'chef', '>= 12.0.0'
+  spec.add_dependency 'pd-blender', '>= 0.1.0'
+  spec.add_dependency 'chef', '>= 12.1.1'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/blender/discoveries/chef.rb

@@ -44,7 +44,7 @@ module Blender
         ::Chef::Config[:chef_server_url] = options[:chef_server_url] if options[:chef_server_url]
         q = ::Chef::Search::Query.new
         res = q.search(:node, search_term, filter_result: {attribute: attr.split('.')})
-        res.first.collect{|node_data| node_data['data']['attribute']}
+        res.first.collect{|node_data| node_data['attribute']}
       end
     end
   end

data/lib/chef/knife/blender.rb

@@ -53,6 +53,12 @@ class Chef
         long: '--noop',
         description: 'no-op aka dry-run mode, run blender without executing jobs'
 
+      option :prompt,
+        default: false,
+        boolean: true,
+        long: '--prompt',
+        description: 'Prompt for password'
+
       option :quiet,
         default: false,
         boolean: true,
@@ -93,17 +99,16 @@ class Chef
         long: '--identity-file IDENTITY_FILE',
         description: 'Identity file for SSH authentication'
 
-      option :recipe_mode,
-        long: '--recipe-mode',
-        description: 'Treat input files as chef recipe and compose blender tasks to execute them (scp + ssh)',
-        boolean: true,
-        default: false
-
-      option :recipe_mode,
-        long: '--recipe-mode',
-        description: 'Treat input files as chef recipe and compose blender tasks to execute them (scp + ssh)',
-        boolean: true,
-        default: false
+      desc = "Run mode. Can be 'blender', 'recipe' or 'berkshelf'\n"
+      desc << "In 'blender' mode input file is treated as a Blender job\n"
+      desc << "In 'recipe' mode input file is treated as an individual recipe and executed using chef-apply\n"
+      desc << "In 'berkshelf' mode input file is treated as a Berksfile. Blender vendors cookbook using berksshelf, scp it and run chef against it in localmode\n"
+      option :mode,
+        long: '--mode MODE',
+        short: '-m MODE',
+        description: desc,
+        default: :blender,
+        proc: lambda{|s| s.to_sym}
 
       option :chef_apply,
         long: '--chef-apply',
@@ -111,54 +116,123 @@ class Chef
         description: 'chef-apply command to be used (effective only in recipe mode)',
         default: 'chef-apply'
 
+      option :run_list,
+        long: '--run-list RUN_LIST',
+        short: '-r RUN_LIST',
+        description: 'chef-apply command to be used (effective only in berkshelf mode)'
+
+      option :hosts,
+        long: '--hosts HOST1,HOST2,HOST3',
+        short: '-h HOST1,HOST2,HOST3',
+        description: 'Pass hosts manually (search and attribute option will be ignored)'
+
       def run
-        ssh_options = {
-          user: config[:user],
-          stdout: $stdout
-        }
-        ssh_options[:stdout] = $stdout if config[:stream]
-        if config[:password]
-          ssh_options[:password] = config[:password]
-        elsif config[:prompt]
-          ssh_options[:password] = ui.ask('SSH password: ') {|q|q.echo = false}
-        end
-        if config[:identity_file]
-          ssh_options[:keys] = Array(config[:identity_file])
-        end
         scheduler_options = {
           config_file: config[:blender_config],
           no_doc: config[:quiet]
         }
+
         discovery_options = {
           attribute: config[:attribute]
         }
+
         Blender::Configuration[:noop] = config[:noop]
-        members = Blender::Discovery::Chef.new(discovery_options).search(config[:search])
-
-        @name_args.each do |file|
-          if config[:recipe_mode]
-            remote_path = File.join('/tmp', SecureRandom.hex(10))
-            Blender.blend(options[:file], scheduler_options) do |scheduler|
-              scheduler.strategy(config[:strategy])
-              scheduler.config(:ssh, ssh_options)
-              scheduler.config(:scp, ssh_options)
-              scheduler.members(members)
-              scheduler.scp_upload(remote_path) do
-                from file
+
+        if config[:hosts]
+          members = config[:hosts].split(',')
+        else
+          members = Blender::Discovery::Chef.new(discovery_options).search(config[:search])
+        end
+        ssh_config = ssh_options
+        Blender.blend('blender-chef', scheduler_options) do |scheduler|
+          scheduler.strategy(config[:strategy])
+          scheduler.config(:ssh, ssh_config)
+          scheduler.config(:scp, ssh_config)
+          scheduler.members(members)
+          @name_args.each do |file|
+            case config[:mode]
+            when :berkshelf
+              begin
+                require 'berkshelf'
+              rescue LoadError
+                raise RuntimeError, 'You must install berkshelf before using blender-chef in berkshelf mode'
               end
-              scheduler.ssh_task "#{config[:chef_apply]} #{remote_path}"
-              scheduler.ssh_task "rm #{remote_path}"
+              tempdir = Dir.mktmpdir
+              berkshelf_mode(scheduler, tempdir, file)
+              FileUtils.rm_rf(tempdir)
+            when :recipe
+              recipe_mode(scheduler, file)
+            when :blender
+              blender_mode(scheduler, file)
+            else
+              raise ArgumentError, "Unknown mode: '#{config[:mode]}'"
             end
-          else
-            job = File.read(file)
-            Blender.blend(options[:file], scheduler_options) do |scheduler|
-              scheduler.strategy(config[:strategy])
-              scheduler.config(:ssh, ssh_options)
-              scheduler.members(members)
-              scheduler.instance_eval(job, __FILE__, __LINE__)
+          end
+        end
+      end
+
+      def ssh_options
+        opts = {
+          user: config[:user]
+        }
+        if config[:identity_file]
+          opts[:keys] = Array(config[:identity_file])
+        end
+        if config[:stream] or (!config[:quiet])
+          opts[:stdout] = $stdout
+        end
+        if config[:password]
+          opts[:password] = config[:password]
+        elsif config[:prompt]
+          opts[:password] = ui.ask('SSH password: ') {|q|q.echo = false}
+        end
+        opts
+      end
+
+      def berkshelf_mode(scheduler, tempdir, file)
+        run_list = config[:run_list]
+        scheduler.ruby_task 'generate cookbook tarball' do
+          execute do
+            berksfile = Berkshelf::Berksfile.from_file('Berksfile')
+            berksfile.vendor(tempdir)
+            File.open('/tmp/solo.rb', 'w') do |f|
+              f.write("cookbook_path '/tmp/cookbooks'\n")
+              f.write("file_cache_path '/var/cache/chef/cookbooks'\n")
             end
           end
         end
+        scheduler.ssh_task 'nuke old cookbook directory if exist' do
+          execute 'rm -rf /tmp/cookbooks'
+        end
+        scheduler.scp_upload 'upload cookbooks' do
+          from tempdir
+          to '/tmp/cookbooks'
+          recursive true
+        end
+        scheduler.scp_upload '/tmp/solo.rb' do
+          from '/tmp/solo.rb'
+        end
+        scheduler.ssh_task 'create cache directory' do
+          execute 'sudo mkdir -p /var/cache/chef/cookbooks'
+        end
+        scheduler.ssh_task 'run chef solo' do
+          execute "sudo chef-client -z -o #{run_list} -c /tmp/solo.rb --force-logger"
+        end
+      end
+
+      def recipe_mode(scheduler, file)
+        remote_path = File.join('/tmp', SecureRandom.hex(10))
+        scheduler.scp_upload('upload recipe') do
+          to remote_path
+          from file
+        end
+        scheduler.ssh_task "#{config[:chef_apply]} #{remote_path}"
+        scheduler.ssh_task "rm #{remote_path}"
+      end
+
+      def blender_mode(scheduler, file)
+        job = File.read(file)
+        scheduler.instance_eval(job, __FILE__, __LINE__)
       end
     end
   end

data/spec/blender/knife_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 require 'chef/knife/blender'
+require 'blender/rspec'
 
 describe Chef::Knife::Blend do
   before(:each) do
@@ -10,20 +11,24 @@ describe Chef::Knife::Blend do
     @knife.config[:passsword] = 'test-password'
     @knife.config[:search] = 'roles:db'
     @knife.config[:strategy] = :default
-    @knife.name_args = ["job.rb"]
   end
   it '#non recipe mode' do
-    disco = double(Blender::Discovery::Chef)
-    expect(Blender::Discovery::Chef).to receive(:new).and_return(disco)
-    expect(disco).to receive(:search).and_return(['host1', 'host2'])
+    @knife.name_args = ["job.rb"]
+    stub_search(:chef, 'roles:db').and_return(%w(host1 host2))
     expect(File).to receive(:read).with('job.rb').and_return('')
+    @knife.config[:mode] = :blender
     @knife.run
   end
   it '#recipe mode' do
-    @knife.config[:recipe_mode] = true
-    disco = double(Blender::Discovery::Chef)
-    expect(Blender::Discovery::Chef).to receive(:new).and_return(disco)
-    expect(disco).to receive(:search).and_return([])
+    @knife.name_args = ["job.rb"]
+    @knife.config[:mode] = :recipe
+    stub_search(:chef, 'roles:db').and_return([])
+    @knife.run
+  end
+  it '#berkshelf mode' do
+    @knife.name_args = ['/path/to/berksfile']
+    @knife.config[:mode] = :recipe
+    stub_search(:chef, 'roles:db').and_return([])
     @knife.run
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blender-chef
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pd-blender
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement