recipiez 0.0.1

data/recipes/deployment_recipiez.rb

@@ -0,0 +1,295 @@
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+require 'basecamp_notifier'
+require 'activecollab_notifier'
+
+# A collection of reusable deployment tasks.
+# Hook them into your deploy script with the *after* function.
+# Author: Alastair Brunton
+
+namespace :recipiez do
+  
+  desc "generate config file used for db syncing etc"
+  task :generate_config do
+    if File.exists?('config/recipiez.yml')
+      puts "Skipping config generation as one exists"
+    else
+      `cp vendor/plugins/deployment_recipiez/recipes/templates/recipiez.yml.example config/recipiez.yml`
+    end
+  end
+  
+  
+  desc "Rename db file for deployment."
+  task :rename_db_file do
+    run "cp #{release_path}/config/database.#{rails_env} #{release_path}/config/database.yml"
+  end
+
+  desc "Rename db file for deployment."
+  task :rename_settings_file do
+    run "cp #{release_path}/config/settings.yml.#{rails_env} #{release_path}/config/settings.yml"
+  end
+
+  # You need to add the below line to your deploy.rb
+  # set :basecamp_auth, {:username => 'robot', :domain => 'ifo.projectpath.com',
+  #                         :password => 'robot', :project_id => 828898,
+  #                         :category_id => 15509}
+  desc "Update basecamp with information of the deployment."
+  task :update_basecamp do
+    basecamp_notifier = BasecampNotifier.new(application, rails_env,
+    basecamp_auth, current_revision, get_rev_log)
+    basecamp_notifier.notify
+  end
+  
+  # You need to add the below line to your deploy.rb
+  # set :activecollab_options, {:base_url => "http://projects.bla.com", 
+  #      :project_id => 5, :ticket_id => 10, 
+  #      :username => 'bla', :password => 'bla'}
+  desc "Update activecollab with information of the deployment."
+  task :update_activecollab do
+    notifier = ActiveCollab::Notifier.new(activecollab_options)
+    notifier.say(get_rev_log)
+  end
+
+  desc "This gets the revision log"
+  task :get_rev_log do
+    grab_revision_log
+  end
+
+  desc "Restart passenger application instance"
+  task :restart_passenger do
+    run "touch #{current_release}/tmp/restart.txt"
+  end
+
+
+  desc "Restart mongrel."
+  task :single_mongrel_restart do
+    use_sudo == true ? command = "sudo" : command = "run"
+    begin
+      eval("#{command} \"mongrel_rails stop -c #{release_path}\"")
+    rescue
+      puts "**** Error ******: Problem stopping mongrel."
+    end
+    run "sleep 3"
+    eval("#{command} \"mongrel_rails start -c #{release_path} -e #{rails_env} -p #{mongrel_port} -d\"")
+  end
+
+  desc "Stop the nginx webserver."
+  task :nginx_stop do
+    sudo '/etc/init.d/nginx stop'
+  end
+
+  desc "Start the nginx webserver"
+  task :nginx_start do
+    sudo '/etc/init.d/nginx start'
+  end
+
+  desc "Restart the nginx webserver"
+  task :nginx_restart do
+    nginx_stop
+    nginx_start
+  end
+
+  desc "Change permissions for apache cgi"
+  task :change_public_perms do
+    run "chmod -R 755 #{release_path}/public"
+  end
+
+  desc "Restart lighttpd"
+  task :lighttpd_restart do
+    run "#{lighttpd_ctl_path} restart &"
+  end
+
+
+  namespace :db do
+
+    desc "Dump database, copy it across and restore locally."
+    task :pull do
+      set_variables_from_yaml
+      archive = generate_archive(application)
+      filename = get_filename(application)
+      cmd = "mysqldump --opt --skip-add-locks -u #{db_user} "
+      cmd += " -p#{db_password} "
+      cmd += "#{database_to_dump} > #{archive}"
+      result = run(cmd)
+
+      cmd = "rsync -av -e \"ssh -p #{ssh_options[:port]} #{get_identities}\" #{user}@#{roles[:db].servers.first}:#{archive} #{dump_dir}#{filename}"
+      puts "running #{cmd}"
+      result = system(cmd)
+      puts result
+      run "rm #{archive}"
+
+      puts "Restoring db"
+      begin
+        `mysqladmin -u#{db_local_user} -p#{db_local_password} --force drop #{db_dev}`
+      rescue
+        # do nothing
+      end
+      `mysqladmin -u#{db_local_user} -p#{db_local_password} --force create #{db_dev}`
+      `cat #{dump_dir}#{get_filename(application)} | mysql -u#{db_local_user} -p#{db_local_password} #{db_dev}`
+      puts "All done!"
+    end
+
+    desc "Push up the db"
+    task :push do
+      set_variables_from_yaml
+      filename = get_filename(application)
+      cmd = "mysqldump --opt --skip-add-locks -u #{db_local_user} "
+      cmd += " -p#{db_local_password} "
+      cmd += "#{db_dev} > #{dump_dir}#{filename}"
+      puts "Running #{cmd}"
+      `#{cmd}`
+      put File.read("#{dump_dir}#{filename}"), filename
+      logger.debug 'Dropping db'
+      begin
+        run "mysqladmin -u#{db_user} -p#{db_password} --force drop #{database_to_dump}"
+      rescue
+        # do nothing
+      end
+      logger.debug 'Creating db'
+      run "mysqladmin -u#{db_user} -p#{db_password} --force create #{database_to_dump}"
+      logger.debug 'Restoring db'
+      run "cat #{filename} | mysql -u#{db_user} -p#{db_password} #{database_to_dump}"
+      run "rm #{filename}"
+    end
+
+
+    desc "Create database, user and priviledges NB: Requires db_root_password"
+    task :setup do
+      set_variables_from_yaml
+      sudo "mysqladmin -u root -p#{db_root_password} create #{database_to_dump}"
+      run mysql_query("CREATE USER '#{db_user}'@'localhost' IDENTIFIED BY '#{db_password}';")
+      grant_sql = "GRANT ALL PRIVILEGES ON #{database_to_dump}.* TO #{db_user}@localhost IDENTIFIED BY '#{db_password}'; FLUSH PRIVILEGES;"
+      run mysql_query(grant_sql)
+    end
+
+  end
+
+  desc "pull db and system files"
+  task :pull_remote do
+    db::pull
+    rsync::pull
+  end
+
+
+  namespace :rsync do
+
+    desc "Rsync the shared system dir"
+    task :pull do
+      `rsync -av -e \"ssh -p #{ssh_options[:port]} #{get_identities}\" #{user}@#{roles[:db].servers.first}:#{shared_path}/system/ public/system/`
+    end
+
+    desc "Sync up the system directory"
+    task :push do
+      system "rsync -vrz -e \"ssh -p #{ssh_options[:port]} #{get_identities}\" --exclude='.DS_Store' public/system/ #{user}@#{roles[:db].servers.first}:#{shared_path}/system"
+    end
+
+  end
+  
+  desc "Install bundler"
+  task :bundler do
+    sudo "gem install bundler --no-rdoc --no-ri"
+  end
+  
+  desc "Install libxml and headers"
+  task :libxml do
+    sudo "apt-get install -y libxml2 libxml2-dev libxslt1-dev"
+  end
+  
+  
+  desc "Setup /var/www/apps"
+  task :app_dir do
+    sudo <<-CMD 
+      if [ ! -d "/var/www/apps" ]; then
+        sudo mkdir -p /var/www/apps
+      fi
+    CMD
+    sudo "chown -R #{user}:#{user} /var/www/apps"
+  end
+    
+  desc "Add user to www-data group"
+  task :www_group do
+    sudo "sudo usermod -a -G www-data #{user}"
+    sudo "sudo usermod -a -G #{user} www-data"
+  end
+
+  desc "Setup the deployment directories and fix permissions"
+  task :setup do
+    deploy::setup
+    sudo "chown -R #{user}:#{user} #{deploy_to}"
+  end
+
+end
+
+namespace :deploy do
+  task :restart do
+    # override this task
+  end
+end
+
+# Internal helper to shell out and run a query. Doesn't select a database.
+def mysql_query(sql)
+  "/usr/bin/mysql -u root -p#{db_root_password} -e \"#{sql}\""
+end
+
+
+
+def generate_archive(name)
+  '/tmp/' + get_filename(name)
+end
+
+def get_filename(name)
+  name.sub('_', '.') + '.sql'
+end
+
+
+def grab_revision_log
+  case scm.to_sym
+  when :git
+    %x( git log --pretty=format:"* #{"[%h, %an] %s"}" #{previous_revision}..#{current_revision} )
+  when :subversion
+    format_svn_log current_revision, previous_revision
+  end
+end
+
+def get_identities
+  op = ''
+  if ssh_options[:keys] && ssh_options[:keys].any?
+    ssh_options[:keys].each do |priv_key|
+      if File.exists?(priv_key)
+        op += "-i #{priv_key} "
+      end
+    end
+  end
+  op
+end
+
+# Using REXML as it comes bundled with Ruby, would love to use Hpricot.
+# <logentry revision="2176">
+# <author>jgoebel</author>
+# <date>2006-09-17T02:38:48.040529Z</date>
+# <msg>add delete link</msg>
+# </logentry>
+def format_svn_log(current_revision, previous_revision)
+  require 'rexml/document'
+  begin
+    xml = REXML::Document.new(%x( svn log --xml --revision #{current_revision}:#{previous_revision} ))
+    xml.elements.collect('//logentry') do |logentry|
+      "* [#{logentry.attributes['revision']}, #{logentry.elements['author'].text}] #{logentry.elements['msg'].text}"
+    end.join("\n")
+  rescue
+    %x( svn log --revision #{current_revision}:#{previous_revision} )
+  end
+end
+
+
+def set_variables_from_yaml
+  
+  unless File.exists?("config/recipiez.yml")
+    raise StandardError, "You need a config/recipiez.yml file which defines the database syncing settings. Run recipiez:generate_config"
+  end
+  
+  global = YAML.load_file("config/recipiez.yml")
+  app_config = global[rails_env]
+  app_config.each_pair do |key, value|
+    set key.to_sym, value
+  end
+end

data/recipes/logrotate.rb

@@ -0,0 +1,9 @@
+namespace :logrotate do
+  desc "Configures logrotate for the application"
+  task :configure, :roles => :app do
+    generated = render('logrotate', binding)
+    puts generated
+    put generated, "#{application}"
+    sudo "mv #{application} /etc/logrotate.d/#{application}"
+  end
+end

data/recipes/monit.rb

@@ -0,0 +1,46 @@
+namespace :monit do
+  
+  desc "configures monit for nginx"
+  task :nginx, :roles => :web do
+    put render('nginx_monit', binding), "nginx.conf"
+    sudo "mv nginx.conf /etc/monit/conf.d/nginx.conf"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  desc "configures monit for thin"
+  task :thin, :roles => :web do
+    put render('thin_monit', binding), "#{application}.conf"
+    sudo "mv #{application}.conf /etc/monit/conf.d/#{application}.conf"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  desc "configures monit for apache"
+  task :apache, :roles => :web do
+    put render('apache_monit', binding), "apache_monit.conf"
+    sudo "mv apache_monit.conf /etc/monit/conf.d/apache_monit.conf"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  desc "configures monit for mysql"
+  task :mysql, :roles => :db do
+    put render("mysql_monit", binding), "mysql_monit.conf"
+    sudo "mv mysql_monit.conf /etc/monit/conf.d/mysql_monit.conf"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  desc "configures monit for mysql"
+  task :sshd, :roles => :web do
+    put render("sshd_monit", binding), "sshd_monit.conf"
+    sudo "mv sshd_monit.conf /etc/monit/conf.d/sshd_monit.conf"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  task :configure, :roles => :web do
+    put render("monit_config", binding), 'monitrc'
+    sudo "mv monitrc /etc/monit/monitrc"
+    sudo "chown root:root /etc/monit/monitrc"
+    sudo "/etc/init.d/monit restart"
+  end
+  
+  
+end

data/recipes/nginx.rb

@@ -0,0 +1,35 @@
+namespace :nginx do
+  desc "configures a vhost for the app, needs - num_servers, start_port"
+  task :configure, :roles => :web do
+    put render("nginx_vhost", binding), "#{application}.conf"
+    sudo "mv #{application}.conf /etc/nginx/sites-available/#{application}.conf"
+    begin
+      sudo "ln -s /etc/nginx/sites-available/#{application}.conf /etc/nginx/sites-enabled/#{application}.conf"
+    rescue
+      # do nothing
+    end
+    
+    begin
+      stop
+    rescue
+      # do nothing
+    end
+
+    begin
+      start
+    rescue
+      # do nothing
+    end
+  end
+
+  desc "Starts Nginx webserver"
+  task :start, :roles => :web do
+    sudo "/etc/init.d/nginx start"
+  end
+
+  desc "Stops Nginx webserver"
+  task :stop, :roles => :web do
+    sudo "/etc/init.d/nginx stop"
+  end
+
+end

data/recipes/render.rb

@@ -0,0 +1,6 @@
+require 'erb'
+
+def render(file, binding)
+  template = File.read("#{File.dirname(__FILE__)}/templates/#{file}.erb")
+  result = ERB.new(template).result(binding)
+end

data/recipes/templates/apache_monit.erb

@@ -0,0 +1,11 @@
+check process httpd with pidfile /var/run/apache2.pid
+   group www-data
+   start program  "/etc/init.d/apache2 start"
+   stop program  "/etc/init.d/apache2 stop"
+   if failed host localhost port 80 protocol http
+      and request "/" then alert
+   if cpu is greater than 60% for 2 cycles then alert
+   if cpu > 80% for 5 cycles then restart
+   if children > 250 then restart
+   if loadavg(5min) greater than 10 for 8 cycles then alert
+   if 3 restarts within 5 cycles then timeout

data/recipes/templates/logrotate.erb

@@ -0,0 +1,9 @@
+<%= current_path %>/log/*.log {
+daily
+missingok
+rotate 14
+compress
+delaycompress
+notifempty
+copytruncate
+}

data/recipes/templates/monit_config.erb

@@ -0,0 +1,7 @@
+set daemon  60
+set logfile syslog facility log_daemon
+set mailserver localhost
+set mail-format { from: <%= monit_from_address %> }
+set alert <%= monit_alert_address %>
+
+include /etc/monit/conf.d/*

data/recipes/templates/mysql_monit.erb

@@ -0,0 +1,6 @@
+check process mysql with pidfile /var/run/mysqld/mysqld.pid
+   group database
+   start program = "/etc/init.d/mysql start"
+   stop program = "/etc/init.d/mysql stop"
+   if failed host 127.0.0.1 port 3306 then restart
+   if 5 restarts within 5 cycles then timeout

data/recipes/templates/nginx_monit.erb

@@ -0,0 +1,9 @@
+# nginx
+check process nginx with pidfile /var/run/nginx.pid
+           start program = "/etc/init.d/nginx start"
+           stop  program = "/etc/init.d/nginx stop"
+           if failed host 127.0.0.1 port <%= web_port ? web_port : 80 %> then restart
+           if cpu is greater than 40% for 2 cycles then alert
+           if cpu > 80% for 5 cycles then restart
+           if 10 restarts within 10 cycles then timeout
+           group www

data/recipes/templates/nginx_vhost.erb

@@ -0,0 +1,135 @@
+upstream <%= application %> {
+        <% i = 0 %>
+        <% num_servers.times do %>
+        server 127.0.0.1:<%= start_port.to_i + i %>;
+        <% i += 1 %>
+        <% end %>
+    }
+
+server {
+
+            listen <%= web_port ? web_port : 80 %>;
+            server_name  www.<%= domain %>;
+            rewrite ^(.*) http://<%= domain %>$1 permanent;
+           }
+
+
+server {
+
+            listen <%= web_port ? web_port : 80 %>;
+            server_name <%= domain %>;
+
+            access_log <%= current_path %>/log/access.log;
+            error_log <%= current_path %>/log/error.log;
+
+            root   <%= current_path %>/public/;
+            index  index.html;
+            client_max_body_size 50M;
+            
+            # 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/maintenance.html) {
+              rewrite ^(.*)$ /maintenance.html last;
+              break;
+            }
+            
+
+            location / {
+                          proxy_set_header  X-Real-IP  $remote_addr;
+                          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 rewrite tests on it
+                          if (-f $request_filename) {
+                            break;
+                          }
+                          
+                          if (-f $request_filename/index.html) {
+                                           rewrite (.*) $1/index.html break;
+                          }
+
+                          if (-f $request_filename.html) {
+                                           rewrite (.*) $1.html break;
+                          }
+
+                          if (!-f $request_filename) {
+                                           proxy_pass http://<%= application %>;
+                                           break;
+                          }
+            }
+            
+            error_page   500 502 503 504  /50x.html;
+            location = /50x.html {
+              root   html;
+            }
+
+}
+
+
+<% if ssl && ssl == 'on' %>
+  server {
+              listen   443;
+              ssl on;
+              
+              ssl_certificate <%= ssl_cert %>;
+              ssl_certificate_key <%= ssl_key %>;
+              
+
+              access_log <%= current_path %>/log/access.log;
+              error_log <%= current_path %>/log/error.log;
+
+              root   <%= current_path %>/public/;
+              index  index.html;
+              client_max_body_size 50M;
+              
+              
+              # 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/maintenance.html) {
+                rewrite ^(.*)$ /maintenance.html last;
+                break;
+              }
+              
+              
+
+              location / {
+                            proxy_set_header  X-Real-IP  $remote_addr;
+                            proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+                            proxy_set_header Host $http_host;
+                            proxy_redirect off;
+                            proxy_set_header X-FORWARDED_PROTO https;
+                            proxy_max_temp_file_size 0;
+
+                            # If the file exists as a static file serve it directly without
+                            # running all the other rewrite tests on it
+                            if (-f $request_filename) {
+                              break;
+                            }
+
+                            if (-f $request_filename/index.html) {
+                                             rewrite (.*) $1/index.html break;
+                            }
+
+                            if (-f $request_filename.html) {
+                                             rewrite (.*) $1.html break;
+                            }
+
+                            if (!-f $request_filename) {
+                                             proxy_pass http://<%= application %>;
+                                             break;
+                            }
+              }
+
+              error_page   500 502 503 504  /50x.html;
+              location = /50x.html {
+                root   html;
+              }
+
+  }
+<% end %>
+

data/recipes/templates/passenger_vhost.erb

@@ -0,0 +1,13 @@
+<VirtualHost *:80>
+ServerName <%= app_domain %>
+ServerAlias www.<%= app_domain %>
+
+DocumentRoot <%= deploy_to %>/current/public
+RailsEnv <%= rails_env %>
+
+<Directory <%= deploy_to %>/current/public>
+  AllowOverride all
+  Options -MultiViews
+</Directory>
+
+</VirtualHost>

data/recipes/templates/php_handler.erb

@@ -0,0 +1 @@
+AddHandler application/x-httpd-php .php

data/recipes/templates/php_vhost.erb

@@ -0,0 +1,12 @@
+<VirtualHost *:<%= apache_port %>>
+ServerName <%= app_domain %>
+ServerAlias www.<%= app_domain %>
+
+DocumentRoot <%= deploy_to %>/current/public
+
+<Directory <%= deploy_to %>/current/public>
+  AllowOverride all
+  Options -MultiViews
+</Directory>
+
+</VirtualHost>

data/recipes/templates/recipiez.yml.example

@@ -0,0 +1,8 @@
+production:
+    db_user: root
+    db_password: password
+    db_local_user: root
+    db_local_password: password
+    dump_dir: /tmp/
+    database_to_dump: dbname_production
+    db_dev: dbname_development

data/recipes/templates/sshd_monit.erb

@@ -0,0 +1,5 @@
+check process sshd with pidfile /var/run/sshd.pid
+   start program  "/etc/init.d/ssh start"
+   stop program  "/etc/init.d/ssh stop"
+   if failed port <%= ssh_options[:port] %> protocol ssh then restart
+   if 5 restarts within 5 cycles then timeout

data/recipes/templates/thin_monit.erb

@@ -0,0 +1,16 @@
+<% i = 0 %>
+<% start_port.upto(start_port + (num_servers - 1)) do |port| %>
+
+check process <%= application %>_<%= port %>
+    with pidfile <%= shared_path %>/pids/thin.<%= port %>.pid
+    start program = "/usr/bin/ruby /usr/bin/thin start -C /etc/thin/<%= application %>.yml --only <%= i %>"
+    stop program = "/usr/bin/ruby /usr/bin/thin stop -C /etc/thin/<%= application %>.yml --only <%= i %>"
+    if totalmem > 120.0 MB for 5 cycles then restart
+    if failed port <%= port %> then restart
+    if cpu usage > 95% for 3 cycles then restart
+    if 5 restarts within 5 cycles then timeout
+    if failed host 127.0.0.1 port <%= port %> protocol http
+        and request "/" then alert
+    group <%= application %>
+    <% i += 1 %>
+<% end %>

data/recipes/thin.rb

@@ -0,0 +1,37 @@
+namespace :thin do
+  
+  desc "configures thin, requires num_servers and start_port"
+  task :configure, :roles => :app do
+    sudo "thin config -C /etc/thin/#{application}.yml -c #{current_path}  --servers #{num_servers} -e #{rails_env} --port #{start_port}"
+  end
+  
+  desc "configures thin with rackup eg. Sinatra. Requires thin_port, rack_env"
+  task :configure_rack, :roles => :app do
+    sudo "thin config -C /etc/thin/#{application}.yml -c #{current_path} --servers #{num_servers} --port #{start_port} -e #{rack_env} -R #{current_path}/config.ru"
+  end
+  
+  desc "install thin"
+  task :install, :roles => :app do
+    sudo "gem install thin"
+    sudo "thin install"
+    sudo "/usr/sbin/update-rc.d -f thin defaults"
+  end
+    
+  desc "start thin"
+  task :start, :roles => :app do
+    sudo "/etc/init.d/thin start"
+    sudo "/usr/bin/ruby /usr/bin/thin start -C /etc/thin/#{application}.yml"
+  end
+  
+  desc "stop thin"
+  task :stop, :roles => :app do
+    sudo "/usr/bin/ruby /usr/bin/thin stop -C /etc/thin/#{application}.yml"
+  end
+  
+  desc "restart thin" 
+  task :restart, :roles => :app do
+    sudo "/usr/bin/ruby /usr/bin/thin restart -C /etc/thin/#{application}.yml"
+  end
+
+  
+end