ec2onrails 0.9.3 → 0.9.4

data/History.txt

@@ -1,3 +1,20 @@
+== 0.9.4 2007-10-25
+
+* ami-ecc12485 (32-bit) and ami-efc12486 (64-bit)
+* This is another test release, still not intended to be production-ready until it's tested more thoroughly. Look for version 1.0.
+* _The rebundling doesn't seem to be working._ I'll fix that in a new version. Details "here":http://rubyforge.org/tracker/?func=detail&aid=15047&group_id=4552&atid=17558
+* Ubuntu 7.10/Gutsy
+* Experimental multiple instance support.
+** *Mongrel & MySQL now listen on all ports.* Be sure your firewall settings are correct, and set a MySQL root password.
+* RDoc and RI not generated for installed gems.
+* No longer upgrades packages & gems on ec2onrails:server:setup task.
+* 32-bit and 64-bit images.
+* EC2 AMI tools version 2007-08-29.
+* NTP removed, it's no longer needed under Xen.
+* MySQL data dir dirs now under /mnt.
+* syslog now logs to /mnt/log.
+* Build now cleans apt cache, image is now 1/2 the size.
+
 == 0.9.3 2007-10-06
 
 * Initial release

data/lib/ec2onrails/capistrano_utils.rb

@@ -5,14 +5,24 @@ module Ec2onrails
       raise("error: #{$?}") unless result
     end
     
-    def make_admin_role_for(role, newrole_sym)
+    def make_admin_role_for(role)
+      newrole = "#{role.to_s}_admin".to_sym
       roles[role].each do |srv_def|
         options = srv_def.options.dup
         options[:user] = "admin"
         options[:port] = srv_def.port
         options[:no_release] = true
-        role newrole_sym, srv_def.host, options
+        role newrole, srv_def.host, options
       end
     end
+    
+    # return hostnames for the role named role_sym. It must have the options given or no hostnames will be returned
+    def hostnames_for_role(role_sym, options = {})
+      role = roles[role_sym]
+      unless role
+        return []
+      end
+      role.reject{|s| s.options != options}.collect{|s| s.host}.join(',')
+    end
   end
 end

data/lib/ec2onrails/recipes.rb

@@ -31,14 +31,16 @@ Capistrano::Configuration.instance.load do
   
   cfg = ec2onrails_config
 
-  set :image_id, Ec2onrails::VERSION::AMI_ID
+  set :ec2onrails_version, Ec2onrails::VERSION::STRING
+  set :image_id_32_bit, Ec2onrails::VERSION::AMI_ID_32_BIT
+  set :image_id_64_bit, Ec2onrails::VERSION::AMI_ID_64_BIT
   set :deploy_to, "/mnt/app"
   set :use_sudo, false
   set :user, "app"
-
-  make_admin_role_for(:web, :web_admin)
-  make_admin_role_for(:app, :app_admin)
-  make_admin_role_for(:db, :db_admin)
+  
+  make_admin_role_for :web
+  make_admin_role_for :app
+  make_admin_role_for :db
   
   roles[:web_admin].to_s
   roles[:app_admin].to_s
@@ -48,30 +50,38 @@ Capistrano::Configuration.instance.load do
   namespace :deploy do
     desc <<-DESC
       Overrides the default Capistrano deploy:start, directly calls \
-      /usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper
+      /etc/init.d/mongrel
     DESC
-    task :start, :except => { :no_release => true } do
-      run "/usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper start"
+    task :start, :roles => :app do
+      run "/etc/init.d/mongrel start"
     end
     
     desc <<-DESC
       Overrides the default Capistrano deploy:stop, directly calls \
-      /usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper
+      /etc/init.d/mongrel
     DESC
-    task :stop, :except => { :no_release => true } do
-      run "/usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper stop"
+    task :stop, :roles => :app do
+      run "/etc/init.d/mongrel stop"
     end
     
     desc <<-DESC
       Overrides the default Capistrano deploy:restart, directly calls \
-      /usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper
+      /etc/init.d/mongrel
     DESC
-    task :restart, :except => { :no_release => true } do
-      run "/usr/local/ec2onrails/bin/mongrel_cluster_ctl_wrapper restart"
+    task :restart, :roles => :app do
+      run "/etc/init.d/mongrel restart"
     end
   end
   
   namespace :ec2onrails do
+    desc <<-DESC
+      Show the AMI id's of the current images for this version of \
+      EC2 on Rails.
+    DESC
+    task :ami_ids, :roles => [:web, :db, :app] do
+      puts "32-bit server image for EC2 on Rails #{ec2onrails_version}: #{image_id_32_bit}"
+      puts "64-bit server image for EC2 on Rails #{ec2onrails_version}: #{image_id_64_bit}"
+    end
     
     desc <<-DESC
       Start a new server instance and prepare it for a cold deploy.
@@ -79,10 +89,12 @@ Capistrano::Configuration.instance.load do
     task :setup, :roles => [:web, :db, :app] do
       ec2.start_instance
       server.set_timezone
-      server.upgrade_and_install_all
+      server.install_packages
+      server.install_gems
       server.deploy_files
       server.restart_services
       deploy.setup
+      server.set_roles
       db.create
     end
     
@@ -98,15 +110,12 @@ Capistrano::Configuration.instance.load do
       deploy.restart
     end
     
-    namespace :ec2 do
+    namespace :ec2 do      
       desc <<-DESC
         Start an instance, using the AMI of the correct version to match this gem.
       DESC
       task :start_instance, :roles => [:web, :db, :app] do
         # TODO
-        # ec2 = EC2::Base.new(:access_key_id => access_key_id, :secret_access_key => secret_access_key)
-        # ec2.run_instances(:image_id => image_id, :key_name => key_name, :group_id => group_id)
-        # wait until image is booted
       end
       
       desc <<-DESC
@@ -119,7 +128,7 @@ Capistrano::Configuration.instance.load do
     
     namespace :db do
       desc <<-DESC
-        Load configuration info for the production database from \
+        [internal] Load configuration info for the production database from \
         config/database.yml.
       DESC
       task :load_config, :roles => :db do
@@ -127,9 +136,19 @@ Capistrano::Configuration.instance.load do
         cfg[:production_db_name] = db_config['database']
         cfg[:production_db_user] = db_config['username']
         cfg[:production_db_password] = db_config['password']
+        cfg[:production_db_host] = db_config['host']
+        cfg[:production_db_socket] = db_config['socket']
+        
+        if (cfg[:production_db_host].nil? || cfg[:production_db_host].empty?) && 
+          (cfg[:production_db_host] != 'localhost' || cfg[:production_db_host] != '127.0.0.1') && 
+          (cfg[:production_db_socket].nil? || cfg[:production_db_socket].empty?)
+            raise "ERROR: missing database config. Make sure database.yml contains a 'production' section with either 'host: localhost' or 'socket: /var/run/mysqld/mysqld.sock'."
+        end
         
         [cfg[:production_db_name], cfg[:production_db_user], cfg[:production_db_password]].each do |s|
-          if s.match(/['"]/)
+          if s.nil? || s.empty?
+            raise "ERROR: missing database config. Make sure database.yml contains a 'production' section with a database name, user, and password."
+          elsif s.match(/['"]/)
             raise "ERROR: database config string '#{s}' contains quotes."
           end
         end
@@ -144,7 +163,7 @@ Capistrano::Configuration.instance.load do
         on_rollback { drop }
         load_config
         run "echo 'create database #{cfg[:production_db_name]};' | mysql -u root"
-        run "echo \"grant all on #{cfg[:production_db_name]}.* to '#{cfg[:production_db_user]}'@'localhost' identified by '#{cfg[:production_db_password]}';\" | mysql -u root"
+        run "echo \"grant all on #{cfg[:production_db_name]}.* to '#{cfg[:production_db_user]}'@'%' identified by '#{cfg[:production_db_password]}';\" | mysql -u root"
       end
       
       desc <<-DESC
@@ -195,6 +214,16 @@ Capistrano::Configuration.instance.load do
     end
     
     namespace :server do
+      desc <<-DESC
+        Tell the servers what roles they are in. This configures them with \
+        the appropriate settings for each role, and starts and/or stops the \
+        relevant services.
+      DESC
+      task :set_roles, :roles => [:web_admin, :db_admin, :app_admin] do
+        # TODO generate this based on the roles that actually exist so arbitrary new ones can be added
+        sudo "/usr/local/ec2onrails/bin/set_roles.rb web=#{hostnames_for_role(:web)} app=#{hostnames_for_role(:app)} db_primary=#{hostnames_for_role(:db, :primary => true)}"
+      end
+      
       desc <<-DESC
         Upgrade to the newest versions of all Ubuntu packages.
       DESC
@@ -207,7 +236,7 @@ Capistrano::Configuration.instance.load do
         Upgrade to the newest versions of all rubygems.
       DESC
       task :upgrade_gems, :roles => [:web_admin, :db_admin, :app_admin] do
-        sudo "gem update -y"
+        sudo "gem update -y --no-rdoc --no-ri"
       end
       
       desc <<-DESC
@@ -230,7 +259,7 @@ Capistrano::Configuration.instance.load do
       DESC
       task :install_gems, :roles => [:web_admin, :db_admin, :app_admin] do
         if cfg[:rubygems] && cfg[:rubygems].any?
-          sudo "gem install #{cfg[:rubygems].join(' ')} -y" do |ch, str, data|
+          sudo "gem install #{cfg[:rubygems].join(' ')} -y --no-rdoc --no-ri" do |ch, str, data|
             ch[:data] ||= ""
             ch[:data] << data
             if data =~ />\s*$/
@@ -259,7 +288,7 @@ Capistrano::Configuration.instance.load do
         Set the timezone using the value of the variable named timezone. \
         Valid options for timezone can be determined by the contents of \
         /usr/share/zoneinfo, which can be seen here: \
-        http://packages.ubuntu.com/cgi-bin/search_contents.pl?searchmode=filelist&word=tzdata&version=feisty&arch=all&page=1&number=all \
+        http://packages.ubuntu.com/cgi-bin/search_contents.pl?searchmode=filelist&word=tzdata&version=gutsy&arch=all&page=1&number=all \
         Remove 'usr/share/zoneinfo/' from the filename, and use the last \
         directory and file as the value. For example 'Africa/Abidjan' or \
         'posix/GMT' or 'Canada/Eastern'.
@@ -291,6 +320,9 @@ Capistrano::Configuration.instance.load do
       end
       
       desc <<-DESC
+        Restart a set of services. Set ec2onrails_config[:services_to_restart] \
+        to an array of strings. It's assumed that each service has a script \
+        in /etc/init.d
       DESC
       task :restart_services, :roles => [:web_admin, :db_admin, :app_admin] do
         if cfg[:services_to_restart] && cfg[:services_to_restart].any?

data/lib/ec2onrails/version.rb

@@ -20,9 +20,10 @@ module Ec2onrails #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 9
-    TINY  = 3
+    TINY  = 4
     STRING = [MAJOR, MINOR, TINY].join('.')
     
-    AMI_ID = 'ami-a3f91cca'
+    AMI_ID_32_BIT = 'ami-ecc12485'
+    AMI_ID_64_BIT = 'ami-efc12486'
   end
 end

data/website/index.html

@@ -33,33 +33,346 @@
     <h1>EC2 on Rails</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/ec2onrails"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/ec2onrails" class="numbers">0.9.3</a>
+      <a href="http://rubyforge.org/projects/ec2onrails" class="numbers">0.9.4</a>
     </div>
-    <h2>This page will be updated soon!</h2>
+    <h2>Deploy a Ruby on Rails app on <span class="caps">EC2</span> in five minutes</h2>
 
 
-	<h2>What</h2>
+	<p><span class="caps">EC2</span> on Rails is an Ubuntu Linux server image for 
+<a href="http://www.amazon.com/b/ref=sc_fe_l_2/102-6342260-7987311?ie=UTF8&#38;node=201590011&#38;no=3435361">Amazon&#8217;s <span class="caps">EC2</span> hosting service</a>
+that&#8217;s ready to run a standard Ruby on Rails application with little or no customization. 
+It&#8217;s a Ruby on Rails <a href="http://en.wikipedia.org/wiki/Virtual_appliance">virtual appliance</a>.</p>
 
 
-	<h2>Installing</h2>
+	<p>If you have an <span class="caps">EC2</span> account and a public keypair you&#8217;re five minutes away from deploying
+your Rails app.</p>
 
 
-	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">ec2onrails</span></pre></p>
+	<p><em>Deploying a simple rails app is simple, and complex customization (if required) is possible.</em></p>
 
 
-	<h2>The basics</h2>
+	<p>Features of the <span class="caps">EC2</span> image:</p>
 
 
-	<h2>Demonstration of usage</h2>
+	<ul>
+	<li>Ready to deploy a Rails app with little or no configuration of the server required.</li>
+		<li>Automatic backup of MySQL database to S3.</li>
+		<li>Capistrano tasks to customize the server image, archive and restore the database to/from S3, and more (available as a rubygem).</li>
+		<li>Mongrel_cluster behind Apache 2.2, configured according to 
+  <a href="http://blog.codahale.com/2006/06/19/time-for-a-grown-up-server-rails-mongrel-apache-capistrano-and-you/">Coda Hale&#8217;s excellent guide</a>
+  with /etc/init.d startup script</li>
+		<li>Ruby on Rails 1.2.5</li>
+		<li>Ruby 1.8.6</li>
+		<li>MySQL 5</li>
+		<li>Ubuntu 7.10 &#8220;Gutsy&#8221; with <a href="http://wiki.xensource.com/xenwiki/XenSpecificGlibc">Xen versions of standard libs</a> (<a href="http://packages.ubuntu.com/feisty/libs/libc6-xen">libc6-xen</a> package).</li>
+		<li>Amazon <span class="caps">AMI</span> tools installed</li>
+		<li>A script to rebundle a customized version of the image in one step if required</li>
+		<li>MySQL and Apache configured to write logs to /mnt/log so you don&#8217;t fill up <span class="caps">EC2</span>&#8217;s small root filesystem</li>
+		<li>32-bit and 64-bit images available (supports all instance types, small to extra large).</li>
+		<li>Created using a publicly available (GPL) build file.</li>
+		<li>Multiple instance support (though it&#8217;s still experimental, not fully tested yet).</li>
+	</ul>
 
 
-	<h2>Forum</h2>
+	<h2>Using the image</h2>
 
 
-	<p><a href="http://groups.google.com/group/ec2-on-rails-announce">Announcements</a></p>
+	<p>This documentation will be improved soon, for now hopefully this covers the basics.</p>
 
 
-	<p><a href="http://groups.google.com/group/ec2-on-rails-discuss">Discussion</a></p>
+	<h4>1. Install the gem</h4>
+
+
+<pre>sudo gem install ec2onrails</pre>
+
+	<h4>2. Add the config files to your Rails app</h4>
+
+
+	<p>Put <a href="http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/Capfile">Capfile</a> 
+in the root of your rails folder, and put
+<a href="http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/deploy.rb">deploy.rb</a> 
+and
+<a href="http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/s3.yml">s3.yml</a>
+in the config folder.</p>
+
+
+	<p>Be sure to customize those files and read the comments.</p>
+
+
+	<p>Also, if you&#8217;re using a separate instance for the database, use the hostname &#8220;db_primary&#8221; 
+in your database.yml file. After running &#8220;cap ec2onrails:server:set_roles&#8221; it will resolve
+to the instance defined in your Capistrano &#8220;db&#8221; role.</p>
+
+
+	<h4>4. Start up one or more instances of the image.</h4>
+
+
+	<p>Soon there will be a Capistrano task to do this for you. In the meantime read the 
+<a href="http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html">running an instance section</a>
+in Amazon&#8217;s getting started guide.</p>
+
+
+The image id&#8217;s of the current images are:
+	<ul>
+	<li>32-bit: <strong>ami-ecc12485</strong>.</li>
+		<li>64-bit: <strong>ami-efc12486</strong>.</li>
+	</ul>
+
+
+	<p>(Please read the change log below for release notes. <span class="caps">NOTE</span>: multiple 
+instance support isn&#8217;t fully tested yet, look for version 1.0 soon!)</p>
+
+
+	<p>As is <a href="http://docs.amazonwebservices.com/AWSEC2/2007-08-29/DeveloperGuide/public-ami-guidelines.html">standard for public <span class="caps">AMI</span>&#8217;s</a>, 
+password-based logins are disabled. You log in with your own 
+<a href="http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html">public/private keypair</a>.</p>
+
+
+	<p>Most basic things can be configured automatically by the Capistrano tasks, but if you want to 
+you can login by ssh as a user named &#8220;admin&#8221; (has sudo ability) or as &#8220;app&#8221; (the user 
+that the app runs as, does not have sudo ability). The Capistrano tasks automatically 
+use the app user use to deploy the app, and the admin user for server admin tasks 
+that require sudo.</p>
+
+
+	<p>Double-check <a href="http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html">your firewall settings</a>. 
+Be sure that you haven&#8217;t allowed public access to any ports other than <span class="caps">TCP 22</span> and <span class="caps">TCP 80</span>.
+If you&#8217;re using multiple instances, be sure to allow them network access to each other.</p>
+
+
+	<h4>5. Deploy the app with Capistrano</h4>
+
+
+<pre>
+cap ec2onrails:setup
+cap deploy:migrations
+</pre>
+
+	<p>Yes, it&#8217;s that easy! The setup task will set the server&#8217;s timezone, install any 
+gems and Ubuntu packages that you specified in the config file, and 
+create your production database.</p>
+
+
+	<p>That&#8217;s it, you&#8217;re done.</p>
+
+
+	<h2>Capistrano tasks</h2>
+
+
+	<p>I&#8217;ll post full documentation for the Capistrano tasks soon, in the meantime here&#8217;s a brief summary:</p>
+
+
+Server config tasks. These run as the admin user. You can specify lists of
+gems and Ubuntu packages to be installed. The deploy_files task uploads
+files to the server (they will be owned by root). It&#8217;s intended mainly for
+customized config files for new packages installed via the install_packages
+task.
+	<ul>
+	<li>ec2onrails:server:deploy_files</li>
+		<li>ec2onrails:server:set_timezone</li>
+		<li>ec2onrails:server:upgrade_gems</li>
+		<li>ec2onrails:server:upgrade_packages</li>
+		<li>ec2onrails:server:install_gems</li>
+		<li>ec2onrails:server:install_packages</li>
+		<li>ec2onrails:server:upgrade_and_install_all</li>
+		<li>ec2onrails:server:restart_services</li>
+		<li>ec2onrails:server:set_roles
+- Customizes each instance for it&#8217;s role(s) (as defined in your Capistrano deploy.rb file).
+For now this just makes sure that only the appropriate services (Apache, Mongrel, and/or MySQL)
+are running. Eventually this will customize settings for the running services also. Note that
+an instance can have more than one role. If there&#8217;s only one instance it will have all roles.</li>
+	</ul>
+
+
+Database management tasks: archive and restore can operate on any specified S3 bucket. 
+For example, I use this to restore the current production data (from my actual production backup
+bucket) onto a staging server that has the current production version of my
+app. I then deploy the new version which tests migrations exactly as they&#8217;ll
+run on the production server.
+	<ul>
+	<li>ec2onrails:db:archive</li>
+		<li>ec2onrails:db:restore</li>
+		<li>ec2onrails:db:create</li>
+		<li>ec2onrails:db:drop</li>
+		<li>ec2onrails:db:recreate</li>
+		<li>ec2onrails:db:set_root_password</li>
+	</ul>
+
+
+	<ul>
+	<li>ec2onrails:ami_ids
+- Shows the <span class="caps">AMI</span> id&#8217;s of the images that match the current version of the gem.</li>
+	</ul>
+
+
+	<ul>
+	<li>ec2onrails:setup
+- This is a convenience task to get a new instance completely set up in one
+step, everything except deploying the app.</li>
+	</ul>
+
+
+	<ul>
+	<li>ec2onrails:restore_db_and_deploy
+- Another convenience task to recreate the db, restore data to it from an s3
+bucket and deploy the app, useful to set up a staging server.</li>
+	</ul>
+
+
+	<h2>Saving your own customized version of the image.</h2>
+
+
+I&#8217;m trying to make the image configurable enough that you won&#8217;t need to do this, but 
+if you want to save a customized version of the image, there is a script to do it: 
+<code>/usr/local/ec2onrails/bin/rebundle.sh</code>. It takes a long time and there 
+are long periods with no output so you might want to hit a key once in a while 
+(or set &#8220;ServerAliveInterval 60&#8221; in your ssh_config file) to avoid being disconnected 
+while it&#8217;s running.
+
+	<p>It expects a directory, /mnt/aws-config, that contains a config file and your <span class="caps">AWS</span> 
+access identifiers. The contents of the directory are the following three files:</p>
+
+
+	<ul>
+	<li>cert-XXXX.pem and pk-XXXX.pem. These are the X.509 certificate and private key files from your Amazon access key identifiers.</li>
+		<li>A file named config. It&#8217;s contents should look like the following:</li>
+	</ul>
+
+
+<pre>
+AWS_ACCOUNT_ID=1234-1234-1234
+KEY_FILE_NAME=pk-XXXX.pem
+CERT_FILE_NAME=cert-XXXX.pem
+AWS_ACCESS_KEY_ID=ABC0123
+AWS_SECRET_ACCESS_KEY=abc0123abc0123abc0123
+BUCKET_BASE_NAME=a-string-identifier
+</pre>
+
+	<h2>Building the image</h2>
+
+
+	<p>Building the image is not required, most people will simply use the prebuilt public
+image, but there is also a Rake build script that builds the image, and optionally bundles 
+and uploads it to S3. 
+It should run on any Linux system, including one of the stock Fedora-based Amazon public <span class="caps">AMI</span>&#8217;s 
+(it is tested on <a href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=994&#38;categoryID=101">Amazon&#8217;s <span class="caps">FC6</span> x86_64 image</a>).</p>
+
+
+	<h2>Mailing lists</h2>
+
+
+	<p>There are two Google groups, one for 
+<a href="http://groups.google.com/group/ec2-on-rails-announce">announcements</a>
+and one for 
+<a href="http://groups.google.com/group/ec2-on-rails-discuss">discussion</a>.</p>
+
+
+	<h2>Comments</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="http://pauldowman.com/contact/">Paul Dowman</a> 
+or to the <a href="http://groups.google.com/group/ec2-on-rails-discuss">Google group</a>.
+If you find bugs please file them 
+<a href="http://rubyforge.org/tracker/?atid=17558&#38;group_id=4552&#38;func=browse">here</a> 
+or send me an <a href="http://pauldowman.com/contact/">email</a>.</p>
+
+
+	<h2>Change log</h2>
+
+
+	<p>Also see the <a href="http://rubyforge.org/tracker/?atid=17558&#38;group_id=4552&#38;func=browse">list of open issues</a>.</p>
+
+
+	<h4>0.9.4, ami-ecc12485 (32-bit) and ami-efc12486 (64-bit)</h4>
+
+
+7 Oct, 2007
+	<ul>
+	<li>This is another test release, still not intended to be production-ready until it&#8217;s tested more thoroughly. Look for version 1.0.</li>
+		<li><em>The rebundling doesn&#8217;t seem to be working.</em> I&#8217;ll fix that in a new version. Details <a href="http://rubyforge.org/tracker/?func=detail&#38;aid=15047&#38;group_id=4552&#38;atid=17558">here</a></li>
+		<li>Ubuntu 7.10/Gutsy</li>
+		<li>Experimental multiple instance support.
+	<ul>
+	<li><strong>Mongrel &#38; MySQL now listen on all ports.</strong> Be sure your firewall settings are correct, and set a MySQL root password.</li>
+	</ul>
+	</li>
+		<li>RDoc and RI not generated for installed gems.</li>
+		<li>No longer upgrades packages &#38; gems on ec2onrails:server:setup task.</li>
+		<li>32-bit and 64-bit images.</li>
+		<li><span class="caps">EC2 AMI</span> tools version 2007-08-29.</li>
+		<li><span class="caps">NTP</span> removed, it&#8217;s no longer needed under Xen.</li>
+		<li>MySQL data dir dirs now under /mnt.</li>
+		<li>syslog now logs to /mnt/log.</li>
+		<li>Build now cleans apt cache, image is now 1/2 the size.</li>
+	</ul>
+
+
+	<h4>0.9.3, ami-a3f91cca</h4>
+
+
+23 Oct, 2007
+	<ul>
+	<li>This is another test release, still not intended to be production-ready until it&#8217;s tested more thoroughly. Look for version 1.0.</li>
+		<li>There is now a rubygem available with Capistrano tasks.</li>
+		<li>&#8220;admin&#8221; user added, server admin cap tasks run as this user</li>
+		<li>MySQL settings tweaked to reflect large amount of <span class="caps">RAM</span> available on <span class="caps">EC2</span> instances.</li>
+		<li><a href="issues">http://code.google.com/p/ec2-on-rails/issues/list?can=1&#38;q=label%3AFixed-in-0_9_3</a> fixed in this release</li>
+	</ul>
+
+
+	<h4>0.9.2, ami-0cf61365</h4>
+
+
+13 Sept, 2007
+	<ul>
+	<li>This is another test release, still not intended to be production-ready until it&#8217;s tested more thoroughly. Look for version 1.0.</li>
+		<li><a href="issues">http://code.google.com/p/ec2-on-rails/issues/list?can=1&#38;q=label%3AFixed-in-0_9_2</a> fixed in this release</li>
+	</ul>
+
+
+	<h4>0.9.1, ami-99f712f0</h4>
+
+
+11 Sept, 2007
+	<ul>
+	<li>This is another test release, still not intended to be production-ready until it&#8217;s tested more thoroughly. Look for version 1.0.</li>
+		<li>Fixed permissions on /var/lib/dhcp3</li>
+		<li><a href="issues">http://code.google.com/p/ec2-on-rails/issues/list?can=1&#38;q=label%3AFixed-in-0_9_1</a> fixed in this release</li>
+	</ul>
+
+
+	<h4>0.9.0, ami-bdf411d4</h4>
+
+
+7 Sept 2007
+	<ul>
+	<li>First release built with new rake build script, this is a test release, not intended to be production-ready until it&#8217;s tested more thoroughly.</li>
+		<li>Amazon <span class="caps">EC2 API</span> tools (java-based) no longer installed by default because they&#8217;re not used on most servers. They&#8217;re needed only for registering a rebundled image so there&#8217;s now a script to install them: /usr/local/ec2-on-rails/install_ec2_api_tools.sh. The ruby-based <span class="caps">EC2</span> image tools are still installed.</li>
+		<li>Removed <a href="Java">http://packages.ubuntu.com/feisty/libs/sun-java6-jre</a> and it&#8217;s massive list of dependencies because it was only needed for the <span class="caps">EC2 API</span> tools. This saved a huge amount of space.</li>
+		<li>Removed ImageMagick, RMagick and hpricot due to popular demand. There will soon be cap2 tasks to customize which packages and gems are installed.</li>
+	</ul>
+
+
+	<h4>0.8.1, ami-b79a7fde</h4>
+
+
+29 July 2007
+	<ul>
+	<li>Fixed S3 backup cron job.</li>
+		<li>Added script to restore data from S3 (/usr/local/aws/bin/restore_app_db.rb). This is useful when setting up a staging server to test your deployment, you can have it set up with a copy of your production data to test your migrations.</li>
+		<li>Rewrite rule now allows images/css on maintenance page</li>
+		<li>Added empty /etc/apache2/sites-available/app.custom for custom Apache configuration in a separate file (so it can be deployed by rsync more easily).</li>
+		<li>Added ImageMagick, RMagick and hpricot due to popular demand.</li>
+	</ul>
+
+
+	<h4>0.8.0, ami-4e907527</h4>
+
+
+20 June 2007
+	<ul>
+	<li>Initial release.</li>
+	</ul>
 
 
 	<h2>How to submit patches</h2>
@@ -75,19 +388,18 @@
 
 
 	<p>This code is free to use under the terms of the <span class="caps">GPL</span> v2.</p>
-
-
-	<h2>Contact</h2>
-
-
-	<p>Comments are welcome. Send an email to <a href="http://pauldowman.com/contact">Paul Dowman</a> or to the <a href="http://groups.google.com/group/ec2-on-rails">forum</a></p>
     <p class="coda">
-      <a href="http://pauldowman.com/contact/">Paul Dowman</a>, 6th October 2007<br>
+      <a href="http://pauldowman.com/contact/">Paul Dowman</a>, 25th October 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>
 
-<!-- insert site tracking codes here, like Google Urchin -->
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-2759652-1";
+urchinTracker();
+</script>
 
 </body>
 </html>

data/website/index.txt

@@ -1,27 +1,266 @@
 h1. EC2 on Rails
 
-h2. This page will be updated soon!
 
+h2. Deploy a Ruby on Rails app on EC2 in five minutes
 
-h2. What
+EC2 on Rails is an Ubuntu Linux server image for 
+"Amazon's EC2 hosting service":http://www.amazon.com/b/ref=sc_fe_l_2/102-6342260-7987311?ie=UTF8&node=201590011&no=3435361
+that's ready to run a standard Ruby on Rails application with little or no customization. 
+It's a Ruby on Rails "virtual appliance":http://en.wikipedia.org/wiki/Virtual_appliance.
 
+If you have an EC2 account and a public keypair you're five minutes away from deploying
+your Rails app.
 
-h2. Installing
+_Deploying a simple rails app is simple, and complex customization (if required) is possible._
 
-<pre syntax="ruby">sudo gem install ec2onrails</pre>
+Features of the EC2 image:
 
-h2. The basics
+* Ready to deploy a Rails app with little or no configuration of the server required.
+* Automatic backup of MySQL database to S3.
+* Capistrano tasks to customize the server image, archive and restore the database to/from S3, and more (available as a rubygem).
+* Mongrel_cluster behind Apache 2.2, configured according to 
+  "Coda Hale's excellent guide":http://blog.codahale.com/2006/06/19/time-for-a-grown-up-server-rails-mongrel-apache-capistrano-and-you/
+  with /etc/init.d startup script
+* Ruby on Rails 1.2.5
+* Ruby 1.8.6
+* MySQL 5
+* Ubuntu 7.10 "Gutsy" with "Xen versions of standard libs":http://wiki.xensource.com/xenwiki/XenSpecificGlibc ("libc6-xen":http://packages.ubuntu.com/feisty/libs/libc6-xen package).
+* Amazon AMI tools installed
+* A script to rebundle a customized version of the image in one step if required
+* MySQL and Apache configured to write logs to /mnt/log so you don't fill up EC2's small root filesystem
+* 32-bit and 64-bit images available (supports all instance types, small to extra large).
+* Created using a publicly available (GPL) build file.
+* Multiple instance support (though it's still experimental, not fully tested yet).
 
 
-h2. Demonstration of usage
+h2. Using the image
 
+This documentation will be improved soon, for now hopefully this covers the basics.
 
+h4. 1. Install the gem
 
-h2. Forum
+<pre>sudo gem install ec2onrails</pre>
 
-"Announcements":http://groups.google.com/group/ec2-on-rails-announce
+h4. 2. Add the config files to your Rails app
 
-"Discussion":http://groups.google.com/group/ec2-on-rails-discuss
+Put "Capfile":http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/Capfile 
+in the root of your rails folder, and put
+"deploy.rb":http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/deploy.rb 
+and
+"s3.yml":http://ec2onrails.rubyforge.org/svn/trunk/documentation/examples/s3.yml
+in the config folder.
+
+Be sure to customize those files and read the comments.
+
+Also, if you're using a separate instance for the database, use the hostname "db_primary"
+in your database.yml file. After running "cap ec2onrails:server:set_roles" it will resolve
+to the instance defined in your Capistrano "db" role.
+
+h4. 4. Start up one or more instances of the image.
+
+Soon there will be a Capistrano task to do this for you. In the meantime read the 
+"running an instance section":http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html
+in Amazon's getting started guide.
+
+The image id's of the current images are:
+* 32-bit: *ami-ecc12485*.
+* 64-bit: *ami-efc12486*.
+
+(Please read the change log below for release notes. NOTE: multiple 
+instance support isn't fully tested yet, look for version 1.0 soon!)
+
+As is "standard for public AMI's":http://docs.amazonwebservices.com/AWSEC2/2007-08-29/DeveloperGuide/public-ami-guidelines.html, 
+password-based logins are disabled. You log in with your own 
+"public/private keypair":http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html.
+
+Most basic things can be configured automatically by the Capistrano tasks, but if you want to 
+you can login by ssh as a user named "admin" (has sudo ability) or as "app" (the user 
+that the app runs as, does not have sudo ability). The Capistrano tasks automatically 
+use the app user use to deploy the app, and the admin user for server admin tasks 
+that require sudo.
+
+Double-check "your firewall settings":http://docs.amazonwebservices.com/AWSEC2/2007-08-29/GettingStartedGuide/running-an-instance.html. 
+Be sure that you haven't allowed public access to any ports other than TCP 22 and TCP 80.
+If you're using multiple instances, be sure to allow them network access to each other.
+
+
+h4. 5. Deploy the app with Capistrano
+
+<pre>
+cap ec2onrails:setup
+cap deploy:migrations
+</pre>
+
+Yes, it's that easy! The setup task will set the server's timezone, install any 
+gems and Ubuntu packages that you specified in the config file, and 
+create your production database.
+
+That's it, you're done.
+
+h2. Capistrano tasks
+
+I'll post full documentation for the Capistrano tasks soon, in the meantime here's a brief summary:
+
+Server config tasks. These run as the admin user. You can specify lists of
+gems and Ubuntu packages to be installed. The deploy_files task uploads
+files to the server (they will be owned by root). It's intended mainly for
+customized config files for new packages installed via the install_packages
+task.
+* ec2onrails:server:deploy_files
+* ec2onrails:server:set_timezone
+* ec2onrails:server:upgrade_gems
+* ec2onrails:server:upgrade_packages
+* ec2onrails:server:install_gems
+* ec2onrails:server:install_packages
+* ec2onrails:server:upgrade_and_install_all
+* ec2onrails:server:restart_services
+* ec2onrails:server:set_roles
+- Customizes each instance for it's role(s) (as defined in your Capistrano deploy.rb file).
+For now this just makes sure that only the appropriate services (Apache, Mongrel, and/or MySQL)
+are running. Eventually this will customize settings for the running services also. Note that
+an instance can have more than one role. If there's only one instance it will have all roles.
+
+Database management tasks: archive and restore can operate on any specified S3 bucket. 
+For example, I use this to restore the current production data (from my actual production backup
+bucket) onto a staging server that has the current production version of my
+app. I then deploy the new version which tests migrations exactly as they'll
+run on the production server.
+* ec2onrails:db:archive
+* ec2onrails:db:restore
+* ec2onrails:db:create
+* ec2onrails:db:drop
+* ec2onrails:db:recreate
+* ec2onrails:db:set_root_password
+
+* ec2onrails:ami_ids
+- Shows the AMI id's of the images that match the current version of the gem.
+
+* ec2onrails:setup
+- This is a convenience task to get a new instance completely set up in one
+step, everything except deploying the app.
+
+* ec2onrails:restore_db_and_deploy
+- Another convenience task to recreate the db, restore data to it from an s3
+bucket and deploy the app, useful to set up a staging server.
+
+
+h2. Saving your own customized version of the image.
+
+I'm trying to make the image configurable enough that you won't need to do this, but 
+if you want to save a customized version of the image, there is a script to do it: 
+<code>/usr/local/ec2onrails/bin/rebundle.sh</code>. It takes a long time and there 
+are long periods with no output so you might want to hit a key once in a while 
+(or set "ServerAliveInterval 60" in your ssh_config file) to avoid being disconnected 
+while it's running.
+
+It expects a directory, /mnt/aws-config, that contains a config file and your AWS 
+access identifiers. The contents of the directory are the following three files:
+
+* cert-XXXX.pem and pk-XXXX.pem. These are the X.509 certificate and private key files from your Amazon access key identifiers.
+* A file named config. It's contents should look like the following:
+
+<pre>
+AWS_ACCOUNT_ID=1234-1234-1234
+KEY_FILE_NAME=pk-XXXX.pem
+CERT_FILE_NAME=cert-XXXX.pem
+AWS_ACCESS_KEY_ID=ABC0123
+AWS_SECRET_ACCESS_KEY=abc0123abc0123abc0123
+BUCKET_BASE_NAME=a-string-identifier
+</pre>
+
+
+h2. Building the image
+
+Building the image is not required, most people will simply use the prebuilt public
+image, but there is also a Rake build script that builds the image, and optionally bundles 
+and uploads it to S3. 
+It should run on any Linux system, including one of the stock Fedora-based Amazon public AMI's 
+(it is tested on "Amazon's FC6 x86_64 image":http://developer.amazonwebservices.com/connect/entry.jspa?externalID=994&categoryID=101).
+
+
+h2. Mailing lists
+
+There are two Google groups, one for 
+"announcements":http://groups.google.com/group/ec2-on-rails-announce
+and one for 
+"discussion":http://groups.google.com/group/ec2-on-rails-discuss.
+
+
+h2. Comments
+
+Comments are welcome. Send an email to "Paul Dowman":http://pauldowman.com/contact/ 
+or to the "Google group":http://groups.google.com/group/ec2-on-rails-discuss.
+If you find bugs please file them 
+"here":http://rubyforge.org/tracker/?atid=17558&group_id=4552&func=browse 
+or send me an "email":http://pauldowman.com/contact/.
+
+
+h2. Change log
+
+Also see the "list of open issues":http://rubyforge.org/tracker/?atid=17558&group_id=4552&func=browse.
+
+
+h4. 0.9.4, ami-ecc12485 (32-bit) and ami-efc12486 (64-bit)
+
+7 Oct, 2007
+* This is another test release, still not intended to be production-ready until it's tested more thoroughly. Look for version 1.0.
+* _The rebundling doesn't seem to be working._ I'll fix that in a new version. Details "here":http://rubyforge.org/tracker/?func=detail&aid=15047&group_id=4552&atid=17558
+* Ubuntu 7.10/Gutsy
+* Experimental multiple instance support.
+** *Mongrel & MySQL now listen on all ports.* Be sure your firewall settings are correct, and set a MySQL root password.
+* RDoc and RI not generated for installed gems.
+* No longer upgrades packages & gems on ec2onrails:server:setup task.
+* 32-bit and 64-bit images.
+* EC2 AMI tools version 2007-08-29.
+* NTP removed, it's no longer needed under Xen.
+* MySQL data dir dirs now under /mnt.
+* syslog now logs to /mnt/log.
+* Build now cleans apt cache, image is now 1/2 the size.
+
+
+h4. 0.9.3, ami-a3f91cca
+
+23 Oct, 2007
+* This is another test release, still not intended to be production-ready until it's tested more thoroughly. Look for version 1.0.
+* There is now a rubygem available with Capistrano tasks.
+* "admin" user added, server admin cap tasks run as this user
+* MySQL settings tweaked to reflect large amount of RAM available on EC2 instances.
+* "http://code.google.com/p/ec2-on-rails/issues/list?can=1&q=label%3AFixed-in-0_9_3":issues fixed in this release
+
+h4. 0.9.2, ami-0cf61365
+
+13 Sept, 2007
+* This is another test release, still not intended to be production-ready until it's tested more thoroughly. Look for version 1.0.
+* "http://code.google.com/p/ec2-on-rails/issues/list?can=1&q=label%3AFixed-in-0_9_2":issues fixed in this release
+
+h4. 0.9.1, ami-99f712f0
+
+11 Sept, 2007
+* This is another test release, still not intended to be production-ready until it's tested more thoroughly. Look for version 1.0.
+* Fixed permissions on /var/lib/dhcp3
+* "http://code.google.com/p/ec2-on-rails/issues/list?can=1&q=label%3AFixed-in-0_9_1":issues fixed in this release
+
+h4. 0.9.0, ami-bdf411d4
+
+7 Sept 2007
+* First release built with new rake build script, this is a test release, not intended to be production-ready until it's tested more thoroughly.
+* Amazon EC2 API tools (java-based) no longer installed by default because they're not used on most servers. They're needed only for registering a rebundled image so there's now a script to install them: /usr/local/ec2-on-rails/install_ec2_api_tools.sh. The ruby-based EC2 image tools are still installed.
+* Removed "http://packages.ubuntu.com/feisty/libs/sun-java6-jre":Java and it's massive list of dependencies because it was only needed for the EC2 API tools. This saved a huge amount of space.
+* Removed ImageMagick, RMagick and hpricot due to popular demand. There will soon be cap2 tasks to customize which packages and gems are installed.
+
+h4. 0.8.1, ami-b79a7fde
+
+29 July 2007
+* Fixed S3 backup cron job.
+* Added script to restore data from S3 (/usr/local/aws/bin/restore_app_db.rb). This is useful when setting up a staging server to test your deployment, you can have it set up with a copy of your production data to test your migrations.
+* Rewrite rule now allows images/css on maintenance page
+* Added empty /etc/apache2/sites-available/app.custom for custom Apache configuration in a separate file (so it can be deployed by rsync more easily).
+* Added ImageMagick, RMagick and hpricot due to popular demand.
+
+h4. 0.8.0, ami-4e907527
+
+20 June 2007
+* Initial release.
 
 
 h2. How to submit patches
@@ -30,11 +269,7 @@ Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/
 
 The trunk repository is <code>svn://rubyforge.org/var/svn/ec2onrails/trunk</code> for anonymous access.
 
+
 h2. License
 
 This code is free to use under the terms of the GPL v2. 
-
-h2. Contact
-
-Comments are welcome. Send an email to "Paul Dowman":http://pauldowman.com/contact or to the "forum":http://groups.google.com/group/ec2-on-rails
-

data/website/stylesheets/screen.css

@@ -1,5 +1,5 @@
 body {
-  background-color: #E1D1F1;
+  background-color: white;
   font-family: "Georgia", sans-serif;
   font-size: 16px;
   line-height: 1.6em;
@@ -17,14 +17,19 @@ h1 {
   letter-spacing: -0.1ex;
 	margin: 5px;
 }
+h4 {
+  margin-bottom: 0;
+}
+ul {
+  margin-top: 0;
+}
 li {
   padding: 0;
   margin: 0;
   list-style-type: square;
 }
 a {
-  color: #5E5AFF;
-	background-color: #DAC;
+  color: #00266F;
   font-weight: normal;
   text-decoration: underline;
 }
@@ -45,7 +50,7 @@ blockquote {
 }
 .coda {
   text-align: right;
-  color: #77f;
+  color: #444;
   font-size: smaller;
 }
 
@@ -101,8 +106,8 @@ pre, code {
   text-align: right;
   font-family: sans-serif;
   font-weight: normal;
-  background-color: #B3ABFF;
-  color: #141331;
+  background-color: #7CBBFF;
+  color: #7CBBFF;
   padding: 15px 20px 10px 20px;
   margin: 0 auto;
 	margin-top: 15px;
@@ -120,7 +125,7 @@ pre, code {
 #version p {
   text-decoration: none;
 	color: #141331;
-	background-color: #B3ABFF;
+	background-color: #7CBBFF;
 	margin: 0;
 	padding: 0;
 }
@@ -128,7 +133,7 @@ pre, code {
 #version a {
   text-decoration: none;
 	color: #141331;
-	background-color: #B3ABFF;
+	background-color: #7CBBFF;
 }
 
 .clickable {

data/website/template.rhtml

@@ -42,7 +42,12 @@
     </p>
 </div>
 
-<!-- insert site tracking codes here, like Google Urchin -->
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-2759652-1";
+urchinTracker();
+</script>
 
 </body>
 </html>

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ec2onrails
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
-date: 2007-10-06 00:00:00 -04:00
+  version: 0.9.4
+date: 2007-10-25 00:00:00 -04:00
 summary: Client-side libraries (Capistrano tasks) for managing and deploying to EC2 on Rails servers.
 require_paths: 
 - lib