hennk-ec2onrails 0.9.9.1

data/README.textile

@@ -0,0 +1,214 @@
+h1. EC2 on Rails
+
+h2. Deploy a Ruby on Rails app on EC2 in five minutes
+
+Main Page: "https://ec2onrails.rubyforge.org":https://ec2onrails.rubyforge.org
+
+Code on Github: "https://github.com/pauldowman/ec2onrails":https://github.com/pauldowman/ec2onrails
+
+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 can start EC2 instances you're five minutes away from deploying your Rails app.
+
+EC2 on Rails is "opinionated software":http://gettingreal.37signals.com/ch04_Make_Opinionated_Software.php: the opinion is that for many rails apps the server setup can be generalized and shared the same way as the web application framework itself. For many people (Twitter, this isn't for you) the server image can be treated the same way as other shared libraries. And if the day comes when your needs areunique enough that EC2 on Rails can't be configured to work for you then you can bundle your own image from it or fork the build source and customize it. 
+
+But until then, why spend your time configuring servers?
+
+Features of the EC2 image:
+
+* Ready to deploy a Rails app with little or no configuration of the server required
+* Optional Amazon Elastic Block Store (EBS) setup and support for MySQL database persistence.
+* Automatic backup of MySQL database to S3 (EBS enabled: snapshots taken every 2 hrs; Non-EBS enabled: full backup nightly + incremental backup using binary logs every 5 minutes if not using )
+* 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/
+* Ruby on Rails 2.1.0, 2.0.2 and 1.2.6
+* Ruby 1.8.6
+* MySQL 5
+* "memcached":http://www.danga.com/memcached/
+* "monit":http://www.tildeslash.com/monit/ configured to monitor apache, mongrel, mysql, memcached, drive space and system load
+* Ubuntu 8.04 LTS "Hardy" base image built using "Eric Hammond's EC2 Ubuntu script":http://alestic.com/
+* SSL support
+* Amazon AMI tools installed
+* Apache or Nginx web proxies
+* MySQL, Apache/Nginx, and syslog configured to use /mnt for data and logging so you don't fill up EC2's small root filesystem
+* Automatically archives Rails and Apache logs to S3 nightly.
+* 32-bit and 64-bit images available (supports all instance types, small to extra large).
+* Created using a build file, full source is "available":http://rubyforge.org/scm/?group_id=4552 (the EC2 on Rails script is run from "Eric Hammond's EC2 Ubuntu script":http://alestic.com/)
+* Can be used as a clustered Rails app running on multiple instances
+* Automatically runs hourly, daily, weekly and monthly scripts if they exist in Rails application's script directory
+* Local "Postfix":http://www.postfix.org/ SMTP mail server (only available from within the instance, not listening on external network interfaces)
+
+
+h2. Using the image
+
+This documentation will be improved soon, for now hopefully this covers the basics. 
+
+The current AMI id's are:
+* ami-c9bc58a0 (32-bit)
+* ami-cbbc58a2 (64-bit)
+
+_I will keep these images available for as long as possible, they will not be deleted for at least a few years._
+
+
+h4. 1. Install the gem
+
+<pre>sudo gem install ec2onrails</pre>
+
+h4. 2. Add the config files to your Rails app
+
+You will need to place "Capfile":http://github.com/pauldowman/ec2onrails/tree/master/examples/Capfile?raw=true in the root of your rails folder, and put "deploy.rb":http://github.com/pauldowman/ec2onrails/tree/master/examples/deploy.rb?raw=true  and "s3.yml":http://github.com/pauldowman/ec2onrails/tree/master/examples/s3.yml?raw=true in the config folder.
+
+Within your rails directory, run
+<code>
+  wget -q -O Capfile http://github.com/pauldowman/ec2onrails/tree/master/examples/Capfile?raw=true
+  wget -q -O config/deploy.rb http://github.com/pauldowman/ec2onrails/tree/master/examples/deploy.rb?raw=true
+  wget -q -O config/s3.yml http://github.com/pauldowman/ec2onrails/tree/master/examples/s3.yml?raw=true
+</code>
+
+
+_Be sure to customize those files and read the comments._
+
+Also, 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. 3. Start up one or more instances of the image.
+
+There is nothing EC2 on Rails-specific here yet (though soon there will be a Capistrano task to do this for you), if you've started EC2 instances before you can skip this section. Otherwise, I'm not going to lie, this part is complicated and will take a lot more than 5 minutes the first time.
+
+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.
+
+For the AMI id's of the current images do <code>cap ec2onrails:ami_ids</code> from within the app that you configured in the previous step (they're also listed earlier on this page).
+
+_NOTE: Only use the images that match the current version of the gem._
+
+Please see the "change log":http://ec2onrails.rubyforge.org/svn/trunk/gem/CHANGELOG for release notes, and see the "list of open issues":http://rubyforge.org/tracker/?atid=17558&group_id=4552&func=browse.
+
+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 to deploy the app, and the admin user for server admin tasks that require sudo.
+
+IMPORTANT: 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 (and possibly TCP 443 if you're going to enable HTTPS). If you're using multiple instances, be sure to allow them network access to each other.
+
+
+h4. 4. Copy your public key from the server to keep Capistrano happy
+
+This is a workaround for a quirk in Capistrano. Technically all you should need to connect to the server is the private  key file, the public key is on the server. But for some reason "Capistrano requires that you have both the public key and the private key files together on the client":http://groups.google.com/group/capistrano/browse_thread/thread/1102208ff925d18.
+
+There is a Capistrano task that tries to fix this for you. From within the root of your rails app do:
+
+<pre>cap ec2onrails:get_public_key_from_server</pre>
+
+Note, this will only work if you have an external ssh command in the path, it won't work for most Windows users.
+
+
+h4. 5. Deploy the app with Capistrano
+
+Now that the gem is installed, your deploy.rb is configured and you can start and stop EC2 instances, this is the only thing you'll need to do from now on.
+
+<pre>
+cap ec2onrails:setup
+cap deploy:cold
+</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 database.
+
+That's it, your app is now running on EC2!!
+
+
+h2. Capistrano tasks
+
+"Capistrano":http://capify.org is the most commonly used Rails deployment tool. It comes with many standard "tasks", and the EC2 on Rails gem includes Capistrano tasks specifically for configuring the server instance.
+
+Capistrano is run from the command-line using the "cap" command, with a task name given as an argument.
+
+h3. Commonly-used tasks
+
+You'll mostly need just the following Capistrano tasks:
+
+* <code>cap ec2onrails:ami_ids</code> Shows the AMI id's of the images that match the current version of the gem.
+
+* <code>cap ec2onrails:setup</code> This task configures a newly-launched instance. This is the first thing you should do after starting a new instance. It can be run more than once without ill effect. After running  "cap ec2onrails:setup" the next thing to do is run "cap deploy:cold"
+
+* <code>cap ec2onrails:db:enable_ebs</code> This task will move the _primary_ mysql database onto an Amazon Elastic Storage Block (EBS) volume. You can call this task with the optional SIZE parameter defined (defaults to 10 gigs) like <pre>cap ec2onrails:db:enable_ebs SIZE=10</pre>
+
+You should then specify your own volume (or the one created by this task) in your capistrano deploy.rb file like so: <pre>role :db, "ec2-xx-xxx-xx-xxx.compute-1.amazonaws.com", :primary => true, :ebs_vol_id => 'vol-12345abc'</pre>
+
+*NOTE* MySQL EBS is not enabled by default.  You may call this task at anytime to move your MySQL over to EBS, but just make sure you keep track of the volume-id that is printed out by this task and use it to modify your deploy.rb file
+
+* <code>cap ec2onrails:server:set_roles</code> Customizes each instance for it's role(s) (as defined in your Capistrano deploy.rb file). Run this after starting or stopping instances. 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.
+
+Note that due to the way that Capistrano works all tasks are run against all hosts that are currently defined in the deploy.rb file. So if you start a new instance then add it to your deploy.rb you will need to run  "cap ec2onrails:setup" again which will be run on all existing instances.
+
+
+h3. Database management tasks
+
+* <code>cap ec2onrails:db:archive</code> Archive the MySQL database to the bucket specified in your deploy.rb. This is for archiving a snapshot of your database into any S3 bucket. For example, you might want to do this before deploying.
+
+* <code>cap ec2onrails:db:restore</code> Restore the MySQL database from the bucket specified in your deploy.rb 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.
+
+To get a full list of the Capistrano tasks at any time type <code>cap -T</code> from with your rails app root.
+
+h2. Building the image
+
+Building the image is not required, most people will simply use the prebuilt public image, but there is also a build script that builds the image. It's meant to be called by "Eric Hammond's EC2 Ubuntu script":http://alestic.com/.
+
+Here is how you go about setting it up:
+
+
+h4. Notes
+
+* amazon-keypair is your amazon keypair, which in this case has has had the public and private keys copied into the ~/.ssh folder
+* we need to copy the ec2onrails source folder onto the image instance
+* HOST_PUBLIC_INSTANCE is the hostname of the instance that you will soon be creating.  run <code>ec2-describe-instances</code> to find this value.  It will look something like <code>ec2-xxx-xxx-xxx-xxx.compute-x.amazonaws.com</code>
+
+h4. Getting started...
+
+* launch one of Eric's default images (see "Eric Hammond's":http://alestic.com/ page for the most recent ami-images): <code>ec2-run-instances ami-179e7a7e -k amazon-keypair</code> (for a 64-bit image, launch: <code>ec2-run-instances ami-f89d7991 -k amazon-keypair --instance-type m1.large</code>)
+* lets get your amazon keypair up onto the instance: <code>scp -i ~/.ssh/id_rsa-amazon-keypair ~/.ec2/{cert,pk}-*.pem root@HOST_PUBLIC_ADDRESS:/mnt/</code>
+* ditto for getting the ec2onrails server code up onto your new instance: <code>scp -rp -i ~/.ssh/id_rsa-amazon-keypair ~/your/copy/of/ec2onrails/. root@HOST_PUBLIC_ADDRESS:/mnt/ec2onrails</code>
+* time to log into your instance: <code>ssh -i ~/.ssh/id_rsa-amazon-keypair root@HOST_PUBLIC_ADDRESS</code>
+* get the most recent ec2ubuntu script: <code>curl -Lo /mnt/ec2ubuntu-build-ami http://ec2ubuntu-build-ami.notlong.com</code>
+* time to get the instance ready for ec2onrails.  The script will end with a command you need to run to finish creating an amazon ami-image. <pre>bash /mnt/ec2ubuntu-build-ami \ 
+--codename hardy \ 
+--bucket YOURNAME_ec2onrails \ 
+--prefix ec2onrails \ 
+--user YOUR_AMAZON_USER_ID \ 
+--access-key AMAZON_ACCESS_KEY \ 
+--secret-key AMAZON_SECRET_KEY \ 
+--private-key /mnt/pk-*.pem \ 
+--cert /mnt/cert-*.pem \ 
+--script /mnt/ec2onrails/server/build-ec2onrails.sh</pre>
+
+h2. Mailing lists
+
+There are two Google groups, one for  "announcements":http://groups.google.com/group/ec2-on-rails-announce (usually just new release announcements) 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
+
+See the "change log":http://ec2onrails.rubyforge.org/svn/trunk/gem/CHANGELOG.
+
+
+h2. How to submit patches
+
+Pleae read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/. The source code can be checked out anonymously using: 
+<pre>
+svn checkout http://ec2onrails.rubyforge.org/svn/trunk ec2onrails
+</pre>
+
+Code on Github: "https://github.com/pauldowman/ec2onrails":https://github.com/pauldowman/ec2onrails
+
+Patches can be submitted to the "RubyForge Tracker":http://rubyforge.org/tracker/?atid=17560&group_id=4552&func=browse  or "emailed directly to me":http://pauldowman.com/contact/ .
+
+h2. License
+
+This code is free to use under the terms of the GPL v2. 
+
+If you find EC2 on Rails useful please "recommend Paul Dowman":http://www.workingwithrails.com/person/10131-paul-dowman at Working With Rails.
+
+Copyright 2007 Paul Dowman, http://pauldowman.com/ This is free software, and you are welcome to redistribute it under certain conditions. This software comes with ABSOLUTELY NO WARRANTY. See the file named COPYING for details.

data/Rakefile

@@ -0,0 +1,36 @@
+require "./lib/ec2onrails/version"
+ 
+begin
+  require 'echoe'
+rescue LoadError
+  abort "You'll need to have `echoe' installed to use ec2onrails' Rakefile"
+end
+ 
+version = Ec2onrails::VERSION::STRING.dup
+ 
+Echoe.new('ec2onrails', version) do |p|
+  p.changelog        = "CHANGELOG"
+ 
+  p.author           = ['Paul Dowman', 'Adam Greene']
+  p.email            = "paul@pauldowman.com"
+ 
+  p.summary = <<-DESC.strip.gsub(/\n\s+/, " ")
+    Client-side libraries (Capistrano tasks) for managing and 
+    deploying to EC2 on Rails servers.
+  DESC
+  
+  #OTHER helpful options
+  # p.install_message = "perhaps telling them where to find the example docs?"
+  # p.rdoc_pattern
+  p.url              = "http://ec2onrails.rubyforge.org"
+  p.need_zip         = true
+  p.rdoc_pattern     = /^(lib|README.textile|CHANGELOG)/
+ 
+  p.dependencies     = [
+                        'capistrano          >= 2.4.3', 
+                        'archive-tar-minitar >= 0.5.1', 
+                        'optiflag            >= 0.6.5']
+                        
+  p.development_dependencies = ['rake >=0.7.1']
+  
+end

data/TODO

@@ -0,0 +1,5 @@
+FUTURE CHANGES
+[ ] Merge multi_app work when done
+[ ] Add munin
+	- See http://onrails.org/articles/2007/08/31/monitoring-rails-performance-with-munin-and-a-mongrel for a munin plugin to show Rails response times
+[ ] Check if EBS is a viable alternative for app file storage

data/ec2onrails.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ec2onrails}
+  s.version = "0.9.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Dowman, Adam Greene"]
+  s.date = %q{2008-11-16}
+  s.description = %q{Client-side libraries (Capistrano tasks) for managing and  deploying to EC2 on Rails servers.}
+  s.email = %q{paul@pauldowman.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/ec2onrails/capistrano_utils.rb", "lib/ec2onrails/recipes.rb", "lib/ec2onrails/version.rb", "lib/ec2onrails.rb", "README.textile"]
+  s.files = ["CHANGELOG", "COPYING", "lib/ec2onrails/capistrano_utils.rb", "lib/ec2onrails/recipes.rb", "lib/ec2onrails/version.rb", "lib/ec2onrails.rb", "Rakefile", "README.textile", "server/build-ec2onrails.sh", "server/files/etc/aliases", "server/files/etc/aliases.db", "server/files/etc/apache2/apache2.conf", "server/files/etc/apache2/conf.d/app.proxy_cluster.conf", "server/files/etc/apache2/conf.d/app.proxy_frontend.conf", "server/files/etc/apache2/mods-available/proxy.conf", "server/files/etc/apache2/sites-available/app.common", "server/files/etc/apache2/sites-available/app.custom", "server/files/etc/apache2/sites-available/default", "server/files/etc/apache2/sites-available/default-ssl", "server/files/etc/cron.d/backup_app_db_to_s3", "server/files/etc/cron.daily/app", "server/files/etc/cron.daily/logrotate_post", "server/files/etc/cron.hourly/app", "server/files/etc/cron.monthly/app", "server/files/etc/cron.weekly/app", "server/files/etc/denyhosts.conf", "server/files/etc/dpkg/dpkg.cfg", "server/files/etc/ec2onrails/balancer_members", "server/files/etc/ec2onrails/roles.yml", "server/files/etc/environment", "server/files/etc/event.d/monit", "server/files/etc/init.d/ec2-every-startup", "server/files/etc/init.d/ec2-first-startup", "server/files/etc/init.d/mongrel", "server/files/etc/init.d/set_roles", "server/files/etc/logrotate.d/apache2", "server/files/etc/logrotate.d/mysql-server", "server/files/etc/logrotate.d/rails", "server/files/etc/memcached.conf", "server/files/etc/mongrel_cluster/app.yml", "server/files/etc/monit/app.monitrc", "server/files/etc/monit/db_primary.monitrc", "server/files/etc/monit/memcache.monitrc", "server/files/etc/monit/monitrc", "server/files/etc/monit/system.monitrc", "server/files/etc/monit/web.monitrc", "server/files/etc/motd.tail", "server/files/etc/mysql/my.cnf", "server/files/etc/postfix/main.cf", "server/files/etc/rc0.d/K10mongrel", "server/files/etc/rc1.d/K10mongrel", "server/files/etc/rc2.d/S90mongrel", "server/files/etc/rc3.d/S90mongrel", "server/files/etc/rc4.d/S90mongrel", "server/files/etc/rc5.d/S90mongrel", "server/files/etc/rc6.d/K10mongrel", "server/files/etc/rcS.d/S91ec2-first-startup", "server/files/etc/rcS.d/S92ec2-every-startup", "server/files/etc/rcS.d/S99set_roles", "server/files/etc/ssh/sshd_config", "server/files/etc/sudoers", "server/files/etc/syslog.conf", "server/files/usr/local/ec2onrails/bin/archive_file.rb", "server/files/usr/local/ec2onrails/bin/backup_app_db.rb", "server/files/usr/local/ec2onrails/bin/backup_files.rb", "server/files/usr/local/ec2onrails/bin/mongrel_start", "server/files/usr/local/ec2onrails/bin/mongrel_stop", "server/files/usr/local/ec2onrails/bin/rails_env", "server/files/usr/local/ec2onrails/bin/rebundle.sh", "server/files/usr/local/ec2onrails/bin/restore_app_db.rb", "server/files/usr/local/ec2onrails/bin/restore_files.rb", "server/files/usr/local/ec2onrails/bin/set_rails_env", "server/files/usr/local/ec2onrails/bin/set_roles.rb", "server/files/usr/local/ec2onrails/config", "server/files/usr/local/ec2onrails/COPYING", "server/files/usr/local/ec2onrails/lib/mysql_helper.rb", "server/files/usr/local/ec2onrails/lib/s3_helper.rb", "server/files/usr/local/ec2onrails/lib/utils.rb", "server/files/usr/local/ec2onrails/startup-scripts/every-startup/get-hostname.sh", "server/files/usr/local/ec2onrails/startup-scripts/first-startup/create-dirs.sh", "server/files/usr/local/ec2onrails/startup-scripts/first-startup/generate-default-web-cert-and-key.sh", "server/files/usr/local/ec2onrails/startup-scripts/first-startup/misc.sh", "server/files/usr/local/ec2onrails/startup-scripts/first-startup/prepare-mysql-data-dir.sh", "server/files/usr/local/ec2onrails/startup-scripts/first-startup/setup_credentials.sh", "server/rakefile.rb", "setup.rb", "test/autobench.conf", "test/spec/lib/s3_helper_spec.rb", "test/spec/lib/s3_old.yml", "test/spec/test_files/test1", "test/spec/test_files/test2", "test/test_app/app/controllers/application.rb", "test/test_app/app/controllers/db_fast_controller.rb", "test/test_app/app/controllers/fast_controller.rb", "test/test_app/app/controllers/slow_controller.rb", "test/test_app/app/controllers/very_slow_controller.rb", "test/test_app/app/helpers/application_helper.rb", "test/test_app/app/helpers/db_fast_helper.rb", "test/test_app/app/helpers/fast_helper.rb", "test/test_app/app/helpers/slow_helper.rb", "test/test_app/app/helpers/very_slow_helper.rb", "test/test_app/Capfile", "test/test_app/config/boot.rb", "test/test_app/config/database.yml", "test/test_app/config/deploy.rb", "test/test_app/config/environment.rb", "test/test_app/config/environments/development.rb", "test/test_app/config/environments/production.rb", "test/test_app/config/environments/test.rb", "test/test_app/config/routes.rb", "test/test_app/db/schema.rb", "test/test_app/doc/README_FOR_APP", "test/test_app/public/404.html", "test/test_app/public/500.html", "test/test_app/public/dispatch.cgi", "test/test_app/public/dispatch.fcgi", "test/test_app/public/dispatch.rb", "test/test_app/public/favicon.ico", "test/test_app/public/images/rails.png", "test/test_app/public/javascripts/application.js", "test/test_app/public/javascripts/controls.js", "test/test_app/public/javascripts/dragdrop.js", "test/test_app/public/javascripts/effects.js", "test/test_app/public/javascripts/prototype.js", "test/test_app/public/robots.txt", "test/test_app/Rakefile", "test/test_app/README", "test/test_app/script/about", "test/test_app/script/breakpointer", "test/test_app/script/console", "test/test_app/script/destroy", "test/test_app/script/generate", "test/test_app/script/performance/benchmarker", "test/test_app/script/performance/profiler", "test/test_app/script/performance/request", "test/test_app/script/plugin", "test/test_app/script/process/inspector", "test/test_app/script/process/reaper", "test/test_app/script/process/spawner", "test/test_app/script/runner", "test/test_app/script/server", "test/test_app/test/functional/db_fast_controller_test.rb", "test/test_app/test/functional/fast_controller_test.rb", "test/test_app/test/functional/slow_controller_test.rb", "test/test_app/test/functional/very_slow_controller_test.rb", "test/test_app/test/test_helper.rb", "TODO", "Manifest", "ec2onrails.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://ec2onrails.rubyforge.org}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ec2onrails", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ec2onrails}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Client-side libraries (Capistrano tasks) for managing and  deploying to EC2 on Rails servers.}
+  s.test_files = ["test/test_app/test/functional/db_fast_controller_test.rb", "test/test_app/test/functional/fast_controller_test.rb", "test/test_app/test/functional/slow_controller_test.rb", "test/test_app/test/functional/very_slow_controller_test.rb", "test/test_app/test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 0", "= 2.4.3"])
+      s.add_runtime_dependency(%q<archive-tar-minitar>, [">= 0", "= 0.5.1"])
+      s.add_runtime_dependency(%q<optiflag>, [">= 0", "= 0.6.5"])
+      s.add_development_dependency(%q<rake>, [">= 0.7.1"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0", "= 2.4.3"])
+      s.add_dependency(%q<archive-tar-minitar>, [">= 0", "= 0.5.1"])
+      s.add_dependency(%q<optiflag>, [">= 0", "= 0.6.5"])
+      s.add_dependency(%q<rake>, [">= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0", "= 2.4.3"])
+    s.add_dependency(%q<archive-tar-minitar>, [">= 0", "= 0.5.1"])
+    s.add_dependency(%q<optiflag>, [">= 0", "= 0.6.5"])
+    s.add_dependency(%q<rake>, [">= 0.7.1"])
+  end
+end

data/lib/ec2onrails.rb

@@ -0,0 +1,20 @@
+#    This file is part of EC2 on Rails.
+#    http://rubyforge.org/projects/ec2onrails/
+#
+#    Copyright 2007 Paul Dowman, http://pauldowman.com/
+#
+#    EC2 on Rails is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    EC2 on Rails is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+$:.unshift File.dirname(__FILE__)

data/lib/ec2onrails/capistrano_utils.rb

@@ -0,0 +1,33 @@
+module Ec2onrails
+  module CapistranoUtils
+    def run_local(command)
+      result = system command
+      raise("error: #{$?}") unless result
+    end
+    
+    def run_init_script(script, arg)
+      # since init scripts might have the execute bit unset by the set_roles script we need to check
+      sudo "sh -c 'if [ -x /etc/init.d/#{script} ] ; then /etc/init.d/#{script} #{arg}; fi'"
+    end
+    
+    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, srv_def.host, options
+      end
+    end
+    
+    # return hostnames for the role named role_sym that has the specified options
+    def hostnames_for_role(role_sym, options = {})
+      role = roles[role_sym]
+      unless role
+        return []
+      end
+      role.select{|s| s.options == options}.collect{|s| s.host}
+    end
+  end
+end

data/lib/ec2onrails/recipes.rb

@@ -0,0 +1,460 @@
+#    This file is part of EC2 on Rails.
+#    http://rubyforge.org/projects/ec2onrails/
+#
+#    Copyright 2007 Paul Dowman, http://pauldowman.com/
+#
+#    EC2 on Rails is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    EC2 on Rails is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+include FileUtils
+require 'tmpdir'
+require 'pp'
+require 'zlib'
+require 'archive/tar/minitar'
+include Archive::Tar
+
+require 'ec2onrails/version'
+require 'ec2onrails/capistrano_utils'
+include Ec2onrails::CapistranoUtils
+
+Capistrano::Configuration.instance.load do
+
+  unless ec2onrails_config
+    raise "ec2onrails_config variable not set. (It should be a hash.)"
+  end
+  
+  cfg = ec2onrails_config
+
+  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 an "admin" role for each role, and create arrays containing
+  # the names of admin roles and non-admin roles for convenience
+  set :all_admin_role_names, []
+  set :all_non_admin_role_names, []
+  roles.keys.clone.each do |name|
+    make_admin_role_for(name)
+    all_non_admin_role_names << name
+    all_admin_role_names << "#{name.to_s}_admin".to_sym
+  end
+  
+  after "deploy:symlink", "ec2onrails:server:set_roles"
+  after "deploy:cold", "ec2onrails:db:init_backup"
+  
+  # override default start/stop/restart tasks
+  namespace :deploy do
+    desc <<-DESC
+      Overrides the default Capistrano deploy:restart, uses \
+      /etc/init.d/mongrel
+    DESC
+    task :start, :roles => :app_admin do
+      run_init_script("mongrel", "start")
+      run "sleep 30" # give the service 30 seconds to start before attempting to monitor it
+      sudo "monit -g app monitor all"
+    end
+    
+    desc <<-DESC
+      Overrides the default Capistrano deploy:restart, uses \
+      /etc/init.d/mongrel
+    DESC
+    task :stop, :roles => :app_admin do
+      sudo "monit -g app unmonitor all"
+      run_init_script("mongrel", "stop")
+    end
+    
+    desc <<-DESC
+      Overrides the default Capistrano deploy:restart, uses \
+      /etc/init.d/mongrel
+    DESC
+    task :restart, :roles => :app_admin do
+      deploy.stop
+      deploy.start
+    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 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
+      Copies the public key from the server using the external "ssh"
+      command because Net::SSH, which is used by Capistrano, needs it.
+      This will only work if you have an ssh command in the path.
+      If Capistrano can successfully connect to your EC2 instance you
+      don't need to do this. It will copy from the first server in the
+      :app role, this can be overridden by specifying the HOST 
+      environment variable
+    DESC
+    task :get_public_key_from_server do
+      host = find_servers_for_task(current_task).first.host
+      privkey = ssh_options[:keys][0]
+      pubkey = "#{privkey}.pub"
+      msg = <<-MSG
+      Your first key in ssh_options[:keys] is #{privkey}, presumably that's 
+      your EC2 private key. The public key will be copied from the server 
+      named '#{host}' and saved locally as #{pubkey}. Continue? [y/n]
+      MSG
+      choice = nil
+      while choice != "y" && choice != "n"
+        choice = Capistrano::CLI.ui.ask(msg).downcase
+        msg = "Please enter 'y' or 'n'."
+      end
+      if choice == "y"
+        run_local "scp -i '#{privkey}' app@#{host}:.ssh/authorized_keys #{pubkey}"
+      end
+    end
+    
+    desc <<-DESC
+      Prepare a newly-started instance for a cold deploy.
+    DESC
+    task :setup, :roles => all_admin_role_names do
+      server.set_admin_mail_forward_address
+      server.set_timezone
+      server.install_packages
+      server.install_gems
+      server.deploy_files
+      server.enable_ssl if cfg[:enable_ssl]
+      server.set_rails_env
+      server.restart_services
+      deploy.setup
+      db.create
+    end
+    
+    desc <<-DESC
+      Deploy and restore database from S3
+    DESC
+    task :restore_db_and_deploy do
+      db.recreate
+      deploy.update_code
+      deploy.symlink
+      db.restore
+      deploy.migrations
+    end
+    
+    namespace :ec2 do
+      desc <<-DESC
+      DESC
+      task :configure_firewall do
+        # TODO
+      end
+    end
+    
+    namespace :db do
+      desc <<-DESC
+        [internal] Load configuration info for the database from 
+        config/database.yml, and start mysql (it must be running
+        in order to interact with it).
+      DESC
+      task :load_config do
+        unless hostnames_for_role(:db, :primary => true).empty?
+          db_config = YAML::load(ERB.new(File.read("config/database.yml")).result)[rails_env.to_s]
+          cfg[:db_name] = db_config['database']
+          cfg[:db_user] = db_config['username'] || db_config['user'] 
+          cfg[:db_password] = db_config['password']
+          cfg[:db_host] = db_config['host']
+          cfg[:db_socket] = db_config['socket']
+        
+          if (cfg[:db_host].nil? || cfg[:db_host].empty?) && (cfg[:db_socket].nil? || cfg[:db_socket].empty?)
+              raise "ERROR: missing database config. Make sure database.yml contains a '#{rails_env}' section with either 'host: hostname' or 'socket: /var/run/mysqld/mysqld.sock'."
+          end
+        
+          [cfg[:db_name], cfg[:db_user], cfg[:db_password]].each do |s|
+            if s.nil? || s.empty?
+              raise "ERROR: missing database config. Make sure database.yml contains a '#{rails_env}' section with a database name, user, and password."
+            elsif s.match(/['"]/)
+              raise "ERROR: database config string '#{s}' contains quotes."
+            end
+          end
+        end
+      end
+      
+      desc <<-DESC
+        Create the MySQL database. Assumes there is no MySQL root \
+        password. To create a MySQL root password create a task that's run \
+        after this task using an after hook.
+      DESC
+      task :create, :roles => :db do
+        on_rollback { drop }
+        load_config
+        start
+        
+        # For some reason the default db on Hardy contains users with '' as the name.
+        # This causes authentication problems when connecting from localhost
+        run %{mysql -u root -D mysql -e "delete from user where User = ''; flush privileges;"}
+        
+        run %{mysql -u root -e "create database if not exists #{cfg[:db_name]};"}
+        run %{mysql -u root -e "grant all on #{cfg[:db_name]}.* to '#{cfg[:db_user]}'@'%' identified by '#{cfg[:db_password]}';"}
+        run %{mysql -u root -e "grant reload on *.* to '#{cfg[:db_user]}'@'%' identified by '#{cfg[:db_password]}';"}
+        run %{mysql -u root -e "grant super on *.* to '#{cfg[:db_user]}'@'%' identified by '#{cfg[:db_password]}';"}
+      end
+      
+      desc <<-DESC
+        [internal] Make sure the MySQL server has been started, just in case the db role 
+        hasn't been set, e.g. when called from ec2onrails:setup.
+        (But don't enable monitoring on it.)
+      DESC
+      task :start, :roles => :db_admin do
+        sudo "chmod a+x /etc/init.d/mysql"
+        # The mysql init script can fail on the first startup if mysql takes too long 
+        # to create the logfiles, so try again
+        sudo "sh -c '/etc/init.d/mysql start || (sleep 10 && /etc/init.d/mysql start)'"
+      end
+      
+      desc <<-DESC
+        Drop the MySQL database. Assumes there is no MySQL root \
+        password. If there is a MySQL root password, create a task that removes \
+        it and run that task before this one using a before hook.
+      DESC
+      task :drop, :roles => :db do
+        load_config
+        run %{mysql -u root -e "drop database if exists #{cfg[:db_name]};"}
+      end
+      
+      desc <<-DESC
+        db:drop and db:create.
+      DESC
+      task :recreate, :roles => :db do
+        drop
+        create
+      end
+      
+      desc <<-DESC
+        Set a root password for MySQL, using the variable mysql_root_password \
+        if it is set. If this is done db:drop won't work.
+      DESC
+      task :set_root_password, :roles => :db do
+        if cfg[:mysql_root_password]
+          run %{mysql -u root -e "UPDATE mysql.user SET Password=PASSWORD('#{cfg[:mysql_root_password]}') WHERE User='root'; FLUSH PRIVILEGES;"}
+        end
+      end
+      
+      desc <<-DESC
+        Dump the MySQL database to the S3 bucket specified by \
+        ec2onrails_config[:archive_to_bucket]. The filename will be \
+        "database-archive/<timestamp>/dump.sql.gz".
+      DESC
+      task :archive, :roles => :db do
+        run "/usr/local/ec2onrails/bin/backup_app_db.rb --bucket #{cfg[:archive_to_bucket]} --dir #{cfg[:archive_to_bucket_subdir]}"
+      end
+      
+      desc <<-DESC
+        Restore the MySQL database from the S3 bucket specified by \
+        ec2onrails_config[:restore_from_bucket]. The archive filename is \
+        expected to be the default, "mysqldump.sql.gz".
+      DESC
+      task :restore, :roles => :db do
+        run "/usr/local/ec2onrails/bin/restore_app_db.rb --bucket #{cfg[:restore_from_bucket]} --dir #{cfg[:restore_from_bucket_subdir]}"
+      end
+      
+      desc <<-DESC
+        [internal] Initialize the default backup folder on S3 (i.e. do a full
+        backup of the newly-created db so the automatic incremental backups 
+        make sense).
+      DESC
+      task :init_backup, :roles => :db do
+        run "/usr/local/ec2onrails/bin/backup_app_db.rb --reset"
+      end
+    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 => all_admin_role_names do
+        # TODO generate this based on the roles that actually exist so arbitrary new ones can be added
+        roles = {
+          :web =>        hostnames_for_role(:web),
+          :app =>        hostnames_for_role(:app),
+          :db_primary => hostnames_for_role(:db, :primary => true),
+          :memcache =>   hostnames_for_role(:memcache)
+        }
+        roles_yml = YAML::dump(roles)
+        put roles_yml, "/tmp/roles.yml"
+        sudo "cp /tmp/roles.yml /etc/ec2onrails"
+        sudo "/usr/local/ec2onrails/bin/set_roles.rb"
+      end
+
+      desc <<-DESC
+        Change the default value of RAILS_ENV on the server. Technically
+        this changes the server's mongrel config to use a different value
+        for "environment". The value is specified in :rails_env.
+        Be sure to do deploy:restart after this.
+      DESC
+      task :set_rails_env, :roles => all_admin_role_names do
+        rails_env = fetch(:rails_env, "production")
+        sudo "/usr/local/ec2onrails/bin/set_rails_env #{rails_env}"
+      end
+      
+      desc <<-DESC
+        Upgrade to the newest versions of all Ubuntu packages.
+      DESC
+      task :upgrade_packages, :roles => all_admin_role_names do
+        sudo "aptitude -q update"
+        run "export DEBIAN_FRONTEND=noninteractive; sudo aptitude -q -y safe-upgrade"
+      end
+      
+      desc <<-DESC
+        Upgrade to the newest versions of all rubygems.
+      DESC
+      task :upgrade_gems, :roles => all_admin_role_names do
+        sudo "gem update --system --no-rdoc --no-ri"
+        sudo "gem update --no-rdoc --no-ri" do |ch, str, data|
+          ch[:data] ||= ""
+          ch[:data] << data
+          if data =~ />\s*$/
+            puts data
+            choice = Capistrano::CLI.ui.ask("The gem command is asking for a number:")
+            ch.send_data("#{choice}\n")
+          else
+            puts data
+          end
+        end
+        
+      end
+      
+      desc <<-DESC
+        Install extra Ubuntu packages. Set ec2onrails_config[:packages], it \
+        should be an array of strings.
+        NOTE: the package installation will be non-interactive, if the packages \
+        require configuration either log in as 'admin' and run \
+        'dpkg-reconfigure packagename' or replace the package's config files \
+        using the 'ec2onrails:server:deploy_files' task.
+      DESC
+      task :install_packages, :roles => all_admin_role_names do
+        if cfg[:packages] && cfg[:packages].any?
+          run "export DEBIAN_FRONTEND=noninteractive; sudo aptitude -q -y install #{cfg[:packages].join(' ')}"
+        end
+      end
+      
+      desc <<-DESC
+        Install extra rubygems. Set ec2onrails_config[:rubygems], it should \
+        be with an array of strings.
+      DESC
+      task :install_gems, :roles => all_admin_role_names do
+        if cfg[:rubygems]
+          cfg[:rubygems].each do |gem|
+            sudo "gem install #{gem} --no-rdoc --no-ri" do |ch, str, data|
+              ch[:data] ||= ""
+              ch[:data] << data
+              if data =~ />\s*$/
+                puts data
+                choice = Capistrano::CLI.ui.ask("The gem command is asking for a number:")
+                ch.send_data("#{choice}\n")
+              else
+                puts data
+              end
+            end
+          end
+        end
+      end
+      
+      desc <<-DESC
+        A convenience task to upgrade existing packages and gems and install \
+        specified new ones.
+      DESC
+      task :upgrade_and_install_all, :roles => all_admin_role_names do
+        upgrade_packages
+        upgrade_gems
+        install_packages
+        install_gems
+      end
+      
+      desc <<-DESC
+        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=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'.
+      DESC
+      task :set_timezone, :roles => all_admin_role_names do
+        if cfg[:timezone]
+          sudo "bash -c 'echo #{cfg[:timezone]} > /etc/timezone'"
+          sudo "cp /usr/share/zoneinfo/#{cfg[:timezone]} /etc/localtime"
+        end
+      end
+      
+      desc <<-DESC
+        Deploy a set of config files to the server, the files will be owned by \
+        root. This doesn't delete any files from the server. This is intended
+        mainly for customized config files for new packages installed via the \
+        ec2onrails:server:install_packages task. Subdirectories and files \
+        inside here will be placed within the same directory structure \
+        relative to the root of the server's filesystem.
+      DESC
+      task :deploy_files, :roles => all_admin_role_names do
+        if cfg[:server_config_files_root]
+          begin
+            filename = "config_files.tar"
+            local_file = "#{Dir.tmpdir}/#{filename}"
+            remote_file = "/tmp/#{filename}"
+            FileUtils.cd(cfg[:server_config_files_root]) do
+              File.open(local_file, 'wb') { |tar| Minitar.pack(".", tar) }
+            end
+            put File.read(local_file), remote_file
+            sudo "tar xvf #{remote_file} -o -C /"
+          ensure
+            rm_rf local_file
+            run "rm -f #{remote_file}"
+          end
+        end
+      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 => all_admin_role_names do
+        if cfg[:services_to_restart] && cfg[:services_to_restart].any?
+          cfg[:services_to_restart].each do |service|
+            run_init_script(service, "restart")
+          end
+        end
+      end
+      
+      desc <<-DESC
+        Set the email address that mail to the admin user forwards to.
+      DESC
+      task :set_admin_mail_forward_address, :roles => all_admin_role_names do
+        put cfg[:admin_mail_forward_address], "/home/admin/.forward" if cfg[:admin_mail_forward_address]
+      end
+
+      desc <<-DESC
+        Enable ssl for the web server. The SSL cert file should be in
+        /etc/ssl/certs/default.pem and the SSL key file should be in
+        /etc/ssl/private/default.key (use the deploy_files task).
+      DESC
+      task :enable_ssl, :roles => :web_admin do
+        sudo "a2enmod ssl"
+        sudo "a2ensite default-ssl"
+        run_init_script("apache2", "restart")
+      end
+    end
+    
+  end
+end