winton-cookbook 1.0.2 → 1.0.3

data/README.markdown

@@ -24,17 +24,17 @@ Install
 
 (Goto **Set up a PHP app** if deploying a PHP project)
 
-### Capify your project
+### Install gem
 
-	capify .
+	gem install winton-cookbook
 
-### Add cookbook as a Git submodule
+### Capify your project
 
-	git submodule add git://github.com:winton/cookbook.git config/cookbook
+	capify .
 
 ### Copy deploy.rb
 
-Copy **config/cookbook/deploy.rb.example** to **config/deploy.rb**
+Copy **[deploy.rb.example](http://github.com/winton/cookbook/tree/master%2Fdeploy.rb.example?raw=true)** to **config/deploy.rb**
 	
 Edit **config/deploy.rb** to your liking. Run `cap -T` to check out your new tasks.
 

data/lib/cookbook.rb

@@ -0,0 +1,66 @@
+# Require helpers and recipes
+
+require File.expand_path('cookbook_helpers.rb', File.dirname(__FILE__))
+Dir[    File.expand_path('recipes/*.rb', File.dirname(__FILE__))].each do |f|
+  require f
+end
+
+
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  ROOT = self
+  
+  # See cookbook hash in config/deploy.rb
+  
+  cookbook[:port] = cookbook[:ssh_port]   # Port is too ambiguous for me
+  cookbook.each do |key, value|           # Merge cookbook with capistrano
+    value.respond_to?(:keys) ? value.each { |k, v| set "#{key}_#{k}".intern, v } : set(key, value)
+  end
+  
+  # Default values
+  
+  set :port,                fetch(:port,                22)
+  set :user,                fetch(:user,                'deploy')
+  set :stage,               fetch(:stage,               :production)
+  set :db_user,             fetch(:db_user,             'app')
+  set :db_pass,             fetch(:db_pass,             '')
+  set :platform,            fetch(:platform,            :rails) # Or :php
+  set :ssl_cert,            fetch(:ssl_cert,            false)
+  set :use_sudo,            fetch(:use_sudo,            false)
+  set :auth_user,           fetch(:auth_user,           false)
+  set :nginx_dir,           fetch(:nginx_dir,           '/usr/local/nginx/conf')
+  set :mysql_dir,           fetch(:mysql_dir,           '/etc/mysql')
+  set :ultrasphinx,         fetch(:ultrasphinx,         false)
+  set :attachment_fu,       fetch(:attachment_fu,       false)
+  set :asset_packager,      fetch(:asset_packager,      false)
+  set :mongrel_etc_dir,     fetch(:mongrel_etc_dir,     '/usr/local/etc/mongrel_cluster')
+  set :mongrel_gem_dir,     fetch(:mongrel_gem_dir,     '/usr/local/lib/ruby/gems/1.8/gems/mongrel_cluster-1.0.5')
+  set :staging_mongrels,    fetch(:staging_mongrels,    1)
+  set :production_mongrels, fetch(:production_mongrels, 2)
+  
+  # Git by default
+  
+  set :scm,                 :git
+  set :deploy_via,          :remote_cache
+  set :repository_cache,    'git_cache'
+  
+  ssh_options[:paranoid] = false
+
+  # Events
+
+  on :before, 'setup_stage', :except => [ :staging, :testing ]  # Executed before every task
+  if platform == :rails
+    after 'deploy:update_code', 'rails:setup_git'               # Initialize submodules
+    after 'deploy:update_code', 'rails:config:to_app'           # Copy shared config to app
+    if asset_packager
+      after 'deploy:update_code', 'rails:config:asset_packager' # Configure attachment_fu
+    end
+    if attachment_fu
+      after 'deploy:update_code', 'rails:config:attachment_fu'  # Configure attachment_fu
+    end
+    if ultrasphinx
+      after 'deploy:update_code', 'rails:config:ultrasphinx'    # Configure ultrasphinx
+    end
+  end
+  
+end

data/lib/cookbook_helpers.rb

@@ -0,0 +1,119 @@
+require 'erb'
+
+
+# Install
+
+def gem_install(name, options='')
+  sudo_puts "gem install #{name} #{options}"
+end
+
+def unpack_source(source)
+  url  = eval "sources_#{source}"  # see cookbook[:sources]
+  name = File.basename url
+  src  = "/home/#{user}/sources"
+  base = nil
+  [ 'tar.gz', 'tgz' ].each do |ext|
+    base = name[0..((ext.length + 2) * -1)] if name.include?(ext)
+  end
+  run_each [
+    "mkdir -p #{src}",
+    "cd #{src} && wget --quiet #{url}",
+    "tar -xzvf #{src}/#{name} -C #{src}"
+  ]
+  "#{src}/#{base}"
+end
+
+def install_source(source)
+  path = unpack_source source
+  yield path
+  sudo "rm -Rf #{path}"
+end
+
+
+# Files
+
+def get_ssh_keys
+  keys = Dir[File.expand_path('~/.ssh/*.pub')].collect do |f|
+    File.open(f).collect { |line| line.strip.empty? ? nil : line.strip }.compact
+  end
+  keys.flatten.join("\n").strip
+end
+
+def upload_from_erb(destination, bind=nil, options={})
+  # options[ :chown  => owner of file (default: deploy user),
+  #          :chmod  => 0644 etc
+  #          :folder => 'postfix' etc,
+  #          :name   => name of template if differs from destination ]
+  if destination.respond_to?(:uniq)
+    destination.each { |d| upload_from_erb d, bind, options }
+  else
+    template = File.basename destination
+    template = template[1..-1] if template[0..0] == '.'
+    folder   = options[:folder] ? options[:folder] + '/' : ''
+    template = File.expand_path("templates/#{folder}#{options[:name]||template}.erb", File.dirname(__FILE__))
+    template = File.read template
+    sudo "touch #{destination}"
+    sudo "chown #{user} #{destination}"
+    put ERB.new(template).result(bind || binding), destination
+    sudo("chown #{options[:chown]} #{destination}") if options[:chown]
+    sudo("chmod #{options[:chmod]} #{destination}") if options[:chmod]
+  end
+end
+
+
+# MySQL
+
+def mysql_run(sql)
+  if sql.respond_to?(:uniq)
+    sql.each { |s| mysql_run s }
+  else
+    run "echo \"#{sql}\" | #{mysql_call}"
+  end
+end
+
+def mysql_call
+  @mysql_root_password = @mysql_root_password || ask("Password for mysql root:")
+  "mysql -u root --password=#{@mysql_root_password}"
+end
+
+
+# Questions
+
+def ask(question, default='')
+  question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+  answer = Capistrano::CLI.ui.ask(question).strip
+  answer.empty? ? default : answer
+end
+
+def yes(question)
+  question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+  question += ' (y/n)'
+  ask(question).downcase.include? 'y'
+end
+
+
+# Runners
+
+def run_each(*args, &block)
+  cmd  = args[0]
+  sudo = args[1]
+  if cmd.respond_to?(:uniq)
+    cmd.each  { |c| run_each c, sudo, &block }
+  elsif sudo
+    sudo(cmd) { |ch, st, data| block.call(data) if block }
+  else
+    run(cmd)  { |ch, st, data| block.call(data) if block }
+  end
+end
+
+def sudo_each(cmds, &block)
+  run_each cmds, true, &block
+end
+
+def run_puts(cmds, &block)
+  run_each(cmds) { |data| puts data }
+end
+
+def sudo_puts(cmds, &block)
+  sudo_each(cmds) { |data| puts data }
+end

data/lib/recipes/debian.rb

@@ -0,0 +1,200 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :debian do
+    desc "Configure and install a fresh Debian server"
+    task :default do
+      if yes("Have you created the user defined in config/deploy.rb? (See vendor/plugins/cookbook/README)")
+        debian.aptitude.default
+        debian.config.default
+        debian.install.default
+      end
+    end
+    
+    namespace :aptitude do
+      desc 'Run all tasks'
+      task :default do
+        aptitude.update
+        aptitude.upgrade
+        aptitude.essential
+      end
+      
+      desc 'Aptitude update'
+      task :update do
+        sudo_puts 'aptitude update -q -y'
+      end
+      
+      desc 'Aptitude upgrade'
+      task :upgrade do
+        sudo_puts 'aptitude upgrade -q -y'
+      end
+      
+      desc 'Aptitude install build-essential'
+      task :essential do
+        sudo_puts 'aptitude install build-essential -q -y'
+      end
+    end
+    
+    namespace :config do
+      desc 'Run all tasks'
+      task :default do
+        debian.config.sshd_config
+        debian.config.iptables
+        debian.config.locales
+        debian.config.bash_profile
+      end
+      
+      desc "Uploads the bash_profile file in config/cookbook"
+      task :bash_profile do
+        question = [
+          "This task uploads the bash_profile file in config/cookbook.",
+          "OK?"
+        ]
+        if yes(question)
+          usr = ask "Update bash_profile for which user? (default: #{user})", user
+          upload_from_erb "/home/#{usr}/.bash_profile", binding, :chown => usr, :folder => 'debian'
+        end
+      end
+
+      desc "Updates server iptables from the file in config/cookbook"
+      task :iptables do
+        question = [
+          "This task updates your server's iptables with the file in config/cookbook.",
+          "OK?"
+        ]
+        if yes(question)
+          upload_from_erb '/etc/iptables.rules', binding, :folder => 'debian'
+          sudo_each [
+            'iptables-restore < /etc/iptables.rules',
+            'rm /etc/iptables.rules'
+          ]
+        end
+      end
+
+      desc "Updates server locales from the file in config/cookbook"
+      task :locales do
+        question = [
+          "This task updates the server's locales from the file in config/cookbook.",
+          "OK?"
+        ]
+        if yes(question)
+          upload_from_erb '/etc/locale.gen', binding, :chown => 'root', :chmod => '0644', :folder => 'debian'
+          sudo '/usr/sbin/locale-gen'
+        end
+      end
+      
+      desc "Updates sshd_config from the file in config/cookbook"
+      task :sshd_config do
+        question = [
+          "This task updates your server's sshd_config with the file in config/cookbook.",
+          "This task assumes your server's current ssh port is 22.",
+          "This task will change your ssh port to the one in config/deploy.rb.",
+          "OK?"
+        ]
+        if yes(question)
+          set :port, 22   # Comment out for testing
+          upload_from_erb '/etc/ssh/sshd_config', binding, :chown => 'root', :chmod => '0644', :folder => 'debian'
+          sudo '/etc/init.d/ssh reload'
+          set :port, ssh_port
+        end
+      end
+    end
+    
+    namespace :install do
+      desc 'Run all tasks'
+      task :default do
+        debian.install.git
+        debian.install.lighttpd
+        debian.install.mysql
+        debian.install.nginx
+        debian.install.php
+        debian.install.ruby
+        debian.install.rubygems
+        debian.install.sphinx
+        debian.install.monit
+      end
+      
+      desc "Install Git"
+      task :git, :roles => :app do
+        install_source(:git) do |path|
+          sudo_puts [
+            "aptitude install tcl8.4 tk8.4 gettext -q -y",
+            "cd #{path} && ./configure && make && sudo make install"
+          ]
+        end
+      end
+      
+      desc "Install Lighttpd" # Lighttpd install is purely for spawn-fcgi
+      task :lighttpd, :roles => :app do
+        sudo_puts 'aptitude install libpcre3-dev libbz2-dev -q -y'
+        install_source(:lighttpd) do |path|
+          sudo_puts "cd #{path} && ./configure && make && sudo make install"
+        end
+      end
+      
+      desc 'Install Monit'
+      task :monit, :roles => :db do
+        sudo_puts 'aptitude install monit -q -y'
+        monit.config.default
+      end
+      
+      desc 'Install MySQL'
+      task :mysql, :roles => :db do
+        sudo_puts 'aptitude install mysql-server mysql-client libmysqlclient15-dev libmysql-ruby -q -y'
+        ROOT.mysql.config
+        puts [
+          '',
+          "It is highly recommended you run mysql_secure_installation manually.",
+          "See http://dev.mysql.com/doc/refman/5.1/en/mysql-secure-installation.html",
+          ''
+        ].join("\n")
+        ROOT.mysql.create.user
+      end
+      
+      desc 'Install Nginx'
+      task :nginx, :roles => :app do
+        # apache2-utils for htpasswd, rest for nginx build
+        sudo_puts 'aptitude install apache2-utils libpcre3 libpcre3-dev libpcrecpp0 libssl-dev zlib1g-dev -q -y'
+        install_source(:nginx) do |path|
+          sudo_puts "cd #{path} && ./configure --sbin-path=/usr/local/sbin --with-http_ssl_module && make && sudo make install"
+        end
+        upload_from_erb '/etc/init.d/nginx', binding, :chown => 'root', :chmod => '+x', :folder => 'nginx'
+        sudo '/usr/sbin/update-rc.d -f nginx defaults'
+        ROOT.nginx.config.run_once.default
+      end
+      
+      desc "Install PHP"
+      task :php, :roles => :app do
+        sudo_puts 'aptitude install php5-cli php5-cgi php5-mysql php5-xcache -q -y'
+        upload_from_erb [
+          '/usr/local/bin/php-fastcgi',
+          '/etc/init.d/init-fastcgi'
+        ], binding, :chown => 'root', :chmod => '+x', :folder => 'php'
+        sudo '/usr/sbin/update-rc.d -f init-fastcgi defaults'
+      end
+      
+      desc 'Install Ruby'
+      task :ruby, :roles => :app do
+        install_source(:ruby) do |path|
+          sudo_puts "cd #{path} && ./configure && make && sudo make install"
+        end
+      end
+      
+      desc 'Install RubyGems'
+      task :rubygems, :roles => :app do
+        install_source(:rubygems) do |path|
+          sudo_puts "cd #{path} && ruby setup.rb"
+        end
+        gems.update
+        gems.install
+      end
+      
+      desc 'Install Sphinx'
+      task :sphinx, :roles => :app do
+        install_source(:sphinx) do |path|
+          sudo_puts "cd #{path} && ./configure && make && sudo make install"
+        end
+      end
+    end
+  end
+
+end

data/lib/recipes/deploy.rb

@@ -0,0 +1,50 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :deploy do
+    desc "Restart mongrel cluster"
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      mongrel.restart if platform == :rails
+    end
+
+    desc "Start mongrel cluster"
+    task :start, :roles => :app do
+      mongrel.start if platform == :rails
+    end
+
+    desc "Stop mongrel cluster"
+    task :stop, :roles => :app do
+      mongrel.stop if platform == :rails
+    end
+  
+    desc "Deploy a fresh app"
+    task :create, :roles => :app do
+      mysql.create.db
+      sudo_each [
+        "mkdir -p #{base_dir}",
+        "chown -R #{user}:#{user} #{base_dir}"
+      ]
+      deploy.setup
+      if platform == :rails
+        mongrel.config.default
+        nginx.config.default
+        rails.config.default
+        deploy.cold
+      elsif platform == :php
+        php.config.default
+        deploy.default
+      end
+      nginx.restart
+    end
+  
+    desc "Stop servers and destroy all files"
+    task :destroy, :roles => :app do
+      deploy.stop
+      mongrel.config.destroy if platform == :rails
+      sudo "rm -Rf #{deploy_to}"
+      nginx.config.destroy
+      nginx.restart
+      mysql.destroy.db
+    end
+  end
+  
+end

data/lib/recipes/gems.rb

@@ -0,0 +1,77 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :gems do  
+    desc "List gems on remote server"
+    task :list, :roles => :app do
+      run_puts "gem list"
+    end
+    
+    desc "Update gems on remote server"
+    task :update, :roles => :app do
+      sudo_each [
+        "gem update --system",
+        "gem update"
+      ]
+    end
+    
+    namespace :install do
+      desc 'Install all standard gems'
+      task :default, :roles => :app do
+        gems.install.haml
+        gems.install.hpricot
+        gems.install.mime_types
+        gems.install.mongrel
+        gems.install.rails
+      end
+      
+      desc 'Install Chronic'
+      task :chronic, :roles => :app do
+        gem_install :chronic
+      end
+      
+      desc 'Install gchart'
+      task :gchart, :roles => :app do
+        gem_install :googlecharts
+      end
+      
+      desc 'Install HAML'
+      task :haml, :roles => :app do
+        gem_install :haml, '--no-ri'
+      end
+      
+      desc 'Install Hpricot'
+      task :hpricot, :roles => :app do
+        gem_install :hpricot
+      end
+      
+      desc 'Install Json'
+      task :json, :roles => :app do
+        gem_install :json
+      end
+      
+      desc 'Install Mime-types'
+      task :mime_types, :roles => :app do
+        gem_install 'mime-types'
+      end
+      
+      desc 'Install Mongrel'
+      task :mongrel, :roles => :app do
+        gem_install :mongrel
+        gem_install :mongrel_cluster
+        mongrel.config.survive_reboot
+      end
+      
+      desc 'Install Rails'
+      task :rails, :roles => :app do
+        gem_install :rails
+      end
+    end
+  
+    desc "Uninstall a remote gem"
+    task :uninstall, :roles => :app do
+      gem_name = ask 'Enter the name of the gem to remove:'
+      sudo "gem uninstall #{gem_name}"
+    end
+  end
+
+end

data/lib/recipes/log.rb

@@ -0,0 +1,47 @@
+Capistrano::Configuration.instance(:must_exist).load do
+ 
+  namespace :log do
+    namespace :tail do
+      desc "Tail all remote logs"
+      task :default, :roles => :app do
+        log.tail.nginx
+        log.tail.mongrel
+        log.tail.production
+      end
+      
+      desc "Tail the remote Nginx log"
+      task :nginx, :roles => :app do
+        puts 'Nginx ' + '=' * 100
+        run_puts "tail -100 #{shared_path}/log/nginx.log"
+      end
+      
+      desc "Tail the remote Mongrel log"
+      task :mongrel, :roles => :app do
+        (mongrel_port..(mongrel_port + production_mongrels - 1)).each do |port|
+          puts "Mongrel #{port} " + '=' * 100
+          run_puts "tail -100 #{shared_path}/log/mongrel.#{port}.log"
+        end
+      end
+      
+      desc "Tail the remote Rails production log"
+      task :production, :roles => :app do
+        puts 'Production ' + '=' * 100
+        run_puts "tail -100 #{shared_path}/log/production.log"
+      end
+    end
+    
+    desc "Add logrotate entry for this application"
+    task :rotate, :roles => :app do
+      upload_from_erb '/etc/rotate.conf', binding, :folder => 'log'
+      sudo_each [
+        'cp -f /etc/logrotate.conf /etc/logrotate2.conf',
+        'chmod 777 /etc/logrotate2.conf',
+        'cat /etc/rotate.conf >> /etc/logrotate2.conf',
+        'cp -f /etc/logrotate2.conf /etc/logrotate.conf',
+        'rm -f /etc/logrotate2.conf',
+        'rm -f /etc/rotate.conf'
+      ]
+    end
+  end
+  
+end

data/lib/recipes/mongrel.rb

@@ -0,0 +1,48 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :mongrel do
+    [ :stop, :start, :restart ].each do |t|
+      desc "#{t.to_s.capitalize} the mongrel appserver"
+      task t, :roles => :app do
+        run "mongrel_rails cluster::#{t.to_s} -C #{mongrel_etc_dir}/#{application}_#{stage}.yml"
+      end
+    end
+    
+    namespace :config do      
+      desc "Generate remote application config"
+      task :default, :roles => :app do
+        mongrel.config.cluster
+        mongrel.config.nginx
+      end
+
+      desc "Generate remote remote mongrel_cluster config"
+      task :cluster, :roles => :app do
+        sudo "mkdir -p #{mongrel_etc_dir}"
+        upload_from_erb "#{mongrel_etc_dir}/#{application}_#{stage}.yml", binding, :folder => 'mongrel', :name => 'mongrel.yml'
+      end
+      
+      desc "Generate remote Nginx vhost"
+      task :nginx, :roles => :app do
+        upload_from_erb "#{nginx_dir}/vhosts/#{application}_#{stage}.conf", binding, :folder => 'mongrel', :name => 'nginx.vhost'
+      end
+      
+      desc "Make our mongrel cluster restart-proof"
+      task :survive_reboot, :roles => :app do
+        sudo_each [
+          "cp -Rf #{mongrel_gem_dir}/resources/mongrel_cluster /etc/init.d/",
+          "chmod +x /etc/init.d/mongrel_cluster",
+          "/usr/sbin/update-rc.d -f mongrel_cluster defaults"
+        ]
+      end
+      
+      desc "Destroy all files created by config:create"
+      task :destroy, :roles => :app do
+        sudo_each [
+          "rm -f #{mongrel_etc_dir}/#{application}_#{stage}.yml",
+          "rm -f #{nginx_dir}/vhosts/#{application}_#{stage}.conf"
+        ]
+      end
+    end
+  end
+
+end

data/lib/recipes/monit.rb

@@ -0,0 +1,47 @@
+Capistrano::Configuration.instance(:must_exist).load do
+ 
+  namespace :monit do
+    [ :stop, :start, :restart ].each do |t|
+      desc "#{t.to_s.capitalize} Monit"
+      task t, :roles => :app do
+        sudo "/etc/init.d/monit #{t.to_s}"
+      end
+    end
+    
+    namespace :config do
+      desc "Generate remote Monit config files"
+      task :default, :roles => :app do
+        upload_from_erb [
+          '/etc/monit/monitrc',
+          '/etc/default/monit'
+        ], binding, :chown => 'root', :chmod => '0644', :folder => 'monit'
+        monit.config.nginx
+      end
+      
+      desc "Add mongrel cluster to monitrc"
+      task :mongrel, :roles => :app do
+        upload_from_erb '/etc/monit/mongrel', binding, :folder => 'monit'
+        sudo_each [
+          'cp -f /etc/monit/monitrc /etc/monit/monitrc2',
+          'chmod 777 /etc/monit/monitrc2',
+          'cat /etc/monit/mongrel >> /etc/monit/monitrc2',
+          'cp -f /etc/monit/monitrc2 /etc/monit/monitrc',
+          'rm -f /etc/monit/mongrel',
+          'rm -f /etc/monit/monitrc2'
+        ]
+      end
+      
+      desc "Generate remote Nginx vhost"
+      task :nginx, :roles => :app do
+        if monit_auth_user
+          sudo_each [
+            "mkdir -p #{nginx_dir}/htpasswd",
+            "htpasswd -bc #{nginx_dir}/htpasswd/monit #{monit_auth_user} #{monit_auth_pass}"
+          ]
+        end
+        upload_from_erb "#{nginx_dir}/vhosts/monit.conf", binding, :folder => 'monit', :name => 'nginx.vhost'
+      end
+    end
+  end
+  
+end