capistrano-recipes 0.5.0 → 0.8.0

data/lib/recipes/god.rb

@@ -0,0 +1,125 @@
+# God Monitoring Tool
+# God is a Process Monitoring Framework written in Ruby
+# More info at http://god.rubyforge.org/
+#------------------------------------------------------------------------------
+Capistrano::Configuration.instance.load do
+  _cset(:god_local_config)  { "#{templates_path}/app.god.erb" }
+  _cset(:god_remote_config) { "#{shared_path}/config/app.god" }
+
+  namespace :god do
+    
+    desc "|DarkRecipes| Parses and uploads god configuration for this app"
+    task :setup, :roles => :app do
+      generate_config(god_local_config, god_remote_config)
+    end
+
+    _cset(:bin_god) { defined?(:rvm_ruby_string) ? 'bootup_god' : 'god' }
+    _cset(:server_name)    { "#{application}-#{app_server}" }
+    _cset(:god_init_local) { "#{docs_path}/god/god.init" }
+    _cset :god_init_temp,   '/tmp/god.init'
+    _cset :god_init_remote, '/etc/init.d/god'
+    _cset(:god_defo_local) { "#{docs_path}/god/god"}
+    _cset :god_defo_temp,   '/tmp/god'
+    _cset :god_defo_remote, '/etc/default/god'
+    _cset(:god_conf_local) { "#{docs_path}/god/god.conf" }
+    _cset :god_conf_temp,   '/tmp/god.conf'
+    _cset :god_conf_remote, '/etc/god/god.conf'
+    
+    task :setup_temp, :roles => :app do
+      sudo "rm -f #{god_conf_remote} #{god_init_remote} #{god_defo_remote}"
+    end
+    
+    task :setup_conf, :roles => :app do
+      upload god_conf_local, god_conf_temp, :via => :scp
+      sudo "mkdir -p #{File.dirname(god_conf_remote)}"
+      sudo "mv #{god_conf_temp} #{god_conf_remote}"
+    end
+    
+    task :setup_init, :roles => :app do
+      upload god_init_local, god_init_temp, :via => :scp
+      sudo "mv #{god_init_temp} #{god_init_remote}"  
+      # Allow executing the init.d script
+      sudo "chmod +x #{god_init_remote}"
+      # Make it run at bootup     
+      sudo "update-rc.d god defaults"    
+    end
+    
+    task :setup_defo, :roles => :app do
+      upload god_defo_local, god_defo_temp, :via => :scp
+      sudo "mv #{god_defo_temp} #{god_defo_remote}"
+    end
+    
+    desc "|DarkRecipes| Bootstraps god on your server. Be careful with this."
+    task :bootstrap, :roles => :app do
+      setup_temp
+      setup_defo
+      setup_init
+      setup_conf    
+
+      puts "God is bootstrapped. To remove use 'cap god:implode'"
+    end
+    
+    desc "|DarkRecipes| (Seppuku) Completely remove god from the system init"
+    task :implode, :roles => :app do
+      #  Removing any system startup links for /etc/init.d/god ...
+      sudo "update-rc.d -f god remove"
+      
+      # Suicide follows.
+      sudo "rm -f #{god_conf_remote}"
+      sudo "rm -f #{god_defo_remote}"
+      sudo "rm -f #{god_init_remote}"
+      puts "God is no more."
+    end
+    
+    desc "|DarkRecipes| Use god to restart the app"
+    namespace :restart do
+      task :default, :roles => :app, :except => { :no_release => true } do
+        sudo "#{bin_god} restart #{application}"
+      end
+
+      desc "|DarkRecipes| Restarts the app server"
+      task :app, :roles => :app, :except => { :no_release => true } do
+        sudo "#{bin_god} restart #{application}-#{app_server.to_s.downcase}"
+      end
+    end
+    
+    desc "|DarkRecipes| Fetches the log for the whole group"
+    task :log, :roles => :app do
+      sudo "#{bin_god} log #{application}"
+    end
+    
+    desc "|DarkRecipes| Reload config"
+    task :reload, :roles => :app do
+      sudo "#{bin_god} load #{god_remote_config}"
+    end
+
+    desc "|DarkRecipes| Start god service"
+    task :start, :roles => :app do
+      sudo "service god start"
+    end
+    
+    desc "|DarkRecipes| Stops god service"
+    task :stop, :roles => :app do
+      sudo "service god stop"
+    end
+        
+    desc "|DarkRecipes| Quit god, but not the processes it's monitoring"
+    task :quit, :roles => :app do
+      sudo "#{bin_god} quit"
+    end
+
+    desc "|DarkRecipes| Terminate god and all monitored processes"
+    task :terminate, :roles => :app do
+      sudo "#{bin_god} terminate"
+    end
+
+    desc "|DarkRecipes| Describe the status of the running tasks"
+    task :status, :roles => :app do
+      sudo "#{bin_god} status"
+    end
+  end
+  
+  after 'deploy:setup' do
+    god.setup if Capistrano::CLI.ui.agree("Create app.god in app's shared path? [Yn]")
+  end if is_using('god', :monitorer)
+end

data/lib/recipes/hooks.rb

@@ -0,0 +1,14 @@
+# Common hooks for all scenarios.
+Capistrano::Configuration.instance.load do
+  after 'deploy:setup' do
+    app.setup
+    bundler.setup if Capistrano::CLI.ui.agree("Do you need to install the bundler gem? [Yn]")
+  end
+    
+  after "deploy:update_code" do
+    symlinks.make
+    bundler.install
+  end
+end
+
+

data/lib/recipes/log.rb

@@ -1,15 +1,15 @@
-Capistrano::Configuration.instance(:must_exist).load do
+Capistrano::Configuration.instance.load do
   namespace :log do
-    desc "Tail application log file for the specified environment, e.g. cap staging log:tail"
+    desc "|DarkRecipes| Tail all application log files"
     task :tail, :roles => :app do
-      run "tail -f #{shared_path}/log/#{environment}.log" do |channel, stream, data|
+      run "tail -f #{shared_path}/log/*.log" do |channel, stream, data|
         puts "#{channel[:host]}: #{data}"
         break if stream == :err
       end
     end
     
     desc <<-DESC
-    Install log rotation script; optional args: days=7, size=5M, group (defaults to same value as :user)
+    |DarkRecipes| Install log rotation script; optional args: days=7, size=5M, group (defaults to same value as :user)
     DESC
     task :rotate, :roles => :app do
       rotate_script = %Q{#{shared_path}/log/#{environment}.log {

data/lib/recipes/nginx.rb

@@ -0,0 +1,52 @@
+Capistrano::Configuration.instance.load do
+    
+  # Where your nginx lives. Usually /opt/nginx or /usr/local/nginx for source compiled.
+  set :nginx_path_prefix, "/opt/nginx" unless exists?(:nginx_path_prefix)
+
+  # Path to the nginx erb template to be parsed before uploading to remote
+  set(:nginx_local_config) { "#{templates_path}/nginx.conf.erb" } unless exists?(:nginx_local_config)
+
+  # Path to where your remote config will reside (I use a directory sites inside conf)
+  set(:nginx_remote_config) do
+    "#{nginx_path_prefix}/conf/sites/#{application}.conf"
+  end unless exists?(:nginx_remote_config)
+
+  # Nginx tasks are not *nix agnostic, they assume you're using Debian/Ubuntu.
+  # Override them as needed.
+  namespace :nginx do
+    desc "|DarkRecipes| Parses and uploads nginx configuration for this app."
+    task :setup, :roles => :app , :except => { :no_release => true } do
+      generate_config(nginx_local_config, nginx_remote_config)
+    end
+    
+    desc "|DarkRecipes| Parses config file and outputs it to STDOUT (internal task)"
+    task :parse, :roles => :app , :except => { :no_release => true } do
+      puts parse_config(nginx_local_config)
+    end
+    
+    desc "|DarkRecipes| Restart nginx"
+    task :restart, :roles => :app , :except => { :no_release => true } do
+      sudo "service nginx restart"
+    end
+    
+    desc "|DarkRecipes| Stop nginx"
+    task :stop, :roles => :app , :except => { :no_release => true } do
+      sudo "service nginx stop"
+    end
+    
+    desc "|DarkRecipes| Start nginx"
+    task :start, :roles => :app , :except => { :no_release => true } do
+      sudo "service nginx start"
+    end
+
+    desc "|DarkRecipes| Show nginx status"
+    task :status, :roles => :app , :except => { :no_release => true } do
+      sudo "service nginx status"
+    end
+  end
+  
+  after 'deploy:setup' do
+    nginx.setup if Capistrano::CLI.ui.agree("Create nginx configuration file? [Yn]")
+  end if is_using_nginx 
+end
+

data/lib/recipes/passenger.rb

@@ -1,18 +1,18 @@
-Capistrano::Configuration.instance(:must_exist).load do
+Capistrano::Configuration.instance.load do
   namespace :passenger do
-    desc "Restart Rails app running under Phusion Passenger by touching restart.txt"
+    desc "|DarkRecipes| Restart Rails app running under Phusion Passenger by touching restart.txt"
     task :bounce, :roles => :app do
       run "#{sudo} touch #{current_path}/tmp/restart.txt"
     end
 
-    desc "Inspect Phusion Passenger's memory usage. Assumes binaries are located in /opt/ruby-enterprise."
+    desc "|DarkRecipes| Inspect Phusion Passenger's memory usage."
     task :memory, :roles => :app do
-      run "#{sudo} /opt/ruby-enterprise/bin/passenger-memory-stats"
+      run "sudo passenger-memory-stats"
     end
         
-    desc "Inspect Phusion Passenger's internal status. Assumes binaries are located in /opt/ruby-enterprise."
+    desc "|DarkRecipes| Inspect Phusion Passenger's internal status."
     task :status, :roles => :app do
-      run "#{sudo} /opt/ruby-enterprise/bin/passenger-status"
+      run "sudo passenger-status"
     end
   end
 end

data/lib/recipes/resque.rb

@@ -0,0 +1,48 @@
+Capistrano::Configuration.instance.load do
+  namespace :resque do  
+    namespace :worker do
+      desc "|DarkRecipes| List all workers"
+      task :list, :roles => :app do
+        run "cd #{current_path} && #{sudo} resque list"
+      end
+    
+      desc "|DarkRecipes| Starts the workers"
+      task :start, :roles => :app do
+        run "cd #{current_path} && #{sudo} god start #{resque_service}"
+      end
+    
+      desc "|DarkRecipes| Stops the workers"
+      task :stop, :roles => :app do
+        run "cd #{current_path} && #{sudo} god stop #{resque_service}"
+      end
+    
+      desc "|DarkRecipes| Restart all workers"
+      task :restart, :roles => :app do
+        run "cd #{current_path} && #{sudo} god restart #{resque_service}"
+      end  
+    end
+  
+    namespace :web do
+      desc "|DarkRecipes| Starts the resque web interface"
+      task :start, :roles => :app do
+        run "cd #{current_path}; resque-web -p 9000 -e #{rails_env} "
+      end
+    
+      desc "|DarkRecipes| Stops the resque web interface"
+      task :stop, :roles => :app do
+        run "cd #{current_path}; resque-web -K"
+      end
+    
+      desc "|DarkRecipes| Restarts the resque web interface "
+      task :restart, :roles => :app do
+        stop
+        start
+      end
+    
+      desc "|DarkRecipes| Shows the status of the resque web interface"
+      task :status, :roles => :app do
+        run "cd #{current_path}; resque-web -S"
+      end 
+    end
+  end
+end

data/lib/recipes/sphinx.rb

@@ -0,0 +1,38 @@
+Capistrano::Configuration.instance.load do
+  namespace :sphinx do
+    desc "|DarkRecipes| Generates Configuration file for TS"
+    task :config, :roles => :app do
+      run "cd #{current_path}; #{rake_bin} RAILS_ENV=#{rails_env} ts:config"
+    end
+
+    desc "|DarkRecipes| Starts TS"
+    task :start, :roles => :app do
+      run "cd #{current_path}; #{rake_bin} RAILS_ENV=#{rails_env} ts:start"
+    end
+
+    desc "|DarkRecipes| Stops TS"
+    task :stop, :roles => :app do
+      run "cd #{current_path}; #{rake_bin} RAILS_ENV=#{rails_env} ts:stop"
+    end
+
+    desc "|DarkRecipes| Rebuild TS"
+    task :rebuild, :roles => :app do
+      run "cd #{current_path}; #{rake_bin} RAILS_ENV=#{rails_env} ts:rebuild"
+    end
+
+    desc "|DarkRecipes| Indexes TS"
+    task :index, :roles => :app do
+      run "cd #{current_path}; #{rake_bin} RAILS_ENV=#{rails_env} ts:in"
+    end
+
+    desc "|DarkRecipes| Re-establishes symlinks"
+    task :symlinks do
+      run <<-CMD
+        rm -rf #{current_path}/db/sphinx && ln -nfs #{shared_path}/db/sphinx #{current_path}/db/sphinx
+      CMD
+    end
+  end
+
+
+end
+

data/lib/recipes/symlinks.rb

@@ -0,0 +1,27 @@
+Capistrano::Configuration.instance.load do
+  # These are set to the same structure in shared <=> current
+  set :normal_symlinks, %w(tmp log config/database.yml) unless exists?(:normal_symlinks)
+  
+  # Weird symlinks go somewhere else. Weird.
+  set :weird_symlinks, { 'bundle' => 'vendor/bundle',
+                         'pids'   => 'tmp/pids' } unless exists?(:weird_symlinks)
+
+  namespace :symlinks do
+    desc "|DarkRecipes| Make all the symlinks in a single run"
+    task :make, :roles => :app, :except => { :no_release => true } do
+      commands = normal_symlinks.map do |path|
+        "rm -rf #{current_path}/#{path} && \
+         ln -s #{shared_path}/#{path} #{current_path}/#{path}"
+      end
+
+      commands += weird_symlinks.map do |from, to|
+        "rm -rf #{current_path}/#{to} && \
+         ln -s #{shared_path}/#{from} #{current_path}/#{to}"
+      end
+
+      run <<-CMD
+        cd #{current_path} && #{commands.join(" && ")}
+      CMD
+    end
+  end
+end

data/lib/recipes/unicorn.rb

@@ -0,0 +1,82 @@
+Capistrano::Configuration.instance.load do
+  # Number of workers (Rule of thumb is 2 per CPU)
+  # Just be aware that every worker needs to cache all classes and thus eat some
+  # of your RAM. 
+  set :unicorn_workers, 8 unless exists?(:unicorn_workers)
+
+  # Workers timeout in the amount of seconds below, when the master kills it and
+  # forks another one.
+  set :unicorn_workers_timeout, 30 unless exists?(:unicorn_workers_timeout)
+
+  # Workers are started with this user/group
+  # By default we get the user/group set in capistrano.
+  set(:unicorn_user) { user }   unless exists?(:unicorn_user)
+  set(:unicorn_group) { group } unless exists?(:unicorn_group)
+
+  # The wrapped bin to start unicorn
+  # This is necessary if you're using rvm
+  set :unicorn_bin, 'bundle exec unicorn' unless exists?(:unicorn_bin)
+  set :unicorn_socket, File.join(sockets_path,'unicorn.sock') unless exists?(:unicorn_socket)
+
+  # Defines where the unicorn pid will live.
+  set(:unicorn_pid) { File.join(pids_path, "unicorn.pid") } unless exists?(:unicorn_pid)
+
+  # Our unicorn template to be parsed by erb
+  # You may need to generate this file the first time with the generator
+  # included in the gem
+  set(:unicorn_local_config) { File.join(templates_path, "unicorn.rb.erb") } 
+
+  # The remote location of unicorn's config file. Used by god to fire it up
+  set(:unicorn_remote_config) { "#{shared_path}/config/unicorn.rb" }
+
+  def unicorn_start_cmd
+    "cd #{current_path} && #{unicorn_bin} -c #{unicorn_remote_config} -E #{rails_env} -D"
+  end
+  
+  def unicorn_stop_cmd
+    "kill -QUIT `cat #{unicorn_pid}`"
+  end
+  
+  def unicorn_restart_cmd
+    "kill -USR2 `cat #{unicorn_pid}`"
+  end
+
+  # Unicorn 
+  #------------------------------------------------------------------------------
+  namespace :unicorn do    
+    desc "|DarkRecipes| Starts unicorn directly"
+    task :start, :roles => :app do
+      run unicorn_start_cmd
+    end  
+    
+    desc "|DarkRecipes| Stops unicorn directly"
+    task :stop, :roles => :app do
+      run unicorn_stop_cmd
+    end  
+    
+    desc "||DarkRecipes|| Restarts unicorn directly"
+    task :restart, :roles => :app do
+      run unicorn_restart_cmd
+    end
+    
+    desc <<-EOF
+    |DarkRecipes| Parses the configuration file through ERB to fetch our variables and \
+    uploads the result to #{unicorn_remote_config}, to be loaded by whoever is booting \
+    up the unicorn.
+    EOF
+    task :setup, :roles => :app , :except => { :no_release => true } do
+      # TODO: refactor this to a more generic setup task once we have more socket tasks.
+      commands = []
+      commands << "mkdir -p #{sockets_path}"
+      commands << "chown #{user}:#{group} #{sockets_path} -R" 
+      commands << "chmod +rw #{sockets_path}"
+      
+      run commands.join(" && ")
+      generate_config(unicorn_local_config,unicorn_remote_config)
+    end
+  end
+  
+  after 'deploy:setup' do
+    unicorn.setup if Capistrano::CLI.ui.agree("Create unicorn configuration file? [Yn]")
+  end if is_using_unicorn
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CapistranoRecipes
+  VERSION = "0.8.0"
+end

metadata

@@ -1,29 +1,59 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-recipes
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  hash: 63
+  prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Phil Misiowiec
+- Leonardo Bighetti
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-01 00:00:00 -07:00
+date: 2011-03-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        - 9
         version: 2.5.9
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id002
 description: Extend the Capistrano gem with these useful recipes
-email: phil@webficient.com
+email: 
+- github@webficient.com
 executables: []
 
 extensions: []
@@ -33,43 +63,67 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
 - capistrano-recipes.gemspec
+- doc/god/god
+- doc/god/god.conf
+- doc/god/god.init
+- generators/app.god.erb
+- generators/nginx.conf.erb
+- generators/unicorn.rb.erb
 - lib/capistrano_recipes.rb
 - lib/helpers.rb
+- lib/recipes/application.rb
+- lib/recipes/bluepill.rb
+- lib/recipes/bundler.rb
 - lib/recipes/db.rb
 - lib/recipes/deploy.rb
+- lib/recipes/god.rb
+- lib/recipes/hooks.rb
 - lib/recipes/log.rb
+- lib/recipes/nginx.rb
 - lib/recipes/passenger.rb
-- lib/recipes/symlink.rb
+- lib/recipes/resque.rb
+- lib/recipes/sphinx.rb
+- lib/recipes/symlinks.rb
+- lib/recipes/unicorn.rb
+- lib/version.rb
 has_rdoc: true
-homepage: http://github.com/webficient/capistrano-recipes
+homepage: ""
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: capistrano-recipes
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Capistrano recipes