hubertlepicki-cap-recipes 0.2.8

data/README.textile

@@ -0,0 +1,153 @@
+h1. cap-recipes
+
+h2. INSTALLATION
+
+ * gem sources -a http://gems.github.com/
+ * sudo gem install nesquena-cap-recipes
+
+h2. DESCRIPTION
+
+This is a collection of capistrano recipes which will grow to encompass many useful recipes. The intended use for these recipes is for a ruby project which deploys using Phusion Passenger and caches using memcached. In addition, recipes for the management of various daemon processes will be included as needed. Feel free to contribute to this and make it better!
+
+Currently included:
+
+ * Phusion Passenger (Setup and Deployment)
+ * Apache Server
+ * Memcache Process
+ * Juggernaut Daemon
+ * Backgroundrb Server
+ 
+h2. SYNOPSIS
+
+To include any of these into your deploy.rb configuration file for Capistrano:
+  
+   require 'cap_recipes/tasks/passenger'
+   require 'cap_recipes/tasks/apache'
+   require 'cap_recipes/tasks/backgroundrb'
+   require 'cap_recipes/tasks/juggernaut'
+   require 'cap_recipes/tasks/memcache'
+   
+Or to include and activate all of them:
+
+   require 'cap_recipes'
+
+h2. USAGE
+
+h3. Passenger
+
+h4. Configuration
+
+ * base_ruby_path - the base path to the ruby installation [default: "/usr"]
+
+The following files and folders are expected to exist:
+ 
+ * "#{base_ruby_path}/lib/ruby"
+ * "#{base_ruby_path}/bin/ruby"
+ * "#{base_ruby_path}/bin/gem"
+
+h4. Tasks
+
+  deploy
+    :start
+    :stop
+    :restart
+    :with_migrations
+    :copy_config
+    :tail
+  install
+    :passenger
+    :gems
+  sweep
+    :cache
+    :log
+    :gems
+    
+h3. Apache
+
+h4. Configuration
+
+  * apache_init_path - the path to the init.d apache file [default: '/etc/init.d/apache2']
+
+h4. Tasks
+
+  apache
+    :stop
+    :start
+    :restart
+    :install
+  
+h3. Backgroundrb
+
+h4. Configuration
+
+  * backgroundrb_log - the path to the backgroundrb log file
+  * backgroundrb_host - the background host machine ip [default: 'localhost']
+  * backgroundrb_env - the rails environment [default: 'production']
+
+h4. Tasks
+
+  tasks:
+    backgroundrb
+      :stop
+      :start
+      :restart
+      :copy_config
+      :tail
+
+h3. Juggernaut
+
+h4. Configuration
+
+  * juggernaut_config - path to juggernaut config file [default: "#{current_path}/config/juggernaut.yml"]
+  * juggernaut_pid - path to juggernaut pid file [default: "#{current_path}/tmp/pids/juggernaut.pid"]
+  * juggernaut_log - path to juggernaut log file [default: "#{current_path}/log/juggernaut.log"]
+
+h4. Tasks
+
+  tasks:
+    juggernaut
+      :start
+      :stop
+      :restart
+      :copy_config
+      :tail
+      
+h3. Memcache
+
+h4. Configuration
+
+  * memcache_init_path - path to memcache config file [default: "/etc/init.d/memcache"]
+
+h4. Tasks
+
+  tasks:
+    memcache
+      :start
+      :stop
+      :restart
+      :install
+
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nathan Esquenazi
+
+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/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+ 
+GEM = "cap-recipes"
+GEM_VERSION = "0.2.8"
+SUMMARY = "Collection of capistrano recipes for apache, passenger, memcache, juggernaut and backgroundrb"
+AUTHOR = "Nathan Esquenazi"
+EMAIL = "nesquena@gmail.com"
+HOMEPAGE = "http://caprecipes.rubyforge.org"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*'].to_a
+  
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  s.rubyforge_project = GEM # GitHub bug, gem isn't being build when this miss
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+  
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/cap_recipes.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'cap_recipes/**/*.rb')].sort.each { |lib| require lib }

data/lib/cap_recipes/tasks/apache.rb

@@ -0,0 +1,38 @@
+Capistrano::Configuration.instance(true).load do
+
+  set :apache_init_path, "/etc/init.d/apache2"
+
+  # ===============================================================
+  # SERVER MANAGEMENT
+  # ===============================================================
+
+  namespace :apache do
+    desc "Stops the apache web server"
+    task :stop, :roles => :web do
+      puts "Stopping the apache server"
+      sudo "#{apache_init_path} stop"
+    end
+
+    desc "Starts the apache web server"
+    task :start, :roles => :web do
+      puts "Starting the apache server"
+      sudo "#{apache_init_path} start"
+    end
+
+    desc "Restarts the apache web server"
+    task :restart, :roles => :web do
+      puts "Restarting the apache server"
+      sudo "#{apache_init_path} restart"
+    end
+
+    # ===============================================================
+    # INSTALLATION
+    # ===============================================================
+
+    desc 'Installs apache 2 and development headers to compile passenger'
+    task :install, :roles => :web do
+      puts 'Installing apache 2'
+      sudo 'apt-get install apache2 apache2.2-common apache2-mpm-prefork apache2-utils libexpat1 ssl-cert libapr1 libapr1-dev   libaprutil1 libmagic1 libpcre3 libpq5 openssl apache2-prefork-dev -y'
+    end
+  end
+end

data/lib/cap_recipes/tasks/backgroundrb.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+
+Capistrano::Configuration.instance(true).load do
+  set :backgroundrb_host, 'localhost'
+  set :backgroundrb_env , 'production'
+  
+  namespace :backgroundrb do   
+    # ===============================================================
+    # PROCESS MANAGEMENT
+    # ===============================================================  
+    
+    desc "Stops the backgroundrb worker processes"
+    task :stop, :roles => :app do
+      run "cd #{current_path} && #{sudo} ruby script/backgroundrb stop -e #{backgroundrb_env}"
+    end
+    
+    desc "Starts the backgroundrb worker processes"
+    task :start, :roles => :app do
+      run "cd #{current_path} && #{sudo} nohup ruby script/backgroundrb start -e #{backgroundrb_env}"
+    end
+    
+    desc "Restarts a running backgroundrb server."
+    task :restart, :roles => :app do
+      backgroundrb.stop
+      sleep(5)  # sleep for 5 seconds to make sure the server has mopped up everything
+      backgroundrb.start
+    end
+    
+    # ===============================================================
+    # PROCESS CONFIGURATION
+    # ===============================================================  
+    
+    desc "Creates configuration file for the backgroundrb server"
+    task :configure, :roles => :app do
+      config = { :backgroundrb => {:ip => backgroundrb_host, :port => backgroundrb_port, :environment => backgroundrb_env} }
+      backgroundrb_yml = config.to_yaml
+      
+      run "if [ ! -d #{shared_path}/config ]; then mkdir #{shared_path}/config; fi"
+      put(backgroundrb_yml, "#{shared_path}/config/backgroundrb.yml", :mode => 0644)
+    end
+    
+    # ===============================================================
+    # FILE MANAGEMENT
+    # ===============================================================  
+    
+    desc "Copies the shared/config/backgroundrb yaml to release/config/"
+    task :copy_config, :roles => :app do
+      on_rollback {
+        puts "***** File shared/config/backgroundrb.yml is missing. Make sure you have run backgroundrb:configure first. *****"
+      }
+      
+      run "ln -s #{shared_path}/config/backgroundrb.yml #{release_path}/config/backgroundrb.yml"
+    end
+    
+    desc "Displays the backgroundrb log from the server"
+    task :tail do
+      stream "tail -f #{shared_path}/log/backgroundrb_#{backgroundrb_port}.log" 
+    end
+    
+    desc "Repair permissions to allow user to perform all actions"
+    task :repair_permissions, :roles => :app do
+      puts "Applying correct permissions to allow for proper command execution"
+      sudo "chown -R #{user}:#{user} #{current_path}"
+      sudo "chown -R #{user}:#{user} #{current_path}/tmp"
+    end
+  end
+  
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================  
+  
+  after "deploy:update_code"   , "backgroundrb:copy_config"
+  after "deploy:restart"       , "backgroundrb:restart"
+  after "backgroundrb:restart" , "backgroundrb:repair_permissions"
+end

data/lib/cap_recipes/tasks/juggernaut.rb

@@ -0,0 +1,50 @@
+Capistrano::Configuration.instance(true).load do
+  set :juggernaut_config, "#{current_path}/config/juggernaut.yml"
+  set :juggernaut_pid, "#{current_path}/tmp/pids/juggernaut.pid"
+  set :juggernaut_log, "#{current_path}/log/juggernaut.log"
+  
+  namespace :juggernaut do            
+    # ===============================================================
+    # PROCESS MANAGEMENT
+    # ===============================================================  
+    
+    desc "Starts the juggernaut push server"
+    task :start, :roles => :app do
+      puts "Starting juggernaut push server"
+      try_sudo "juggernaut -c #{juggernaut_config} -d --pid #{juggernaut_pid} --log #{juggernaut_log}"
+    end
+    
+    desc "Stops the juggernaut push server"
+    task :stop, :roles => :app do
+      puts "Stopping juggernaut push server"
+      try_sudo "juggernaut -c #{juggernaut_config} -k * --pid #{juggernaut_pid} --log #{juggernaut_log}"
+    end
+    
+    desc "Restarts the juggernaut push server"
+    task :restart, :roles => :app do
+      juggernaut.stop
+      juggernaut.start
+    end  
+    
+    # ===============================================================
+    # FILE MANAGEMENT
+    # ===============================================================  
+    
+    desc "Copies the shared/config/juggernaut yaml to release/config/"
+    task :copy_config, :roles => :app do
+      try_sudo "ln -s #{shared_path}/config/juggernaut.yml #{release_path}/config/juggernaut.yml"
+    end
+    
+    desc "Displays the juggernaut log from the server"
+    task :tail, :roles => :app do
+      stream "tail -f #{shared_path}/log/juggernaut.log" 
+    end
+  end
+  
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================  
+  
+  after "deploy:update_code", "juggernaut:copy_config" # copy juggernaut.yml on update code
+  after "deploy:restart"    , "juggernaut:restart"     # restart juggernaut on app restart
+end

data/lib/cap_recipes/tasks/memcache.rb

@@ -0,0 +1,43 @@
+Capistrano::Configuration.instance(true).load do
+
+  set :memcache_init_path, "/etc/init.d/memcached"
+
+  # ===============================================================
+  # SERVER MANAGEMENT
+  # ===============================================================
+
+  namespace :memcache do
+    desc "Stops the memcache server"
+    task :stop, :roles => :app do
+      puts "Stopping the memcache server"
+      sudo "#{memcache_init_path} stop"
+    end
+
+    desc "Starts the memcache server"
+    task :start, :roles => :app do
+      puts "Starting the memcache server"
+      sudo "#{memcache_init_path} start"
+    end
+
+    desc "Restarts the memcache server"
+    task :restart, :roles => :app do
+      puts "Restarting the memcache server"
+      memcache.stop
+      memcache.start
+    end
+
+    # ===============================================================
+    # INSTALLATION
+    # ===============================================================
+
+    desc 'Installs memcache and the ruby gem'
+    task :install, :roles => :app do
+      puts 'Installing memcache'
+      sudo 'apt-get install memcached'
+      sudo "#{base_ruby_path}/bin/gem install memcache-client --no-ri --no-rdoc"
+      memcache.start
+    end
+  end
+  
+  after "deploy:update_code", "memcache:restart" # clear cache after updating code
+end

data/lib/cap_recipes/tasks/passenger.rb

@@ -0,0 +1,152 @@
+require 'cap_recipes/tasks/with_scope.rb'
+
+Capistrano::Configuration.instance(true).load do
+  set :base_ruby_path, '/usr'  
+
+  # ===============================================================
+  # DEPLOYMENT SCRIPTS
+  # ===============================================================
+
+  namespace :deploy do
+    
+    desc "Default deploy action" 
+    task :default, :roles => :web do
+      with_role(:web) do
+        update
+        restart
+      end
+    end
+
+    # ===============================================================
+    # SERVER MANAGEMENT
+    # ===============================================================
+
+    desc "Stops the phusion passenger server"
+    task :stop, :roles => :web do
+      puts "Stopping rails web server"
+      apache.stop
+    end
+
+    desc "Starts the phusion passenger server"
+    task :start, :roles => :web do
+      puts "Starting rails web server"
+      apache.start
+    end
+
+    desc "Restarts the phusion passenger server"
+    task :restart, :roles => :web do
+      puts "Restarting the application"
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+
+    desc "Update code on server, apply migrations, and restart passenger server"
+    task :with_migrations, :roles => :web do
+      with_role(:web) do
+        deploy.update
+        deploy.migrate
+        deploy.restart
+      end
+    end
+
+    # ===============================================================
+    # UTILITY TASKS
+    # ===============================================================
+
+    desc "Copies the shared/config/database yaml to release/config/"
+    task :copy_config, :roles => :web do
+      puts "Copying database configuration to release path"
+      sudo "ln -s #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+
+    desc "Repair permissions to allow user to perform all actions"
+    task :repair_permissions, :roles => :web do
+      puts "Applying correct permissions to allow for proper command execution"
+      sudo "chmod -R 744 #{current_path}/log #{current_path}/tmp"
+      sudo "chown -R #{user}:#{user} #{current_path}"
+      sudo "chown -R #{user}:#{user} #{current_path}/tmp"
+    end
+
+    desc "Displays the production log from the server locally"
+    task :tail, :roles => :web do
+      stream "tail -f #{shared_path}/log/production.log"
+    end
+    
+  end
+  
+  # ===============================================================
+  # INSTALLATION
+  # ===============================================================
+  
+  namespace :install do
+    
+    desc "Updates all installed ruby gems"
+    task :gems, :roles => :web do
+      sudo "gem update"
+    end
+    
+    desc "Installs Phusion Passenger"
+    task :passenger, :roles => :web do
+      puts 'Installing passenger module'
+      install.passenger_apache_module
+      install.config_passenger
+    end
+  
+    desc "Setup Passenger Module"
+    task :passenger_apache_module, :roles => :web do
+      sudo "#{base_ruby_path}/bin/gem install passenger --no-ri --no-rdoc"
+      input = ''
+      run "sudo #{base_ruby_path}/bin/passenger-install-apache2-module" do |ch, stream, out|
+        next if out.chomp == input.chomp || out.chomp == ''
+        print out
+        ch.send_data(input = $stdin.gets) if out =~ /(Enter|ENTER)/
+      end
+    end
+
+    desc "Configure Passenger"
+    task :config_passenger, :roles => :web do
+      version = 'ERROR' # default
+    
+      # passenger (2.X.X, 1.X.X)
+      run("gem list | grep passenger") do |ch, stream, data|
+        version = data.sub(/passenger \(([^,]+).*?\)/,"\\1").strip
+      end
+
+      puts "  passenger version #{version} configured"
+
+      passenger_config =<<-EOF
+        LoadModule passenger_module #{base_ruby_path}/lib/ruby/gems/1.8/gems/passenger-#{version}/ext/apache2/mod_passenger.so
+        PassengerRoot #{base_ruby_path}/lib/ruby/gems/1.8/gems/passenger-#{version}
+        PassengerRuby #{base_ruby_path}/bin/ruby
+      EOF
+    
+      put passenger_config, "/tmp/passenger"
+      sudo "mv /tmp/passenger /etc/apache2/conf.d/passenger"
+      apache.restart
+    end
+    
+  end
+
+  # ===============================================================
+  # MAINTENANCE TASKS
+  # ===============================================================
+  namespace :sweep do
+    desc "Clear file-based fragment and action caching"
+    task :log, :roles => :web  do
+      puts "Sweeping all the log files"
+      run "cd #{current_path} && #{sudo} rake log:clear RAILS_ENV=production"
+    end
+
+    desc "Clear file-based fragment and action caching"
+    task :cache, :roles => :web do
+      puts "Sweeping the fragment and action cache stores"
+      run "cd #{release_path} && #{sudo} rake tmp:cache:clear RAILS_ENV=production"
+    end    
+  end
+
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================
+  after "deploy:update_code", "deploy:copy_config" # copy database.yml file to release path
+  after "deploy:update_code", "sweep:cache" # clear cache after updating code
+  after "deploy:restart"    , "deploy:repair_permissions" # fix the permissions to work properly
+end

data/lib/cap_recipes/tasks/thinking_sphinx.rb

@@ -0,0 +1,64 @@
+Capistrano::Configuration.instance(true).load do
+  namespace :thinking_sphinx do
+
+    # ===============================================================
+    # PROCESS MANAGEMENT
+    # ===============================================================  
+    
+    desc "Starts the thinking sphinx searchd server"
+    task :start, :roles => :app do
+      puts "Starting thinking sphinx searchd server"
+      rake = fetch(:rake, "rake")
+      rails_env = fetch(:rails_env, "production")
+
+      run "cd #{current_path}; #{rake} RAILS_ENV=#{rails_env} thinking_sphinx:configure; #{rake} RAILS_ENV=#{rails_env} ts:start"
+    end
+    
+    desc "Stops the thinking sphinx searchd server"
+    task :stop, :roles => :app do
+      puts "Stopping thinking sphinx searchd server"
+      rake = fetch(:rake, "rake")
+      rails_env = fetch(:rails_env, "production")
+
+      run "cd #{current_path}; #{rake} RAILS_ENV=#{rails_env} thinking_sphinx:configure; #{rake} RAILS_ENV=#{rails_env} ts:stop"
+    end
+    
+    desc "Restarts the thinking sphinx searchd server"
+    task :restart, :roles => :app do
+      thinking_sphinx.stop
+      thinking_sphinx.index
+      thinking_sphinx.start
+    end
+
+
+    # ===============================================================
+    # FILE MANAGEMENT
+    # ===============================================================  
+    
+    desc "Copies the shared/config/sphinx yaml to release/config/"
+    task :copy_config, :roles => :app do
+      run "ln -s #{shared_path}/config/sphinx.yml #{release_path}/config/sphinx.yml"
+    end
+    
+    desc "Displays the thinking sphinx log from the server"
+    task :tail, :roles => :app do
+      stream "tail -f #{shared_path}/log/searchd.log"
+    end
+
+    desc "Runs Thinking Sphinx indexer"
+    task :index, :roles => :app do
+      rake = fetch(:rake, "rake")
+      rails_env = fetch(:rails_env, "production")
+      puts "Updating search index"
+
+      run "cd #{current_path}; #{rake} RAILS_ENV=#{rails_env} ts:index"
+    end
+  end
+  
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================  
+  
+  after "deploy:update_code", "thinking_sphinx:copy_config" # copy thinking_sphinx.yml on update code
+  after "deploy:restart"    , "thinking_sphinx:restart"     # restart thinking_sphinx on app restart
+end

data/lib/cap_recipes/tasks/with_scope.rb

@@ -0,0 +1,22 @@
+# role = :app
+def with_role(role, &block)
+  original, ENV['HOSTS'] = ENV['HOSTS'], find_servers(:roles => role).map{|d| d.host}.join(",")
+  begin
+    yield
+  ensure
+    ENV['HOSTS'] = original
+  end
+end
+
+# options = { :user => 'xxxxx', :password => 'xxxxx' }
+def with_credentials(options={}, &block)
+  original_username, original_password = user, password
+  begin
+    set :user,     options[:user] || original_username
+    set :password, options[:password] || original_password
+    yield
+  ensure
+    set :user,     original_username
+    set :password, original_password
+  end
+end

data/spec/cap-recipes-spec.rb

@@ -0,0 +1,5 @@
+describe "Cap recipes" do
+  it "should have real tests eventually" do
+    true.should eql(true)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: hubertlepicki-cap-recipes
+version: !ruby/object:Gem::Version 
+  version: 0.2.8
+platform: ruby
+authors: 
+- Nathan Esquenazi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: nesquena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.textile
+- lib/cap_recipes/tasks/apache.rb
+- lib/cap_recipes/tasks/backgroundrb.rb
+- lib/cap_recipes/tasks/juggernaut.rb
+- lib/cap_recipes/tasks/memcache.rb
+- lib/cap_recipes/tasks/passenger.rb
+- lib/cap_recipes/tasks/thinking_sphinx.rb
+- lib/cap_recipes/tasks/with_scope.rb
+- lib/cap_recipes.rb
+- spec/cap-recipes-spec.rb
+has_rdoc: false
+homepage: http://caprecipes.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: cap-recipes
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Collection of capistrano recipes for apache, passenger, memcache, juggernaut and backgroundrb
+test_files: []
+