easy-deployment 0.5.3 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog for easy-deployment
 
+## 0.6.0 (2013-11-05)
+
+Features:
+
+* Clearer error message, by checking and raises an exception if you haven't added an ssh-key as an identity (`ssh-add -L`) since this is a pre-requisite for ssh-agent forwarding.
+* Support for using nginx - intended to be along with a stand-alone ruby application server.
+
+Bugfixes:
+
+* Using builting `easy-reference` gem support now works with a custom bundler path if set.
+
 ## 0.5.3 (2013-09-05)
 
 Bugfixes:

data/README.md

@@ -31,7 +31,7 @@ Replace any missing configuration lines, and don't forget to remove the TODO tex
 
 ## Integration
 
-### Apache
+### Apache (via Passenger)
 
 Automatically setup an Apache V-Host, and reload apache2:
 
@@ -43,7 +43,7 @@ Add to deploy.rb
 
     require "easy/deployment/apache"
 
-Customise the vhost file within `config/deploy/<stage>/apache/<app>.conf`
+Customise the vhost file within `config/deploy/<stage>/apache.conf`
 If necessary, you can set the path to the apache2ctl binary via:
 
     set :apachectl_bin, "/usr/sbin/apachectl"
@@ -56,6 +56,26 @@ This assumes your deploy user has access to run the apachectl command with sudo
 
 Read more about passenger configuration on our wiki at https://github.com/AbleTech/easy-deployment/wiki/Common-passenger-config
 
+### Nginx (for use with standalone ruby app server)
+
+Add to deploy.rb
+
+    require "easy/deployment/nginx"
+
+Customise the site configuration within `config/deploy/<stage>/nginx.conf`
+Alter the paths used if required:
+
+    set :nginx_bin, "/etc/init.d/nginx" # This is the default, change if necessary
+    set :nginx_dir, "/etc/nginx"        # This is the default, change if necessary
+
+Like the apache integration, this requires sudo privileges to reload nginx:
+
+This example shows setting a passwordless sudo for a single user `deploy` for a limited set of commands controlling nginx
+
+    # Example sudoers file entries to grant deploy user passwordless sudo privileges to only these commands
+    deploy ALL=(ALL) NOPASSWD:/etc/init.d/nginx reload
+    deploy ALL=(ALL) NOPASSWD:/etc/init.d/nginx configtest
+
 ### Logrotate
 
 Automatically configure logrotate for your application logfile:

data/lib/easy-deployment/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Deployment
-    VERSION = "0.5.3"
+    VERSION = "0.6.0"
   end
 end

data/lib/easy/deployment/capistrano.rb

@@ -61,6 +61,29 @@ Capistrano::Configuration.instance(:must_exist).load do
         puts "Skipping copying of config/deploy/#{stage}/database.yml as the file is not present"
       end
     end
+
+    desc "[internal] Check ssh-key is added. ssh key forwarding deployments will fail without it"
+    # To disable this check set the variable `set :ignore_ssh_keys, true`
+    task :preflight_environment_check do
+      if fetch(:disable_agent_check, false) || !ssh_options[:forward_agent]
+        return true # Don't run the check if not using ssh agent forwarding
+      end
+      keys, status = run_local("ssh-add -L")
+      if fetch(:ignore_ssh_keys, false) || status != 0 || !(any_keys_registered = keys.chomp.split("\n").select {|line| line =~ /^ssh\-/ }.size > 0)
+        cmd_to_run = case RUBY_PLATFORM
+        when /darwin/
+          "ssh-add -K"
+        else
+          "ssh-add"
+        end
+        Capistrano::CLI.ui.say("<%= color('Error, no ssh-keys registered to be forwarded', :red) %>")
+        Capistrano::CLI.ui.say("<%= color('Run the following command to register your ssh-key then try again:', :red) %> #{cmd_to_run}")
+        Capistrano::CLI.ui.say("If you do not use ssh-agent-forwarding, put `set :disable_agent_check, true` in deploy.rb to disable this check")
+        exit(1)
+      else
+        Capistrano::CLI.ui.say("<%= color('ssh-keys are good to go captain!', :cyan) %>") if ENV['DEBUG']
+      end
+    end
   end
 
   namespace :tail do
@@ -91,9 +114,15 @@ Capistrano::Configuration.instance(:must_exist).load do
     run %Q(printf "#{version_info}" > #{release_path}/version.txt)
   end
 
+  before "deploy:update", "deploy:preflight_environment_check"
   after "deploy:update", "tag_release"
   after "deploy:update", "annotate_release"
 
+  def run_local(cmd, verbose = false)
+    result = `#{cmd}`
+    puts(result) if verbose
+    return [result, $?.exitstatus]
+  end
 
   # Helper function to stream output colorized by host
   def stream_output_from_command(cmd, continuous = false)

data/lib/easy/deployment/dbreference.rb

@@ -11,7 +11,7 @@ Capistrano::Configuration.instance(:must_exist).load do
                   else raise ArgumentError, "unknown migration target #{migrate_target.inspect}"
                   end
       
-      run "cd #{directory} && RAILS_ENV=#{rails_env} bundle exec rake reference:load"
+      run "cd #{directory} && RAILS_ENV=#{rails_env} #{fetch(:bundle_cmd, 'bundle')} exec rake reference:load"
     end
   end
 

data/lib/easy/deployment/nginx.rb

@@ -0,0 +1,35 @@
+# Define some defaults for Capistrano deploys.
+# To load this Capistrano configuration, require 'easy/deployment/nginx' from deploy.rb
+
+Capistrano::Configuration.instance(:must_exist).load do
+  def remote_file_exists?(full_path)
+    'true' ==  capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
+  end
+
+  set :nginx_bin, "/etc/init.d/nginx"
+  set :nginx_dir, "/etc/nginx"
+
+  namespace :nginx do
+    desc "Configure this site, test the configuration & gracefully reload the Nginx configuration"
+    task :configure_and_reload, :roles => :web, :except => { :no_release => true } do
+      configure
+      configtest
+      reload
+    end
+
+    desc "Configure this site with config/deploy/nginx.conf)"
+    task :configure, :roles => :web, :except => { :no_release => true } do
+      run "cp -f #{current_path}/config/deploy/#{stage}/nginx.conf #{nginx_dir}/sites-available/#{application}"
+      run "ln -fs #{nginx_dir}/sites-available/#{application} #{nginx_dir}/sites-enabled/#{application}"
+    end
+
+    [:stop, :start, :restart, :reload, :configtest].each do |action|
+      desc "#{action.to_s.capitalize} Nginx"
+      task action, :roles => :web do
+        run "sudo #{nginx_bin} #{action.to_s}"
+      end
+    end
+  end
+
+  before 'deploy:start', 'nginx:configure_and_reload'
+end

data/lib/easy/generators/stage_generator.rb

@@ -10,6 +10,7 @@ module Easy
       directory("stage", "config/deploy/#{name}")
       template("stage.rb.tt", "config/deploy/#{name}.rb")
       template("stage/apache.conf.tt", "config/deploy/#{name}/apache.conf")
+      template("stage/nginx.conf.tt", "config/deploy/#{name}/nginx.conf")
 
       # Ensure we have a config/environments/<env-name>.rb
       dest = "config/environments/#{name}.rb"

data/lib/easy/generators/templates/stage/nginx.conf.tt

@@ -0,0 +1,28 @@
+upstream <%= application_name %> {
+  server unix:///var/apps/<%= application_name %>/shared/sockets/<%= application_name %>.sock;
+}
+
+server {
+  listen 80;
+  server_name <%= name %>.<%= application_name %>.co.nz;
+  root /var/apps/<%= application_name %>/current/public;
+
+  location / {
+    proxy_pass http://<%= application_name %>; # match the name of upstream directive which is defined above
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  }
+
+  location ~* ^/assets/ {
+    # Per RFC2616 - 1 year maximum expiry
+    expires 1y;
+    add_header Cache-Control public;
+
+    # Some browsers still send conditional-GET requests if there's a
+    # Last-Modified header or an ETag header even if they haven't
+    # reached the expiry date sent in the Expires header.
+    add_header Last-Modified "";
+    add_header ETag "";
+    break;
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-deployment
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,7 @@ files:
 - lib/easy/deployment/dbreference.rb
 - lib/easy/deployment/logrotate.rb
 - lib/easy/deployment/nfs.rb
+- lib/easy/deployment/nginx.rb
 - lib/easy/deployment/niet.rb
 - lib/easy/deployment/performance.rb
 - lib/easy/deployment/whenever.rb
@@ -119,6 +120,7 @@ files:
 - lib/easy/generators/templates/stage.rb.tt
 - lib/easy/generators/templates/stage/apache.conf.tt
 - lib/easy/generators/templates/stage/logrotate.conf.tt
+- lib/easy/generators/templates/stage/nginx.conf.tt
 - spec/easy_deployment_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/AbleTech/easy-deployment