mongrel_cluster 0.1 → 0.1.1

data/README

@@ -1,6 +1,6 @@
 == Mongrel Cluster Plugin
 
-Tool to help start/stop/restart multiple mongrel servers to use behind a load balancer like Pound or Balance. This plugin adds an option to specify a number of Mongrel servers to launch, a range of ports, and a configuration file for the cluster. Use "-h" to see command syntax.
+Tool to help start/stop/restart multiple mongrel servers to use behind a load balancer like Pound, Pen or Balance. This plugin adds an option to specify a number of Mongrel servers to launch, a range of ports, and a configuration file for the cluster. Use "-h" to see command syntax.
 
 Configure cluster and write configuration file:
 mongrel_rails cluster::configure  
@@ -15,3 +15,26 @@ Stop cluster:
 mongrel_rails cluster::stop
 
 
+Capistrano Recipe
+
+Add to deploy.rb:
+require 'mongrel_cluster/recipes'
+
+Example usage:
+cap -a configure_mongrel_cluster
+
+Variables
+mongrel_servers: Number of Mongrel servers to start.
+mongrel_port: Starting port to bind to.
+mongrel_address: Address to bind to.
+mongrel_environment: Rails environment to run as.
+mongrel_config: Path to config file.
+use_sudo: Whether or not tasks that can use sudo, ought to use sudo. Capistrano defaults to true.
+
+Tasks (performed on :app role)
+configure_mongrel_cluster: Configure the cluster with variables. Uses sudo if use_sudo is true.
+start_mongrel_cluster: Start Mongrel processes on the app server. Uses sudo if use_sudo is true.
+stop_mongrel_cluster: Stop the Mongrel processes on the app server. Uses sudo if use_sudo is true.
+restart_mongrel_cluster: Restart the Mongrel processes on the app server. Uses sudo if use_sudo is true.
+restart: Calls restart_mongrel_cluster to allow Mongrel to be used with the standard Capistrano deploy task.
+spinner: Calls start_mongrel_cluster to allow Mongrel to be used with the standard Capistrano cold_deploy task.

data/Rakefile

@@ -15,16 +15,17 @@ setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc']
 desc "Does a full compile, test run"
 task :default => [:test, :package]
 
-version="0.1"
+version="0.1.1"
 name="mongrel_cluster"
 
 setup_gem(name, version) do |spec|
-  spec.summary = "The mongrel_cluster GemPlugin"
+  spec.summary = "Mongrel plugin that provides commands and Capistrano tasks for managing multiple Mongrel processes."
   spec.description = spec.summary
   spec.author="Bradley Taylor"
   spec.add_dependency('gem_plugin', '>= 0.2.1')
-  spec.add_dependency('mongrel', '>= 0.3.12.2')
+  spec.add_dependency('mongrel', '>= 0.3.12.4')
   spec.files += Dir.glob("resources/**/*")
+  spec.has_rdoc = false
 end
 
 

data/lib/mongrel_cluster/init.rb

@@ -8,7 +8,7 @@ module Cluster
     include Mongrel::Command::Base
     
     def configure
-      options [['-C', '--config PATH', "Path to configuraion file", :@config_file, "config/mongrel_cluster.yml"]]
+      options [['-C', '--config PATH', "Path to configuration file", :@config_file, "config/mongrel_cluster.yml"]]
     end
 
     def validate
@@ -18,10 +18,7 @@ module Cluster
     
     def run
       @options = { 
-        "environment" => ENV['RAILS_ENV'] || "development",
         "port" => 3000,
-        "address" => "0.0.0.0",
-        "log_file" => "log/mongrel.log",
         "pid_file" => "log/mongrel.pid",
         "servers" => 2 
       }
@@ -35,16 +32,16 @@ module Cluster
         argv = [ "mongrel_rails" ]
         argv << "start"
         argv << "-d"
-        argv << "-e #{@options["environment"]}"
+        argv << "-e #{@options["environment"]}" if @options["environment"]
         argv << "-p #{port+i}"
-        argv << "-a #{@options["address"]}"
-        argv << "-l #{@options["log_file"]}"
-        argv << "-P #{pid[0]}-#{i}.#{pid[1]}"
-        argv << "-c #{@options["cwd"]}"
-        argv << "-t #{@options["timeout"]}"
+        argv << "-a #{@options["address"]}"  if @options["address"]
+        argv << "-l #{@options["log_file"]}" if @options["log_file"]
+        argv << "-P #{pid[0]}.#{port+i}.#{pid[1]}"
+        argv << "-c #{@options["cwd"]}" if @options["cwd"]
+        argv << "-t #{@options["timeout"]}" if @options["timeout"]
         argv << "-m #{@options["mime_map"]}" if @options["mime_map"]
-        argv << "-r #{@options["docroot"]}"
-        argv << "-n #{@options["num-procs"]}"
+        argv << "-r #{@options["docroot"]}" if @options["docroot"]
+        argv << "-n #{@options["num_procs"]}" if @options["num_procs"]
         argv << "-B" if @options["debug"]
         argv << "-S #{@options["config_script"]}" if @options["config_script"]
         cmd = argv.join " "
@@ -74,18 +71,22 @@ module Cluster
       @options = { 
        "environment" => ENV['RAILS_ENV'] || "development",
        "port" => 3000,
-       "address" => "0.0.0.0",
-       "log_file" => "log/mongrel.log",
        "pid_file" => "log/mongrel.pid",
        "servers" => 2 
       }
       
       @conf_options = YAML.load_file(@config_file)
       @options.merge! @conf_options if @conf_options
+      port = @options["port"].to_i - 1
       pid = @options["pid_file"].split(".")
       puts "Stopping #{@options["servers"]} Mongrel servers..."
       1.upto(@options["servers"].to_i) do |i|
-        cmd = "mongrel_rails stop -P #{pid[0]}-#{i}.#{pid[1]} -c #{@options["cwd"]} #{"-f" if @force }"
+        argv = [ "mongrel_rails" ]
+        argv << "stop"
+        argv << "-P #{pid[0]}.#{port+i}.#{pid[1]}"
+        argv << "-c #{@options["cwd"]}" if @options["cwd"]
+        argv << "-f" if @force
+        cmd = argv.join " "
         puts cmd
         status = `#{cmd}`
         puts status
@@ -110,20 +111,23 @@ module Cluster
     
     def run
       @options = { 
-        "environment" => ENV['RAILS_ENV'] || "development",
         "port" => 3000,
-        "address" => "0.0.0.0",
-        "log_file" => "log/mongrel.log",
         "pid_file" => "log/mongrel.pid",
         "servers" => 2 
       }
       
       @conf_options = YAML.load_file(@config_file)
       @options.merge! @conf_options if @conf_options
+      port = @options["port"].to_i - 1
       pid = @options["pid_file"].split(".")
       puts "Restarting #{@options["servers"]} Mongrel servers..."
       1.upto(@options["servers"].to_i) do |i|
-        cmd = "mongrel_rails restart -P #{pid[0]}-#{i}.#{pid[1]} -c #{@options["cwd"]} #{"-s" if @soft }"
+        argv = [ "mongrel_rails" ]
+        argv << "restart"
+        argv << "-P #{pid[0]}.#{port+i}.#{pid[1]}"
+        argv << "-c #{@options["cwd"]}" if @options["cwd"]
+        argv << "-s" if @soft
+        cmd = argv.join " "
         puts cmd
         status = `#{cmd}`
         puts status
@@ -136,17 +140,17 @@ module Cluster
     
     def configure 
       options [
-        ["-e", "--environment ENV", "Rails environment to run as", :@environment, ENV['RAILS_ENV'] || "development"],
+        ["-e", "--environment ENV", "Rails environment to run as", :@environment, nil],
         ['-p', '--port PORT', "Starting port to bind to", :@port, 3000],
-        ['-a', '--address ADDR', "Address to bind to", :@address, "0.0.0.0"],
-        ['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
+        ['-a', '--address ADDR', "Address to bind to", :@address, nil],
+        ['-l', '--log FILE', "Where to write log messages", :@log_file, nil],
         ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"],
-        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, Dir.pwd],
-        ['-t', '--timeout SECONDS', "Timeout all requests after SECONDS time", :@timeout, 120],
+        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, nil],
+        ['-t', '--timeout SECONDS', "Timeout all requests after SECONDS time", :@timeout, nil],
         ['-m', '--mime PATH', "A YAML file that lists additional MIME types", :@mime_map, nil],
-        ['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, "public"],
-        ['-n', '--num-procs INT', "Number of processor threads to use", :@num_procs, 1024],
-        ['-B', '--debug', "Enable debugging mode", :@debug, false],
+        ['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, nil],
+        ['-n', '--num-procs INT', "Number of processor threads to use", :@num_procs, nil],
+        ['-B', '--debug', "Enable debugging mode", :@debug, nil],
         ['-S', '--script PATH', "Load the given file as an extra config script.", :@config_script, nil],
         ['-N', '--num-servers INT', "Number of Mongrel servers", :@servers, 2],
         ['-C', '--config PATH', "Path to config file", :@config_file, "config/mongrel_cluster.yml"]
@@ -155,43 +159,34 @@ module Cluster
 
     def validate
       @servers = @servers.to_i
-      @port = @port.to_i
-      @timeout = @timeout.to_i
       
-      @cwd = File.expand_path(@cwd)
-      valid_dir? @cwd, "Invalid path to change to during daemon mode: #{@cwd}"
       valid?(@servers > 0, "Must give a valid number of servers")
-      valid?(@port > 0, "Must give a valid starting port")
-      valid?(@timeout > 0, "Must give a valid timeout for requests")
-
-      valid_dir? File.dirname(@log_file), "Path to log file not valid: #{@log_file}"
-      valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #{@pid_file}"
       valid_dir? File.dirname(@config_file), "Path to config file not valid: #{@config_file}"
       
-      valid_dir? File.dirname(@docroot), "Path to docroot not valid: #{@docroot}"
-      valid_exists? @mime_map, "MIME mapping file does not exist: #{@mime_map}" if @mime_map
-      
       return @valid
     end
 
     def run
       @options = { 
-        "environment" => @environment,
         "port" => @port,
-        "address" => @address,
-        "log_file" => @log_file,
-        "pid_file" => @pid_file,
         "servers" => @servers,
-        "cwd" => @cwd,
-        "timeout" => @timeout,
-        "mime_map" => @mime_map,
-        "docroot" => @docroot,
-        "debug" => @debug,
-        "config_script" => @config_script,
-        "num-procs" => @num_procs
+        "pid_file" => @pid_file
       }
+      
+      @options["log_file"] = @log_file if @log_file
+      @options["debug"] = @debug if @debug
+      @options["num_procs"] = @num_procs if @num_procs
+      @options["docroot"] = @docroot if @docroots
+      @options["address"] = @address if @address
+      @options["timeout"] = @timeout if @timeout
+      @options["environment"] = @environment if @environment
+      @options["mime_map"] = @mime_map if @mime_map
+      @options["config_script"] = @config_script if @config_script
+      @options["cwd"] = @cwd if @cwd
+      
       puts "Writing configuration file to #{@config_file}."
       File.open(@config_file,"w") {|f| f.write(@options.to_yaml)}
     end  
   end
-end
+end
+

data/lib/mongrel_cluster/recipes.rb

@@ -0,0 +1,55 @@
+Capistrano.configuration(:must_exist).load do
+  set :mongrel_servers, "2"
+  set :mongrel_port, "8000"
+  set :mongrel_address, "127.0.0.1"
+  set :mongrel_environment, "production"
+  set(:mongrel_config) { "#{deploy_to}/config/mongrel_cluster.yml" }
+  
+  desc <<-DESC
+  Configure Mongrel processes on the app server. This uses the :use_sudo
+  variable to determine whether to use sudo or not.
+  DESC
+  task :configure_mongrel_cluster, :roles => :app do
+    send(run_method, "if [ ! -d #{File.dirname(mongrel_config)} ]; then mkdir -p #{File.dirname(mongrel_config)}; fi")
+    send(run_method, "mongrel_rails cluster::configure -N #{mongrel_servers} -p #{mongrel_port} -e #{mongrel_environment} -a #{mongrel_address} -c #{current_path} -C #{mongrel_config}")
+  end
+  
+  desc <<-DESC
+  Start Mongrel processes on the app server. This uses the :use_sudo
+  variable to determine whether to use sudo or not.
+  DESC
+  task :start_mongrel_cluster , :roles => :app do
+    send(run_method, "mongrel_rails cluster::start -C #{mongrel_config}")
+  end
+  
+  desc <<-DESC
+  Restart the Mongrel processes on the app server. This uses the :use_sudo
+  variable to determine whether to use sudo or not. 
+  DESC
+  task :restart_mongrel_cluster , :roles => :app do
+    send(run_method, "mongrel_rails cluster::restart -C #{mongrel_config}")
+  end
+  
+  desc <<-DESC
+  Stop the Mongrel processes on the app server. This uses the :use_sudo
+  variable to determine whether to use sudo or not.
+  DESC
+  task :stop_mongrel_cluster , :roles => :app do
+    send(run_method, "mongrel_rails cluster::stop -C #{mongrel_config}")
+  end
+  
+  desc <<-DESC
+  Restart the Mongrel processes on the app server by calling restart_mongrel_cluster.
+  DESC
+  task :restart, :roles => :app do
+    restart_mongrel_cluster
+  end
+  
+  desc <<-DESC
+  Start the Mongrel processes on the app server by calling start_mongrel_cluster.
+  DESC
+  task :spinner, :roles => :app do
+    start_mongrel_cluster
+  end
+
+end

metadata

@@ -3,19 +3,19 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: mongrel_cluster
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2006-04-24 00:00:00 -04:00
-summary: The mongrel_cluster GemPlugin
+  version: 0.1.1
+date: 2006-05-01 00:00:00 -04:00
+summary: Mongrel plugin that provides commands and Capistrano tasks for managing multiple Mongrel processes.
 require_paths: 
 - lib
 email: 
 homepage: 
 rubyforge_project: 
-description: The mongrel_cluster GemPlugin
+description: Mongrel plugin that provides commands and Capistrano tasks for managing multiple Mongrel processes.
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: true
+has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -34,6 +34,7 @@ files:
 - Rakefile
 - lib/mongrel_cluster
 - lib/mongrel_cluster/init.rb
+- lib/mongrel_cluster/recipes.rb
 - tools/rakehelp.rb
 - resources/defaults.yaml
 test_files: []
@@ -65,5 +66,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.12.2
+        version: 0.3.12.4
     version: