cuoco 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Leonid Shevtsov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Cuoco provides plumbing necessary to run Chef Solo through Capistrano with zero configuration.
+
+## Key values
+
+* reuse as much server information from Capistrano as possible (including roles);
+* comply to Chef directory structure as much as possible to simplify transition;
+* bootstrap bare machines with minimal footprint.
+
+## Summary
+
+*Capistrano and Chef Solo, sitting in a tree...*
+
+[Capistrano](https://github.com/capistrano/capistrano#capistrano) is a framework that allows you to run commands in parallel on multiple remote machines. It's primary use is application deployment, but Capistrano can automate any task you can do over SSH. A big advantage of Capistrano is that it is wildly popular among web developers, and thus well supported and rich with plugins.
+
+Another common task you have to do on the remote machines is server provisioning/management, and Capistrano has no facilities for that. It's definitely possible to manage machines using Capistrano, but you have to bring your own scripts.
+
+[Chef Solo](http://wiki.opscode.com/display/chef/Chef+Solo) is a tool that uses well-structured, data-driven Ruby scripts to describe and run configuration management routines. It runs locally and manages the machine it's running from. So before running Chef Solo, you have to install it and upload your scripts to that machine. You can do that by hand, you can use one of the many Chef Solo bootstrap scripts, or you can use some tool like littlechef, which needs to be configured to know about your servers.
+
+But wait - not only Capistrano knows where your servers are, it can already run commands on them, and in parallel. It's exactly what Chef Solo is lacking.
+
+Cuoco provides a set of Capistrano tasks to tie in Chef Solo into Capistrano.
+
+## Installation
+
+    gem install cuoco
+
+If you're using bundler you already know the drill.
+
+To make Cuoco tasks available in Capistrano, require this file in your `Capfile` or `config/deploy.rb`:
+
+    require 'cuoco/capistrano'
+
+## Usage
+
+### Fully automatic mode
+
+Cuoco can turn a completely bare machine into a live server with a single command. You buy servers, you declare them in Capistrano, you run `cap deploy:setup && cap deploy`. Done! [*]
+
+To do so, require this file in your `Capfile` or `config/deploy.rb`.
+
+    require 'cuoco/capistrano/automatic'
+
+It hooks up `cuoco:update_configuration` before `deploy:setup`. This built-in task, quote, 
+*"Prepares one or more servers for deployment."*. Which is what Chef does. If you 
+update your server configuration you run `cap deploy:setup` again, it is non-destructive.
+
+My personal opinion is that running Chef on each deploy is wasteful and forces
+sudo rights as a requirement for all deployers. If you really want to do that, you'll
+have to figure out the (extremely tricky) Capistrano directive yourself.
+
+[*] Naturally, you have to write the provisioning scripts first.
+
+### Manual mode
+
+There are separate Cuoco tasks defined for more granular control.
+
+    cuoco:bootstrap # Installs chef, but does not run anything
+    cuoco:run       # Runs chef assuming it's already installed
+
+### Usage without deployment
+
+If application deployment doesn't apply in your scenario, you can just run
+
+    cap cuoco:update_configuration
+
+directly.
+
+## Minimal requirements for remote machines
+
+Here are the minimal requirements for running Cuoco:
+
+* the server is running [one of the operating systems supported by Omnibus](http://wiki.opscode.com/display/chef/Installing+Omnibus+Chef+Client+on+Linux+and+Mac#InstallingOmnibusChefClientonLinuxandMac-TestedOperatingSystems) (most flavors of Linux will do);
+* Capistrano can connect to the server;
+* the Capistrano user has sudo rights on the server. See [my article on setting up user accounts](http://leonid.shevtsov.me/en/how-to-set-up-user-accounts-on-your-web-server) for the suggested approach.
+
+## Configuration
+
+Cuoco works with a traditional Chef directory structure. By default it looks for it in `config/chef`.
+You can change that:
+
+    # set the root Chef directory 
+    set :chef_path, 'chef'
+
+### Roles
+
+**Cuoco assigns Chef roles from Capistrano roles.**
+
+This means that every server that you will run `cuoco:update_configuration` on will
+get its own run list based on the roles it has: if it has `:app` and `:db` roles, Chef's run list for that server will be `role[app], role[db]`.
+
+The chef roles directory *must* contain a role file for every Capistrano role you are using.
+
+### Variables
+
+TODO
+
+### Environments
+
+TODO Environments are not supported by Chef Solo. It would be nice to provide the functionality based on Capistrano stages.
+
+## What's in a name?
+
+"Cuoco" means "cook" in Italian. The original [Capistrano is a city in Italy](https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Capistrano,+Vibo+Valentia,+Italy&aq=0&oq=capistrano,+italy&sll=37.0625,-95.677068&sspn=60.376022,135.263672&vpsrc=0&t=h&ie=UTF8&hq=&hnear=Capistrano,+Province+of+Vibo+Valentia,+Calabria,+Italy&z=16). So a chef working solo in Capistrano would be called *un cuoco*... get it now?
+
+(If you've been expecting to see Kaley Cuoco here, I'll save you a trip to Reddit:)
+
+![Another Cuoco](http://i.imgur.com/u5OIil.jpg)
+
+* * * 
+
+2012 [Leonid Shevtsov](http://leonid.shevtsov.me)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cuoco.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cuoco/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Leonid Shevtsov"]
+  gem.email         = ["leonid@shevtsov.me"]
+  gem.description   = %q{Run Chef Solo from Capistrano}
+  gem.summary       = %q{Use Capistrano for server provisioning and configuration management, not only application deployment.}
+  gem.homepage      = "https://github.com/leonid-shevtsov/Cuoco"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cuoco"
+  gem.require_paths = ["lib"]
+  gem.version       = Cuoco::VERSION
+
+  gem.add_runtime_dependency 'capistrano', '>= 2'
+  
+  gem.add_development_dependency 'rake'
+end

data/lib/cuoco.rb

@@ -0,0 +1,8 @@
+require "cuoco/version"
+require 'cuoco/bootstrapper'
+require 'cuoco/uploader'
+require 'cuoco/runner'
+
+module Cuoco
+  # Your code goes here...
+end

data/lib/cuoco/bootstrapper.rb

@@ -0,0 +1,26 @@
+module Cuoco
+  class Bootstrapper
+    BOOTSTRAP_COMMAND = "\
+      if ! command -v chef-solo &>/dev/null;\
+      then\
+        curl -L http://opscode.com/chef/install.sh | sudo -p \"sudo password: \" bash;\
+        if ! command -v chef-solo &>/dev/null;\
+        then\
+          false;\
+        else\
+          true;\
+        fi;\
+      else\
+        true;\
+      fi\
+    ".gsub(/ +/,' ')
+
+    def initialize(capistrano)
+      @cap = capistrano
+    end
+
+    def bootstrap
+      @cap.run(BOOTSTRAP_COMMAND, :shell => '/bin/bash')
+    end
+  end
+end

data/lib/cuoco/capistrano.rb

@@ -0,0 +1,44 @@
+require 'cuoco'
+
+::Capistrano::Configuration.instance(:must_exist).load do
+  namespace :cuoco do
+    desc "Configures remote servers using Chef Solo"
+    task :update_configuration do
+      bootstrap
+      run_roles
+    end
+
+    desc "Sets up Chef on remote server"
+    task :bootstrap do
+      bootstrapper = Cuoco::Bootstrapper.new(self)
+      bootstrapper.bootstrap
+    end
+
+    desc "Uploads Cuoco and Chef files to remote servers"
+    task :upload_files do
+      uploader = Cuoco::Uploader.new(self)
+      uploader.upload
+    end
+
+    desc "Executes Chef Solo with role-based run lists"
+    task :run_roles do
+      upload_files
+
+      runner = Cuoco::Runner.new(self)
+      runner.run
+    end
+
+    desc "Executes Chef Solo with a custom run list"
+    task :run_list do
+      list = fetch(:chef_run_list, [])
+      if list.empty?
+        abort ":chef_run_list is empty"
+      end
+
+      upload_files
+
+      runner = Cuoco::Runner.new(self)
+      runner.run_list( list )
+    end
+  end
+end

data/lib/cuoco/capistrano/automatic.rb

@@ -0,0 +1,5 @@
+require 'cuoco/capistrano'
+
+::Capistrano::Configuration.instance(:must_exist).load do
+  before 'deploy:setup', 'cuoco:update_configuration'
+end

data/lib/cuoco/config_generator.rb

@@ -0,0 +1,10 @@
+require 'erb'
+
+module Cuoco
+  class ConfigGenerator
+    def self.chef_config(scope)
+      template_path = File.expand_path(File.join(__FILE__, '..', '..', '..', 'templates', 'solo.rb.erb'))
+      ERB.new(File.read(template_path)).result(scope)
+    end
+  end
+end

data/lib/cuoco/runner.rb

@@ -0,0 +1,30 @@
+module Cuoco
+  class Runner
+    # $CAPISTRANO:HOSTROLES$ is a magic Capistrano placeholder that gets replaced 
+    # with a comma-delimited list of roles *for each specific server individually*.
+    # See Capistrano::Command#replace_placeholders
+    # The awk command translates "app,web,db" into "role[app],role[web],role[db]" to pass them to Chef
+    SERVER_ROLES = %Q{`echo '$CAPISTRANO:HOSTROLES$' | awk '{sub(/^/,"role["); sub(/$/,"]"); gsub(/,/,"],role["); print}'`}
+
+    def initialize(capistrano)
+      @cap = capistrano
+    end
+
+    def run
+      run_list(SERVER_ROLES)
+    end
+
+    def run_list(roles_and_recipes)
+      if roles_and_recipes.is_a? Array
+        roles_and_recipes = roles_and_recipes.join(',')
+      end
+
+      @cap.sudo(chef_command(roles_and_recipes), :shell => '/bin/bash')
+    end
+
+  private
+    def chef_command(roles_and_recipes)
+      "chef-solo -j /tmp/cuoco/node.json -o #{roles_and_recipes}"
+    end
+  end
+end

data/lib/cuoco/uploader.rb

@@ -0,0 +1,41 @@
+require 'cuoco/config_generator'
+
+module Cuoco
+  # This class handles uploading Cuoco and Chef scripts onto the remote machines
+  class Uploader
+    def initialize(capistrano)
+      @cap = capistrano
+
+      @chef_path = File.expand_path(@cap.fetch(:chef_path, 'config/chef'))
+
+      @cuoco_remote_path = '/tmp/cuoco'
+    end
+
+    def upload
+      prepare_directory_structure
+      upload_chef_config
+      upload_chef_files
+      upload_node_json
+    end
+
+    def prepare_directory_structure
+      @cap.run("mkdir -p #{@cuoco_remote_path}", :shell => '/bin/bash')
+    end
+
+    def upload_chef_config
+      @config_contents = Cuoco::ConfigGenerator.chef_config(binding)
+      @cap.put(@config_contents, @cuoco_remote_path+'/solo.rb')
+      @cap.sudo("mv #{@cuoco_remote_path}/solo.rb /etc/chef/solo.rb", :shell => '/bin/bash')
+    end
+
+    def upload_chef_files
+      @cap.sudo("rm -rf #{@cuoco_remote_path}/chef", :shell => '/bin/bash')
+      @cap.upload(@chef_path, @cuoco_remote_path+'/chef', :recursive => true)
+      @cap.run("#{@cap.sudo} rm -rf /var/chef && #{@cap.sudo} mv #{@cuoco_remote_path}/chef /var/chef && #{@cap.sudo} chown -R root:root /var/chef", :shell => '/bin/bash')
+    end
+
+    def upload_node_json
+      @cap.put('{}', @cuoco_remote_path+'/node.json')
+    end
+  end
+end

data/lib/cuoco/version.rb

@@ -0,0 +1,3 @@
+module Cuoco
+  VERSION = "0.0.1"
+end

data/templates/solo.rb.erb

@@ -0,0 +1,37 @@
+# Chef-solo config generated by Cuoco at <%=Time.now.to_s%>
+
+<% if @node_name %>
+  node_name <%=@node_name.inspect %>
+<% end %>
+
+# Paths
+
+<% if @cookbook_paths %>
+  cookbook_path <%=@cookbook_paths.inspect %>
+<% end %>
+
+<% if @data_bag_path %>
+  data_bag_path <%=@data_bag_path.inspect %>
+<% end %>
+
+<% if @role_path %>
+  role_path <%=@role_path.inspect %>
+<% end %>
+
+<% if @node_path %>
+  node_path <%=@node_path.inspect %>
+<% end %>
+
+<% if @file_backup_path %>
+  file_backup_path <%=@file_backup_path.inspect %>
+<% end %>
+
+# Logging
+
+<% if @log_level %>
+  log_level <%=@log_level.inspect %>
+<% end %>
+
+<% if @verbose_logging != nil %>
+  verbose_logging <%=@verbose_logging.inspect%>
+<% end %>

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cuoco
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Leonid Shevtsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run Chef Solo from Capistrano
+email:
+- leonid@shevtsov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cuoco.gemspec
+- lib/cuoco.rb
+- lib/cuoco/bootstrapper.rb
+- lib/cuoco/capistrano.rb
+- lib/cuoco/capistrano/automatic.rb
+- lib/cuoco/config_generator.rb
+- lib/cuoco/runner.rb
+- lib/cuoco/uploader.rb
+- lib/cuoco/version.rb
+- templates/solo.rb.erb
+homepage: https://github.com/leonid-shevtsov/Cuoco
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3430509962393590737
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3430509962393590737
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use Capistrano for server provisioning and configuration management, not
+  only application deployment.
+test_files: []