capitate 0.1.7 → 0.1.8

data/lib/recipes/centos/monit.rb

@@ -1,8 +1,19 @@
-namespace :centos do
+namespace :monit do
   
-  namespace :monit do
+  namespace :centos do
 
-    desc "Install monit"
+    desc <<-DESC
+    Install monit.
+    
+    monit_port: Monit port. Defaults to 2812.
+    
+      set :monit_port, 2812
+
+    monit_password: Monit password. Defaults to password prompt.
+    
+      set :monit_password, Proc.new { Capistrano::CLI.ui.ask('Monit admin password (to set): ') })
+      
+    DESC
     task :install do
       
       # Settings

data/lib/recipes/centos/mysql.rb

@@ -1,8 +1,15 @@
-namespace :centos do
+namespace :mysql do
   
-  namespace :mysql do
+  namespace :centos do
     
-    desc "Install mysql"
+    desc <<-DESC
+    Install mysql.
+    
+    mysql_admin_password_set: Mysql admin password (to set). Defaults to password prompt.
+    
+      set :mysql_admin_password_set, Proc.new { Capistrano::CLI.ui.ask('Mysql admin password (to set): ') }
+      
+    DESC
     task :install do    
       
       # Settings

data/lib/recipes/centos/nginx.rb

@@ -1,8 +1,26 @@
-namespace :centos do 
+namespace :nginx do 
   
-  namespace :nginx do
+  namespace :centos do
     
-    desc "Install nginx, conf, initscript, nginx user and service"
+    desc <<-DESC
+    Install nginx, conf, initscript, nginx user and service.
+    nginx_bin_path: Nginx sbin path. Defaults to /sbin/nginx
+    
+      set :nginx_bin_path, "/sbin/nginx"
+
+    nginx_conf_path: Path to nginx conf. Defaults to /etc/nginx/nginx.conf
+    
+      set :nginx_conf_path, "/etc/nginx/nginx.conf"
+
+    nginx_pid_path: Path to nginx pid file. Defaults to /var/run/nginx.pid
+    
+      set :nginx_pid_path, "/var/run/nginx.pid"
+
+    nginx_prefix_path: Nginx install prefix. Defaults to /var/nginx
+    
+      set :nginx_prefix_path, "/var/nginx"
+      
+    DESC
     task :install do
       
       # Settings
@@ -40,6 +58,14 @@ namespace :centos do
       sudo "id nginx || /usr/sbin/adduser -r nginx"
     end
     
+    # Restart nginx
+    desc "Restart nginx (service)"
+    task :restart do
+      # TODO: Monit
+      sudo "/sbin/service nginx restart"
+    end
+    
+    
   end
   
 end

data/lib/recipes/centos/ruby.rb

@@ -1,6 +1,6 @@
-namespace :centos do 
+namespace :ruby do 
   
-  namespace :ruby do
+  namespace :centos do
   
     desc "Install ruby and rubygems"
     task :install do 

data/lib/recipes/centos/sphinx.rb

@@ -1,8 +1,15 @@
-namespace :centos do
+namespace :sphinx do
   
-  namespace :sphinx do
+  namespace :centos do
     
-    desc "Install sphinx"
+    desc <<-DESC
+    Install sphinx.
+    
+    sphinx_prefix: Sphinx install prefix. Defaults to "/usr/local/sphinx"
+    
+      set :sphinx_prefix, "/usr/local/sphinx"
+      
+    DESC
     task :install do 
       
       # Settings
@@ -22,9 +29,15 @@ namespace :centos do
       script.make_install("sphinx", sphinx_options)
     end
         
-    desc "Setup sphinx for application"
-    after "centos:sphinx:setup", "sphinx:setup_monit"
-    task :setup do 
+    desc <<-DESC
+    Setup sphinx for application.
+    
+    sphinx_prefix: Sphinx install prefix. Defaults to "/usr/local/sphinx"
+    
+      set :sphinx_prefix, "/usr/local/sphinx"
+      
+    DESC
+    task :setup do       
       
       # Settings
       fetch_or_default(:sphinx_prefix, "/usr/local/sphinx")

data/lib/recipes/docs.rb

@@ -0,0 +1,17 @@
+namespace :docs do
+  
+  desc "Generate documentation for all currently loaded recipes."
+  task :recipes do
+    top_node = capitate.task_tree
+    
+    puts "Tree:\n#{}"
+    
+    dir = "docs/recipes"
+    FileUtils.rm_rf(dir)
+    FileUtils.mkdir_p(dir)
+    
+    top_node.write_doc(dir, "index", "Recipes")
+    
+  end
+end
+

data/lib/recipes/gems.rb

@@ -1,6 +1,15 @@
 namespace :gems do
   
-  desc "Install gems"
+  desc <<-DESC    
+    Install gems.
+    
+      set :gem_list, [ 
+        "rake", 
+        "mysql -- --with-mysql-include=/usr/include/mysql --with-mysql-lib=/usr/lib/mysql --with-mysql-config",
+        "raspell"
+      ]
+      
+  DESC
   task :install do        
     # Settings
     fetch(:gem_list)

data/lib/recipes/memcached.rb

@@ -1,6 +1,16 @@
 namespace :memcached do
   
-  desc "Install memcached monit hooks"
+  desc <<-DESC
+  Install memcached monit hooks.
+  
+  memcached_pid_path: Path to memcached pid file. Defaults to /var/run/memcached.pid    
+  
+    set :memcached_pid_path, "/var/run/memcached.pid"
+  
+  memcached_port: Memcached port. Defaults to 11211.    
+    
+    set :memcached_port, 11211
+  DESC
   task :install_monit do
     
     # Settings

data/lib/recipes/mongrel_cluster.rb

@@ -1,7 +1,19 @@
 # Create init script
 namespace :mongrel_cluster do
 
-  desc "Create monit configuration for mongrel cluster"
+  desc <<-DESC
+  Create monit configuration for mongrel cluster.
+  
+  mongrel_size: Number of mongrels.
+  
+    set :mongrel_size, 3
+
+  mongrel_port: Starting port for mongrels. If there are 3 mongrels with port 9000, then instances 
+  will be at 9000, 9001, and 9002
+    
+    set :mongrel_port, 9000
+    
+  DESC
   task :setup_monit do
     
     # See http://www.igvita.com/2006/11/07/monit-makes-mongrel-play-nice/

data/lib/recipes/mysql.rb

@@ -1,7 +1,18 @@
 # Mysql recipes
 namespace :mysql do
   
-  desc "Install mysql monit hooks"
+  desc <<-DESC
+  Install mysql monit hooks.
+  
+  db_port: Mysql port. Defaults to 3306.    
+    
+    set :db_port, 3306
+    
+  mysql_pid_path: Path to mysql pid file. Defaults to /var/run/mysqld/mysqld.pid    
+    
+    set :mysql_pid_path, "/var/run/mysqld/mysqld.pid"
+    
+  DESC
   task :install_monit do
     
     # Settings 
@@ -12,7 +23,35 @@ namespace :mysql do
     sudo "install -o root /tmp/mysql.monitrc /etc/monit/mysql.monitrc"
   end
   
-  desc "Create database user, and database with appropriate permissions"
+  desc <<-DESC
+  Create database user, and database with appropriate permissions.
+  
+  db_name: Database name (application).    
+  
+    set :db_name, "app_db_name"
+  
+  db_user: Database user (application).    
+  
+    set :db_user, "app_db_user"
+    
+  db_pass: Database password (application).    
+  
+    set :db_pass, "the_password"
+    
+  web_host: Web host to provide access privileges to (if recipe used in context of web app). 
+  Defaults to nil. TODO: Support multiple web hosts    
+  
+    set :web_host, 10.0.6.100
+    
+  db_host: Database host (to provide itself with access).    
+  
+    set :db_host, 10.0.6.101
+    
+  mysql_admin_password: Mysql admin password (to use to connect). Defaults to password prompt.
+  
+    set :mysql_admin_password, Proc.new { Capistrano::CLI.ui.ask('Mysql admin password: ') })
+    
+  DESC
   task :setup do    
     
     # Settings

data/lib/recipes/nginx.rb

@@ -1,10 +1,14 @@
 # Nginx recipes
 namespace :nginx do
   
-  # Callbacks
-  after "nginx:setup", "nginx:restart"
+  desc <<-DESC 
+  Install nginx monit hooks.
+  
+  nginx_pid_path: Path to nginx pid file. Defaults to /var/run/nginx.pid    
+  
+    set :nginx_pid_path, "/var/run/nginx.pid"
     
-  desc "Install nginx monit hooks"
+  DESC
   task :install_monit do
     
     # Settings
@@ -14,7 +18,23 @@ namespace :nginx do
     sudo "install -o root /tmp/nginx.monitrc /etc/monit/nginx.monitrc"
   end
     
-  desc "Create and update the nginx vhost include"
+  desc <<-DESC
+  Create and update the nginx vhost include.
+  
+  mongrel_size: Number of mongrels.    
+  
+    set :mongrel_size, 3
+    
+  mongrel_port: Starting port for mongrels.
+  If there are 3 mongrels with port 9000, then instances will be at 9000, 9001, and 9002    
+  
+    set :mongrel_port, 9000
+
+  domain_name: Domain name for nginx virtual host, (without www prefix).    
+  
+    set :domain_name, "foo.com"
+    
+  DESC
   task :setup_mongrel do 
     
     # Settings
@@ -30,11 +50,5 @@ namespace :nginx do
     
     sudo "install -o root /tmp/nginx_#{application}.conf /etc/nginx/vhosts/#{application}.conf"        
   end
-    
-  # Restart nginx
-  task :restart do
-    # TODO: Monit
-    sudo "/sbin/service nginx restart"
-  end
-    
+        
 end

data/lib/recipes/packages.rb

@@ -1,6 +1,21 @@
 namespace :packages do
   
-  desc "Remove, update and install packages"
+  desc <<-DESC
+  Remove, update and install packages.
+  
+  packages_type: Package manager type. Currently can only be :yum. \n\nTODO: Support more package managers.
+  
+    set :packages_type, :yum
+    
+  packages_remove: Packages to remove.  
+    
+    set :packages_remove, [ "openoffice.org-*", "ImageMagick" ]
+    
+  packages_add: Packages to add.    
+  
+    set :packages_add, [ "gcc", "kernel-devel", "libevent-devel", "libxml2-devel" ]
+    
+  DESC
   task :install do
     
     # Settings

data/lib/recipes/rails.rb

@@ -1,7 +1,22 @@
 # Rails recipes
 namespace :rails do
   
-  desc "Create database yaml in shared path" 
+  desc <<-DESC
+  Create database yaml in shared path.
+  
+  db_name: Database name (rails).    
+  
+    set :db_name, "app_db_name"
+  
+  db_user: Database user (rails).    
+  
+    set :db_user, "app_db_user"
+    
+  db_pass: Database password (rails).    
+  
+    set :db_pass, "the_password"
+    
+  DESC
   task :setup do    
     
     # Settings

data/lib/recipes/recipes.rb

@@ -0,0 +1,30 @@
+namespace :recipes do
+  
+  desc <<-DESC
+  Run recipes, as user.
+  
+  *recipes_run*: Recipes to run.    
+    
+     set :recipes, [ "centos:setup_for_web", "packages:install", "ruby:centos:install" ]
+    
+  *recipes_user*: The user to run as for these recipes. Defaults to root.
+  
+     set :recipes_user, "root"
+    
+  DESC
+  task :run do
+      
+    # Settings
+    fetch(:recipes_run)
+    fetch_or_default(:recipes_user, "root")
+        
+    # Change user to install user for this recipes run
+    set_user(recipes_user)      
+        
+    # These run after install task and install all the apps
+    recipes_run.each do |task_name|
+      after "recipes:run", task_name
+    end
+  end
+  
+end

data/tasks/website.rake

@@ -3,6 +3,15 @@ task :website_generate => :ruby_env do
   (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
     sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
   end
+  
+  # Clean and re-create
+  FileUtils.rm_rf("website/recipes")
+  FileUtils.mkdir_p("website/recipes")  
+  sh "cap docs:recipes"
+  template = File.join(File.dirname(__FILE__), '/../website/template_recipe.rhtml')
+  Dir['docs/recipes/**/*.txt'].each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} #{template} > website/recipes/#{txt.split("/").last.gsub(/txt$/,'html')} }
+  end
 end
 
 desc 'Upload website files to rubyforge'

data/website/index.html

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      Capistrano plugins, recipes and templates
+      &#x2192; &#8216;capitate&#8217;
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -21,24 +21,34 @@
           antiAlias: true,
           autoPad: true,
           validTags: ["div"]
-      }
-      var versionBox = new curvyCorners(settings, document.getElementById("version"));
-      versionBox.applyCornersToAll();
+      };
+      
+      curvy_ids = [ "version", "recipes" ];
+      for(id in curvy_ids) {        
+        var box = new curvyCorners(settings, document.getElementById(curvy_ids[id]));
+        box.applyCornersToAll();
+      }      
     }
   </script>
 </head>
 <body>
-<div id="main">
+<div id="main" class="landing">
 
-    <h1>Capistrano plugins, recipes and templates</h1>
-    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/capitate"; return false'>
-      <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/capitate" class="numbers">0.1.7</a>
-    </div>
     <h1>&#x2192; &#8216;capitate&#8217;</h1>
 
+    <div id="version" class="clickable box" onclick='document.location = "http://rubyforge.org/projects/capitate"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/capitate" class="numbers">0.1.8</a>
+    </div>
+    
+    <div id="recipes" class="box">
+      <a href="recipes/index.html">Recipes</a> &#x2192;
+      <a href="http://svn.ducktyper.com/capitate/trunk/lib/capitate/plugins/">Plugins</a> &#x2192;
+      <a href="http://svn.ducktyper.com/capitate/trunk/lib/templates/">Templates</a>
+    </div>
 
-	<h2>What</h2>
+    <div style="clear:both">
+    <h2>What</h2>
 
 
 	<p>Capistrano plugins, recipes and templates.</p>
@@ -47,22 +57,19 @@
 	<h2>Installing</h2>
 
 
-	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">capitate</span></pre></p>
-
-
-	<p>Create a Capfile (in your project):</p>
-
-
-	<p><pre class='syntax'><span class="ident">capitate</span></pre></p>
+<pre>sudo gem install capitate</pre>
 
+	<h2>Running</h2>
 
-	<p>Create and set a profile in you Capfile:</p>
 
+	<p>Add capitate to your Capfile. Copy this somewhere near the top:</p>
 
-	<p><pre class='syntax'><span class="comment"># load &quot;config/deployment/centos-sick.rb&quot;</span></pre></p>
 
-
-	<p><em>See profiles section below for more info</em></p>
+	<p><pre class='syntax'>
+  <span class="ident">set</span> <span class="symbol">:project_root</span><span class="punct">,</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">dirname</span><span class="punct">(</span><span class="constant">__FILE__</span><span class="punct">)</span>
+  <span class="ident">require</span> <span class="punct">'</span><span class="string">capitate</span><span class="punct">'</span>  
+  <span class="ident">require</span> <span class="punct">'</span><span class="string">capitate/recipes</span><span class="punct">'</span>
+</pre></p>
 
 
 	<h2>The basics</h2>
@@ -79,49 +86,43 @@
 	</ul>
 
 
-	<h3>Profiles</h3>
-
-
-	<p>Profiles are capfiles which store lists of recipes to run for cap install and deploy and settings for those recipes.</p>
-
+	<h3>Beefing up your deploy</h3>
 
-	<p>For an example profile, see <a href="http://svn.ducktyper.com/capitate/trunk/lib/profiles/centos-sick.rb">centos-sick.rb</a></p>
 
+	<p>For an example deploy, see <a href="http://svn.ducktyper.com/capitate/trunk/lib/profiles/centos-sick.rb">centos-sick.rb</a></p>
 
-	<p><span class="caps">TODO</span>: More on profiles&#8230;</p>
 
+	<p>You could copy this profile into config/deployment/ and add it to your Capfile:</p>
 
-	<h3>Install recipes</h3>
 
+	<pre><code>load "config/deployment/centos-sick.rb"</code></pre>
 
-	<p>To install a group of applications based on a profile (see Profiles section below):</p>
 
+	<h3>Use recipes</h3>
 
-	<pre><code>cap install</code></pre>
 
+	<p><a href="recipes/index.html">View recipes documentation</a></p>
 
-	<p><em>You may need to comment out &#8220;Defaults requiretty&#8221; in /etc/sudoders on the image before capistrano recipes will work.</em></p>
 
+	<p>For example, to script the install of a group of applications as root, use <a href="recipes/recipes.html">recipes:run</a>:</p>
 
-	<h3>Deploying (application)</h3>
 
+	<p>Configure your Capfile to run it:</p>
 
-	<p>If this is the first time you&#8217;ve deployed you&#8217;ll need to run:</p>
 
+	<p><pre class='syntax'>
+<span class="ident">set</span> <span class="symbol">:recipes_run</span><span class="punct">,</span> <span class="punct">[</span> <span class="punct">&quot;</span><span class="string">ruby:centos:install</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">memcached:centos:install</span><span class="punct">&quot;</span> <span class="punct">]</span>
+<span class="ident">set</span> <span class="symbol">:recipes_user</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">root</span><span class="punct">&quot;</span>
+</pre></p>
 
-	<pre><code>cap deploy:setup</code></pre>
 
+	<p>Then run:</p>
 
-	<p>Otherwise, your standard deploy options:</p>
 
+	<pre><code>cap recipes:run</code></pre>
 
-	<pre><code>cap deploy</code></pre>
 
-
-	<pre><code>cap deploy:migrations (deploys and does migration)</code></pre>
-
-
-	<pre><code>cap deploy:migrate (only does migration on existing deployment)</code></pre>
+	<p>This is just a basic example.</p>
 
 
 	<h2>Forum</h2>
@@ -136,7 +137,7 @@
 	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
 
 
-	<p>The trunk repository is <code>http://svn.ducktyper.com/var/svn/capitate/trunk</code> for anonymous access.</p>
+	<p>The trunk repository is <code>http://svn.ducktyper.com/capitate/trunk</code> for anonymous access.</p>
 
 
 	<h2>License</h2>
@@ -149,6 +150,7 @@
 
 
 	<p>Comments are welcome. Send an email to <a href="mailto:gabrielh@gmail.com">Gabriel Handford</a> via the <a href="http://groups.google.com/group/capitate">forum</a></p>
+    </div>
     <p class="coda">
       <a href="FIXME email">Gabriel Handford</a>, 21st February 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>