seesaw 0.2.0 → 0.2.1

data/README.txt

@@ -4,24 +4,57 @@ seesaw
 
 == DESCRIPTION:
   
-FIX (describe your package)
-
-== FEATURES/PROBLEMS:
+seesaw: [verb] to change rapidly from one state or condition to another and back again.
+  
+Seesaw is a replacement/addition to the mongrel_cluster gem and allows you to perform a safe rippling restart of your mongrel cluster without dropping any requests.
   
-* FIX (list of features or problems)
+Let's say you have a mongrel cluster setup with 7 individual mongrels on your server. Let's also say that you have to deploy a code update and restart all of your mongrels but your site is really busy and you cannot afford any downtime whatsoever.
+
+When you execute:
+
+mongrel_rails seesaw::ripple
+
+This will happen:
+
+1. your webserver configuration is switched to only use the front half of your mongrel pack (mongrels 1-4)
+2. the webserver (apache or nginx) is gracefully restarted
+3. the back half of your mongrel pack (mongrels 5-7) is restarted
+4. your webserver configuration is switched to only use the back half of the pack
+5. the webserver is gracefully restarted
+6. front half mongrels are restared
+7. webserver configuration switched back to full cluster configuration
+8. webserver restarted one last time
+
+Halfway through the process, your site is only running on half of the mongrels, but that will only result in reduced performance for a small amount of time, rather than downtime.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+* mongrel_rails::ripple
+  perform a rippling restart of the mongrel cluster
+  
+* mongrel_rails::switch --cluster CLUSTER
+  transfers the cluster into a guaranteed running configuration. CLUSTER can be one of [1|2|all], starting the front half, back half or full cluster respectively. If only a half cluster is started, the mongrels for the other half will be shut down.
+  
+* mongrel_rails::configure --server TYPE
+  generate a starting configuration for the chosen webserver [nginx|apache]. Default is apache.
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* mongrel installation
+* mongrel_cluster installed and configured for the application
 
 == INSTALL:
 
 sudo gem install seesaw
 
+== CONFIGURATION
+
+=== seesaw.yml
+
+The seesaw configuration looks like this:
+
+
+
 == LICENSE:
 
 (The MIT License)

data/lib/seesaw/init.rb

@@ -6,9 +6,10 @@ require 'seesaw/mongrel_cluster_patch'
 require "erb"
 
 module Seesaw
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
   
   module CommandBase
+
     def log(message)
       puts message
     end   
@@ -135,6 +136,7 @@ module Seesaw
   
   class Configure < GemPlugin::Plugin "/commands"
     include Mongrel::Command::Base    
+    include CommandBase
     
     def configure 
       options [
@@ -142,7 +144,7 @@ module Seesaw
         ['-C', '--config PATH', "Path to seesaw configuration file", :@config_file, 'config/seesaw.yml'],
         ['-M', '--mongrel PATH', "Path to mongrel cluster configuration file", :@mongrel_config_file, 'config/mongrel_cluster.yml'],
         ['', '--http_config PATH', "Path to the http server configuration includes", :@http_config_path, "config/http_cluster"],
-        ['', '--server TYPE', "Webserver to generate example configuration for. TYPE can be nginx or apache. Default is nginx.", :@server, 'nginx']
+        ['', '--server TYPE', "Webserver to generate example configuration for. TYPE can be nginx or apache. Default is apache.", :@server, 'apache']
       ]
     end
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: seesaw
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 date: 2007-08-19 00:00:00 +10:00
 summary: Ripple-restart a mongrel cluster with no downtime
 require_paths: 
@@ -11,7 +11,7 @@ require_paths:
 email: max@muermann.org
 homepage: "    by Matt Allen and Max Muermann"
 rubyforge_project: seesaw
-description: "== FEATURES/PROBLEMS:  * FIX (list of features or problems)  == SYNOPSIS:  FIX (code sample of usage)  == REQUIREMENTS:"
+description: "When you execute:  mongrel_rails seesaw::ripple  This will happen:  1. your webserver configuration is switched to only use the front half of your mongrel pack (mongrels 1-4) 2. the webserver (apache or nginx) is gracefully restarted 3. the back half of your mongrel pack (mongrels 5-7) is restarted 4. your webserver configuration is switched to only use the back half of the pack 5. the webserver is gracefully restarted 6. front half mongrels are restared 7. webserver configuration switched back to full cluster configuration 8. webserver restarted one last time"
 autorequire: seesaw/init.rb
 default_executable: 
 bindir: bin