capistrano-recipes 0.5.0 → 0.8.0

data/.gitignore

@@ -3,3 +3,6 @@
 coverage
 rdoc
 pkg
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Webficient LLC, Phil Misiowiec
+Copyright (c) 2009-2011 Webficient LLC, Phil Misiowiec
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -6,19 +6,53 @@ Useful Capistrano recipes including:
 * Create standalone copy of database.yml in shared path (via prompts)
 * Log rotation and tailing commands
 * Restart and profile Phusion Passenger application server
+* Configure, start/stop/restart Unicorn application server
+* Send commands to God or Bluepill monitoring tools
+* Send commands to Thinking Sphinx
 
 ==Included Tasks
 
 * cap db:create_yaml
 * cap db:mysql:setup
+* cap db:mysql:dump
+* cap db:mysql:fetch_dump
+* cap db:mysql:restore
 * cap log:rotate
 * cap log:tail
 * cap passenger:bounce
 * cap passenger:memory
 * cap passenger:status
-* cap symlink:create_shared_dirs
-* cap symlink:shared_config_files
-* cap symlink:shared_directories
+* cap nginx:setup
+* cap nginx:start
+* cap nginx:stop
+* cap nginx:restart
+* cap nginx:status
+* cap unicorn:start
+* cap unicorn:stop
+* cap unicorn:restart
+* cap unicorn:setup
+* cap symlinks:make
+* cap god:setup
+* cap god:implode
+* cap god:restart
+* cap god:reload
+* cap god:status
+* cap god:terminate
+* cap god:start
+* cap god:stop
+* cap god:quit
+* cap bluepill:install
+* cap bluepill:init
+* cap bluepill:start
+* cap bluepill:restart
+* cap bluepill:stop
+* cap bluepill:status
+* cap sphinx:config
+* cap sphinx:start
+* cap sphinx:stop
+* cap sphinx:rebuild
+* cap sphinx:index
+* cap sphinx:symlinks
 
 ==Installation
 
@@ -35,20 +69,53 @@ Optionally install the Capistrano extensions gem to give you multistage support:
 Install this gem:
 
   sudo gem install capistrano-recipes --source=http://gemcutter.com
-
+  
 To setup the initial Capistrano deploy file, go to your Rails app folder via command line and enter:
 
   capify .
 
+==Configuration
+
 Inside the newly created config/deploy.rb, add:
 
-  require 'capistrano_recipes'
   require 'capistrano/ext/multistage' # only require if you've installed Cap ext gem
+  
+  # This one should go at the end of your deploy.rb
+  require 'capistrano_recipes'
+
+===RVM
+
+RVM is enabled by default. You can disable it by setting :using_rvm to false, or leverage it
+by setting your rvm_ruby_string to appropriate ones (default is ree)
+
+If using_rvm is true, the rvm recipe will load rvm's own capistrano extensions so you don't
+have to worry about it during deploy. Just make sure you have everything set up right, like
+.rvmrc on project root and system-wide install on the servers.
+
+See (http://rvm.beginrescueend.com/rvm/install) for more info.
+
+===Nginx
+
+If you're using nginx as your web server, set :web_server to :nginx and deploy:setup will
+generate the appropriate configuration file for it based on your other variables, such as
+:application_uses_ssl, etc.
+
+===Passenger
 
 If you're running Phusion Passenger (http://www.modrails.com) be sure you add this line to config/deploy.rb:
 
   set :server, :passenger
+
+===Unicorn
+  
+If you're running Unicorn (http://unicorn.bogomips.org/) be sure to add this line instead:
+  
+  set :server, :unicorn
+
+==Contributors (thank you!)
+
+* Leonardob Bighetti
   
 ==Copyright
 
-Copyright (c) 2009 Webficient LLC, Phil Misiowiec. See LICENSE for details.
+Copyright (c) 2009-2011 Webficient LLC, Phil Misiowiec. See LICENSE for details.

data/Rakefile

@@ -1,27 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "capistrano-recipes"
-    gem.summary = %Q{Capistrano recipes}
-    gem.description = 'Extend the Capistrano gem with these useful recipes'
-    gem.email = "phil@webficient.com"
-    gem.homepage = "http://github.com/webficient/capistrano-recipes"
-    gem.authors = ["Phil Misiowiec"]
-    gem.add_dependency('capistrano', ['>= 2.5.9'])
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = 'capistrano-recipes'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/capistrano-recipes.gemspec

@@ -1,52 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
 
 Gem::Specification.new do |s|
-  s.name = %q{capistrano-recipes}
-  s.version = "0.5.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Phil Misiowiec"]
-  s.date = %q{2009-10-01}
+  s.name        = "capistrano-recipes"
+  s.version     = CapistranoRecipes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Phil Misiowiec", "Leonardo Bighetti"]
+  s.email       = ["github@webficient.com"]
+  s.homepage    = ""
+  s.summary     = %q{Capistrano recipes}
   s.description = %q{Extend the Capistrano gem with these useful recipes}
-  s.email = %q{phil@webficient.com}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "capistrano-recipes"
+
+  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"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
   ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "capistrano-recipes.gemspec",
-     "lib/capistrano_recipes.rb",
-     "lib/helpers.rb",
-     "lib/recipes/db.rb",
-     "lib/recipes/deploy.rb",
-     "lib/recipes/log.rb",
-     "lib/recipes/passenger.rb",
-     "lib/recipes/symlink.rb"
-  ]
-  s.homepage = %q{http://github.com/webficient/capistrano-recipes}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Capistrano recipes}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<capistrano>, [">= 2.5.9"])
-    else
-      s.add_dependency(%q<capistrano>, [">= 2.5.9"])
-    end
-  else
-    s.add_dependency(%q<capistrano>, [">= 2.5.9"])
-  end
-end
+  
+  s.add_dependency "capistrano", ">= 2.5.9"
+  s.add_dependency "capistrano-ext", ">= 1.2.1"
+end

data/doc/god/god

@@ -0,0 +1 @@
+GOD_CONFIG=/etc/god/god.conf

data/doc/god/god.conf

@@ -0,0 +1,102 @@
+APPS_ROOT = Dir.glob("/var/www/apps/*/current/config/app.god")
+
+# Helper Methods
+def unicorn(w, config, options = {})
+  rails_root      = options[:rails_root]
+  rails_env       = options[:rails_env] || 'production'
+  unicorn_group   = options[:app] || options[:name] || 'default'
+  unicorn_name    = "#{unicorn_group}-unicorn"
+  unicorn_bin     = options[:bin_unicorn] || 'bootup_unicorn_rails'
+  unicorn_pid     = options[:unicorn_pid] || "#{rails_root}/log/unicorn.pid"
+  unicorn_config  = "#{rails_root}/config/unicorn.rb"
+  unicorn_start   = options[:start_cmd] || "cd #{rails_root} && #{unicorn_bin} -c #{unicorn_config} -E #{rails_env} -D"
+  # QUIT gracefully shuts down workers
+  unicorn_stop    = options[:stop_cmd] || "kill -QUIT `cat #{unicorn_pid}`"
+  # USR2 causes the master to re-create itself and spawn a new worker pool
+  unicorn_restart = options[:restart_cmd] || "kill -USR2 `cat #{unicorn_pid}`"
+  
+  
+  w.name          = unicorn_name
+  w.group         = unicorn_group
+  w.start         = unicorn_start
+  w.stop          = unicorn_stop
+  w.restart       = unicorn_restart
+  w.start_grace   = 20.seconds
+  w.restart_grace = 20.seconds
+  w.pid_file      = unicorn_pid
+  w.behavior(:clean_pid_file)
+  
+  generic_monitor(w, config, rails_root, options)
+end
+
+def generic_monitor(w, config, rails_root, options = {})
+  w.uid       = options[:user]  || 'deploy'
+  w.gid       = options[:group] || 'www-data'
+  w.interval  = 60.seconds # default
+  
+  # determine the state on startup
+  w.transition(:init, { true => :up, false => :start }) do |on|
+    on.condition(:process_running) do |c|
+      c.running = true
+    end
+  end
+  
+  # determine when process has finished starting
+  w.transition([:start, :restart], :up) do |on|
+    on.condition(:process_running) do |c|
+      c.running = true
+    end
+    
+    # failsafe
+    on.condition(:tries) do |c|
+      c.times = 5
+      c.transition = :start
+    end
+  end
+
+  # start if process is not running
+  w.transition(:up, :start) do |on|
+    on.condition(:process_exits) do |c|
+    end
+  end
+  
+  # restart if memory or cpu is too high
+  w.transition(:up, :restart) do |on|
+    on.condition(:memory_usage) do |c|
+      c.interval = 20
+      c.above = options[:memory_limit] || 150.megabytes
+      c.times = [3, 5]
+    end
+    
+    on.condition(:cpu_usage) do |c|
+      c.interval = 20
+      c.above = options[:cpu_limit] || 50.percent
+      c.times = [3, 5]
+    end
+  end
+  
+  # lifecycle
+  w.lifecycle do |on|
+    on.condition(:flapping) do |c|
+      c.to_state = [:start, :restart]
+      c.times = 5
+      c.within = 5.minute
+      c.transition = :unmonitored
+      c.retry_in = 10.minutes
+      c.retry_times = 5
+      c.retry_within = 2.hours
+    end
+  end  
+end
+
+God.log_level = :info
+puts "God is loading the apps now..."
+APPS_ROOT.each do  |app|
+  begin
+    puts "Loading app: #{app}"
+    God.load app    
+    puts "Done"
+  rescue Exception => e
+    puts "Failed! #{e}"
+  end
+end

data/doc/god/god.init

@@ -0,0 +1,62 @@
+#!/bin/sh
+
+### BEGIN INIT INFO
+# Provides:             god
+# Required-Start:       $all
+# Required-Stop:        $all
+# Default-Start:        2 3 4 5
+# Default-Stop:         0 1 6
+# Short-Description:    God
+### END INIT INFO
+
+NAME=god
+DESC=god
+
+GOD_BIN=/usr/local/bin/bootup_god
+GOD_PID=/var/run/god.pid
+GOD_LOG=/var/log/god.log
+set -e
+
+# Make sure the binary and the config file are present before proceeding
+test -x $GOD_BIN || exit 0
+
+# Create this file and put in a variable called GOD_CONFIG, pointing to
+# your God configuration file
+test -f /etc/default/god && . /etc/default/god
+[ $GOD_CONFIG ] || exit 0
+
+. /lib/lsb/init-functions
+
+RETVAL=0
+
+case "$1" in
+  start)
+    echo -n "Starting $DESC: "
+    $GOD_BIN -c $GOD_CONFIG -P $GOD_PID -l $GOD_LOG
+    RETVAL=$?
+    echo "$NAME."
+    ;;
+  stop)
+    echo -n "Stopping $DESC: "
+    kill `cat $GOD_PID`
+    RETVAL=$?
+    echo "$NAME."
+    ;;
+  restart)
+    echo -n "Restarting $DESC: "
+    kill `cat $GOD_PID`
+    $GOD_BIN -c $GOD_CONFIG -P $GOD_PID -l $GOD_LOG
+    RETVAL=$?
+    echo "$NAME."
+    ;;
+  status)
+    $GOD_BIN status
+    RETVAL=$?
+    ;;
+  *)
+    echo "Usage: god {start|stop|restart|status}"
+    exit 1
+    ;;
+esac
+
+exit $RETVAL

data/generators/app.god.erb

@@ -0,0 +1,25 @@
+app_name            = '<%= application %>'
+rails_root          = '<%= deploy_to %>/current'
+unicorn_bin         = '<%= unicorn_bin %>'
+unicorn_pid         = '<%= unicorn_pid %>'
+unicorn_config      = '<%= unicorn_remote_config %>'
+unicorn_start_cmd   = '<%= unicorn_start_cmd %>'
+unicorn_stop_cmd    = '<%= unicorn_stop_cmd %>'
+unicorn_restart_cmd = '<%= unicorn_restart_cmd %>'
+
+# Unicorn
+God.watch do |w|
+  unicorn(w, rails_root, 
+    :memory_limit => 100.megabytes, 
+    :cpu_limit    => 50.percent,
+    :bin_unicorn  => unicorn_bin,
+    :name         => app_name,
+    :rails_root   => rails_root,
+    :unicorn_conf => unicorn_config,
+    :unicorn_pid  => unicorn_pid,
+    :start_cmd    => unicorn_start_cmd,
+    :stop_cmd     => unicorn_stop_cmd,
+    :restart_cmd  => unicorn_restart_cmd,
+    :user         => '<%= unicorn_user %>',
+    :group        => '<%= unicorn_group %>')
+end

data/generators/nginx.conf.erb

@@ -0,0 +1,207 @@
+    <% if is_using_unicorn %>
+    upstream <%= application %>_app_server {
+        server unix:<%= unicorn_socket %> fail_timeout=0;
+    }
+    <% end %>
+    # <%= application %> Server
+    server {
+        listen <%= application_port %>;
+        <% if is_using_passenger %>
+        rails_env <%= rails_env %>;
+        passenger_enabled on;
+        <% end %>
+        client_max_body_size 500M;
+        server_name <%= application %>;
+
+        # ~2 seconds is often enough for most folks to parse HTML/CSS and
+        # retrieve needed images/icons/frames, connections are cheap in
+        # nginx so increasing this is generally safe...
+        keepalive_timeout 5;
+
+        # path for static files
+        root <%= deploy_to %>/current/public;
+        access_log <%= deploy_to %>/current/log/nginx.access.log main;
+        error_log  <%= deploy_to %>/current/log/nginx.error.log info;
+
+        # this rewrites all the requests to the maintenance.html
+        # page if it exists in the doc root. This is for capistrano's
+        # disable web task
+        if (-f $document_root/system/maintenance.html) {
+          rewrite  ^(.*)$  /system/maintenance.html last;
+          break;
+        }
+        
+        location / {
+          <% if is_using_passenger %>
+          rails_env <%= rails_env %>;
+          passenger_enabled on;
+          <% end %>
+          
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header Host $http_host;
+          
+          # If the file exists as a static file serve it directly without
+          # running all the other rewite tests on it
+          if (-f $request_filename) { 
+            break; 
+          }
+
+          # check for index.html for directory index
+          # if its there on the filesystem then rewite 
+          # the url to add /index.html to the end of it
+          # and then break to send it to the next config rules.
+          if (-f $request_filename/index.html) {
+            rewrite (.*) $1/index.html break;
+          }
+
+          # this is the meat of the rails page caching config
+          # it adds .html to the end of the url and then checks
+          # the filesystem for that file. If it exists, then we
+          # rewite the url to have explicit .html on the end 
+          # and then send it on its way to the next config rule.
+          # if there is no file on the fs then it sets all the 
+          # necessary headers and proxies to our upstream mongrels
+          if (-f $request_filename.html) {
+            rewrite (.*) $1.html break;
+          }
+          
+          <% if is_using_unicorn %>
+          if (!-f $request_filename) {
+            proxy_pass http://<%= application %>_app_server;
+            break;
+          }
+          <% end %>
+        }
+        
+        # Now this supposedly should work as it gets the filenames with querystrings that Rails provides.
+        # BUT there's a chance it could break the ajax calls.
+        location ~* \.(ico|css|gif|jpe?g|png)(\?[0-9]+)?$ {
+        	 expires max;
+        	 break;
+        }
+        
+        location ~ ^/javascripts/.*\.js(\?[0-9]+)?$ {
+        	 expires max;
+        	 break;
+        }
+        
+        # Now this supposedly should work as it gets the filenames with querystrings that Rails provides.
+        # BUT there's a chance it could break the ajax calls.
+        location ~* \.(ico|css|gif|jpe?g|png)(\?[0-9]+)?$ {
+        	 expires max;
+        	 break;
+        }
+        
+        location ~ ^/javascripts/.*\.js(\?[0-9]+)?$ {
+        	 expires max;
+        	 break;
+        }
+        
+        # if the request is for a static resource, nginx should serve it directly
+        # and add a far future expires header to it, making the browser
+        # cache the resource and navigate faster over the website
+        location ~ ^/(images|javascripts|stylesheets|system)/ {
+          root /home/deployer/shop/current/public;
+          expires max;
+          break;
+        }
+        
+        # Rails error pages
+        error_page 500 502 503 504 /500.html;
+        location = /500.html {
+          root <%= deploy_to %>/current/public;
+        }
+    }
+    
+    <% if application_uses_ssl %>
+      
+    <% if is_using_unicorn %>
+    upstream <%= application %>_app_ssl {
+      server unix:<%= unicorn_socket %> fail_timeout=0;
+    }  
+    <% end %>
+    
+    # This server is setup for ssl. Uncomment if 
+    # you are using ssl as well as port 80.
+    server {
+      listen <%= application_port_ssl%>;
+      server_name <%= application %>;
+      <% if is_using_passenger %>
+      rails_env <%= rails_env %>;
+      passenger_enabled on;
+      <% end %>
+      ssl                     on;
+      ssl_certificate         /etc/ssl/certs/server.crt;
+      ssl_certificate_key     /etc/ssl/private/server.key;
+      ssl_session_timeout     5m;
+      client_max_body_size    50M;
+      
+      root <%= deploy_to %>/current/public;
+      access_log <%= deploy_to %>/current/log/nginx.access.log main;
+      error_log  <%= deploy_to %>/current/log/nginx.error.log info;
+
+      # this rewrites all the requests to the maintenance.html
+      # page if it exists in the doc root. This is for capistrano's
+      # disable web task
+      if (-f $document_root/system/maintenance.html) {
+        rewrite  ^(.*)$  /system/maintenance.html last;
+        break;
+      }
+
+      location / {
+        <% if is_using_passenger %>
+        rails_env <%= rails_env %>;
+        passenger_enabled on;
+        <% end %>
+        
+        # needed to forward user's IP address to rails
+        proxy_set_header  X-Real-IP  $remote_addr;
+
+        # needed for HTTPS
+        proxy_set_header X_FORWARDED_PROTO https;
+
+        proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $http_host;
+        proxy_redirect off;
+        proxy_max_temp_file_size 0;
+
+        
+        # If the file exists as a static file serve it directly without
+        # running all the other rewite tests on it
+        if (-f $request_filename) { 
+          break; 
+        }
+
+        # check for index.html for directory index
+        # if its there on the filesystem then rewite 
+        # the url to add /index.html to the end of it
+        # and then break to send it to the next config rules.
+        if (-f $request_filename/index.html) {
+          rewrite (.*) $1/index.html break;
+        }
+
+        # this is the meat of the rails page caching config
+        # it adds .html to the end of the url and then checks
+        # the filesystem for that file. If it exists, then we
+        # rewite the url to have explicit .html on the end 
+        # and then send it on its way to the next config rule.
+        # if there is no file on the fs then it sets all the 
+        # necessary headers and proxies to our upstream mongrels
+        if (-f $request_filename.html) {
+          rewrite (.*) $1.html break;
+        }
+        
+        <% if is_using_unicorn %>
+        if (!-f $request_filename) {
+          proxy_pass http://<%= application %>_app_ssl;
+          break;
+        }
+        <% end %>
+      }
+
+      error_page   500 502 503 504  /500.html;
+      location = /500.html {
+        root   <%= deploy_to %>/current/public;
+      }
+    }
+    <% end %>