rubber 1.3.2 → 1.5.0

data/lib/generators/vulcanize/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Prepares the rails application for deploying with rubber by installing a
+    sample rubber configuration template
+
+Examples:
+    ./script/generate vulcanize minimal_mysql

data/lib/generators/vulcanize/templates/apache/config/rubber/deploy-apache.rb

@@ -0,0 +1,51 @@
+
+namespace :rubber do
+
+  namespace :apache do
+  
+    rubber.allow_optional_tasks(self)
+
+    after "rubber:install_packages", "rubber:apache:custom_install"
+
+    task :custom_install, :roles => :apache do
+      rsudo "a2dissite default"
+    end
+
+    # serial_task can only be called after roles defined - not normally a problem, but
+    # rubber auto-roles don't get defined till after all tasks are defined
+    on :load do
+      rubber.serial_task self, :serial_restart, :roles => :apache do
+        rsudo "service apache2 restart"
+      end
+      rubber.serial_task self, :serial_reload, :roles => :apache do
+        rsudo "if ! ps ax | grep -v grep | grep -c apache2 &> /dev/null; then service apache2 start; else service apache2 reload; fi"
+      end
+    end
+    
+    before "deploy:stop", "rubber:apache:stop"
+    after "deploy:start", "rubber:apache:start"
+    after "deploy:restart", "rubber:apache:reload"
+    
+    desc "Stops the apache web server"
+    task :stop, :roles => :apache do
+      rsudo "service apache2 stop; exit 0"
+    end
+    
+    desc "Starts the apache web server"
+    task :start, :roles => :apache do
+      rsudo "service apache2 start"
+    end
+    
+    desc "Restarts the apache web server"
+    task :restart, :roles => :apache do
+      serial_restart
+    end
+  
+    desc "Reloads the apache web server"
+    task :reload, :roles => :apache do
+      serial_reload
+    end
+  
+  end
+
+end

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/deflate.conf

@@ -0,0 +1,10 @@
+<%
+  @path = "/etc/apache2/mods-available/deflate.conf"
+  @post = "a2enmod deflate"
+%>
+<IfModule mod_deflate.c>
+  SetOutputFilter DEFLATE
+  BrowserMatch ^Mozilla/4 gzip-only-text/html
+  BrowserMatch ^Mozilla/4.0[678] no-gzip
+  BrowserMatch bMSIE !no-gzip !gzip-only-text/html
+</IfModule>

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/expires.conf

@@ -0,0 +1,9 @@
+<%
+  @path = "/etc/apache2/mods-available/expires.conf"
+  @post = "a2enmod expires"
+%>
+ExpiresActive On
+<FilesMatch "\.(ico|gif|jpe?g|png|js|css)$">
+  ExpiresDefault "access plus 1 year"
+</FilesMatch>
+

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/headers.conf

@@ -0,0 +1,6 @@
+<%
+  @path = "/etc/apache2/mods-available/headers.conf"
+  @post = "a2enmod headers"
+%>
+# Make sure proxies don't deliver the wrong content
+Header append Vary User-Agent env=!dont-vary

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/monit-apache.conf

@@ -0,0 +1,8 @@
+<%
+  @path = '/etc/monit/monit.d/monit-apache.conf'
+%>
+<% PIDFILE = "/var/run/apache2.pid" %>
+check process apache with pidfile <%= PIDFILE %>
+  group apache-<%= RUBBER_ENV %>
+  start program = "/usr/sbin/service apache2 start"
+  stop program = "/usr/sbin/service apache2 stop"

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/ports.conf

@@ -0,0 +1,8 @@
+<%
+  @path = '/etc/apache2/ports.conf'
+  # need to stop here so that apache will release port 80 before other
+  # services start and need to bind to it (e.g. haproxy)
+  @post = 'service apache2 stop'
+%>
+# empty ports file since other modules contribute which ports to open (vhosts)
+

data/lib/generators/vulcanize/templates/apache/config/rubber/role/apache/setenvif.conf

@@ -0,0 +1,52 @@
+<%
+  @path = "/etc/apache2/mods-available/setenvif.conf"
+  @post = "a2enmod setenvif"
+%>
+<IfModule mod_setenvif.c>
+
+#
+# The following directives modify normal HTTP response behavior to
+# handle known problems with browser implementations.
+#
+BrowserMatch "Mozilla/2" nokeepalive
+BrowserMatch "MSIE 4\.0b2;" nokeepalive downgrade-1.0 force-response-1.0
+BrowserMatch "RealPlayer 4\.0" force-response-1.0
+BrowserMatch "Java/1\.0" force-response-1.0
+BrowserMatch "JDK/1\.0" force-response-1.0
+
+#
+# The following directive disables redirects on non-GET requests for
+# a directory that does not include the trailing slash.  This fixes a 
+# problem with Microsoft WebFolders which does not appropriately handle 
+# redirects for folders with DAV methods.
+# Same deal with Apple's DAV filesystem and Gnome VFS support for DAV.
+#
+BrowserMatch "Microsoft Data Access Internet Publishing Provider" redirect-carefully
+BrowserMatch "MS FrontPage" redirect-carefully
+BrowserMatch "^WebDrive" redirect-carefully
+BrowserMatch "^WebDAVFS/1.[012]" redirect-carefully
+BrowserMatch "^gnome-vfs/1.0" redirect-carefully
+BrowserMatch "^XML Spy" redirect-carefully
+BrowserMatch "^Dreamweaver-WebDAV-SCM1" redirect-carefully
+
+SetEnvIf User-Agent "^websitepulse.*" no-log
+
+# Netscape 4.x has some problems...
+ BrowserMatch ^Mozilla/4 gzip-only-text/html
+
+  # Netscape 4.06-4.08 have some more problems
+  BrowserMatch ^Mozilla/4\.0[678] no-gzip
+
+  # MSIE masquerades as Netscape, but it is fine
+  BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
+
+  # Don't compress images
+  SetEnvIfNoCase Request_URI \
+      \.(?:gif|jpe?g|png)$ no-gzip dont-vary
+
+  # Don't compress downloads from files that are
+  # downloaded before they have been pushed to S3.
+  SetEnvIfNoCase Request_URI ^/assets/.* no-gzip dont-vary
+
+</IfModule>
+

data/lib/generators/vulcanize/templates/apache/config/rubber/role/web_tools/tools-apache-vhost.conf

@@ -0,0 +1,79 @@
+<%
+  @path = "/etc/apache2/sites-available/#{rubber_env.app_name}-tools"
+  @post = "a2enmod rewrite && a2enmod ssl && a2enmod proxy_http && a2enmod proxy_html && a2ensite #{rubber_env.app_name}-tools"
+%>
+
+Listen <%= rubber_env.web_tools_port %>
+<VirtualHost *:<%= rubber_env.web_tools_port %>>
+  ServerName      <%= rubber_env.full_host %>
+
+  RewriteEngine   on
+  RewriteCond     %{HTTPS} !=on
+  RewriteRule     ^/(.*)$ https://%{SERVER_NAME}:<%= rubber_env.web_tools_ssl_port %>/$1 [L,R]
+  RewriteLog      "/var/log/apache2/rewrite.log"
+</VirtualHost>
+
+Listen <%= rubber_env.web_tools_ssl_port %>
+<VirtualHost *:<%= rubber_env.web_tools_ssl_port %>>
+  ServerName      <%= rubber_env.full_host %>
+  DocumentRoot    /var/www
+
+  SSLEngine on
+  SSLOptions +FakeBasicAuth +ExportCertData +StrictRequire
+  SSLCertificateFile    /etc/ssl/certs/ssl-cert-snakeoil.pem
+  SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
+  # SSLCertificateFile <%= RUBBER_ROOT %>/config/<%= rubber_env.domain %>.crt
+  # SSLCertificateKeyFile <%= RUBBER_ROOT %>/config/<%= rubber_env.domain %>.key
+  # SSLCertificateChainFile /etc/ssl/certs/gd_intermediate_bundle.crt
+
+  <Location />
+    AuthType Basic
+    AuthName "Rubber Admin Tools"
+    AuthUserFile <%= RUBBER_ROOT %>/config/<%= rubber_env.app_name %>.auth
+    Require valid-user
+
+    Allow from all
+  </Location>
+
+  SetOutputFilter  proxy-html
+
+  <% rubber_instances.for_role('haproxy').each do |ic| %>
+    ProxyPass /haproxy_<%= ic.name %>/  http://<%= ic.full_name %>:<%= rubber_env.haproxy_admin_port %>/haproxy/
+    <Location /haproxy_<%= ic.name %>/>
+      ProxyPassReverse /
+      ProxyHTMLURLMap http://<%= ic.full_name %>:<%= rubber_env.haproxy_admin_port %>/ /haproxy_<%= ic.name %>/
+      ProxyHTMLURLMap /haproxy/ /haproxy_<%= ic.name %>/
+      ProxyHTMLURLMap /haproxy /haproxy_<%= ic.name %>/
+    </Location>
+  <% end %>
+
+  <% if cruise_host = rubber_instances.for_role('cruise').first %>
+    ProxyPass /cruise/  http://<%= cruise_host.full_name %>:<%= rubber_env.cruise_port %>/
+    <Location /cruise/>
+      ProxyPassReverse /
+      ProxyHTMLURLMap http://<%= cruise_host.full_name %>:<%= rubber_env.cruise_port %>/ /cruise/
+      ProxyHTMLURLMap / /cruise/
+    </Location>
+  <% end %>
+
+  <% rubber_instances.each do |ic| %>
+    ProxyPass /monit_<%= ic.name %>/ http://<%= ic.full_name %>:<%= rubber_env.monit_admin_port %>/
+    <Location /monit_<%= ic.name %>/>
+      ProxyPassReverse /
+      ProxyHTMLURLMap http://<%= ic.full_name %>:<%= rubber_env.monit_admin_port %>/ /monit_<%= ic.name %>/
+      ProxyHTMLURLMap / /monit_<%= ic.name %>/
+    </Location>
+  <% end %>
+
+  <% if resque_host = rubber_instances.for_role('resque_web').first %>
+    ProxyPass /resque/  http://<%= resque_host.full_name %>:<%= rubber_env.resque_web_port %>/
+    # special case, sinatra is using X-Forwarded-Host header to set redirects (Location header) to our external address, so we have to rewrite that to the right path
+    ProxyPassReverse /resque/ http://<%= rubber_env.full_host %>:<%= rubber_env.web_tools_ssl_port %>/
+    <Location /resque/>
+      ProxyPassReverse /
+      ProxyHTMLURLMap http://<%= resque_host.full_name %>:<%= rubber_env.resque_web_port %>/ /resque/
+      ProxyHTMLURLMap / /resque/
+    </Location>
+  <% end %>
+  
+</VirtualHost>

data/lib/generators/vulcanize/templates/apache/config/rubber/role/web_tools/tools-apache.auth

@@ -0,0 +1,7 @@
+<%
+  @path = "#{RUBBER_ROOT}/config/#{rubber_env.app_name}.auth"
+  user = rubber_env.web_tools_user || 'admin'
+  pass = rubber_env.web_tools_password || rand(1000000000).to_s
+%>
+
+<%= `htpasswd -nb #{user} #{pass}` %>

data/lib/generators/vulcanize/templates/apache/config/rubber/role/web_tools/tools-index.html

@@ -0,0 +1,34 @@
+<%
+  @path = "/var/www/index.html"
+%>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+		<title>Rubber Admin Tools</title>
+	</head>
+	<body>
+		<h1>Rubber Admin Tools</h1>
+		<ul>
+
+      <li><a href="/munin/">Munin</a></li>
+
+      <% if cruise_host = rubber_instances.for_role('cruise').first %>
+        <li><a href="http://<%= cruise_host %>/cruise/">CruiseControl</a></li>
+      <% end %>
+
+		  <% rubber_instances.for_role('haproxy').sort {|a,b| a.name <=> b.name }.each do |ic| %>
+		      <li><a href="/haproxy_<%= ic.name %>/">HAProxy <%= ic.name %></a></li>
+		  <% end %>
+
+      <% rubber_instances.sort {|a,b| a.name <=> b.name }.each do |ic| %>
+          <li><a href="/monit_<%= ic.name %>/">Monit <%= ic.name %></a></li>
+      <% end %>
+      
+      <% if resque_host = rubber_instances.for_role('resque_web').first %>
+          <li><a href="/resque/">Resque</a></li>
+      <% end %>
+
+		</ul>
+	</body>
+</html>

data/lib/generators/vulcanize/templates/apache/config/rubber/rubber-apache.yml

@@ -0,0 +1,6 @@
+
+roles:
+  apache:
+    packages: [apache2]
+  web_tools:
+    packages: [libapache2-mod-proxy-html]

data/lib/generators/vulcanize/templates/apache/templates.yml

@@ -0,0 +1 @@
+description: The apache module

data/lib/generators/vulcanize/templates/base/Capfile

@@ -0,0 +1,14 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+
+env = ENV['RUBBER_ENV'] ||= (ENV['RAILS_ENV'] || 'production')
+root = File.dirname(__FILE__)
+
+# this tries first as a rails plugin then as a gem
+$:.unshift "#{root}/vendor/plugins/rubber/lib/"
+require 'rubber'
+
+Rubber::initialize(root, env)
+require 'rubber/capistrano'
+
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy'

data/lib/generators/vulcanize/templates/base/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+env = ENV['RUBBER_ENV'] ||= (ENV['RAILS_ENV'] || 'development')
+RAILS_ENV = ENV['RAILS_ENV'] = env
+root = File.dirname(__FILE__)
+
+require 'rubber'
+
+Rubber::initialize(root, env)
+
+require 'rubber/tasks/rubber'
+
+task :console do
+  ARGV.clear
+  require "irb"
+  IRB.start
+end
+
+RAILS_TASKS

data/lib/generators/vulcanize/templates/base/config/deploy.rb

@@ -0,0 +1,55 @@
+# This is a sample Capistrano config file for rubber
+
+set :rails_env, RUBBER_ENV
+
+on :load do
+  set :application, rubber_env.app_name
+  set :runner,      rubber_env.app_user
+  set :deploy_to,   "/mnt/#{application}-#{RUBBER_ENV}"
+end
+
+# Use a simple directory tree copy here to make demo easier.
+# You probably want to use your own repository for a real app
+set :scm, :none
+set :repository, "."
+set :deploy_via, :copy
+
+# Easier to do system level config as root - probably should do it through
+# sudo in the future.  We use ssh keys for access, so no passwd needed
+set :user, 'root'
+set :password, nil
+
+# Use sudo with user rails for cap deploy:[stop|start|restart]
+# This way exposed services (mongrel) aren't running as a privileged user
+set :use_sudo, true
+
+# How many old releases should be kept around when running "cleanup" task
+set :keep_releases, 3
+
+# Lets us work with staging instances without having to checkin config files
+# (instance*.yml + rubber*.yml) for a deploy.  This gives us the
+# convenience of not having to checkin files for staging, as well as 
+# the safety of forcing it to be checked in for production.
+set :push_instance_config, RUBBER_ENV != 'production'
+
+# Allows the tasks defined to fail gracefully if there are no hosts for them.
+# Comment out or use "required_task" for default cap behavior of a hard failure
+rubber.allow_optional_tasks(self)
+# Wrap tasks in the deploy namespace that have roles so that we can use FILTER
+# with something like a deploy:cold which tries to run deploy:migrate but can't
+# because we filtered out the :db role
+namespace :deploy do
+  rubber.allow_optional_tasks(self)
+  tasks.values.each do |t|
+    if t.options[:roles]
+      task t.name, t.options, &t.body
+    end
+  end
+end
+
+# load in the deploy scripts installed by vulcanize for each rubber module
+Dir["#{File.dirname(__FILE__)}/rubber/deploy-*.rb"].each do |deploy_file|
+  load deploy_file
+end
+
+after "deploy", "deploy:cleanup"

data/lib/generators/vulcanize/templates/base/config/rubber/common/crontab

@@ -0,0 +1,22 @@
+<%
+  @read_cmd = 'crontab -l'
+  @write_cmd = 'crontab -'
+%>
+
+# cron clears out enviroment variables, so we need to add these in
+# to make sure we are running the correct ruby (rvm env vars, plus paths)
+<%- ENV.select {|k, v| k =~ /rvm|ruby|bundler|gem|path/i }.each do |k, v| -%>
+<%= k %>=<%= v %>
+<%- end -%>
+
+MAILTO=<%= rubber_env.admin_email %>
+# don't need to set RUBBER_ENV for each script since we set it for all cron here
+RUBBER_ENV=<%= RUBBER_ENV %>
+RAILS_ENV=<%= RUBBER_ENV %>
+RUBYOPT=rubygems
+
+# Roll all rails logs at midnight
+0 0 * * * LOG_DIR=<%= RUBBER_ROOT %>/log <%= RUBBER_ROOT %>/script/cron-rake rubber:rotate_logs
+
+# Automatically set the clock for all machines
+<%= rand(60) %> 4 * * * <%= RUBBER_ROOT %>/script/cron-sh -- ntpdate pool.ntp.org

data/lib/generators/vulcanize/templates/base/config/rubber/common/monit-postfix.conf

@@ -0,0 +1,8 @@
+<%
+  @path = '/etc/monit/monit.d/monit-postfix.conf'
+%>
+
+check process postfix with pidfile /var/spool/postfix/pid/master.pid
+  start program  "/usr/sbin/service postfix start"
+  stop program  "/usr/sbin/service postfix stop"
+  if 5 restarts within 5 cycles then timeout

data/lib/generators/vulcanize/templates/base/config/rubber/common/rubber.profile

@@ -0,0 +1,13 @@
+<%
+  @path = "/etc/profile.d/rubber.sh"
+  current_path = "/mnt/#{rubber_env.app_name}-#{RUBBER_ENV}/current" 
+%>
+
+# convenience to simply running rails console, etc with correct env
+export RUBBER_ENV=<%= RUBBER_ENV %>
+export RAILS_ENV=<%= RUBBER_ENV %>
+alias current="cd <%= current_path %>"
+alias release="cd <%= RUBBER_ROOT %>"
+
+# Always use rubygems
+export RUBYOPT="rubygems"

data/lib/generators/vulcanize/templates/base/config/rubber/deploy-setup.rb

@@ -0,0 +1,63 @@
+namespace :rubber do
+  namespace :base do
+  
+    rubber.allow_optional_tasks(self)
+
+    before "rubber:install_gems", "rubber:base:install_rvm"
+    task :install_rvm do
+      rubber.sudo_script "install_rvm", <<-ENDSCRIPT
+        if [[ `rvm --version 2> /dev/null` == "" ]]; then
+          wget -qNP /tmp http://rvm.beginrescueend.com/releases/rvm-install-head
+          bash /tmp/rvm-install-head
+          echo "#{rubber_env.rvm_prepare}" > /etc/profile.d/rvm.sh
+          echo "rvm_prefix=/usr/local" > /etc/rvmrc
+        fi
+      ENDSCRIPT
+    end
+
+    # ensure that the rvm profile script gets sourced by reconnecting
+    after "rubber:base:install_rvm" do
+      teardown_connections_to(sessions.keys)
+    end
+
+    after "rubber:base:install_rvm", "rubber:base:install_rvm_ruby"
+    task :install_rvm_ruby do
+      opts = get_host_options('rvm_ruby')
+      install_rvm_ruby_script = <<-ENDSCRIPT
+        rvm_ver=$1
+        if [[ ! `rvm list default 2> /dev/null` =~ "$rvm_ver" ]]; then
+          rvm install $rvm_ver
+          # need to set default after using once or something in env is broken
+          rvm use $rvm_ver &> /dev/null
+          rvm use $rvm_ver --default
+        fi
+      ENDSCRIPT
+      opts[:script_args] = '$CAPISTRANO:VAR$'
+      rubber.sudo_script "install_rvm_ruby", install_rvm_ruby_script, opts
+    end
+
+    after "rubber:install_packages", "rubber:base:configure_git" if scm == "git"
+    task :configure_git do
+      rubber.sudo_script 'configure_git', <<-ENDSCRIPT
+        if [[ "#{repository}" =~ "@" ]]; then
+          # Get host key for src machine to prevent ssh from failing
+          rm -f ~/.ssh/known_hosts
+          ! ssh -o 'StrictHostKeyChecking=no' #{repository.gsub(/:.*/, '')} &> /dev/null
+        fi
+      ENDSCRIPT
+    end
+    
+    # We need a rails user for safer permissions used by deploy.rb
+    after "rubber:install_packages", "rubber:base:custom_install"
+    task :custom_install do
+      rubber.sudo_script 'custom_install', <<-ENDSCRIPT
+        # add the user for running app server with
+        if ! id #{rubber_env.app_user} &> /dev/null; then adduser --system --group #{rubber_env.app_user}; fi
+          
+        # add ssh keys for root 
+        if [[ ! -f /root/.ssh/id_dsa ]]; then ssh-keygen -q -t dsa -N '' -f /root/.ssh/id_dsa; fi
+      ENDSCRIPT
+    end
+
+  end
+end