capistrano-nginx-unicorn 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Tkalin
+
+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,146 @@
+# Capistrano-Nginx-Unicorn
+
+Capistrano tasks for configuration and management nginx+unicorn combo for zero downtime deployments of Rails applications.
+
+Provides capistrano tasks to:
+
+* easily add application to nginx and reload it's configuration
+* create unicorn init script for application, so it will be automatically started when OS restarts
+* start/stop unicorn (also can be done using `sudo service unicorn_<your_app> start/stop`)
+* reload unicorn using `USR2` signal to load new application version with zero downtime
+
+Provides several capistrano variables for easy customization.
+Also, for full customization, all configs can be copied to the application using generators.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-nginx-unicorn', require: false, group: :development
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-nginx-unicorn
+
+## Usage
+
+Add this line to your `deploy.rb`
+
+    require 'capistrano-nginx-unicorn'
+
+Note, that following capistrano variables should be defined:
+
+    application
+    current_path
+    shared_path
+    user
+
+You can check that new tasks are available (`cap -T`):
+
+for nginx:
+
+    # add and enable application to nginx
+    cap nginx:setup
+
+    # reload nginx configuration
+    cap nginx:reload
+
+and for unicorn:
+
+    # create unicorn configuration and init script
+    cap unicorn:setup
+
+    # start unicorn
+    cap unicorn:start
+
+    # stop unicorn
+    cap unicorn:stop
+
+    # reload unicorn with no downtime
+    # old workers will process new request until new master is fully loaded
+    # then old workers will be automatically killed and new workers will start processing requests
+    cap unicorn:reload
+
+There is no need to execute any of these tasks manually.
+They will be called automatically on different deploy stages:
+
+* `nginx:setup`, `nginx:reload` and `unicorn:setup` are hooked to `deploy:setup`
+* `unicorn:restart` is hooked to `deploy:restart`
+
+This means that if you run `cap deploy:setup`,
+nginx and unicorn will be automatically configured
+And after each deploy, unicorn will be automatically reloaded.
+
+However, if you changed variables or customized templates,
+you can run any of these tasks to update configuration.
+
+## Customization
+
+### Using variables
+
+You can customize nginx and unicorn configs using capistrano variables:
+
+    # path to customized templates (see below for details)
+    # default value: "config/deploy/templates"
+    set :templates_path, "config/deploy/templates"
+
+    # server name for nginx, default value: no (will be prompted if not set)
+    # set this to your site name as it is visible from outside
+    # this will allow 1 nginx to serve several sites with different `server_name`
+    set :nginx_server_name, "example.com"
+
+    # path, where unicorn pid file will be stored
+    # default value: `"#{current_path}/tmp/pids/unicorn.pid"`
+    set :unicorn_pid, "#{current_path}/tmp/pids/unicorn.pid"
+
+    # path, where unicorn config file will be stored
+    # default value: `"#{shared_path}/config/unicorn.rb"`
+    set :unicorn_config, "#{shared_path}/config/unicorn.rb"
+
+    # path, where unicorn log file will be stored
+    # default value: `"#{shared_path}/config/unicorn.rb"`
+    set :unicorn_log, "#{shared_path}/config/unicorn.rb"
+
+    # user name to run unicorn
+    # default value: `user` (user varibale defined in your `deploy.rb`)
+    set :unicorn_user, "user"
+
+    # number of unicorn workers
+    # default value: no (will be prompted if not set)
+    set :unicorn_workers, 4
+
+For example, of you site name is `example.com` and you want to use 8 unicorn workers,
+your `deploy.rb` will look like this:
+
+    set :server_name, "example.com"
+    set :unicorn_workers, 4
+    require 'capistrano-nginx-unicorn'
+
+### Template Customization
+
+If you want to change default templates, you can generate them using `rails generator`
+
+    rails g capistrano:nginx_unicorn:config
+
+This will copy default templates to `config/deploy/templates` directory,
+so you can customize them as you like, and capistrano tasks will use this templates instead of default.
+
+You can also provide path, where to generate templates:
+
+    rails g capistrano:nginx_unicorn:config config/templates
+
+# TODO:
+
+* add tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-nginx-unicorn.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/nginx_unicorn/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-nginx-unicorn"
+  gem.version       = Capistrano::NginxUnicorn::VERSION
+  gem.authors       = ["Ivan Tkalin"]
+  gem.email         = ["itkalin@gmail.com"]
+  gem.description   = %q{Capistrano tasks for configuration and management nginx+unicorn combo for zero downtime deployments of Rails applications. Configs can be copied to the application using generators and easily customized.}
+  gem.summary       = %q{Create and manage nginx+unicorn configs from capistrano}
+  gem.homepage      = "https://github.com/ivalkeen/capistrano-nginx-unicorn"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '>= 2.0'
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano-nginx-unicorn.rb

@@ -0,0 +1,2 @@
+require "capistrano/nginx_unicorn/version"
+require "capistrano/nginx_unicorn/tasks"

data/lib/capistrano/nginx_unicorn/tasks.rb

@@ -0,0 +1,62 @@
+require 'capistrano'
+
+Capistrano::Configuration.instance.load do
+  set_default(:templates_path, "config/deploy/templates")
+
+  set_default(:nginx_server_name) { Capistrano::CLI.ui.ask "Nginx server name: " }
+
+  set_default(:unicorn_pid, "#{current_path}/tmp/pids/unicorn.pid")
+  set_default(:unicorn_config, "#{shared_path}/config/unicorn.rb")
+  set_default(:unicorn_log, "#{shared_path}/log/unicorn.log")
+  set_default(:unicorn_user, user)
+  set_default(:unicorn_workers) { Capistrano::CLI.ui.ask "Number of unicorn workers: " }
+
+  namespace :nginx do
+    desc "Setup nginx configuration for this application"
+    task :setup, roles: :web do
+      template("nginx_conf.erb", "/tmp/#{application}")
+      run "#{sudo} mv /tmp/#{application} /etc/nginx/sites-available/#{application}"
+      run "#{sudo} ln -fs /etc/nginx/sites-available/#{application} /etc/nginx/sites-enabled/#{application}"
+    end
+
+    after "deploy:setup", "nginx:setup"
+    after "deploy:setup", "nginx:reload"
+
+    desc "Reload nginx configuration"
+    task :reload, roles: :web do
+      run "#{sudo} /etc/init.d/nginx reload"
+    end
+  end
+
+  namespace :unicorn do
+    desc "Setup Unicorn initializer and app configuration"
+    task :setup, roles: :app do
+      run "mkdir -p #{shared_path}/config"
+      template "unicorn.rb.erb", unicorn_config
+      template "unicorn_init.erb", "/tmp/unicorn_init"
+      run "chmod +x /tmp/unicorn_init"
+      run "#{sudo} mv /tmp/unicorn_init /etc/init.d/unicorn_#{application}"
+      run "#{sudo} update-rc.d -f unicorn_#{application} defaults"
+    end
+
+    after "deploy:setup", "unicorn:setup"
+
+    %w[start stop restart].each do |command|
+      desc "#{command} unicorn"
+      task command, roles: :app do
+        run "service unicorn_#{application} #{command}"
+      end
+
+      after "deploy:#{command}", "unicorn:#{command}"
+    end
+  end
+
+  def template(template_name, target)
+    config_file = "#{templates_path}/#{template_name}"
+    # if no customized file, proceed with default
+    unless File.exists?(config_file)
+      config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/nginx_unicorn/templates/#{template_name}")
+    end
+    put ERB.new(File.read(config_file)).result(binding), target
+  end
+end

data/lib/capistrano/nginx_unicorn/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module NginxUnicorn
+    VERSION = "0.0.1"
+  end
+end

data/lib/generators/capistrano/nginx_unicorn/USAGE

@@ -0,0 +1,9 @@
+To create local nginx and unicorn configuration files call
+
+    rails generate capistrano:nginx_unicorn:config [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate capistrano:nginx_unicorn:config "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/nginx_unicorn/config_generator.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  module NginxUnicorn
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local nginx and unicorn configuration files for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, :type => :string,
+          :default => "config/deploy/templates",
+          :banner => "path to templates"
+
+        def copy_template
+          copy_file "nginx_conf.erb", "#{templates_path}/nginx_conf.erb"
+          copy_file "unicorn.rb.erb", "#{templates_path}/unicorn.rb.erb"
+          copy_file "unicorn_init.erb", "#{templates_path}/unicorn_init.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/nginx_unicorn/templates/nginx_conf.erb

@@ -0,0 +1,67 @@
+upstream unicorn_<%= application %> {
+  server unix:/tmp/unicorn.<%= application %>.sock fail_timeout=0;
+}
+
+server {
+  listen 80;
+  server_name <%= nginx_server_name %>;
+  root <%= current_path %>/public;
+  try_files $uri/index.html $uri @unicorn_<%= application %>;
+
+  location @unicorn_<%= application %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://unicorn_<%= application %>;
+    # limit_req zone=one;
+    access_log <%= shared_path %>/log/nginx.access.log;
+    error_log <%= shared_path %>/log/nginx.error.log;
+  }
+
+  location ~ ^/(assets|images|javascripts|stylesheets|swfs|system)/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+    add_header Last-Modified "";
+    add_header ETag "";
+
+    open_file_cache max=1000 inactive=500s;
+    open_file_cache_valid 600s;
+    open_file_cache_errors on;
+    break;
+  }
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  location = /50x.html {
+    root html;
+  }
+
+  location = /404.html {
+    root html;
+  }
+
+  location @503 {
+    error_page 405 = /system/maintenance.html;
+    if (-f $document_root/system/maintenance.html) {
+      rewrite ^(.*)$ /system/maintenance.html break;
+    }
+    rewrite ^(.*)$ /503.html break;
+  }
+
+  if ($request_method !~ ^(GET|HEAD|PUT|POST|DELETE|OPTIONS)$ ){
+    return 405;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+
+  location ~ \.(php|html)$ {
+    return 405;
+  }
+}

data/lib/generators/capistrano/nginx_unicorn/templates/unicorn.rb.erb

@@ -0,0 +1,48 @@
+working_directory "<%= current_path %>"
+pid "<%= unicorn_pid %>"
+stderr_path "<%= unicorn_log %>"
+stdout_path "<%= unicorn_log %>"
+
+listen "/tmp/unicorn.<%= application %>.sock"
+worker_processes <%= unicorn_workers %>
+timeout 30
+
+preload_app true
+
+before_exec do |server|
+  ENV["BUNDLE_GEMFILE"] = "<%= current_path %>/Gemfile"
+end
+
+before_fork do |server, worker|
+  # Disconnect since the database connection will not carry over
+  if defined? ActiveRecord::Base
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  # Quit the old unicorn process
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if File.exists?(old_pid) && server.pid != old_pid
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+
+  if defined?(Resque)
+    Resque.redis.quit
+  end
+
+  sleep 1
+end
+
+after_fork do |server, worker|
+  # Start up the database connection again in the worker
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.establish_connection
+  end
+
+  if defined?(Resque)
+    Resque.redis = 'localhost:6379'
+  end
+end

data/lib/generators/capistrano/nginx_unicorn/templates/unicorn_init.erb

@@ -0,0 +1,84 @@
+#!/bin/sh
+### BEGIN INIT INFO
+# Provides: unicorn
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: Manage unicorn server
+# Description: Start, stop, restart unicorn server for a specific application.
+### END INIT INFO
+set -e
+
+# Feel free to change any of the following variables for your app:
+TIMEOUT=${TIMEOUT-60}
+APP_ROOT=<%= current_path %>
+PID=<%= unicorn_pid %>
+CMD="cd <%= current_path %>; bundle exec unicorn -D -c <%= unicorn_config %> -E production"
+AS_USER=<%= unicorn_user %>
+set -u
+
+OLD_PIN="$PID.oldbin"
+
+sig () {
+  test -s "$PID" && kill -$1 `cat $PID`
+}
+
+oldsig () {
+  test -s $OLD_PIN && kill -$1 `cat $OLD_PIN`
+}
+
+run () {
+  if [ "$(id -un)" = "$AS_USER" ]; then
+    eval $1
+  else
+    su -c "$1" - $AS_USER
+  fi
+}
+
+case "$1" in
+start)
+  sig 0 && echo >&2 "Already running" && exit 0
+  run "$CMD"
+  ;;
+stop)
+  sig QUIT && exit 0
+  echo >&2 "Not running"
+  ;;
+force-stop)
+  sig TERM && exit 0
+  echo >&2 "Not running"
+  ;;
+restart|reload)
+  sig USR2 && echo reloaded OK && exit 0
+  echo >&2 "Couldn't reload, starting '$CMD' instead"
+  run "$CMD"
+  ;;
+upgrade)
+  if sig USR2 && sleep 2 && sig 0 && oldsig QUIT
+  then
+    n=$TIMEOUT
+    while test -s $OLD_PIN && test $n -ge 0
+    do
+      printf '.' && sleep 1 && n=$(( $n - 1 ))
+    done
+    echo
+
+    if test $n -lt 0 && test -s $OLD_PIN
+    then
+      echo >&2 "$OLD_PIN still exists after $TIMEOUT seconds"
+      exit 1
+    fi
+    exit 0
+  fi
+  echo >&2 "Couldn't upgrade, starting '$CMD' instead"
+  run "$CMD"
+  ;;
+reopen-logs)
+  sig USR1
+  ;;
+*)
+  echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop|reopen-logs>"
+  exit 1
+  ;;
+esac

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-nginx-unicorn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Tkalin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: capistrano
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+description: Capistrano tasks for configuration and management nginx+unicorn combo
+  for zero downtime deployments of Rails applications. Configs can be copied to the
+  application using generators and easily customized.
+email:
+- itkalin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-nginx-unicorn.gemspec
+- lib/capistrano-nginx-unicorn.rb
+- lib/capistrano/nginx_unicorn/tasks.rb
+- lib/capistrano/nginx_unicorn/version.rb
+- lib/generators/capistrano/nginx_unicorn/USAGE
+- lib/generators/capistrano/nginx_unicorn/config_generator.rb
+- lib/generators/capistrano/nginx_unicorn/templates/nginx_conf.erb
+- lib/generators/capistrano/nginx_unicorn/templates/unicorn.rb.erb
+- lib/generators/capistrano/nginx_unicorn/templates/unicorn_init.erb
+homepage: https://github.com/ivalkeen/capistrano-nginx-unicorn
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2151274067948030801
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2151274067948030801
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Create and manage nginx+unicorn configs from capistrano
+test_files: []